src/language/stats/binomial.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2006 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18 #include <libpspp/compiler.h>
  19 #include <output/table.h>
  20
  21 #include <data/case.h>
  22 #include <data/casereader.h>
  23 #include <data/dictionary.h>
  24 #include <data/procedure.h>
  25 #include <data/variable.h>
  26 #include <data/value.h>
  27 #include <data/value-labels.h>
  28
  29 #include <libpspp/message.h>
  30 #include <libpspp/assertion.h>
  31
  32 #include "binomial.h"
  33 #include "freq.h"
  34
  35 #include "xalloc.h"
  36
  37 #include "gettext.h"
  38 #define _(msgid) gettext (msgid)
  39
  40 #include <libpspp/misc.h>
  41
  42 #include <gsl/gsl_cdf.h>
  43 #include <gsl/gsl_randist.h>
  44
  45 #include <minmax.h>
  46
  47 #include <libpspp/hash.h>
  48
  49 static double calculate_binomial_internal (double n1, double n2,
  50                                            double p);
  51
  52
  53 static void
  54 swap (double *i1, double *i2)
  55 {
  56   double temp = *i1;
  57   *i1 = *i2;
  58   *i2 = temp;
  59 }
  60
  61 static double
  62 calculate_binomial (double n1, double n2, double p)
  63 {
  64   const double n = n1 + n2;
  65   const bool test_reversed = (n1 / n > p ) ;
  66   if ( test_reversed )
  67     {
  68       p = 1 - p ;
  69       swap (&n1, &n2);
  70     }
  71
  72   return calculate_binomial_internal (n1, n2, p);
  73 }
  74
  75 static double
  76 calculate_binomial_internal (double n1, double n2, double p)
  77 {
  78   /* SPSS Statistical Algorithms has completely different and WRONG
  79      advice here. */
  80
  81   double sig1tailed = gsl_cdf_binomial_P (n1, p, n1 + n2);
  82
  83   if ( p == 0.5 )
  84     return sig1tailed > 0.5 ? 1.0 :sig1tailed * 2.0;
  85
  86   return sig1tailed ;
  87 }
  88
  89 static bool
  90 do_binomial (const struct dictionary *dict,
  91              struct casereader *input,
  92              const struct binomial_test *bst,
  93              struct freq_mutable *cat1,
  94              struct freq_mutable *cat2,
  95              enum mv_class exclude
  96              )
  97 {
  98   bool warn = true;
  99
 100   const struct one_sample_test *ost = (const struct one_sample_test *) bst;
 101   struct ccase c;
 102
 103   while (casereader_read(input, &c))
 104     {
 105       int v;
 106       double w = dict_get_case_weight (dict, &c, &warn);
 107
 108       for (v = 0 ; v < ost->n_vars ; ++v )
 109         {
 110           const struct variable *var = ost->vars[v];
 111           const union value *value = case_data (&c, var);
 112           int width = var_get_width (var);
 113
 114           if (var_is_value_missing (var, value, exclude))
 115             break;
 116
 117           if ( NULL == cat1[v].value )
 118             {
 119               cat1[v].value = value_dup (value, width);
 120               cat1[v].count = w;
 121             }
 122           else if ( 0 == compare_values_short (cat1[v].value, value, var))
 123             cat1[v].count += w;
 124           else if ( NULL == cat2[v].value )
 125             {
 126               cat2[v].value = value_dup (value, width);
 127               cat2[v].count = w;
 128             }
 129           else if ( 0 == compare_values_short (cat2[v].value, value, var))
 130             cat2[v].count += w;
 131           else if ( bst->category1 == SYSMIS)
 132             msg (ME, _("Variable %s is not dichotomous"), var_get_name (var));
 133         }
 134
 135       case_destroy (&c);
 136     }
 137   return casereader_destroy (input);
 138 }
 139
 140
 141
 142 void
 143 binomial_execute (const struct dataset *ds,
 144                   struct casereader *input,
 145                   enum mv_class exclude,
 146                   const struct npar_test *test,
 147                   bool exact UNUSED,
 148                   double timer UNUSED)
 149 {
 150   int v;
 151   const struct binomial_test *bst = (const struct binomial_test *) test;
 152   const struct one_sample_test *ost = (const struct one_sample_test*) test;
 153
 154   struct freq_mutable *cat1 = xzalloc (sizeof (*cat1) * ost->n_vars);
 155   struct freq_mutable *cat2 = xzalloc (sizeof (*cat1) * ost->n_vars);
 156
 157   assert ((bst->category1 == SYSMIS) == (bst->category2 == SYSMIS) );
 158
 159   if ( bst->category1 != SYSMIS )
 160     {
 161       union value v;
 162       v.f = bst->category1;
 163       cat1->value = value_dup (&v, 0);
 164     }
 165
 166   if ( bst->category2 != SYSMIS )
 167     {
 168       union value v;
 169       v.f = bst->category2;
 170       cat2->value = value_dup (&v, 0);
 171     }
 172
 173   if (do_binomial (dataset_dict(ds), input, bst, cat1, cat2, exclude))
 174     {
 175       struct tab_table *table = tab_create (7, ost->n_vars * 3 + 1, 0);
 176
 177       tab_dim (table, tab_natural_dimensions);
 178
 179       tab_title (table, _("Binomial Test"));
 180
 181       tab_headers (table, 2, 0, 1, 0);
 182
 183       tab_box (table, TAL_1, TAL_1, -1, TAL_1,
 184                0, 0, table->nc - 1, tab_nr(table) - 1 );
 185
 186       for (v = 0 ; v < ost->n_vars; ++v)
 187         {
 188           double n_total, sig;
 189           struct string catstr1;
 190           struct string catstr2;
 191           const struct variable *var = ost->vars[v];
 192
 193           ds_init_empty (&catstr1);
 194           ds_init_empty (&catstr2);
 195
 196           var_append_value_name (var, cat1[v].value, &catstr1);
 197           var_append_value_name (var, cat2[v].value, &catstr2);
 198
 199           tab_hline (table, TAL_1, 0, tab_nc (table) -1, 1 + v * 3);
 200
 201           /* Titles */
 202           tab_text (table, 0, 1 + v * 3, TAB_LEFT, var_to_string (var));
 203           tab_text (table, 1, 1 + v * 3, TAB_LEFT, _("Group1"));
 204           tab_text (table, 1, 2 + v * 3, TAB_LEFT, _("Group2"));
 205           tab_text (table, 1, 3 + v * 3, TAB_LEFT, _("Total"));
 206
 207           /* Test Prop */
 208           tab_float (table, 5, 1 + v * 3, TAB_NONE, bst->p, 8, 3);
 209
 210           /* Category labels */
 211           tab_text (table, 2, 1 + v * 3, TAB_NONE, ds_cstr (&catstr1));
 212           tab_text (table, 2, 2 + v * 3, TAB_NONE, ds_cstr (&catstr2));
 213
 214           /* Observed N */
 215           tab_float (table, 3, 1 + v * 3, TAB_NONE, cat1[v].count, 8, 0);
 216           tab_float (table, 3, 2 + v * 3, TAB_NONE, cat2[v].count, 8, 0);
 217
 218           n_total = cat1[v].count + cat2[v].count;
 219           tab_float (table, 3, 3 + v * 3, TAB_NONE, n_total, 8, 0);
 220
 221           /* Observed Proportions */
 222           tab_float (table, 4, 1 + v * 3, TAB_NONE,
 223                      cat1[v].count / n_total, 8, 3);
 224           tab_float (table, 4, 2 + v * 3, TAB_NONE,
 225                      cat2[v].count / n_total, 8, 3);
 226           tab_float (table, 4, 3 + v * 3, TAB_NONE,
 227                      (cat1[v].count + cat2[v].count) / n_total, 8, 2);
 228
 229           /* Significance */
 230           sig = calculate_binomial (cat1[v].count, cat2[v].count, bst->p);
 231           tab_float (table, 6, 1 + v * 3, TAB_NONE, sig, 8, 3);
 232
 233           ds_destroy (&catstr1);
 234           ds_destroy (&catstr2);
 235         }
 236
 237       tab_text (table,  2, 0,  TAB_CENTER, _("Category"));
 238       tab_text (table,  3, 0,  TAB_CENTER, _("N"));
 239       tab_text (table,  4, 0,  TAB_CENTER, _("Observed Prop."));
 240       tab_text (table,  5, 0,  TAB_CENTER, _("Test Prop."));
 241
 242       tab_text (table,  6, 0,  TAB_CENTER | TAT_PRINTF,
 243                 _("Exact Sig. (%d-tailed)"),
 244                 bst->p == 0.5 ? 2: 1);
 245
 246       tab_vline (table, TAL_2, 2, 0, tab_nr (table) -1);
 247       tab_submit (table);
 248     }
 249
 250   for (v = 0; v < ost->n_vars; v++)
 251     {
 252       free (cat1[v].value);
 253       free (cat2[v].value);
 254     }
 255   free (cat1);
 256   free (cat2);
 257 }