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