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