treewide: Replace <name>_cnt by n_<name>s and <name>_cap by allocated_<name>.
[pspp] / tests / libpspp / heap-test.c
index 642ce7e05a0c3a5c904945ccc161d41e12679142..8f4ce1600aa826ab2cdc333aab9d32b8962d5311 100644 (file)
@@ -1,20 +1,18 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 2007 Free Software Foundation, Inc.
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2007, 2010, 2012 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 /* This is a test program for the routines defined in heap.c.
    This test program aims to be as comprehensive as possible.
 
 #include "xalloc.h"
 \f
-/* Currently running test. */
-static const char *test_name;
-
 /* Exit with a failure code.
    (Place a breakpoint on this function while debugging.) */
 static void
-check_die (void) 
+check_die (void)
 {
-  exit (EXIT_FAILURE);   
+  exit (EXIT_FAILURE);
 }
 
 /* If OK is not true, prints a message about failure on the
    current source file and the given LINE and terminates. */
 static void
-check_func (bool ok, int line) 
+check_func (bool ok, int line)
 {
-  if (!ok) 
+  if (!ok)
     {
-      printf ("Check failed in %s test at %s, line %d\n",
-              test_name, __FILE__, line);
+      fprintf (stderr, "%s:%d: check failed\n", __FILE__, line);
       check_die ();
     }
 }
@@ -79,7 +73,7 @@ struct element
     int x;                      /* Primary value. */
   };
 
-int aux_data;
+static int aux_data;
 
 /* Returns the `struct element' that NODE is embedded within. */
 static struct element *
