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   double w;
  45   const struct dictionary *dict;
  46 };
  47
  48 static void show_ranks_box (const struct one_sample_test *ost,
  49                             const struct friedman *fr);
  50
  51 static void show_sig_box (const struct one_sample_test *ost,
  52                           const struct friedman *fr);
  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 *ost = UP_CAST (test, struct one_sample_test, parent);
 100   struct friedman_test *ft = UP_CAST (ost, struct friedman_test, parent);
 101   bool warn = true;
 102
 103   double sigma_t = 0.0;
 104   struct datum *row = xcalloc (ost->n_vars, sizeof *row);
 105   double rsq;
 106   struct friedman fr;
 107   fr.rank_sum = xcalloc (ost->n_vars, sizeof *fr.rank_sum);
 108   fr.cc = 0.0;
 109   fr.dict = dict;
 110   for (v = 0; v < ost->n_vars; ++v)
 111     {
 112       row[v].posn = v;
 113       fr.rank_sum[v] = 0.0;
 114     }
 115
 116   input = casereader_create_filter_weight (input, dict, &warn, NULL);
 117   input = casereader_create_filter_missing (input,
 118                                             ost->vars, ost->n_vars,
 119                                             exclude, 0, 0);
 120
 121   for (; (c = casereader_read (input)); case_unref (c))
 122     {
 123       double prev_x = SYSMIS;
 124       int run_length = 0;
 125
 126       const double w = weight ? case_data (c, weight)->f: 1.0;
 127
 128       fr.cc += w;
 129
 130       for (v = 0; v < ost->n_vars; ++v)
 131         {
 132           const struct variable *var = ost->vars[v];
 133           const union value *val = case_data (c, var);
 134           row[v].x = val->f;
 135         }
 136
 137       qsort (row, ost->n_vars, sizeof *row, cmp_x);
 138       for (v = 0; v < ost->n_vars; ++v)
 139         {
 140           double x = row[v].x;
 141           /* Replace value by the Rank */
 142           if ( prev_x == x)
 143             {
 144               /* Deal with ties */
 145               int i;
 146               run_length++;
 147               for (i = v - run_length; i < v; ++i)
 148                 {
 149                   row[i].x *= run_length ;
 150                   row[i].x += v + 1;
 151                   row[i].x /= run_length + 1;
 152                 }
 153               row[v].x = row[v-1].x;
 154             }
 155           else
 156             {
 157               row[v].x = v + 1;
 158               if ( run_length > 0)
 159                 {
 160                   double t = run_length + 1;
 161                   sigma_t += w * (pow3 (t) - t);
 162                 }
 163               run_length = 0;
 164             }
 165           prev_x = x;
 166         }
 167       if ( run_length > 0)
 168         {
 169           double t = run_length + 1;
 170           sigma_t += w * (pow3 (t) - t );
 171         }
 172
 173       qsort (row, ost->n_vars, sizeof *row, cmp_posn);
 174
 175       for (v = 0; v < ost->n_vars; ++v)
 176         fr.rank_sum[v] += row[v].x * w;
 177     }
 178   casereader_destroy (input);
 179   free (row);
 180
 181
 182   for (v = 0; v < ost->n_vars; ++v)
 183     {
 184       numerator += pow2 (fr.rank_sum[v]);
 185     }
 186
 187   rsq = numerator;
 188
 189   numerator *= 12.0 / (fr.cc * ost->n_vars * ( ost->n_vars + 1));
 190   numerator -= 3 * fr.cc * ( ost->n_vars + 1);
 191
 192   denominator = 1 - sigma_t / ( fr.cc * ost->n_vars * ( pow2 (ost->n_vars) - 1));
 193
 194   fr.chi_sq = numerator / denominator;
 195
 196   if ( ft->kendalls_w)
 197     {
 198       fr.w = 12 * rsq ;
 199       fr.w -= 3 * pow2 (fr.cc) *
 200         ost->n_vars * pow2 (ost->n_vars + 1);
 201
 202       fr.w /= pow2 (fr.cc) * (pow3 (ost->n_vars) - ost->n_vars)
 203         - fr.cc * sigma_t;
 204     }
 205
 206   show_ranks_box (ost, &fr);
 207   show_sig_box (ost, &fr);
 208
 209   free (fr.rank_sum);
 210 }
 211
 212 \f
 213
 214 #include <output/tab.h>
 215
 216 static void
 217 show_ranks_box (const struct one_sample_test *ost, const struct friedman *fr)
 218 {
 219   int i;
 220   const int row_headers = 1;
 221   const int column_headers = 1;
 222   struct tab_table *table =
 223     tab_create (row_headers + 1, column_headers + ost->n_vars);
 224
 225   tab_headers (table, row_headers, 0, column_headers, 0);
 226
 227   tab_title (table, _("Ranks"));
 228
 229   /* Vertical lines inside the box */
 230   tab_box (table, 1, 0, -1, TAL_1,
 231            row_headers, 0, tab_nc (table) - 1, tab_nr (table) - 1 );
 232
 233   /* Box around the table */
 234   tab_box (table, TAL_2, TAL_2, -1, -1,
 235            0,  0, tab_nc (table) - 1, tab_nr (table) - 1 );
 236
 237
 238   tab_text (table, 1, 0, 0, _("Mean Rank"));
 239
 240   tab_hline (table, TAL_2, 0, tab_nc (table) - 1, column_headers);
 241   tab_vline (table, TAL_2, row_headers, 0, tab_nr (table) - 1);
 242
 243   for (i = 0 ; i < ost->n_vars ; ++i)
 244     {
 245       tab_text (table, 0, row_headers + i,
 246                 TAB_LEFT, var_to_string (ost->vars[i]));
 247
 248       tab_double (table, 1, row_headers + i,
 249                   0, fr->rank_sum[i] / fr->cc, 0);
 250     }
 251
 252   tab_submit (table);
 253 }
 254
 255
 256 static void
 257 show_sig_box (const struct one_sample_test *ost, const struct friedman *fr)
 258 {
 259   const struct friedman_test *ft = UP_CAST (ost, const struct friedman_test, parent);
 260
 261   int row = 0;
 262   const struct variable *weight = dict_get_weight (fr->dict);
 263   const struct fmt_spec *wfmt = weight ? var_get_print_format (weight) : &F_8_0;
 264
 265   const int row_headers = 1;
 266   const int column_headers = 0;
 267   struct tab_table *table =
 268     tab_create (row_headers + 1, column_headers + (ft->kendalls_w ? 5 : 4));
 269
 270   tab_headers (table, row_headers, 0, column_headers, 0);
 271
 272   tab_title (table, _("Test Statistics"));
 273
 274   tab_text (table,  0, column_headers + row++,
 275             TAT_TITLE | TAB_LEFT , _("N"));
 276
 277   if ( ft->kendalls_w)
 278     tab_text (table,  0, column_headers + row++,
 279               TAT_TITLE | TAB_LEFT , _("Kendall's W"));
 280
 281   tab_text (table,  0, column_headers + row++,
 282             TAT_TITLE | TAB_LEFT , _("Chi-Square"));
 283
 284   tab_text (table,  0, column_headers + row++,
 285             TAT_TITLE | TAB_LEFT, _("df"));
 286
 287   tab_text (table,  0, column_headers + row++,
 288             TAT_TITLE | TAB_LEFT, _("Asymp. Sig."));
 289
 290   /* Box around the table */
 291   tab_box (table, TAL_2, TAL_2, -1, -1,
 292            0,  0, tab_nc (table) - 1, tab_nr (table) - 1 );
 293
 294
 295   tab_hline (table, TAL_2, 0, tab_nc (table) -1, column_headers);
 296   tab_vline (table, TAL_2, row_headers, 0, tab_nr (table) - 1);
 297
 298   row = 0;
 299   tab_double (table, 1, column_headers + row++,
 300               0, fr->cc, wfmt);
 301
 302   if (ft->kendalls_w)
 303     tab_double (table, 1, column_headers + row++,
 304                 0, fr->w, 0);
 305
 306   tab_double (table, 1, column_headers + row++,
 307               0, fr->chi_sq, 0);
 308
 309   tab_double (table, 1, column_headers + row++,
 310               0, ost->n_vars - 1, &F_8_0);
 311
 312   tab_double (table, 1, column_headers + row++,
 313               0, gsl_cdf_chisq_Q (fr->chi_sq, ost->n_vars - 1),
 314               0);
 315
 316   tab_submit (table);
 317 }