Separate table functions that format their arguments from those that don't.
[pspp-builds.git] / src / language / stats / binomial.c
index a27e8422a4190925f0cdb9e771d72b6abf7aa93e..26e0257ca14030ca3d58a2ae10acd8f960b45d2c 100644 (file)
@@ -1,35 +1,31 @@
-/* PSPP - computes sample statistics.
-   Copyright (C) 2006 Free Software Foundation, Inc.
-   Written by John Darrington <john@darrington.wattle.id.au>
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2006, 2009 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/>. */
 
 #include <config.h>
 #include <libpspp/compiler.h>
 #include <output/table.h>
-#include <libpspp/alloc.h>
 
+#include <data/format.h>
 #include <data/case.h>
-#include <data/casefile.h>
+#include <data/casereader.h>
 #include <data/dictionary.h>
 #include <data/procedure.h>
 #include <data/variable.h>
 #include <data/value.h>
 #include <data/value-labels.h>
-#include <data/casefilter.h>
 
 #include <libpspp/message.h>
 #include <libpspp/assertion.h>
@@ -37,6 +33,8 @@
 #include "binomial.h"
 #include "freq.h"
 
+#include "xalloc.h"
+
 #include "gettext.h"
 #define _(msgid) gettext (msgid)
 
@@ -44,7 +42,6 @@
 
 #include <gsl/gsl_cdf.h>
 #include <gsl/gsl_randist.h>
-#include <gsl-extras/gsl-extras.h>
 
 #include <minmax.h>
 
@@ -79,10 +76,10 @@ calculate_binomial (double n1, double n2, double p)
 static double
 calculate_binomial_internal (double n1, double n2, double p)
 {
-  /* SPSS Statistical Algorithms has completely different and WRONG 
+  /* SPSS Statistical Algorithms has completely different and WRONG
      advice here. */
 
-  double sig1tailed = gslextras_cdf_binomial_P (n1, n1 + n2, p);
+  double sig1tailed = gsl_cdf_binomial_P (n1, p, n1 + n2);
 
   if ( p == 0.5 )
     return sig1tailed > 0.5 ? 1.0 :sig1tailed * 2.0;
@@ -90,181 +87,188 @@ calculate_binomial_internal (double n1, double n2, double p)
   return sig1tailed ;
 }
 