@@ -92,7 +86,7 @@ heap_node_to_element (const struct heap_node *node)
    return value.  Verifies that AUX points to aux_data. */
 static int
 compare_elements (const struct heap_node *a_, const struct heap_node *b_,
-                  const void *aux) 
+                  const void *aux)
 {
   const struct element *a = heap_node_to_element (a_);
   const struct element *b = heap_node_to_element (b_);
@@ -103,7 +97,7 @@ compare_elements (const struct heap_node *a_, const struct heap_node *b_,
 
 /* Returns the smallest of the N integers in ARRAY. */
 static int
-min_int (int *array, size_t n) 
+min_int (int *array, size_t n)
 {
   int min;
   size_t i;
@@ -117,7 +111,7 @@ min_int (int *array, size_t n)
 
 /* Swaps *A and *B. */
 static void
-swap (int *a, int *b) 
+swap (int *a, int *b)
 {
   int t = *a;
   *a = *b;
@@ -148,7 +142,7 @@ next_permutation (int *values, size_t cnt)
   if (cnt > 0)
     {
       size_t i = cnt - 1;
-      while (i != 0) 
+      while (i != 0)
         {
           i--;
           if (values[i] < values[i + 1])
@@ -159,18 +153,18 @@ next_permutation (int *values, size_t cnt)
               swap (values + i, values + j);
               reverse (values + (i + 1), cnt - (i + 1));
               return true;
-            } 
+            }
         }
-      
+
       reverse (values, cnt);
     }
-  
+
   return false;
 }
 
 /* Returns N!. */
 static unsigned int
-factorial (unsigned int n) 
+factorial (unsigned int n)
 {
   unsigned int value = 1;
   while (n > 1)
@@ -182,26 +176,26 @@ factorial (unsigned int n)
    VALUES.  If VALUES contains duplicates, they must be
    adjacent. */
 static unsigned int
-expected_perms (int *values, size_t cnt) 
+expected_perms (int *values, size_t cnt)
 {
   size_t i, j;
-  unsigned int perm_cnt;
-  
-  perm_cnt = factorial (cnt);
-  for (i = 0; i < cnt; i = j) 
+  unsigned int n_perms;
+
+  n_perms = factorial (cnt);
+  for (i = 0; i < cnt; i = j)
     {
       for (j = i + 1; j < cnt; j++)
         if (values[i] != values[j])
           break;
-      perm_cnt /= factorial (j - i);
+      n_perms /= factorial (j - i);
     }
-  return perm_cnt;
+  return n_perms;
 }
 
 /* Tests whether PARTS is a K-part integer composition of N.
    Returns true if so, false otherwise. */
 static bool UNUSED
-is_k_composition (int n, int k, const int parts[]) 
+is_k_composition (int n, int k, const int parts[])
 {
   int sum;
   int i;
@@ -222,7 +216,7 @@ is_k_composition (int n, int k, const int parts[])
    already the greatest K-part composition of N (in which case
    PARTS is unaltered). */
 static bool
-next_k_composition (int n UNUSED, int k, int parts[]) 
+next_k_composition (int n UNUSED, int k, int parts[])
 {
   int x, i;
 
@@ -255,7 +249,7 @@ next_k_composition (int n UNUSED, int k, int parts[])
    Returns true if successful, false if the set of compositions
    has been exhausted. */
 static bool
-next_composition (int n, int *k, int parts[]) 
+next_composition (int n, int *k, int parts[])
 {
   if (*k >= 1 && next_k_composition (n, *k, parts))
     return true;
@@ -277,35 +271,35 @@ next_composition (int n, int *k, int parts[])
    order as we delete them.  Exhaustively tests every input
    permutation up to 'max_elems' elements. */
 static void
-test_insert_no_dups_delete_min (void) 
+test_insert_no_dups_delete_min (void)
 {
   const int max_elems = 8;
   int cnt;
 
-  for (cnt = 0; cnt <= max_elems; cnt++) 
+  for (cnt = 0; cnt <= max_elems; cnt++)
     {
       struct heap *h;
       struct element *elements;
       int *values;
-      unsigned int permutation_cnt;
+      unsigned int n_permutations;
       int i;
 
       values = xnmalloc (cnt, sizeof *values);
       elements = xnmalloc (cnt, sizeof *elements);
-      for (i = 0; i < cnt; i++) 
+      for (i = 0; i < cnt; i++)
         values[i] = i;
 
       h = heap_create (compare_elements, &aux_data);
-      permutation_cnt = 0;
-      while (permutation_cnt == 0 || next_permutation (values, cnt)) 
+      n_permutations = 0;
+      while (n_permutations == 0 || next_permutation (values, cnt))
         {
           int i;
 
-          for (i = 0; i < cnt; i++) 
+          for (i = 0; i < cnt; i++)
             elements[i].x = values[i];
 
           check (heap_is_empty (h));
-          for (i = 0; i < cnt; i++) 
+          for (i = 0; i < cnt; i++)
             {
               heap_insert (h, &elements[i].node);
               check (heap_node_to_element (heap_minimum (h))->x
@@ -319,9 +313,9 @@ test_insert_no_dups_delete_min (void)
               heap_delete (h, heap_minimum (h));
             }
           check (heap_is_empty (h));
-          permutation_cnt++;
+          n_permutations++;
         }
-      check (permutation_cnt == factorial (cnt));
+      check (n_permutations == factorial (cnt));
       heap_destroy (h);
       free (values);
       free (elements);
@@ -336,36 +330,36 @@ test_insert_no_dups_delete_min (void)
    See Usenet article <87mz4utika.fsf@blp.benpfaff.org> for
    details of the algorithm used here. */
 static void
-test_insert_with_dups_delete_min (void) 
+test_insert_with_dups_delete_min (void)
 {
   const int max_elems = 7;
   int cnt;
 
-  for (cnt = 1; cnt <= max_elems; cnt++) 
+  for (cnt = 1; cnt <= max_elems; cnt++)
     {
-      unsigned int composition_cnt;
+      unsigned int n_compositions;
       int *dups;
-      int unique_cnt;
+      int n_uniques;
       int *values;
       int *sorted_values;
       struct element *elements;
       int n = 0;
-      
+
       dups = xnmalloc (cnt, sizeof *dups);
       values = xnmalloc (cnt, sizeof *values);
       sorted_values = xnmalloc (cnt, sizeof *sorted_values);
       elements = xnmalloc (cnt, sizeof *elements);
 
-      unique_cnt = 0;
-      composition_cnt = 0;
-      while (next_composition (cnt, &unique_cnt, dups)) 
+      n_uniques = 0;
+      n_compositions = 0;
+      while (next_composition (cnt, &n_uniques, dups))
         {
           struct heap *h;
           int i, j, k;
-          unsigned int permutation_cnt;
+          unsigned int n_permutations;
 
           k = 0;
-          for (i = 0; i < unique_cnt; i++) 
+          for (i = 0; i < n_uniques; i++)
             for (j = 0; j < dups[i]; j++)
               {
                 values[k] = i;
@@ -375,8 +369,8 @@ test_insert_with_dups_delete_min (void)
           check (k == cnt);
 
           h = heap_create (compare_elements, &aux_data);
-          permutation_cnt = 0;
-          while (permutation_cnt == 0 || next_permutation (values, cnt)) 
+          n_permutations = 0;
+          while (n_permutations == 0 || next_permutation (values, cnt))
             {
               int min = INT_MAX;
 
@@ -385,7 +379,7 @@ test_insert_with_dups_delete_min (void)
               n++;
 
               check (heap_is_empty (h));
-              for (i = 0; i < cnt; i++) 
+              for (i = 0; i < cnt; i++)
                 {
                   heap_insert (h, &elements[i].node);
                   if (values[i] < min)
@@ -401,14 +395,14 @@ test_insert_with_dups_delete_min (void)
                   heap_delete (h, heap_minimum (h));
                 }
               check (heap_is_empty (h));
-              permutation_cnt++;
+              n_permutations++;
             }
-          check (permutation_cnt == expected_perms (values, cnt));
+          check (n_permutations == expected_perms (values, cnt));
           heap_destroy (h);
-          
-          composition_cnt++;
+
+          n_compositions++;
         }
-      check (composition_cnt == 1 << (cnt - 1));
+      check (n_compositions == 1 << (cnt - 1));
 
       free (dups);
       free (values);
@@ -420,23 +414,23 @@ test_insert_with_dups_delete_min (void)
 /* Inserts a sequence without duplicates into a heap, then
    deletes them in a different order. */
 static void
-test_insert_no_dups_delete_random (void) 
+test_insert_no_dups_delete_random (void)
 {
   const int max_elems = 5;
   int cnt;
 
-  for (cnt = 0; cnt <= max_elems; cnt++) 
+  for (cnt = 0; cnt <= max_elems; cnt++)
     {
       struct heap *h;
       struct element *elements;
       int *insert, *delete;
-      unsigned int insert_perm_cnt;
+      unsigned int insert_n_perms;
       int i;
 
       insert = xnmalloc (cnt, sizeof *insert);
       delete = xnmalloc (cnt, sizeof *delete);
       elements = xnmalloc (cnt, sizeof *elements);
-      for (i = 0; i < cnt; i++) 
+      for (i = 0; i < cnt; i++)
         {
           insert[i] = i;
           delete[i] = i;
@@ -444,19 +438,19 @@ test_insert_no_dups_delete_random (void)
         }
 
       h = heap_create (compare_elements, &aux_data);
-      insert_perm_cnt = 0;
-      while (insert_perm_cnt == 0 || next_permutation (insert, cnt)) 
+      insert_n_perms = 0;
+      while (insert_n_perms == 0 || next_permutation (insert, cnt))
         {
-          unsigned int delete_perm_cnt = 0;
+          unsigned int delete_n_perms = 0;
 
-          while (delete_perm_cnt == 0 || next_permutation (delete, cnt)) 
+          while (delete_n_perms == 0 || next_permutation (delete, cnt))
             {
               int min;
               int i;
 
               check (heap_is_empty (h));
               min = INT_MAX;
-              for (i = 0; i < cnt; i++) 
+              for (i = 0; i < cnt; i++)
                 {
                   heap_insert (h, &elements[insert[i]].node);
                   if (insert[i] < min)
@@ -474,12 +468,12 @@ test_insert_no_dups_delete_random (void)
                     check (heap_node_to_element (heap_minimum (h))->x == new_min);
                 }
               check (heap_is_empty (h));
-              delete_perm_cnt++;
+              delete_n_perms++;
             }
-          check (delete_perm_cnt == factorial (cnt));
-          insert_perm_cnt++; 
+          check (delete_n_perms == factorial (cnt));
+          insert_n_perms++;
         }
-      check (insert_perm_cnt == factorial (cnt));
+      check (insert_n_perms == factorial (cnt));
       heap_destroy (h);
       free (insert);
       free (delete);
@@ -487,38 +481,38 @@ test_insert_no_dups_delete_random (void)
     }
 }
 
-/* Inserts a set of values into a heap, then changes them to a 
+/* Inserts a set of values into a heap, then changes them to a
    different random set of values, then removes them in sorted
    order. */
 static void
-test_inc_dec (void) 
+test_inc_dec (void)
 {
   const int max_elems = 8;
   int cnt;
 
-  for (cnt = 0; cnt <= max_elems; cnt++) 
+  for (cnt = 0; cnt <= max_elems; cnt++)
     {
       struct heap *h;
       struct element *elements;
       int *insert, *delete;
-      unsigned int insert_perm_cnt;
+      unsigned int insert_n_perms;
       int i;
 
       insert = xnmalloc (cnt, sizeof *insert);
       delete = xnmalloc (cnt, sizeof *delete);
       elements = xnmalloc (cnt, sizeof *elements);
-      for (i = 0; i < cnt; i++) 
+      for (i = 0; i < cnt; i++)
         insert[i] = i;
 
       h = heap_create (compare_elements, &aux_data);
-      insert_perm_cnt = 0;
-      while (insert_perm_cnt == 0 || next_permutation (insert, cnt)) 
+      insert_n_perms = 0;
+      while (insert_n_perms == 0 || next_permutation (insert, cnt))
         {
-          for (i = 0; i < cnt; i++) 
+          for (i = 0; i < cnt; i++)
             elements[i].x = insert[i];
 
           check (heap_is_empty (h));
-          for (i = 0; i < cnt; i++) 
+          for (i = 0; i < cnt; i++)
             {
               int new_min = min_int (insert, i + 1);
               heap_insert (h, &elements[i].node);
@@ -528,13 +522,9 @@ test_inc_dec (void)
 
           for (i = 0; i < cnt; i++)
             delete[i] = insert[i];
-          for (i = 0; i < cnt; i++) 
+          for (i = 0; i < cnt; i++)
             {
-              int old_value, old_min, new_min;
-              old_min = min_int (delete, cnt);
-              old_value = delete[i];
               elements[i].x = delete[i] = rand () % (cnt + 2) - 1;
-              new_min = min_int (delete, cnt);
               heap_changed (h, &elements[i].node);
               check (heap_node_to_element (heap_minimum (h))->x
                      == min_int (delete, cnt));
@@ -549,9 +539,9 @@ test_inc_dec (void)
                 check (heap_node_to_element (heap_minimum (h))->x == new_min);
             }
           check (heap_is_empty (h));
-          insert_perm_cnt++; 
+          insert_n_perms++;
         }
-      check (insert_perm_cnt == factorial (cnt));
+      check (insert_n_perms == factorial (cnt));
       heap_destroy (h);
       free (insert);
       free (delete);
@@ -562,7 +552,7 @@ test_inc_dec (void)
 /* Performs a random sequence of insertions and deletions in a
    heap. */
 static void
-test_random_insert_delete (void) 
+test_random_insert_delete (void)
 {
   const int max_elems = 64;
   const int num_actions = 250000;
@@ -579,29 +569,28 @@ test_random_insert_delete (void)
   insert_chance = 5;
 
   h = heap_create (compare_elements, &aux_data);
-  for (i = 0; i < num_actions; i++) 
+  for (i = 0; i < num_actions; i++)
     {
       enum { INSERT, DELETE } action;
 
-      if (cnt == 0) 
+      if (cnt == 0)
         {
           action = INSERT;
           if (insert_chance < 9)
-            insert_chance++; 
+            insert_chance++;
         }
-      else if (cnt == max_elems) 
+      else if (cnt == max_elems)
         {
           action = DELETE;
           if (insert_chance > 0)
-            insert_chance--; 
+            insert_chance--;
         }
       else
         action = rand () % 10 < insert_chance ? INSERT : DELETE;
 
-      if (action == INSERT) 
+      if (action == INSERT)
         {
           int new_value;
-          int old_min;
 
           new_value = rand () % max_elems;
           values[cnt] = new_value;
@@ -609,31 +598,22 @@ test_random_insert_delete (void)
 
           heap_insert (h, &elements[cnt].node);
 
-          old_min = min_int (values, cnt);
-
           cnt++;
         }
       else if (action == DELETE)
         {
           int del_idx;
-          int del_value;
-          int old_min, new_min;
-
-          old_min = min_int (values, cnt);
 
           del_idx = rand () % cnt;
-          del_value = values[del_idx];
           heap_delete (h, &elements[del_idx].node);
 
           cnt--;
-          if (del_idx != cnt) 
+          if (del_idx != cnt)
             {
               values[del_idx] = values[cnt];
               elements[del_idx] = elements[cnt];
               heap_moved (h, &elements[del_idx].node);
             }
-
-          new_min = min_int (values, cnt);
         }
       else
         abort ();
@@ -651,28 +631,74 @@ test_random_insert_delete (void)
 \f
 /* Main program. */
 
-/* Runs TEST_FUNCTION and prints a message about NAME. */
-static void
-run_test (void (*test_function) (void), const char *name) 
-{
-  test_name = name;
-  putchar ('.');
-  fflush (stdout);
-  test_function ();
-}
+struct test
+  {
+    const char *name;
+    const char *description;
+    void (*function) (void);
+  };
+
+static const struct test tests[] =
+  {
+    {
+      "insert-no-dups-delete-min",
+      "insert (no dups), delete minimum values",
+      test_insert_no_dups_delete_min
+    },
+    {
+      "insert-with-dups-delete-min",
+      "insert with dups, delete minimum values",
+      test_insert_with_dups_delete_min
+    },
+    {
+      "insert-no-dups-delete-random",
+      "insert (no dups), delete in random order",
+      test_insert_no_dups_delete_random
+    },
+    {
+      "inc-dec",
+      "increase and decrease values",
+      test_inc_dec
+    },
+    {
+      "random-insert-delete",
+      "random insertions and deletions",
+      test_random_insert_delete
+    }
+  };
+
+enum { N_TESTS = sizeof tests / sizeof *tests };
 
 int
-main (void) 
+main (int argc, char *argv[])
 {
-  run_test (test_insert_no_dups_delete_min,
-            "insert (no dups), delete minimum values");
-  run_test (test_insert_with_dups_delete_min,
-            "insert with dups, delete minimum values");
-  run_test (test_insert_no_dups_delete_random,
-            "insert (no dups), delete in random order");
-  run_test (test_inc_dec, "increase and decrease values");
-  run_test (test_random_insert_delete, "random insertions and deletions");
-  putchar ('\n');
-
-  return 0;
+  int i;
+
+  if (argc != 2)
+    {
+      fprintf (stderr, "exactly one argument required; use --help for help\n");
+      return EXIT_FAILURE;
+    }
+  else if (!strcmp (argv[1], "--help"))
+    {
+      printf ("%s: test heap library\n"
+              "usage: %s TEST-NAME\n"
+              "where TEST-NAME is one of the following:\n",
+              argv[0], argv[0]);
+      for (i = 0; i < N_TESTS; i++)
+        printf ("  %s\n    %s\n", tests[i].name, tests[i].description);
+      return 0;
+    }
+  else
+    {
+      for (i = 0; i < N_TESTS; i++)
+        if (!strcmp (argv[1], tests[i].name))
+          {
+            tests[i].function ();
+            return 0;
+          }
+
+      fprintf (stderr, "unknown test %s; use --help for help\n", argv[1]);
+      return EXIT_FAILURE;
+    }
 }