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/format.h>
  22 #include <data/case.h>
  23 #include <data/casereader.h>
  24 #include <data/dictionary.h>
  25 #include <data/procedure.h>
  26 #include <data/variable.h>
  27 #include <data/value.h>
  28 #include <data/value-labels.h>
  29
  30 #include <libpspp/message.h>
  31 #include <libpspp/assertion.h>
  32
  33 #include "binomial.h"
  34 #include "freq.h"
  35
  36 #include "xalloc.h"
  37
  38 #include "gettext.h"
  39 #define _(msgid) gettext (msgid)
  40
  41 #include <libpspp/misc.h>
  42
  43 #include <gsl/gsl_cdf.h>
  44 #include <gsl/gsl_randist.h>
  45
  46 #include <minmax.h>
  47
  48 #include <libpspp/hash.h>
  49
  50 static double calculate_binomial_internal (double n1, double n2,
  51                                            double p);
  52
  53
  54 static void
  55 swap (double *i1, double *i2)
  56 {
  57   double temp = *i1;
  58   *i1 = *i2;
  59   *i2 = temp;
  60 }
  61
  62 static double
  63 calculate_binomial (double n1, double n2, double p)
  64 {
  65   const double n = n1 + n2;
  66   const bool test_reversed = (n1 / n > p ) ;
  67   if ( test_reversed )
  68     {
  69       p = 1 - p ;
  70       swap (&n1, &n2);
  71     }
  72
  73   return calculate_binomial_internal (n1, n2, p);
  74 }
  75
  76 static double
  77 calculate_binomial_internal (double n1, double n2, double p)
  78 {
  79   /* SPSS Statistical Algorithms has completely different and WRONG
  80      advice here. */
  81
  82   double sig1tailed = gsl_cdf_binomial_P (n1, p, n1 + n2);
  83
  84   if ( p == 0.5 )
  85     return sig1tailed > 0.5 ? 1.0 :sig1tailed * 2.0;
  86
  87   return sig1tailed ;
  88 }
  89
  90 static bool
  91 do_binomial (const struct dictionary *dict,
  92              struct casereader *input,
  93              const struct binomial_test *bst,
  94              struct freq_mutable *cat1,
  95              struct freq_mutable *cat2,
  96              enum mv_class exclude
  97              )
  98 {
  99   bool warn = true;
 100
 101   const struct one_sample_test *ost = (const struct one_sample_test *) bst;
 102   struct ccase c;
 103
 104   while (casereader_read(input, &c))
 105     {
 106       int v;
 107       double w = dict_get_case_weight (dict, &c, &warn);
 108
 109       for (v = 0 ; v < ost->n_vars ; ++v )
 110         {
 111           const struct variable *var = ost->vars[v];
 112           const union value *value = case_data (&c, var);
 113           int width = var_get_width (var);
 114
 115           if (var_is_value_missing (var, value, exclude))
 116             break;
 117
 118           if ( NULL == cat1[v].value )
 119             {
 120               cat1[v].value = value_dup (value, width);
 121               cat1[v].count = w;
 122             }
 123           else if ( 0 == compare_values (cat1[v].value, value, width))
 124             cat1[v].count += w;
 125           else if ( NULL == cat2[v].value )
 126             {
 127               cat2[v].value = value_dup (value, width);
 128               cat2[v].count = w;
 129             }
 130           else if ( 0 == compare_values (cat2[v].value, value, width))
 131             cat2[v].count += w;
 132           else if ( bst->category1 == SYSMIS)
 133             msg (ME, _("Variable %s is not dichotomous"), var_get_name (var));
 134         }
 135
 136       case_destroy (&c);
 137     }
 138   return casereader_destroy (input);
 139 }
 140
 141
 142
 143 void
 144 binomial_execute (const struct dataset *ds,
 145                   struct casereader *input,
 146                   enum mv_class exclude,
 147                   const struct npar_test *test)
 148 {
 149   int v;
 150   const struct dictionary *dict = dataset_dict (ds);
 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 (dict, input, bst, cat1, cat2, exclude))
 174     {
 175       const struct variable *wvar = dict_get_weight (dict);
 176       const struct fmt_spec *wfmt = wvar ?
 177         var_get_print_format (wvar) : & F_8_0;
 178
 179       struct tab_table *table = tab_create (7, ost->n_vars * 3 + 1, 0);
 180
 181       tab_dim (table, tab_natural_dimensions);
 182
 183       tab_title (table, _("Binomial Test"));
 184
 185       tab_headers (table, 2, 0, 1, 0);
 186
 187       tab_box (table, TAL_1, TAL_1, -1, TAL_1,
 188                0, 0, table->nc - 1, tab_nr(table) - 1 );
 189
 190       for (v = 0 ; v < ost->n_vars; ++v)
 191         {
 192           double n_total, sig;
 193           struct string catstr1;
 194           struct string catstr2;
 195           const struct variable *var = ost->vars[v];
 196
 197           ds_init_empty (&catstr1);
 198           ds_init_empty (&catstr2);
 199
 200           var_append_value_name (var, cat1[v].value, &catstr1);
 201           var_append_value_name (var, cat2[v].value, &catstr2);
 202
 203           tab_hline (table, TAL_1, 0, tab_nc (table) -1, 1 + v * 3);
 204
 205           /* Titles */
 206           tab_text (table, 0, 1 + v * 3, TAB_LEFT, var_to_string (var));
 207           tab_text (table, 1, 1 + v * 3, TAB_LEFT, _("Group1"));
 208           tab_text (table, 1, 2 + v * 3, TAB_LEFT, _("Group2"));
 209           tab_text (table, 1, 3 + v * 3, TAB_LEFT, _("Total"));
 210
 211           /* Test Prop */
 212           tab_double (table, 5, 1 + v * 3, TAB_NONE, bst->p, NULL);
 213
 214           /* Category labels */
 215           tab_text (table, 2, 1 + v * 3, TAB_NONE, ds_cstr (&catstr1));
 216           tab_text (table, 2, 2 + v * 3, TAB_NONE, ds_cstr (&catstr2));
 217
 218           /* Observed N */
 219           tab_double (table, 3, 1 + v * 3, TAB_NONE, cat1[v].count, wfmt);
 220           tab_double (table, 3, 2 + v * 3, TAB_NONE, cat2[v].count, wfmt);
 221
 222           n_total = cat1[v].count + cat2[v].count;
 223           tab_double (table, 3, 3 + v * 3, TAB_NONE, n_total, wfmt);
 224
 225           /* Observed Proportions */
 226           tab_double (table, 4, 1 + v * 3, TAB_NONE,
 227                      cat1[v].count / n_total, NULL);
 228           tab_double (table, 4, 2 + v * 3, TAB_NONE,
 229                      cat2[v].count / n_total, NULL);
 230
 231           tab_double (table, 4, 3 + v * 3, TAB_NONE,
 232                      (cat1[v].count + cat2[v].count) / n_total, wfmt);
 233
 234           /* Significance */
 235           sig = calculate_binomial (cat1[v].count, cat2[v].count, bst->p);
 236           tab_double (table, 6, 1 + v * 3, TAB_NONE, sig, NULL);
 237
 238           ds_destroy (&catstr1);
 239           ds_destroy (&catstr2);
 240         }
 241
 242       tab_text (table,  2, 0,  TAB_CENTER, _("Category"));
 243       tab_text (table,  3, 0,  TAB_CENTER, _("N"));
 244       tab_text (table,  4, 0,  TAB_CENTER, _("Observed Prop."));
 245       tab_text (table,  5, 0,  TAB_CENTER, _("Test Prop."));
 246
 247       tab_text (table,  6, 0,  TAB_CENTER | TAT_PRINTF,
 248                 _("Exact Sig. (%d-tailed)"),
 249                 bst->p == 0.5 ? 2: 1);
 250
 251       tab_vline (table, TAL_2, 2, 0, tab_nr (table) -1);
 252       tab_submit (table);
 253     }
 254
 255   for (v = 0; v < ost->n_vars; v++)
 256     {
 257       free (cat1[v].value);
 258       free (cat2[v].value);
 259     }
 260   free (cat1);
 261   free (cat2);
 262 }