comments, check unit tests prepared

Author: Thomas Irgang

.gitignore

@@ -10,4 +10,5 @@ obj/*
 *.out.*
 *.out
 
+doc/*
 

Doxyfile

@@ -0,0 +1,25 @@
+#include <stdlib.h>
+#include <check.h>
+
+#include "check_simplex.h"
+#include "check_rational.h"
+
+int main(void)
+{
+    int number_failed;
+    SRunner *sr;
+    Suite *s_rational = rational_suite();
+    Suite *s_simplex = simplex_suite();
+
+
+    sr = srunner_create(s_simplex);
+    srunner_add_suite(sr, s_rational);
+
+    srunner_run_all(sr, CK_NORMAL);
+
+    number_failed = srunner_ntests_failed(sr);
+
+    srunner_free(sr);
+
+    return (number_failed == 0)? EXIT_SUCCESS : EXIT_FAILURE;
+}

check.c

@@ -1,13 +1,23 @@
+/**
+ * @brief Check unit tests for rational numbers.
+ *
+ * This file contains the unit tests for the rational numbers.
+ *
+ * @file check_rational.c
+ * @author Thomas Irgang
+ * @date 17 Feb 2015
+ */
+
 #include <stdlib.h>
 #include <check.h>
 
 #include "rational.h"
 
-START_TEST(test_getRational)
+START_TEST(test_rational_get)
 {
     struct Rational *r;
 
-    r = getRational(2,3);
+    r = rational_get(2,3);
 
     ck_assert_int_eq(r->n, 2);
     ck_assert_int_eq(r->d, 3);
@@ -25,26 +35,9 @@ Suite *rational_suite(void)
 
     tc_core = tcase_create("Core");
 
-    tcase_add_test(tc_core, test_getRational);
+    tcase_add_test(tc_core, test_rational_get);
     suite_add_tcase(s, tc_core);
 
     return s;
 }
 
-int main(void)
-{
-    int number_failed;
-    Suite *s;
-    SRunner *sr;
-
-    s = rational_suite();
-    sr = srunner_create(s);
-
-    srunner_run_all(sr, CK_NORMAL);
-    number_failed = srunner_ntests_failed(sr);
-
-    srunner_free(sr);
-
-    return (number_failed == 0)? EXIT_SUCCESS : EXIT_FAILURE;
-}
-

check_rational.c

@@ -0,0 +1,10 @@
+/**
+ * @brief Check unit tests for rational numbers.
+ *
+ *
+ * @file check_rational.h
+ * @author Thomas Irgang
+ * @date 17 Feb 2015
+ */
+
+Suite *rational_suite(void);

check_rational.h

@@ -0,0 +1,33 @@
+/**
+ * @brief Check unit tests for simplex algorithm.
+ *
+ * This file contains the unit tests for the simples algorithm.
+ *
+ * @file check_simplex.c
+ * @author Thomas Irgang
+ * @date 17 Feb 2015
+ */
+
+#include <stdlib.h>
+#include <check.h>
+
+#include "simplex.h"
+
+Suite *simplex_suite(void)
+{
+    Suite *s;
+    TCase *tc_core;
+
+    s = suite_create("Simplex");
+
+    tc_core = tcase_create("Core");
+
+    /*tcase_add_test(tc_core, test_);*/
+    suite_add_tcase(s, tc_core);
+
+    return s;
+}
+
+
+
+

check_simplex.c

@@ -0,0 +1,9 @@
+/**
+ * @brief Check unit tests for simplex algorithm.
+ *
+ * @file check_simplex.h
+ * @author Thomas Irgang
+ * @date 17 Feb 2015
+ */
+
+Suite *simplex_suite(void);

check_simplex.h

