Skip to content

Tests for basic igo_common functions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
billy-bao wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Tests for basic igo_common functions #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2e0fc5
add igo_common test
billy-bao Feb 19, 2024
429c816
add NULL checks for igo_init and igo_finish
billy-bao Feb 19, 2024
45cc02f
documentation updates for NULL handling in igo_init/igo_finish
billy-bao Feb 19, 2024
d657160
minor doc change
billy-bao Feb 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/igo.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ int igo_init (
/* --- inouts --- */
igo_common* igo_cm
) {
if (igo_cm == NULL) {
return 0;
}

igo_cm->cholmod_cm = malloc(sizeof(cholmod_common));
cholmod_start(igo_cm->cholmod_cm);

Expand Down Expand Up @@ -44,6 +48,9 @@ int igo_finish (
/* --- inouts --- */
igo_common* igo_cm
) {
if (igo_cm == NULL) {
return 1;
}
igo_free_sparse(&(igo_cm->A), igo_cm);
igo_free_dense(&(igo_cm->b), igo_cm);
igo_free_factor(&(igo_cm->L), igo_cm);
Expand Down
2 changes: 2 additions & 0 deletions src/igo.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,13 @@ typedef struct igo_common_struct {
/* Primary functions */
/* ---------------------------------------------------------- */

/* Returns 0 if given a NULL pointer, 1 otherwise. */
int igo_init (
/* --- inouts --- */
igo_common* igo_cm
) ;

/* Always succeeds and returns 1. Attempting to finish a NULL pointer performs no operation on it instead. */
int igo_finish (
/* --- inouts --- */
igo_common* igo_cm
Expand Down
55 changes: 55 additions & 0 deletions tests/test_igo_common.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
#include <gtest/gtest.h>

extern "C" {
#include <igo.h>
}

TEST(CommonTests, TestInitTypical) {
igo_common* igo_cm = (igo_common*) malloc(sizeof(igo_common));
int ret = igo_init(igo_cm);
ASSERT_EQ(ret, 1);
ASSERT_NE(igo_cm, (void*)NULL);
// check cholmod initialization
ASSERT_NE(igo_cm->cholmod_cm, (void*)NULL);
ASSERT_EQ(igo_cm->cholmod_cm->status, 0);
// check matrices
ASSERT_NE(igo_cm->A, (void*)NULL);
ASSERT_NE(igo_cm->b, (void*)NULL);
ASSERT_NE(igo_cm->L, (void*)NULL);
ASSERT_NE(igo_cm->x, (void*)NULL);
ASSERT_NE(igo_cm->y, (void*)NULL);
// cleanup
cholmod_free_sparse(&igo_cm->A->A, igo_cm->cholmod_cm);
cholmod_free_dense(&igo_cm->b->B, igo_cm->cholmod_cm);
cholmod_free_factor(&igo_cm->L->L, igo_cm->cholmod_cm);
cholmod_free_dense(&igo_cm->x->B, igo_cm->cholmod_cm);
cholmod_free_dense(&igo_cm->y->B, igo_cm->cholmod_cm);
free(igo_cm->A);
free(igo_cm->b);
free(igo_cm->L);
free(igo_cm->x);
free(igo_cm->y);
cholmod_finish(igo_cm->cholmod_cm);
free(igo_cm);
}

TEST(CommonTests, TestFinishTypical) {
igo_common* igo_cm = (igo_common*) malloc(sizeof(igo_common));
igo_init(igo_cm);
int ret = igo_finish(igo_cm);
ASSERT_EQ(ret, 1);
ASSERT_EQ(igo_cm->cholmod_cm, (void*)NULL);
free(igo_cm);
}

TEST(CommonTests, TestFinishNull) {
igo_common* igo_cm = NULL;
int ret = igo_finish(igo_cm);
ASSERT_EQ(ret, 1);
}

TEST(CommonTests, TestInitNull) {
igo_common* igo_cm = NULL;
int ret = igo_init(igo_cm);
ASSERT_EQ(ret, 0);
}