src/language/stats/friedman.c

   1 /* PSPP - a program for statistical analysis. -*-c-*-
   2    Copyright (C) 2010 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
  18 #include <config.h>
  19
  20 #include "friedman.h"
  21
  22 #include <gsl/gsl_cdf.h>
  23 #include <math.h>
  24
  25 #include <data/format.h>
  26
  27 #include <libpspp/misc.h>
  28 #include <libpspp/message.h>
  29 #include <data/procedure.h>
  30 #include <data/casereader.h>
  31 #include <data/dictionary.h>
  32 #include <data/variable.h>
  33
  34
  35 #include "gettext.h"
  36 #define _(msgid) gettext (msgid)
  37
  38
  39 struct friedman
  40 {
  41   double *rank_sum;
  42   double cc;
  43   double chi_sq;
  44   const struct dictionary *dict;
  45 };
  46
  47 static void show_ranks_box (const struct one_sample_test *ost,
  48                             const struct friedman *fr);
  49
  50 static void show_sig_box (const struct one_sample_test *ost,
  51                           const struct friedman *fr);
  52
  53
  54 struct datum
  55 {
  56   long posn;
  57   double x;
  58 };
  59
  60 static int
  61 cmp_x (const void *a_, const void *b_)
  62 {
  63   const struct datum *a = a_;
  64   const struct datum *b = b_;
  65
  66   if (a->x < b->x)
  67     return -1;
  68
  69   return (a->x > b->x);
  70 }
  71
  72 static int
  73 cmp_posn (const void *a_, const void *b_)
  74 {
  75   const struct datum *a = a_;
  76   const struct datum *b = b_;
  77
  78   if (a->posn < b->posn)
  79     return -1;
  80
  81   return (a->posn > b->posn);
  82 }
  83
  84 void
  85 friedman_execute (const struct dataset *ds,
  86               struct casereader *input,
  87               enum mv_class exclude,
  88               const struct npar_test *test,
  89               bool exact UNUSED,
  90               double timer UNUSED)
  91 {
  92   double numerator = 0.0;
  93   double denominator = 0.0;
  94   int v;
  95   struct ccase *c;
  96   const struct dictionary *dict = dataset_dict (ds);
  97   const struct variable *weight = dict_get_weight (dict);
  98
  99   struct one_sample_test *ft = UP_CAST (test, struct one_sample_test, parent);
 100   bool warn = true;
 101
 102   double sigma_t = 0.0;
 103   struct datum *row = xcalloc (ft->n_vars, sizeof *row);
 104
 105   struct friedman fr;
 106   fr.rank_sum = xcalloc (ft->n_vars, sizeof *fr.rank_sum);
 107   fr.cc = 0.0;
 108   fr.dict = dict;
 109   for (v = 0; v < ft->n_vars; ++v)
 110     {
 111       row[v].posn = v;
 112       fr.rank_sum[v] = 0.0;
 113     }
 114
 115   input = casereader_create_filter_weight (input, dict, &warn, NULL);
 116   input = casereader_create_filter_missing (input,
 117                                             ft->vars, ft->n_vars,
 118                                             exclude, 0, 0);
 119
 120   for (; (c = casereader_read (input)); case_unref (c))
 121     {
 122       double prev_x = SYSMIS;
 123       int run_length = 0;
 124
 125       const double w = weight ? case_data (c, weight)->f: 1.0;
 126
 127       fr.cc += w;
 128
 129       for (v = 0; v < ft->n_vars; ++v)
 130         {
 131           const struct variable *var = ft->vars[v];
 132           const union value *val = case_data (c, var);
 133           row[v].x = val->f;
 134         }
 135
 136       qsort (row, ft->n_vars, sizeof *row, cmp_x);
 137       for (v = 0; v < ft->n_vars; ++v)
 138         {
 139           double x = row[v].x;
 140           /* Replace value by the Rank */
 141           if ( prev_x == x)
 142             {
 143               /* Deal with ties */
 144               int i;
 145               run_length++;
 146               for (i = v - run_length; i < v; ++i)
 147                 {
 148                   row[i].x *= run_length ;
 149                   row[i].x += v + 1;
 150                   row[i].x /= run_length + 1;
 151                 }
 152               row[v].x = row[v-1].x;
 153             }
 154           else
 155             {
 156               row[v].x = v + 1;
 157               if ( run_length > 0)
 158                 {
 159                   double t = run_length + 1;
 160                   sigma_t += pow3 (t) - t;
 161                 }
 162               run_length = 0;
 163             }
 164           prev_x = x;
 165         }
 166       if ( run_length > 0)
 167         {
 168           double t = run_length + 1;
 169           sigma_t += pow3 (t) - t;
 170         }
 171
 172       qsort (row, ft->n_vars, sizeof *row, cmp_posn);
 173
 174       for (v = 0; v < ft->n_vars; ++v)
 175         fr.rank_sum[v] += row[v].x;
 176
 177     }
 178   casereader_destroy (input);
 179   free (row);
 180
 181
 182   for (v = 0; v < ft->n_vars; ++v)
 183     {
 184       numerator += pow2 (fr.rank_sum[v]);
 185     }
 186
 187   numerator *= 12.0 / (fr.cc * ft->n_vars * ( ft->n_vars + 1));
 188   numerator -= 3 * fr.cc * ( ft->n_vars + 1);
 189
 190   denominator = 1 - sigma_t / ( fr.cc * ft->n_vars * ( pow2 (ft->n_vars) - 1));
 191
 192   fr.chi_sq = numerator / denominator;
 193
 194   show_ranks_box (ft, &fr);
 195
 196   show_sig_box (ft, &fr);
 197
 198   free (fr.rank_sum);
 199 }
 200
 201 \f
 202
 203 #include <output/tab.h>
 204
 205 static void
 206 show_ranks_box (const struct one_sample_test *ost, const struct friedman *fr)
 207 {
 208   int i;
 209   const int row_headers = 1;
 210   const int column_headers = 1;
 211   struct tab_table *table =
 212     tab_create (row_headers + 1, column_headers + ost->n_vars);
 213
 214   tab_headers (table, row_headers, 0, column_headers, 0);
 215
 216   tab_title (table, _("Ranks"));
 217
 218   /* Vertical lines inside the box */
 219   tab_box (table, 1, 0, -1, TAL_1,
 220            row_headers, 0, tab_nc (table) - 1, tab_nr (table) - 1 );
 221
 222   /* Box around the table */
 223   tab_box (table, TAL_2, TAL_2, -1, -1,
 224            0,  0, tab_nc (table) - 1, tab_nr (table) - 1 );
 225
 226
 227   tab_text (table, 1, 0, 0, _("Mean Rank"));
 228
 229   tab_hline (table, TAL_2, 0, tab_nc (table) - 1, column_headers);
 230   tab_vline (table, TAL_2, row_headers, 0, tab_nr (table) - 1);
 231
 232   for (i = 0 ; i < ost->n_vars ; ++i)
 233     {
 234       tab_text (table, 0, row_headers + i,
 235                 TAB_LEFT, var_to_string (ost->vars[i]));
 236
 237       tab_double (table, 1, row_headers + i,
 238                   0, fr->rank_sum[i] / fr->cc, 0);
 239     }
 240
 241   tab_submit (table);
 242 }
 243
 244
 245 static void
 246 show_sig_box (const struct one_sample_test *ost, const struct friedman *fr)
 247 {
 248   const struct variable *weight = dict_get_weight (fr->dict);
 249   const struct fmt_spec *wfmt = weight ? var_get_print_format (weight) : &F_8_0;
 250
 251   const int row_headers = 1;
 252   const int column_headers = 0;
 253   struct tab_table *table =
 254     tab_create (row_headers + 1, column_headers + 4);
 255
 256   tab_headers (table, row_headers, 0, column_headers, 0);
 257
 258   tab_title (table, _("Test Statistics"));
 259
 260   tab_text (table,  0, column_headers,
 261             TAT_TITLE | TAB_LEFT , _("N"));
 262
 263   tab_text (table,  0, 1 + column_headers,
 264             TAT_TITLE | TAB_LEFT , _("Chi-Square"));
 265
 266   tab_text (table,  0, 2 + column_headers,
 267             TAT_TITLE | TAB_LEFT, _("df"));
 268
 269   tab_text (table,  0, 3 + column_headers,
 270             TAT_TITLE | TAB_LEFT, _("Asymp. Sig."));
 271
 272   /* Box around the table */
 273   tab_box (table, TAL_2, TAL_2, -1, -1,
 274            0,  0, tab_nc (table) - 1, tab_nr (table) - 1 );
 275
 276
 277   tab_hline (table, TAL_2, 0, tab_nc (table) -1, column_headers);
 278   tab_vline (table, TAL_2, row_headers, 0, tab_nr (table) - 1);
 279
 280   tab_double (table, 1, column_headers,
 281               0, fr->cc, wfmt);
 282
 283   tab_double (table, 1, column_headers + 1,
 284               0, fr->chi_sq, 0);
 285
 286   tab_double (table, 1, column_headers + 2,
 287               0, ost->n_vars - 1, &F_8_0);
 288
 289   tab_double (table, 1, column_headers + 3,
 290               0, gsl_cdf_chisq_Q (fr->chi_sq, ost->n_vars - 1),
 291               0);
 292
 293   tab_submit (table);
 294 }