@@ -1,74 +1,104 @@
+/**
+ * @brief Little program using simplex algorithm.
+ *
+ * This file implements a little example using the simplex algorithm.
+ *
+ * @file rational_test.c
+ * @author Thomas Irgang
+ * @date 17 Feb 2015
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <time.h>
 
 #include "simplex.h"
-#include "rational.h"
-
-struct Tableau *createTestdata(void);
-struct Tableau *createTestdataPhase2(void);
 
+/**
+ * @brief Create tableau with example problem.
+ *
+ * This function creates a new (invalid) simplex tableau filled with a
+ * small test optimization problem.
+ *
+ * Maximize 300x + 500y
+ * s.t.: 1) x + 2y <= 170
+ *       2) x +  y <= 150
+ *       3)     3y <= 180
+ *       4)      y >= 1
+ *
+ * @return tableau for problem
+ */
+struct Tableau *create_testproblem_tableau(void);
+
+/**
+ * @brief Solve example problem.
+ *
+ * This function solves the little example problem using
+ * phase 1 and 2 of simplex algorithm.
+ */
 int main(void)
 {
-    struct Tableau *tableau = NULL, *phase1 = NULL;
-    clock_t start, s_p1, e_p1, s_prep, e_prep, s_p2, e_p2, end, calc;
+    struct Tableau *tableau = NULL, *phase1 = NULL; /* variables for tableaus */
+    clock_t start, s_p1, e_p1, s_prep = 0, e_prep = 0, s_p2 = 0, e_p2 = 0, end, calc; /* variables for time */
 
     start = clock();
 
-    tableau = createTestdata();
-    printf("aktualisiere Pivot-Element ...\n");
-    updatePivot(tableau);
-    printf("schreibe Tableau ...\n");
-    printTableau(tableau);
+    tableau = create_testproblem_tableau(); /* Create test problem. */
+    printf("Print tableau ...\n");
+    simplex_print_tableau(tableau); /* Print test problem to stdout. */
 
 
-    printf("Simplex Phase I ...\n");
+    printf("Run simplex phase 1 ...\n");
     s_p1 = clock();
-    phase1 = simplexPhaseI(tableau);
+    phase1 = simplex_find_start_corner(tableau); /* Calculate start corner for phase 2 of simplex algorithm. */
     e_p1 = clock();
-    printTableau(phase1);
-    printf("Lösung von Phase I:\n");
-    printSolution(phase1);
+    simplex_print_tableau(phase1); /* Print solved, extended tableau. */
+    printf("Solution of phase 1:\n");
+    simplex_print_solution(phase1); /* Print solution of phase 1. */
 
     if((phase1->z)->n == 0)
     {
-        printf("Phase I hat erfolgreiche eine Startlösung gefunden.\n");
-        printf("Phase II vorbereiten ...\n");
+        printf("Phase 1 found a start corner for phase 2.\n");
+        printf("Prepare tableau for phase 2 ...\n");
         s_prep = clock();
-        prepareTableauForPhaseII(phase1, tableau);
+        prepare_with_start_corner(phase1, tableau); /* Update tableau with found solution of phase 1. */
         e_prep = clock();
-        printf("Tableau für Phase II:\n");
-        printTableau(tableau);
+        printf("Tableau updated for phase 2:\n");
+        simplex_print_tableau(tableau); /* Print tableau used for phase 2 of simplex algorithm. */
 
-        printf("Simplex Phase II ...\n");
+        printf("Run simplex phase 2 ...\n");
         s_p2 = clock();
-        simplexPhaseII(tableau);
+        simplex_find_best_solution(tableau); /* Phase 2: Find best solution for problem. */
         e_p2 = clock();
-        printTableau(tableau);
-        printf("Lösung von Phase II: ");
-        printSolution(tableau);
+        simplex_print_tableau(tableau); /* Print final tableau of phase 2. */
+        printf("Best solution of problem: ");
+        simplex_print_solution(tableau); /* Print best solution of problem. */
     }
 
-    printf("gebe Tableau Speicher frei ...\n");
-    freeTableau(phase1);
-    freeTableau(tableau);
-
     end = clock();
 
-    calc = (double)(end - start);
+    calc = (double)(end - start); /* Calculate and print times. */
     printf("Total time: %f ms\n", (double)(calc*1000)/CLOCKS_PER_SEC);
     calc = (double)(e_p1 - s_p1);
-    printf("Phase I: %f ms\n", (double)(calc*1000)/CLOCKS_PER_SEC);
-    calc = (double)(e_prep - s_prep);
-    printf("Prepare: %f ms\n", (double)(calc*1000)/CLOCKS_PER_SEC);
-    calc = (double)(e_p2 - s_p2);
-    printf("Phase II: %f ms\n", (double)(calc*1000)/CLOCKS_PER_SEC);
+
+    if((phase1->z)->n == 0)
+    {
+      printf("Simplex phase 1: %f ms\n", (double)(calc*1000)/CLOCKS_PER_SEC);
+      calc = (double)(e_prep - s_prep);
+      printf("Prepare phase 2: %f ms\n", (double)(calc*1000)/CLOCKS_PER_SEC);
+      calc = (double)(e_p2 - s_p2);
+      printf("Simplex phase 2: %f ms\n", (double)(calc*1000)/CLOCKS_PER_SEC);
+    }
+
+    printf("Free tableau memory ...\n");
+    simplex_free_tableau(phase1); /* Free memory of tableaus. */
+    simplex_free_tableau(tableau);
 
     return EXIT_SUCCESS;
 }
 
-struct Tableau *createTestdata(void)
+struct Tableau *create_testproblem_tableau(void)
 {
     struct Tableau *tableau;
     int i, j;
@@ -83,32 +113,32 @@ struct Tableau *createTestdata(void)
     int basis[4] = {2,3,4,5};
     int nbvs[2] = {0,1};
 
-    printf("erzeuge Tableau ...\n");
-    tableau = create_tableau(4,6);
-    printf("fülle Tableau mit Testdaten...\n");
+    printf("Create a new tableau ...\n");
+    tableau = simplex_create_tableau(4,6); /* Create a new tableau for 4 conditions and 6 variables (x, y and slack variables for the 4 inequalities) */
+    printf("Fill tableau with test problem data ...\n");
 
-    for(i=0; i<2; i++)
+    for(i=0; i<2; i++) /* Target function. */
     {
         (tableau->c[i])->n = t[0][i];
     }
 
-    (tableau->z)->n = 0;
+    (tableau->z)->n = 0; /* Target function value. */
 
-    for(i=0; i<4; i++)
+    for(i=0; i<4; i++) /* Limits of inequalities. */
     {
         (tableau->b[i])->n = t[i+1][2];
     }
 
-    for(i=0; i<4; ++i)
+    for(i=0; i<4; ++i) /* Tableau data (only none basis variable columns, (invalid) basis is s1, s2, s3, s4). */
     {
         for(j=0; j<2; ++j)
         {
             (tableau->A[i][j])->n = t[i+1][j];
         }
     }
 
-    memcpy(tableau->bvs, basis, 4*sizeof(int));
-    memcpy(tableau->nbvs, nbvs, 2*sizeof(int));
+    memcpy(tableau->bvs, basis, 4*sizeof(int)); /* Initialze basis variables. */
+    memcpy(tableau->nbvs, nbvs, 2*sizeof(int)); /* Initialize none basis variables. */
 
     return tableau;
 }