-static void
+static bool
 do_binomial (const struct dictionary *dict,
-            const struct casefile *cf,
+            struct casereader *input,
             const struct binomial_test *bst,
-            struct freq *cat1,
-            struct freq *cat2,
-            const struct casefilter *filter
+            struct freq_mutable *cat1,
+            struct freq_mutable *cat2,
+             enum mv_class exclude
             )
 {
   bool warn = true;
 
   const struct one_sample_test *ost = (const struct one_sample_test *) bst;
-  struct ccase c;
-  struct casereader *r = casefile_get_reader (cf, NULL);
+  struct ccase *c;
 
-  while (casereader_read(r, &c))
+  for (; (c = casereader_read (input)) != NULL; case_unref (c))
     {
       int v;
-      double w =
-       dict_get_case_weight (dict, &c, &warn);
+      double w = dict_get_case_weight (dict, c, &warn);
 
       for (v = 0 ; v < ost->n_vars ; ++v )
        {
          const struct variable *var = ost->vars[v];
-         const union value *value = case_data (&c, var);
+         double value = case_num (c, var);
 
-         if ( casefilter_variable_missing (filter, &c, var))
-           break;
+         if (var_is_num_missing (var, value, exclude))
+           continue;
 
-         if ( NULL == cat1[v].value )
+         if (bst->cutpoint != SYSMIS)
            {
-             cat1[v].value = value_dup (value, var_get_width (var));
-             cat1[v].count = w;
+             if ( cat1[v].value.f >= value )
+                 cat1[v].count  += w;
+             else
+                 cat2[v].count += w;
            }
-         else if ( 0 == compare_values (cat1[v].value, value,
-                                        var_get_width (var)))
-           cat1[v].count += w;
-         else if ( NULL == cat2[v].value )
+         else
            {
-             cat2[v].value = value_dup (value, var_get_width (var));
-             cat2[v].count = w;
+             if ( SYSMIS == cat1[v].value.f )
+               {
+                 cat1[v].value.f = value;
+                 cat1[v].count = w;
+               }
+             else if ( cat1[v].value.f == value )
+               cat1[v].count += w;
+             else if ( SYSMIS == cat2[v].value.f )
+               {
+                 cat2[v].value.f = value;
+                 cat2[v].count = w;
+               }
+             else if ( cat2[v].value.f == value )
+               cat2[v].count += w;
+             else if ( bst->category1 == SYSMIS)
+               msg (ME, _("Variable %s is not dichotomous"), var_get_name (var));
            }
-         else if ( 0 == compare_values (cat2[v].value, value,
-                                        var_get_width (var)))
-           cat2[v].count += w;
-         else if ( bst->category1 == SYSMIS)
-           msg (ME, _("Variable %s is not dichotomous"), var_get_name (var));
        }
-
-      case_destroy (&c);
     }
-  casereader_destroy (r);
+  return casereader_destroy (input);
 }
 
 
 
 void
 binomial_execute (const struct dataset *ds,
-                 const struct casefile *cf,
-                 struct casefilter *filter,
-                 const struct npar_test *test)
+                 struct casereader *input,
+                  enum mv_class exclude,
+                 const struct npar_test *test,
+                 bool exact UNUSED,
+                 double timer UNUSED)
 {
   int v;
+  const struct dictionary *dict = dataset_dict (ds);
   const struct binomial_test *bst = (const struct binomial_test *) test;
   const struct one_sample_test *ost = (const struct one_sample_test*) test;
 
-  struct freq *cat1 = xzalloc (sizeof (*cat1) * ost->n_vars);
-  struct freq *cat2 = xzalloc (sizeof (*cat1) * ost->n_vars);
-  struct tab_table *table ;
+  struct freq_mutable *cat[2];
+  int i;
 
-  assert ((bst->category1 == SYSMIS) == (bst->category2 == SYSMIS) );
+  assert ((bst->category1 == SYSMIS) == (bst->category2 == SYSMIS) || bst->cutpoint != SYSMIS);
 
-  if ( bst->category1 != SYSMIS )
+  for (i = 0; i < 2; i++)
     {
-      union value v;
-      v.f = bst->category1;
-      cat1->value = value_dup (&v, 0);
+      double value;
+      if (i == 0)
+        value = bst->cutpoint != SYSMIS ? bst->cutpoint : bst->category1;
+      else
+        value = bst->category2;
+
+      cat[i] = xnmalloc (ost->n_vars, sizeof *cat[i]);
+      for (v = 0; v < ost->n_vars; v++)
+        {
+          cat[i][v].value.f = value;
+          cat[i][v].count = 0;
+        }
     }
 
-  if ( bst->category2 != SYSMIS )
+  if (do_binomial (dataset_dict (ds), input, bst, cat[0], cat[1], exclude))
     {
-      union value v;
-      v.f = bst->category2;
-      cat2->value = value_dup (&v, 0);
-    }
-
-  do_binomial (dataset_dict(ds), cf, bst, cat1, cat2, filter);
-
-  table = tab_create (7, ost->n_vars * 3 + 1, 0);
-
-  tab_dim (table, tab_natural_dimensions);
-
-  tab_title (table, _("Binomial Test"));
-
-  tab_headers (table, 2, 0, 1, 0);
-
-  tab_box (table, TAL_1, TAL_1, -1, TAL_1,
-          0, 0, table->nc - 1, tab_nr(table) - 1 );
-
-  for (v = 0 ; v < ost->n_vars; ++v)
-    {
-      double n_total, sig;
-      const struct variable *var = ost->vars[v];
-      tab_hline (table, TAL_1, 0, tab_nc (table) -1, 1 + v * 3);
-
-      /* Titles */
-      tab_text (table, 0, 1 + v * 3, TAB_LEFT,
-               var_to_string (var));
-
-      tab_text (table, 1, 1 + v * 3, TAB_LEFT,
-               _("Group1"));
-
-      tab_text (table, 1, 2 + v * 3, TAB_LEFT,
-               _("Group2"));
+      const struct variable *wvar = dict_get_weight (dict);
+      const struct fmt_spec *wfmt = wvar ?
+       var_get_print_format (wvar) : & F_8_0;
 
-      tab_text (table, 1, 3 + v * 3, TAB_LEFT,
-               _("Total"));
+      struct tab_table *table = tab_create (7, ost->n_vars * 3 + 1, 0);
 
-      /* Test Prop */
-      tab_float (table, 5, 1 + v * 3, TAB_NONE, bst->p, 8, 3);
+      tab_dim (table, tab_natural_dimensions, NULL);
 
-      /* Category labels */
-      tab_text (table, 2, 1 + v * 3, TAB_NONE,
-               var_get_value_name (var, cat1[v].value));
+      tab_title (table, _("Binomial Test"));
 
-      tab_text (table, 2, 2 + v * 3, TAB_NONE,
-               var_get_value_name (var, cat2[v].value));
+      tab_headers (table, 2, 0, 1, 0);
 
-      /* Observed N */
-      tab_float (table, 3, 1 + v * 3, TAB_NONE,
-                cat1[v].count, 8, 0);
+      tab_box (table, TAL_1, TAL_1, -1, TAL_1,
+               0, 0, table->nc - 1, tab_nr(table) - 1 );
 
-      tab_float (table, 3, 2 + v * 3, TAB_NONE,
-                cat2[v].count, 8, 0);
+      for (v = 0 ; v < ost->n_vars; ++v)
+        {
+          double n_total, sig;
+         struct string catstr[2];
+          const struct variable *var = ost->vars[v];
 
-      n_total = cat1[v].count + cat2[v].count;
+         ds_init_empty (&catstr[0]);
+         ds_init_empty (&catstr[1]);
 
-
-      tab_float (table, 3, 3 + v * 3, TAB_NONE,
-                n_total, 8, 0);
-
-      /* Observed Proportions */
-
-      tab_float (table, 4, 1 + v * 3, TAB_NONE,
-                cat1[v].count / n_total, 8, 3);
-
-      tab_float (table, 4, 2 + v * 3, TAB_NONE,
-                cat2[v].count / n_total, 8, 3);
-
-      tab_float (table, 4, 3 + v * 3, TAB_NONE,
-                (cat1[v].count + cat2[v].count) / n_total, 8, 2);
-
-
-      /* Significance */
-      sig = calculate_binomial (cat1[v].count, cat2[v].count,
-                                      bst->p);
-
-      tab_float (table, 6, 1 + v * 3, TAB_NONE,
-                sig, 8, 3);
+         if ( bst->cutpoint != SYSMIS)
+           {
+             ds_put_format (&catstr[0], "<= %g", bst->cutpoint);
+           }
+          else
+            {
+              var_append_value_name (var, &cat[0][v].value, &catstr[0]);
+              var_append_value_name (var, &cat[1][v].value, &catstr[1]);
+            }
+
+          tab_hline (table, TAL_1, 0, tab_nc (table) -1, 1 + v * 3);
+
+          /* Titles */
+          tab_text (table, 0, 1 + v * 3, TAB_LEFT, var_to_string (var));
+          tab_text (table, 1, 1 + v * 3, TAB_LEFT, _("Group1"));
+          tab_text (table, 1, 2 + v * 3, TAB_LEFT, _("Group2"));
+          tab_text (table, 1, 3 + v * 3, TAB_LEFT, _("Total"));
+
+          /* Test Prop */
+          tab_double (table, 5, 1 + v * 3, TAB_NONE, bst->p, NULL);
+
+          /* Category labels */
+          tab_text (table, 2, 1 + v * 3, TAB_NONE, ds_cstr (&catstr[0]));
+         tab_text (table, 2, 2 + v * 3, TAB_NONE, ds_cstr (&catstr[1]));
+
+          /* Observed N */
+          tab_double (table, 3, 1 + v * 3, TAB_NONE, cat[0][v].count, wfmt);
+          tab_double (table, 3, 2 + v * 3, TAB_NONE, cat[1][v].count, wfmt);
+
+          n_total = cat[0][v].count + cat[1][v].count;
+          tab_double (table, 3, 3 + v * 3, TAB_NONE, n_total, wfmt);
+
+          /* Observed Proportions */
+          tab_double (table, 4, 1 + v * 3, TAB_NONE,
+                     cat[0][v].count / n_total, NULL);
+          tab_double (table, 4, 2 + v * 3, TAB_NONE,
+                     cat[1][v].count / n_total, NULL);
+
+          tab_double (table, 4, 3 + v * 3, TAB_NONE,
+                     (cat[0][v].count + cat[1][v].count) / n_total, NULL);
+
+          /* Significance */
+          sig = calculate_binomial (cat[0][v].count, cat[1][v].count, bst->p);
+          tab_double (table, 6, 1 + v * 3, TAB_NONE, sig, NULL);
+
+         ds_destroy (&catstr[0]);
+         ds_destroy (&catstr[1]);
+        }
+
+      tab_text (table,  2, 0,  TAB_CENTER, _("Category"));
+      tab_text (table,  3, 0,  TAB_CENTER, _("N"));
+      tab_text (table,  4, 0,  TAB_CENTER, _("Observed Prop."));
+      tab_text (table,  5, 0,  TAB_CENTER, _("Test Prop."));
+
+      tab_text_format (table,  6, 0,  TAB_CENTER,
+                       _("Exact Sig. (%d-tailed)"),
+                       bst->p == 0.5 ? 2 : 1);
+
+      tab_vline (table, TAL_2, 2, 0, tab_nr (table) -1);
+      tab_submit (table);
     }
 
-  tab_text (table,  2, 0,  TAB_CENTER, _("Category"));
-  tab_text (table,  3, 0,  TAB_CENTER, _("N"));
-  tab_text (table,  4, 0,  TAB_CENTER, _("Observed Prop."));
-  tab_text (table,  5, 0,  TAB_CENTER, _("Test Prop."));
-
-  tab_text (table,  6, 0,  TAB_CENTER | TAT_PRINTF,
-           _("Exact Sig. (%d-tailed)"),
-           bst->p == 0.5 ? 2: 1);
-
-  tab_vline (table, TAL_2, 2, 0, tab_nr (table) -1);
-
-  free (cat1);
-  free (cat2);
-
-  tab_submit (table);
-
+  for (i = 0; i < 2; i++)
+    free (cat[i]);
 }