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   const struct variable *wv;
  65
  66   size_t n_vars;
  67
  68   /* An array of var_params */
  69   struct var_params *vp;
  70
  71   /* A map to enable the lookup of variables indexed by subscript */
  72   int *reverse_variable_map;
  73
  74   size_t n_cats_total;
  75
  76   struct pool *pool;
  77
  78   /* Missing values to be excluded */
  79   enum mv_class exclude;
  80 };
  81
  82
  83 void
  84 categoricals_destroy ( struct categoricals *cat)
  85 {
  86   int i;
  87   for (i = 0 ; i < cat->n_vars; ++i)
  88     hmap_destroy (&cat->vp[i].map);
  89
  90   pool_destroy (cat->pool);
  91   free (cat);
  92 }
  93
  94
  95 void
  96 categoricals_dump (const struct categoricals *cat)
  97 {
  98   int v;
  99
 100   for (v = 0 ; v < cat->n_vars; ++v)
 101     {
 102       const struct var_params *vp = &cat->vp[v];
 103       const struct hmap *m = &vp->map;
 104       struct hmap_node *node ;
 105       int x;
 106
 107       printf ("\n%s (%d)  CC=%g:\n", var_get_name (vp->var), vp->base_subscript, vp->cc);
 108
 109       assert (vp->reverse_value_map);
 110
 111       printf ("Reverse map\n");
 112       for (x = 0 ; x < vp->n_cats; ++x)
 113         {
 114           struct string s;
 115           const struct value_node *vn = vp->reverse_value_map[x];
 116           ds_init_empty (&s);
 117           var_append_value_name (vp->var, &vn->value, &s);
 118           printf ("Value for %d is %s\n", x, ds_cstr(&s));
 119           ds_destroy (&s);
 120         }
 121
 122       printf ("\nForward map\n");
 123       for (node = hmap_first (m); node; node = hmap_next (m, node))
 124         {
 125           struct string s;
 126           ds_init_empty (&s);
 127           const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
 128           var_append_value_name (vp->var, &vn->value, &s);
 129           printf ("Value: %s; Index %d; CC %g\n",
 130                   ds_cstr (&s),
 131                   vn->subscript, vn->cc);
 132           ds_destroy (&s);
 133         }
 134     }
 135 }
 136
 137
 138
 139 static struct value_node *
 140 lookup_value (const struct hmap *map, const struct variable *var, const union value *val)
 141 {
 142   struct value_node *foo;
 143   unsigned int width = var_get_width (var);
 144   size_t hash = value_hash (val, width, 0);
 145
 146   HMAP_FOR_EACH_WITH_HASH (foo, struct value_node, node, hash, map)
 147     {
 148       if (value_equal (val, &foo->value, width))
 149         break;
 150
 151       fprintf (stderr, "Warning: Hash table collision\n");
 152     }
 153
 154   return foo;
 155 }
 156
 157
 158
 159 struct categoricals *
 160 categoricals_create (const struct variable **v, size_t n_vars,
 161                      const struct variable *wv, enum mv_class exclude)
 162 {
 163   size_t i;
 164   struct categoricals *cat = xmalloc (sizeof *cat);
 165
 166   cat->n_vars = n_vars;
 167   cat->wv = wv;
 168   cat->n_cats_total = 0;
 169   cat->reverse_variable_map = NULL;
 170   cat->pool = pool_create ();
 171   cat->exclude = exclude;
 172
 173   cat->vp = pool_calloc (cat->pool, n_vars, sizeof *cat->vp);
 174
 175   for (i = 0 ; i < cat->n_vars; ++i)
 176     {
 177       hmap_init (&cat->vp[i].map);
 178       cat->vp[i].var = v[i];
 179     }
 180
 181   return cat;
 182 }
 183
 184
 185
 186 void
 187 categoricals_update (struct categoricals *cat, const struct ccase *c)
 188 {
 189   size_t i;
 190
 191   const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
 192
 193   assert (NULL == cat->reverse_variable_map);
 194
 195   for (i = 0 ; i < cat->n_vars; ++i)
 196     {
 197       const struct variable *var = cat->vp[i].var;
 198       unsigned int width = var_get_width (var);
 199       const union value *val = case_data (c, var);
 200       size_t hash;
 201       struct value_node *node ;
 202
 203       if ( var_is_value_missing (var, val, cat->exclude))
 204         continue;
 205
 206       hash = value_hash (val, width, 0);
 207       node = lookup_value (&cat->vp[i].map, var, val);
 208
 209       if ( NULL == node)
 210         {
 211           node = pool_malloc (cat->pool, sizeof *node);
 212
 213           value_init (&node->value, width);
 214           value_copy (&node->value, val, width);
 215           node->cc = 0.0;
 216
 217           hmap_insert (&cat->vp[i].map, &node->node,  hash);
 218           cat->n_cats_total ++;
 219           node->subscript = cat->vp[i].n_cats++ ;
 220         }
 221
 222       node->cc += weight;
 223       cat->vp[i].cc += weight;
 224     }
 225 }
 226
 227 /* Return the number of categories (distinct values) for variable N */
 228 size_t
 229 categoricals_n_count (const struct categoricals *cat, size_t n)
 230 {
 231   return hmap_count (&cat->vp[n].map);
 232 }
 233
 234
 235 /* Return the index for value VAL in the Nth variable */
 236 int
 237 categoricals_index (const struct categoricals *cat, size_t n, const union value *val)
 238 {
 239   struct value_node *vn = lookup_value (&cat->vp[n].map, cat->vp[n].var, val);
 240
 241   if ( vn == NULL)
 242     return -1;
 243
 244   return vn->subscript;
 245 }
 246
 247
 248 /* Return the total number of categories */
 249 size_t
 250 categoricals_total (const struct categoricals *cat)
 251 {
 252   return cat->n_cats_total;
 253 }
 254
 255
 256 /* This function must be called *before* any call to categoricals_get_*_by subscript an
 257  *after* all calls to categoricals_update */
 258 void
 259 categoricals_done (struct categoricals *cat)
 260 {
 261   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
 262      uses it will be more efficient that using a tree based structure, since it
 263      is called only once, and means that subsequent lookups will be O(1).
 264
 265      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
 266   */
 267   int v;
 268   int idx = 0;
 269   cat->reverse_variable_map = pool_calloc (cat->pool, cat->n_cats_total, sizeof *cat->reverse_variable_map);
 270
 271   for (v = 0 ; v < cat->n_vars; ++v)
 272     {
 273       int i;
 274       struct var_params *vp = &cat->vp[v];
 275       int n_cats_total = categoricals_n_count (cat, v);
 276       struct hmap_node *node ;
 277
 278       vp->reverse_value_map = pool_calloc (cat->pool, n_cats_total, sizeof *vp->reverse_value_map);
 279
 280       vp->base_subscript = idx;
 281
 282       for (node = hmap_first (&vp->map); node; node = hmap_next (&vp->map, node))
 283         {
 284           const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
 285           vp->reverse_value_map[vn->subscript] = vn;
 286         }
 287
 288       for (i = 0; i < vp->n_cats; ++i)
 289         cat->reverse_variable_map[idx++] = v;
 290     }
 291 }
 292
 293
 294
 295 /* Return the categorical variable corresponding to SUBSCRIPT */
 296 const struct variable *
 297 categoricals_get_variable_by_subscript (const struct categoricals *cat, int subscript)
 298 {
 299   int index;
 300
 301   assert (cat->reverse_variable_map);
 302
 303   index = cat->reverse_variable_map[subscript];
 304
 305   return cat->vp[index].var;
 306 }
 307
 308
 309 /* Return the value corresponding to SUBSCRIPT */
 310 const union value *
 311 categoricals_get_value_by_subscript (const struct categoricals *cat, int subscript)
 312 {
 313   int vindex = cat->reverse_variable_map[subscript];
 314   const struct var_params *vp = &cat->vp[vindex];
 315   const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
 316
 317   return &vn->value;
 318 }
 319
 320 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 321    for that subscript */
 322 double
 323 categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
 324                                       const struct ccase *c)
 325 {
 326   const struct variable *var = categoricals_get_variable_by_subscript (cat, subscript);
 327   int width = var_get_width (var);
 328
 329   const union value *val = case_data (c, var);
 330
 331   return value_equal (val, categoricals_get_value_by_subscript (cat, subscript), width);
 332 }