src/factor_stats.c

   1 /* PSPP - A program for statistical analysis . -*-c-*-
   2
   3 Copyright (C) 2004 Free Software Foundation, Inc.
   4 Author: John Darrington 2004
   5
   6 This program is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU General Public License as
   8 published by the Free Software Foundation; either version 2 of the
   9 License, or (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA. */
  20
  21 #include "factor_stats.h"
  22 #include "config.h"
  23 #include "val.h"
  24 #include "hash.h"
  25 #include "algorithm.h"
  26 #include "alloc.h"
  27 #include "moments.h"
  28
  29 #include <stdlib.h>
  30 #include <math.h>
  31 #include <float.h>
  32 #include <assert.h>
  33 #include <chart.h>
  34
  35
  36 void
  37 metrics_precalc(struct metrics *m)
  38 {
  39   assert (m) ;
  40
  41   m->n_missing = 0;
  42
  43   m->min = DBL_MAX;
  44   m->max = -DBL_MAX;
  45
  46
  47   m->moments = moments1_create(MOMENT_KURTOSIS);
  48
  49   m->ordered_data = hsh_create(20,
  50                                 (hsh_compare_func *) compare_values,
  51                                 (hsh_hash_func *) hash_value,
  52                                 (hsh_free_func *) weighted_value_free,
  53                                 (void *) 0);
  54
  55
  56
  57 }
  58
  59
  60 /* Include val in the calculation for the metrics.
  61    If val is null, then treat it as MISSING
  62 */
  63 void
  64 metrics_calc(struct metrics *fs, const union value *val,
  65              double weight, int case_no)
  66 {
  67   struct weighted_value **wv;
  68   double x;
  69
  70   if ( ! val )
  71     {
  72       fs->n_missing += weight;
  73       return ;
  74     }
  75
  76   x = val->f;
  77
  78   moments1_add(fs->moments, x, weight);
  79
  80
  81   if ( x < fs->min) fs->min = x;
  82   if ( x > fs->max) fs->max = x;
  83
  84
  85   wv = (struct weighted_value **) hsh_probe (fs->ordered_data,(void *) val );
  86
  87   if ( *wv  )
  88     {
  89       /* If this value has already been seen, then simply
  90          increase its weight  and push a new case number */
  91
  92       struct case_node *cn;
  93
  94       assert( (*wv)->v.f == val->f );
  95       (*wv)->w += weight;
  96
  97       cn = xmalloc( sizeof (struct case_node) ) ;
  98       cn->next = (*wv)->case_nos ;
  99       cn->num = case_no;
 100
 101       (*wv)->case_nos = cn;
 102     }
 103   else
 104     {
 105       struct case_node *cn;
 106
 107       *wv = weighted_value_create();
 108       (*wv)->v = *val;
 109       (*wv)->w = weight;
 110
 111       cn = xmalloc( sizeof (struct case_node) ) ;
 112       cn->next=0;
 113       cn->num = case_no;
 114       (*wv)->case_nos  = cn;
 115
 116     }
 117
 118 }
 119
 120 void
 121 metrics_postcalc(struct metrics *m)
 122 {
 123   double cc = 0.0;
 124   double tc ;
 125   int k1, k2 ;
 126   int i;
 127   int j = 1;
 128
 129
 130   moments1_calculate (m->moments, &m->n, &m->mean, &m->var,
 131                       &m->skewness, &m->kurtosis);
 132
 133   moments1_destroy (m->moments);
 134
 135
 136   m->stddev = sqrt(m->var);
 137
 138   /* FIXME: Check this is correct ???
 139      Shouldn't we use the sample variance ??? */
 140   m->se_mean = sqrt (m->var / m->n) ;
 141
 142
 143
 144   m->wvp = (struct weighted_value **) hsh_sort(m->ordered_data);
 145   m->n_data = hsh_count(m->ordered_data);
 146
 147   if ( m->n_data == 0 )
 148     {
 149       m->trimmed_mean = m->mean;
 150       return;
 151     }
 152
 153
 154   /* Trimmed mean calculation */
 155
 156   tc = m->n * 0.05 ;
 157   k1 = -1;
 158   k2 = -1;
 159
 160
 161   for ( i = 0 ; i < m->n_data ; ++i )
 162     {
 163       cc += m->wvp[i]->w;
 164       m->wvp[i]->cc = cc;
 165
 166       m->wvp[i]->rank = j + (m->wvp[i]->w - 1) / 2.0 ;
 167
 168       j += m->wvp[i]->w;
 169
 170       if ( cc < tc )
 171         k1 = i;
 172
 173     }
 174
 175   k2 = m->n_data;
 176   for ( i = m->n_data -1  ; i >= 0; --i )
 177     {
 178       if ( tc > m->n - m->wvp[i]->cc)
 179         k2 = i;
 180     }
 181
 182
 183   m->trimmed_mean = 0;
 184   for ( i = k1 + 2 ; i <= k2 - 1 ; ++i )
 185     {
 186       m->trimmed_mean += m->wvp[i]->v.f * m->wvp[i]->w;
 187     }
 188
 189
 190   m->trimmed_mean += (m->n - m->wvp[k2 - 1]->cc - tc) * m->wvp[k2]->v.f ;
 191   m->trimmed_mean += (m->wvp[k1 + 1]->cc - tc) * m->wvp[k1 + 1]->v.f ;
 192   m->trimmed_mean /= 0.9 * m->n ;
 193
 194   m->histogram = histogram_create(10, m->min, m->max);
 195
 196   for ( i = 0 ; i < m->n_data ; ++i )
 197     {
 198       struct weighted_value **wv = (m->wvp) ;
 199       gsl_histogram_accumulate(m->histogram, wv[i]->v.f, wv[i]->w);
 200     }
 201
 202 }
 203
 204
 205 struct weighted_value *
 206 weighted_value_create(void)
 207 {
 208   struct weighted_value *wv;
 209   wv = xmalloc (sizeof (struct weighted_value ));
 210
 211   wv->cc = 0;
 212   wv->case_nos = 0;
 213
 214   return wv;
 215 }
 216
 217 void
 218 weighted_value_free(struct weighted_value *wv)
 219 {
 220   struct case_node *cn = wv->case_nos;
 221
 222   while(cn)
 223     {
 224       struct case_node *next = cn->next;
 225
 226       free(cn);
 227       cn = next;
 228     }
 229
 230   free(wv);
 231
 232 }
 233
 234
 235
 236
 237
 238 /* Create a factor statistics object with for N dependent vars
 239    and ID as the value of the independent variable */
 240 struct factor_statistics *
 241 create_factor_statistics (int n, union value *id0, union value *id1)
 242 {
 243   struct factor_statistics *f;
 244
 245   f =  xmalloc( sizeof  ( struct factor_statistics ));
 246
 247   f->id[0] = *id0;
 248   f->id[1] = *id1;
 249   f->m = xmalloc( sizeof ( struct metrics ) * n ) ;
 250
 251   return f;
 252 }
 253
 254
 255 void
 256 factor_statistics_free(struct factor_statistics *f)
 257 {
 258   hsh_destroy(f->m->ordered_data);
 259   gsl_histogram_free(f->m->histogram);
 260   free(f->m) ;
 261   free(f);
 262 }
 263
 264
 265
 266
 267 int
 268 factor_statistics_compare(const struct factor_statistics *f0,
 269                           const struct factor_statistics *f1, int width)
 270 {
 271
 272   int cmp0;
 273
 274   assert(f0);
 275   assert(f1);
 276
 277   cmp0 = compare_values(&f0->id[0], &f1->id[0], width);
 278
 279   if ( cmp0 != 0 )
 280     return cmp0;
 281
 282
 283   if ( ( f0->id[1].f == SYSMIS )  && (f1->id[1].f != SYSMIS) )
 284     return 1;
 285
 286   if ( ( f0->id[1].f != SYSMIS )  && (f1->id[1].f == SYSMIS) )
 287     return -1;
 288
 289   return compare_values(&f0->id[1], &f1->id[1], width);
 290
 291 }
 292
 293 unsigned int
 294 factor_statistics_hash(const struct factor_statistics *f, int width)
 295 {
 296
 297   unsigned int h;
 298
 299   h = hash_value(&f->id[0], width);
 300
 301   if ( f->id[1].f != SYSMIS )
 302     h += hash_value(&f->id[1], width);
 303
 304
 305   return h;
 306
 307 }
 308