pintos-os.org Git - pspp/blob - src/levene.c

   1 /* This file is part of GNU PSPP
   2    Computes Levene test  statistic.
   3
   4    Copyright (C) 2004 Free Software Foundation, Inc.
   5    Written by John Darrington <john@darrington.wattle.id.au>
   6
   7    This program is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License as
   9    published by the Free Software Foundation; either version 2 of the
  10    License, or (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful, but
  13    WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15    General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20    02111-1307, USA. */
  21
  22 #include <config.h>
  23 #include "error.h"
  24 #include "casefile.h"
  25 #include "levene.h"
  26 #include "hash.h"
  27 #include "str.h"
  28 #include "var.h"
  29 #include "vfm.h"
  30 #include "alloc.h"
  31 #include "misc.h"
  32
  33
  34 #include <math.h>
  35 #include <stdlib.h>
  36
  37
  38 /* This module calculates the Levene statistic for variables.
  39
  40    Just for reference, the Levene Statistic is a defines as follows:
  41
  42    W = \frac{ (n-k)\sum_{i=1}^k n_i(Z_{iL} - Z_{LL})^2}
  43             { (k-1)\sum_{i=1}^k \sum_{j=1}^{n_i} (Z_{ij} - Z_{iL})^2}
  44
  45    where:
  46         k is the number of groups
  47         n is the total number of samples
  48         n_i is the number of samples in the ith group
  49         Z_{ij} is | Y_{ij} - Y_{iL} | where Y_{iL} is the mean of the ith group
  50         Z_{iL} is the  mean of Z_{ij} over the ith group
  51         Z_{LL} is the grand mean of Z_{ij}
  52
  53    Imagine calculating that with pencil and paper!
  54
  55  */
  56
  57 static struct group_statistics *get_group(int v, struct group_statistics *key);
  58
  59
  60 struct levene_info
  61 {
  62
  63   /* Per group statistics */
  64   struct t_test_proc **group_stats;
  65
  66   /* The independent variable */
  67   struct variable *v_indep;
  68
  69   /* Number of dependent variables */
  70   int n_dep;
  71
  72   /* The dependent variables */
  73   struct variable  **v_dep;
  74
  75   /* How to treat missing values */
  76   enum lev_missing missing;
  77
  78   /* Function to test for missing values */
  79   is_missing_func is_missing;
  80
  81 };
  82
  83 /* First pass */
  84 static void  levene_precalc (const struct levene_info *l);
  85 static int levene_calc (const struct ccase *, void *);
  86 static void levene_postcalc (void *);
  87
  88
  89 /* Second pass */
  90 static void levene2_precalc (void *);
  91 static int levene2_calc (const struct ccase *, void *);
  92 static void levene2_postcalc (void *);
  93
  94
  95 void
  96 levene(const struct casefile *cf,
  97        struct variable *v_indep, int n_dep, struct variable **v_dep,
  98              enum lev_missing missing,   is_missing_func value_is_missing)
  99 {
 100   struct casereader *r;
 101   const struct ccase *c;
 102   struct levene_info l;
 103
 104   l.n_dep      = n_dep;
 105   l.v_indep    = v_indep;
 106   l.v_dep      = v_dep;
 107   l.missing    = missing;
 108   l.is_missing = value_is_missing;
 109
 110
 111
 112   levene_precalc(&l);
 113   for(r = casefile_get_reader (cf);
 114       casereader_read (r, &c) ; )
 115     {
 116       levene_calc(c,&l);
 117     }
 118   casereader_destroy (r);
 119   levene_postcalc(&l);
 120
 121   levene2_precalc(&l);
 122   for(r = casefile_get_reader (cf);
 123       casereader_read (r, &c) ; )
 124     {
 125       levene2_calc(c,&l);
 126     }
 127   casereader_destroy (r);
 128   levene2_postcalc(&l);
 129
 130 }
 131
 132 static struct hsh_table **hash;
 133
 134
 135 /* Return -1 if the id of a is less than b; +1 if greater than and
 136    0 if equal */
 137 static int
 138 compare_group(const struct group_statistics *a,
 139                  const struct group_statistics *b,
 140                  int width)
 141 {
 142   int id_cmp = compare_values(&a->id, &b->id, width);
 143
 144   if (id_cmp == 0 )
 145     {
 146       int c;
 147       c= memcmp(&a->criterion,&b->criterion,sizeof(enum comparison));
 148       return c;
 149     }
 150   else
 151     return id_cmp;
 152 }
 153
 154
 155 static unsigned
 156 hash_group(const struct group_statistics *g, int width)
 157 {
 158   unsigned id_hash;
 159
 160   if ( 0 == width )
 161     id_hash = hsh_hash_double (g->id.f);
 162   else
 163     id_hash = hsh_hash_bytes (g->id.s, width);
 164
 165   return id_hash;
 166 }
 167
 168 /* Internal variables used in calculating the Levene statistic */
 169
 170 /* Per variable statistics */
 171 struct lz_stats
 172 {
 173   /* Total of all lz */
 174   double grand_total;
 175
 176   /* Mean of all lz */
 177   double grand_mean;
 178
 179   /* The total number of cases */
 180   double total_n ;
 181
 182   /* Number of groups */
 183   int n_groups;
 184 };
 185
 186 /* An array of lz_stats for each variable */
 187 static struct lz_stats *lz;
 188
 189 /* Set to 1 if the groups require inequality comparisions */
 190 static int inequality_compare;
 191
 192
 193 static void
 194 levene_precalc (const struct levene_info *l)
 195 {
 196   int i;
 197
 198   lz  = xmalloc (sizeof (struct lz_stats ) * l->n_dep ) ;
 199
 200   hash = xmalloc (sizeof ( struct hsh_table *) * l->n_dep );
 201
 202   for(i=0; i < l->n_dep ; ++i )
 203     {
 204       struct variable *v = l->v_dep[i];
 205       int g;
 206       int number_of_groups = v->p.t_t.n_groups ;
 207
 208       hash[i] = hsh_create (l->n_dep * number_of_groups,
 209                             (hsh_compare_func *) compare_group,
 210                             (hsh_hash_func *) hash_group,
 211                             0,(void *) l->v_indep->width);
 212
 213       lz[i].grand_total = 0;
 214       lz[i].total_n = 0;
 215       lz[i].n_groups = number_of_groups;
 216
 217       for (g = 0 ; g < v->p.t_t.n_groups ; ++g )
 218         {
 219           struct group_statistics *gs = &v->p.t_t.gs[g];
 220           gs->lz_total = 0;
 221           hsh_insert(hash[i], gs);
 222           if ( gs->criterion != CMP_EQ )
 223             {
 224               inequality_compare = 1;
 225             }
 226         }
 227     }
 228
 229 }
 230
 231 static int
 232 levene_calc (const struct ccase *c, void *_l)
 233 {
 234   int i;
 235   struct levene_info *l = (struct levene_info *) _l;
 236   const union value *gv = &c->data[l->v_indep->fv];
 237   struct group_statistics key;
 238   double weight = dict_get_case_weight(default_dict,c);
 239
 240
 241   /* Skip the entire case if /MISSING=LISTWISE is set */
 242   if ( l->missing == LEV_LISTWISE )
 243     {
 244       for (i = 0; i < l->n_dep; ++i)
 245         {
 246           struct variable *v = l->v_dep[i];
 247           const union value *val = &c->data[v->fv];
 248
 249           if (l->is_missing(val,v) )
 250             {
 251               return 0;
 252             }
 253         }
 254     }
 255
 256
 257   key.id = *gv;
 258   key.criterion = CMP_EQ;
 259
 260   for (i = 0; i < l->n_dep; ++i)
 261     {
 262       struct variable *var = l->v_dep[i];
 263       double levene_z;
 264       const union value *v = &c->data[var->fv];
 265       struct group_statistics *gs;
 266       gs = get_group(i,&key);
 267       if ( 0 == gs )
 268         continue ;
 269
 270       if ( ! l->is_missing(v,var))
 271         {
 272           levene_z= fabs(v->f - gs->mean);
 273           lz[i].grand_total += levene_z * weight;
 274           lz[i].total_n += weight;
 275
 276           gs->lz_total += levene_z * weight;
 277         }
 278     }
 279   return 0;
 280 }
 281
 282
 283 static void
 284 levene_postcalc (void *_l)
 285 {
 286   int v;
 287
 288   struct levene_info *l = (struct levene_info *) _l;
 289
 290   for (v = 0; v < l->n_dep; ++v)
 291     {
 292       lz[v].grand_mean = lz[v].grand_total / lz[v].total_n ;
 293
 294     }
 295
 296 }
 297
 298
 299 /* The denominator for the expression for the Levene */
 300 static double *lz_denominator;
 301
 302 static void
 303 levene2_precalc (void *_l)
 304 {
 305   int v;
 306
 307   struct levene_info *l = (struct levene_info *) _l;
 308
 309   lz_denominator = (double *) xmalloc(sizeof(double) * l->n_dep);
 310
 311   /* This stuff could go in the first post calc . . . */
 312   for (v = 0; v < l->n_dep; ++v)
 313     {
 314       struct hsh_iterator hi;
 315       struct group_statistics *g;
 316       for(g = (struct group_statistics *) hsh_first(hash[v],&hi);
 317           g != 0 ;
 318           g = (struct group_statistics *) hsh_next(hash[v],&hi) )
 319         {
 320           g->lz_mean = g->lz_total/g->n ;
 321         }
 322       lz_denominator[v] = 0;
 323   }
 324 }
 325
 326 static int
 327 levene2_calc (const struct ccase *c, void *_l)
 328 {
 329   int i;
 330
 331   struct levene_info *l = (struct levene_info *) _l;
 332
 333   double weight = dict_get_case_weight(default_dict,c);
 334
 335   const union value *gv = &c->data[l->v_indep->fv];
 336   struct group_statistics key;
 337
 338   /* Skip the entire case if /MISSING=LISTWISE is set */
 339   if ( l->missing == LEV_LISTWISE )
 340     {
 341       for (i = 0; i < l->n_dep; ++i)
 342         {
 343           struct variable *v = l->v_dep[i];
 344           const union value *val = &c->data[v->fv];
 345
 346           if (l->is_missing(val,v) )
 347             {
 348               return 0;
 349             }
 350         }
 351     }
 352
 353   key.id = *gv;
 354   key.criterion = CMP_EQ;
 355
 356   for (i = 0; i < l->n_dep; ++i)
 357     {
 358       double levene_z;
 359       struct variable *var = l->v_dep[i] ;
 360       const union value *v = &c->data[var->fv];
 361       struct group_statistics *gs;
 362       gs = get_group(i,&key);
 363       if ( 0 == gs )
 364         continue;
 365
 366       if ( ! l->is_missing(v,var) )
 367         {
 368           levene_z = fabs(v->f - gs->mean);
 369           lz_denominator[i] += weight * pow2(levene_z - gs->lz_mean);
 370         }
 371     }
 372
 373   return 0;
 374 }
 375
 376
 377 static void
 378 levene2_postcalc (void *_l)
 379 {
 380   int v;
 381
 382   struct levene_info *l = (struct levene_info *) _l;
 383
 384   for (v = 0; v < l->n_dep; ++v)
 385     {
 386       double lz_numerator = 0;
 387       struct hsh_iterator hi;
 388       struct group_statistics *g;
 389       for(g = (struct group_statistics *) hsh_first(hash[v],&hi);
 390           g != 0 ;
 391           g = (struct group_statistics *) hsh_next(hash[v],&hi) )
 392         {
 393
 394           lz_numerator += g->n * pow2(g->lz_mean - lz[v].grand_mean );
 395
 396
 397         }
 398       lz_numerator *= ( l->v_dep[v]->p.t_t.ugs.n -
 399                         l->v_dep[v]->p.t_t.n_groups );
 400
 401       lz_denominator[v] /= (l->v_dep[v]->p.t_t.n_groups - 1);
 402
 403       l->v_dep[v]->p.t_t.levene = lz_numerator/lz_denominator[v] ;
 404     }
 405
 406   /* Now clear up after ourselves */
 407   free(lz_denominator);
 408   for (v = 0; v < l->n_dep; ++v)
 409     {
 410       hsh_destroy(hash[v]);
 411     }
 412
 413   free(hash);
 414   free(lz);
 415 }
 416
 417
 418 /* Return the group belonging to the v_th dependent variable
 419    which matches the key */
 420 static struct group_statistics *
 421 get_group(int v, struct group_statistics *key)
 422 {
 423   struct group_statistics *gs;
 424   gs = hsh_find(hash[v],key);
 425
 426
 427   if ( ( !gs )  && inequality_compare)
 428     {
 429       /* Here we degrade to a linear search.
 430          This would seem inefficient.  However, it should only ever happen
 431          with the T-TEST, for which there are exactly two groups */
 432
 433       struct hsh_iterator hi;
 434
 435       assert( hsh_count(hash[v]) == 2 ) ;
 436       for(gs = (struct group_statistics *) hsh_first(hash[v],&hi);
 437           gs != 0 ;
 438           gs = (struct group_statistics *) hsh_next(hash[v],&hi) )
 439         {
 440           int cmp;
 441
 442           cmp = compare_values(&gs->id, &key->id, 0);
 443
 444           assert( cmp != 0 ); /* or else the hash would have found something */
 445
 446           if ( cmp == -1 &&
 447                ( gs->criterion == CMP_GT || gs->criterion == CMP_GE )
 448              )
 449             break;
 450
 451           if ( cmp == 1 &&
 452                ( gs->criterion == CMP_LT || gs->criterion == CMP_LE )
 453              )
 454             break;
 455         }
 456     }
 457
 458   return gs;
 459 }