pintos-os.org Git - pspp/blob - src/math/categoricals.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009 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
  19 #include <stdio.h>
  20
  21 #include "categoricals.h"
  22
  23 #include <gl/xalloc.h>
  24 #include <data/variable.h>
  25 #include <data/case.h>
  26 #include <data/value.h>
  27 #include <libpspp/hmap.h>
  28 #include <libpspp/pool.h>
  29
  30 #include <libpspp/str.h>
  31
  32 struct value_node
  33 {
  34   struct hmap_node node;      /* Node in hash map. */
  35   union value value;          /* The value being labeled. */
  36   double cc;                  /* The total of the weights of cases with this value */
  37   int subscript;              /* A zero based integer, unique within the variable.
  38                                  Can be used as an index into an array */
  39 };
  40
  41
  42 struct var_params
  43 {
  44   /* A map indexed by a union values */
  45   struct hmap map;
  46
  47   const struct variable *var;
  48
  49   int base_subscript;
  50
  51   /* The number of distinct values of this variable */
  52   int n_cats;
  53
  54   /* A map of values indexed by subscript */
  55   const struct value_node **reverse_value_map;
  56
  57   /* Total of the weights of this variable */
  58   double cc;
  59 };
  60
  61
  62 struct categoricals
  63 {
  64   /* The weight variable */
  65   const struct variable *wv;
  66
  67
  68   /* An array of var_params */
  69   struct var_params *vp;
  70
  71   /* The size of VP. (ie, the number of variables involved.) */
  72   size_t n_vp;
  73
  74   /* The number of categorical variables which contain entries.
  75      In the absence of missing values, this will be equal to N_VP */
  76   size_t n_vars;
  77
  78   /* A map to enable the lookup of variables indexed by subscript */
  79   int *reverse_variable_map;
  80
  81   size_t n_cats_total;
  82
  83   struct pool *pool;
  84
  85   /* Missing values to be excluded */
  86   enum mv_class exclude;
  87 };
  88
  89
  90 void
  91 categoricals_destroy ( struct categoricals *cat)
  92 {
  93   int i;
  94   if (cat != NULL)
  95     {
  96       for (i = 0 ; i < cat->n_vp; ++i)
  97         hmap_destroy (&cat->vp[i].map);
  98
  99       pool_destroy (cat->pool);
 100       free (cat);
 101     }
 102 }
 103
 104
 105 #if 0
 106 void
 107 categoricals_dump (const struct categoricals *cat)
 108 {
 109   int v;
 110
 111   for (v = 0 ; v < cat->n_vp; ++v)
 112     {
 113       const struct var_params *vp = &cat->vp[v];
 114       const struct hmap *m = &vp->map;
 115       struct hmap_node *node ;
 116       int x;
 117
 118       printf ("\n%s (%d)  CC=%g n_cats=%d:\n",
 119               var_get_name (vp->var), vp->base_subscript, vp->cc, vp->n_cats);
 120
 121       printf ("Reverse map\n");
 122       for (x = 0 ; x < vp->n_cats; ++x)
 123         {
 124           struct string s;
 125           const struct value_node *vn = vp->reverse_value_map[x];
 126           ds_init_empty (&s);
 127           var_append_value_name (vp->var, &vn->value, &s);
 128           printf ("Value for %d is %s\n", x, ds_cstr(&s));
 129           ds_destroy (&s);
 130         }
 131
 132       printf ("\nForward map\n");
 133       for (node = hmap_first (m); node; node = hmap_next (m, node))
 134         {
 135           struct string s;
 136           const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
 137           ds_init_empty (&s);
 138           var_append_value_name (vp->var, &vn->value, &s);
 139           printf ("Value: %s; Index %d; CC %g\n",
 140                   ds_cstr (&s),
 141                   vn->subscript, vn->cc);
 142           ds_destroy (&s);
 143         }
 144     }
 145
 146   assert (cat->n_vars <= cat->n_vp);
 147
 148   printf ("\n");
 149   printf ("Number of categorical variables: %d\n", cat->n_vp);
 150   printf ("Number of non-empty categorical variables: %d\n", cat->n_vars);
 151   printf ("Total number of categories: %d\n", cat->n_cats_total);
 152
 153   printf ("\nReverse variable map:\n");
 154
 155   for (v = 0 ; v < cat->n_cats_total; ++v)
 156     printf ("%d ", cat->reverse_variable_map[v]);
 157   printf ("\n");
 158 }
 159 #endif
 160
 161
 162
 163 static struct value_node *
 164 lookup_value (const struct hmap *map, const struct variable *var, const union value *val)
 165 {
 166   struct value_node *foo;
 167   unsigned int width = var_get_width (var);
 168   size_t hash = value_hash (val, width, 0);
 169
 170   HMAP_FOR_EACH_WITH_HASH (foo, struct value_node, node, hash, map)
 171     {
 172       if (value_equal (val, &foo->value, width))
 173         break;
 174
 175       fprintf (stderr, "Warning: Hash table collision\n");
 176     }
 177
 178   return foo;
 179 }
 180
 181
 182
 183 struct categoricals *
 184 categoricals_create (const struct variable *const *v, size_t n_vars,
 185                      const struct variable *wv, enum mv_class exclude)
 186 {
 187   size_t i;
 188   struct categoricals *cat = xmalloc (sizeof *cat);
 189
 190   cat->n_vp = n_vars;
 191   cat->wv = wv;
 192   cat->n_cats_total = 0;
 193   cat->n_vars = 0;
 194   cat->reverse_variable_map = NULL;
 195   cat->pool = pool_create ();
 196   cat->exclude = exclude;
 197
 198   cat->vp = pool_calloc (cat->pool, cat->n_vp, sizeof *cat->vp);
 199
 200   for (i = 0 ; i < cat->n_vp; ++i)
 201     {
 202       hmap_init (&cat->vp[i].map);
 203       cat->vp[i].var = v[i];
 204     }
 205
 206   return cat;
 207 }
 208
 209
 210
 211 void
 212 categoricals_update (struct categoricals *cat, const struct ccase *c)
 213 {
 214   size_t i;
 215
 216   const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
 217
 218   assert (NULL == cat->reverse_variable_map);
 219
 220   for (i = 0 ; i < cat->n_vp; ++i)
 221     {
 222       const struct variable *var = cat->vp[i].var;
 223       unsigned int width = var_get_width (var);
 224       const union value *val = case_data (c, var);
 225       size_t hash;
 226       struct value_node *node ;
 227
 228       if ( var_is_value_missing (var, val, cat->exclude))
 229         continue;
 230
 231       hash = value_hash (val, width, 0);
 232       node = lookup_value (&cat->vp[i].map, var, val);
 233
 234       if ( NULL == node)
 235         {
 236           node = pool_malloc (cat->pool, sizeof *node);
 237
 238           value_init (&node->value, width);
 239           value_copy (&node->value, val, width);
 240           node->cc = 0.0;
 241
 242           hmap_insert (&cat->vp[i].map, &node->node,  hash);
 243           cat->n_cats_total++;
 244
 245           if ( 0 == cat->vp[i].n_cats)
 246             cat->n_vars++;
 247
 248           node->subscript = cat->vp[i].n_cats++ ;
 249         }
 250
 251       node->cc += weight;
 252       cat->vp[i].cc += weight;
 253     }
 254 }
 255
 256 /* Return the number of categories (distinct values) for variable N */
 257 size_t
 258 categoricals_n_count (const struct categoricals *cat, size_t n)
 259 {
 260   return hmap_count (&cat->vp[n].map);
 261 }
 262
 263
 264 /* Return the total number of categories */
 265 size_t
 266 categoricals_total (const struct categoricals *cat)
 267 {
 268   return cat->n_cats_total;
 269 }
 270
 271
 272 /* This function must be called *before* any call to categoricals_get_*_by subscript an
 273  *after* all calls to categoricals_update */
 274 void
 275 categoricals_done (struct categoricals *cat)
 276 {
 277   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
 278      uses it will be more efficient that using a tree based structure, since it
 279      is called only once, and means that subsequent lookups will be O(1).
 280
 281      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
 282   */
 283   int v;
 284   int idx = 0;
 285   cat->reverse_variable_map = pool_calloc (cat->pool,
 286                                            cat->n_cats_total,
 287                                            sizeof *cat->reverse_variable_map);
 288
 289   for (v = 0 ; v < cat->n_vp; ++v)
 290     {
 291       int i;
 292       struct var_params *vp = &cat->vp[v];
 293       int n_cats_total = categoricals_n_count (cat, v);
 294       struct hmap_node *node ;
 295
 296       vp->reverse_value_map = pool_calloc (cat->pool, n_cats_total, sizeof *vp->reverse_value_map);
 297
 298       vp->base_subscript = idx;
 299
 300       for (node = hmap_first (&vp->map); node; node = hmap_next (&vp->map, node))
 301         {
 302           const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
 303           vp->reverse_value_map[vn->subscript] = vn;
 304         }
 305
 306       /* Populate the reverse variable map.
 307        */
 308       for (i = 0; i < vp->n_cats; ++i)
 309         cat->reverse_variable_map[idx++] = v;
 310     }
 311
 312   assert (cat->n_vars <= cat->n_vp);
 313 }
 314
 315
 316 static int
 317 reverse_variable_lookup (const struct categoricals *cat, int subscript)
 318 {
 319   assert (cat->reverse_variable_map);
 320   assert (subscript >= 0);
 321   assert (subscript < cat->n_cats_total);
 322
 323   return cat->reverse_variable_map[subscript];
 324 }
 325
 326
 327 /* Return the categorical variable corresponding to SUBSCRIPT */
 328 const struct variable *
 329 categoricals_get_variable_by_subscript (const struct categoricals *cat, int subscript)
 330 {
 331   int index = reverse_variable_lookup (cat, subscript);
 332
 333   return cat->vp[index].var;
 334 }
 335
 336 /* Return the value corresponding to SUBSCRIPT */
 337 const union value *
 338 categoricals_get_value_by_subscript (const struct categoricals *cat, int subscript)
 339 {
 340   int vindex = reverse_variable_lookup (cat, subscript);
 341   const struct var_params *vp = &cat->vp[vindex];
 342   const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
 343
 344   return &vn->value;
 345 }
 346
 347
 348 double
 349 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
 350 {
 351   int vindex = reverse_variable_lookup (cat, subscript);
 352   const struct var_params *vp = &cat->vp[vindex];
 353
 354   return vp->cc;
 355 }
 356
 357 double
 358 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
 359 {
 360   int vindex = reverse_variable_lookup (cat, subscript);
 361   const struct var_params *vp = &cat->vp[vindex];
 362
 363   const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
 364   return vn->cc;
 365 }
 366
 367
 368 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 369    for that subscript */
 370 double
 371 categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
 372                                       const struct ccase *c)
 373 {
 374   const struct variable *var = categoricals_get_variable_by_subscript (cat, subscript);
 375   int width = var_get_width (var);
 376
 377   const union value *val = case_data (c, var);
 378
 379   return value_equal (val, categoricals_get_value_by_subscript (cat, subscript), width);
 380 }
 381
 382
 383 size_t
 384 categoricals_get_n_variables (const struct categoricals *cat)
 385 {
 386   return cat->n_vars;
 387 }