src/math/categoricals.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2010, 2011 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 "math/categoricals.h"
  20 #include "math/interaction.h"
  21
  22 #include <stdio.h>
  23
  24 #include "data/case.h"
  25 #include "data/value.h"
  26 #include "data/variable.h"
  27 #include "libpspp/array.h"
  28 #include "libpspp/hmap.h"
  29 #include "libpspp/pool.h"
  30 #include "libpspp/str.h"
  31 #include "libpspp/hash-functions.h"
  32
  33 #include "gl/xalloc.h"
  34
  35 struct value_node
  36 {
  37   struct hmap_node node;      /* Node in hash map. */
  38
  39   union value val;            /* The value */
  40
  41 };
  42
  43 struct interaction_value
  44 {
  45   struct hmap_node node;        /* Node in hash map. */
  46
  47   struct ccase *ccase;          /* A case (probably the first in the dataset) which matches this value */
  48
  49   /* Total of the weights of cases matching this interaction */
  50   double cc;
  51
  52   void *user_data;            /* A pointer to data which the caller can store stuff */
  53 };
  54
  55 static struct value_node *
  56 lookup_value (const struct hmap *map, const union value *val, unsigned int hash, int width)
  57 {
  58   struct value_node *vn = NULL;
  59   HMAP_FOR_EACH_WITH_HASH (vn, struct value_node, node, hash, map)
  60     {
  61       if (value_equal (&vn->val, val, width))
  62         break;
  63     }
  64
  65   return vn;
  66 }
  67
  68 struct variable_node
  69 {
  70   struct hmap_node node;      /* Node in hash map. */
  71   const struct variable *var; /* The variable */
  72
  73   struct hmap valmap;         /* A map of value nodes */
  74 };
  75
  76 #if 0
  77 static void
  78 dump_interaction (const struct interaction *iact)
  79 {
  80   struct string str = DS_EMPTY_INITIALIZER;
  81   interaction_to_string (iact, &str);
  82   printf ("Interaction: %s\n", ds_cstr (&str));
  83   ds_destroy (&str);
  84 }
  85 #endif
  86
  87
  88 static struct variable_node *
  89 lookup_variable (const struct hmap *map, const struct variable *var, unsigned int hash)
  90 {
  91   struct variable_node *vn = NULL;
  92   HMAP_FOR_EACH_WITH_HASH (vn, struct variable_node, node, hash, map)
  93     {
  94       if (vn->var == var)
  95         break;
  96
  97       fprintf (stderr, "Warning: Hash table collision\n");
  98     }
  99
 100   return vn;
 101 }
 102
 103
 104 struct interact_params
 105 {
 106   /* A map indexed by a interaction_value */
 107   struct hmap ivmap;
 108
 109   const struct interaction *iact;
 110
 111   int base_subscript_short;
 112   int base_subscript_long;
 113
 114   /* The number of distinct values of this interaction */
 115   int n_cats;
 116
 117   /* The degrees of freedom for this interaction */
 118   int df;
 119
 120   /* A map of interaction_values indexed by subscript */
 121   struct interaction_value **reverse_interaction_value_map;
 122
 123   double cc;
 124 };
 125
 126
 127 /* Comparison function to sort the reverse_value_map in ascending order */
 128 static int
 129 compare_interaction_value_3way (const void *vn1_, const void *vn2_, const void *aux)
 130 {
 131   const struct interaction_value *const *vn1p = vn1_;
 132   const struct interaction_value *const *vn2p = vn2_;
 133
 134   const struct interact_params *iap = aux;
 135
 136   return interaction_case_cmp_3way (iap->iact, (*vn1p)->ccase, (*vn2p)->ccase);
 137 }
 138
 139 struct categoricals
 140 {
 141   /* The weight variable */
 142   const struct variable *wv;
 143
 144   /* An array of interact_params */
 145   struct interact_params *iap;
 146
 147   /* Map whose members are the union of the variables which comprise IAP */
 148   struct hmap varmap;
 149
 150   /* The size of IAP. (ie, the number of interactions involved.) */
 151   size_t n_iap;
 152
 153   /* The number of categorical variables which contain entries.
 154      In the absence of missing values, this will be equal to N_IAP */
 155   size_t n_vars;
 156
 157   size_t df_sum;
 158
 159   /* A map to enable the lookup of variables indexed by subscript.
 160      This map considers only the N - 1 of the N variables.
 161    */
 162   int *reverse_variable_map_short;
 163
 164   /* Like the above, but uses all N variables */
 165   int *reverse_variable_map_long;
 166
 167   size_t n_cats_total;
 168
 169   struct pool *pool;
 170
 171   /* Missing values to be excluded */
 172   enum mv_class exclude;
 173
 174   /* Function to be called on each update */
 175   update_func *update;
 176
 177   /* Function specified by the caller to create user_data */
 178   user_data_create_func *user_data_create;
 179
 180   /* Auxilliary data to be passed to update and user_data_create_func*/
 181   void *aux1;
 182   void *aux2;
 183 };
 184
 185 #if 0
 186 static void
 187 categoricals_dump (const struct categoricals *cat)
 188 {
 189   int i;
 190
 191   printf ("Reverse Variable Map (short):\n");
 192   for (i = 0; i < cat->df_sum; ++i)
 193     {
 194       printf (" %d", cat->reverse_variable_map_short[i]);
 195     }
 196   printf ("\n");
 197
 198   printf ("Reverse Variable Map (long):\n");
 199   for (i = 0; i < cat->n_cats_total; ++i)
 200     {
 201       printf (" %d", cat->reverse_variable_map_long[i]);
 202     }
 203   printf ("\n");
 204
 205
 206   printf ("Number of interactions %d\n", cat->n_iap);
 207   for (i = 0 ; i < cat->n_iap; ++i)
 208     {
 209       int v;
 210       struct string str;
 211       const struct interact_params *iap = &cat->iap[i];
 212       const struct interaction *iact = iap->iact;
 213
 214       ds_init_empty (&str);
 215       interaction_to_string (iact, &str);
 216
 217       printf ("\nInteraction: %s (n: %d; df: %d ); ", ds_cstr (&str), iap->n_cats, iap->df);
 218       ds_destroy (&str);
 219       printf ("Base subscript: %d\n", iap->base_subscript_short);
 220
 221       printf ("\t(");
 222       for (v = 0; v < hmap_count (&iap->ivmap); ++v)
 223         {
 224           int vv;
 225           const struct interaction_value *iv = iap->reverse_interaction_value_map[v];
 226
 227           if (v > 0)  printf ("   ");
 228           printf ("{");
 229           for (vv = 0; vv < iact->n_vars; ++vv)
 230             {
 231               const struct variable *var = iact->vars[vv];
 232               const union value *val = case_data (iv->ccase, var);
 233
 234               printf ("%g", val->f);
 235               if (vv < iact->n_vars - 1)
 236                 printf (", ");
 237             }
 238           printf ("}");
 239         }
 240       printf (")\n");
 241     }
 242 }
 243 #endif
 244
 245 void
 246 categoricals_destroy (struct categoricals *cat)
 247 {
 248   struct variable_node *vn = NULL;
 249   int i;
 250   if (NULL == cat)
 251     return;
 252   for (i = 0; i < cat->n_iap; ++i)
 253     {
 254       struct interaction_value *iv = NULL;
 255       /* Interate over each interaction value, and unref any cases that we reffed */
 256       HMAP_FOR_EACH (iv, struct interaction_value, node, &cat->iap[i].ivmap)
 257         {
 258           case_unref (iv->ccase);
 259         }
 260       hmap_destroy (&cat->iap[i].ivmap);
 261     }
 262
 263   /* Interate over each variable and delete its value map */
 264   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
 265     {
 266       hmap_destroy (&vn->valmap);
 267     }
 268
 269   hmap_destroy (&cat->varmap);
 270
 271   pool_destroy (cat->pool);
 272
 273   free (cat);
 274 }
 275
 276
 277
 278 static struct interaction_value *
 279 lookup_case (const struct hmap *map, const struct interaction *iact, const struct ccase *c)
 280 {
 281   struct interaction_value *iv = NULL;
 282   size_t hash = interaction_case_hash (iact, c, 0);
 283
 284   HMAP_FOR_EACH_WITH_HASH (iv, struct interaction_value, node, hash, map)
 285     {
 286       if (interaction_case_equal (iact, c, iv->ccase))
 287         break;
 288
 289       fprintf (stderr, "Warning: Hash table collision\n");
 290     }
 291
 292   return iv;
 293 }
 294
 295
 296 struct categoricals *
 297 categoricals_create (struct interaction *const*inter, size_t n_inter,
 298                      const struct variable *wv, enum mv_class exclude,
 299                      user_data_create_func *udf,
 300                      update_func *update, void *aux1, void *aux2
 301                      )
 302 {
 303   size_t i;
 304   struct categoricals *cat = xmalloc (sizeof *cat);
 305
 306   cat->n_iap = n_inter;
 307   cat->wv = wv;
 308   cat->n_cats_total = 0;
 309   cat->n_vars = 0;
 310   cat->reverse_variable_map_short = NULL;
 311   cat->reverse_variable_map_long = NULL;
 312   cat->pool = pool_create ();
 313   cat->exclude = exclude;
 314   cat->update = update;
 315   cat->user_data_create = udf;
 316
 317   cat->aux1 = aux1;
 318   cat->aux2 = aux2;
 319
 320   cat->iap = pool_calloc (cat->pool, cat->n_iap, sizeof *cat->iap);
 321
 322   hmap_init (&cat->varmap);
 323   for (i = 0 ; i < cat->n_iap; ++i)
 324     {
 325       int v;
 326       hmap_init (&cat->iap[i].ivmap);
 327       cat->iap[i].iact = inter[i];
 328       cat->iap[i].cc = 0.0;
 329       for (v = 0; v < inter[i]->n_vars; ++v)
 330         {
 331           const struct variable *var = inter[i]->vars[v];
 332           unsigned int hash = hash_pointer (var, 0);
 333           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash);
 334           if (vn == NULL)
 335             {
 336               vn = pool_malloc (cat->pool, sizeof *vn);
 337               vn->var = var;
 338               hmap_init (&vn->valmap);
 339
 340               hmap_insert (&cat->varmap, &vn->node,  hash);
 341             }
 342         }
 343     }
 344
 345   return cat;
 346 }
 347
 348
 349
 350 void
 351 categoricals_update (struct categoricals *cat, const struct ccase *c)
 352 {
 353   int i;
 354   struct variable_node *vn = NULL;
 355   const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
 356
 357   assert (NULL == cat->reverse_variable_map_short);
 358   assert (NULL == cat->reverse_variable_map_long);
 359
 360   /* Interate over each variable, and add the value of that variable
 361      to the appropriate map, if it's not already present. */
 362   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
 363     {
 364       const int width = var_get_width (vn->var);
 365       const union value *val = case_data (c, vn->var);
 366       unsigned int hash = value_hash (val, width, 0);
 367
 368       struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
 369       if (valn == NULL)
 370         {
 371           valn = pool_malloc (cat->pool, sizeof *valn);
 372           value_init (&valn->val, width);
 373           value_copy (&valn->val, val, width);
 374           hmap_insert (&vn->valmap, &valn->node, hash);
 375         }
 376     }
 377
 378   for (i = 0 ; i < cat->n_iap; ++i)
 379     {
 380       const struct interaction *iact = cat->iap[i].iact;
 381
 382       //      if ( interaction_case_is_missing (iact, c, cat->exclude))
 383       //         continue;
 384
 385       size_t hash = interaction_case_hash (iact, c, 0);
 386       struct interaction_value *node = lookup_case (&cat->iap[i].ivmap, iact, c);
 387
 388       if ( NULL == node)
 389         {
 390           node = pool_malloc (cat->pool, sizeof *node);
 391
 392           node->ccase = case_ref (c);
 393           node->cc = weight;
 394
 395           hmap_insert (&cat->iap[i].ivmap, &node->node, hash);
 396
 397           if (cat->user_data_create)
 398             node->user_data = cat->user_data_create (cat->aux1, cat->aux2);
 399         }
 400       else
 401         {
 402           node->cc += weight;
 403         }
 404       cat->iap[i].cc += weight;
 405
 406       if (cat->update)
 407         cat->update (node->user_data, cat->exclude, cat->wv, NULL, c, cat->aux1, cat->aux2);
 408     }
 409 }
 410
 411 /* Return the number of categories (distinct values) for interction N */
 412 size_t
 413 categoricals_n_count (const struct categoricals *cat, size_t n)
 414 {
 415   return hmap_count (&cat->iap[n].ivmap);
 416 }
 417
 418
 419 size_t
 420 categoricals_df (const struct categoricals *cat, size_t n)
 421 {
 422   return cat->iap[n].df;
 423 }
 424
 425
 426 /* Return the total number of categories */
 427 size_t
 428 categoricals_n_total (const struct categoricals *cat)
 429 {
 430   assert (cat->reverse_variable_map_long);
 431
 432   return cat->n_cats_total;
 433 }
 434
 435 size_t
 436 categoricals_df_total (const struct categoricals *cat)
 437 {
 438   return cat->df_sum;
 439 }
 440
 441 /* This function must be called *before* any call to categoricals_get_*_by subscript and
 442  *after* all calls to categoricals_update */
 443 void
 444 categoricals_done (const struct categoricals *cat_)
 445 {
 446   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
 447      uses it will be more efficient that using a tree based structure, since it
 448      is called only once, and means that subsequent lookups will be O(1).
 449
 450      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
 451   */
 452   struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
 453   int v;
 454   int i;
 455   int idx_short = 0;
 456   int idx_long = 0;
 457   cat->df_sum = 0;
 458   cat->n_cats_total = 0;
 459
 460   /* Calculate the degrees of freedom, and the number of categories */
 461   for (i = 0 ; i < cat->n_iap; ++i)
 462     {
 463       const struct interaction *iact = cat->iap[i].iact;
 464
 465       cat->iap[i].df = 1;
 466       cat->iap[i].n_cats = 1;
 467
 468       for (v = 0 ; v < iact->n_vars; ++v)
 469         {
 470           const struct variable *var = iact->vars[v];
 471
 472           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
 473
 474           cat->iap[i].df *= hmap_count (&vn->valmap) - 1;
 475           cat->iap[i].n_cats *= hmap_count (&vn->valmap);
 476         }
 477
 478       cat->df_sum += cat->iap[i].df;
 479       cat->n_cats_total += cat->iap[i].n_cats;
 480     }
 481
 482
 483   cat->reverse_variable_map_short = pool_calloc (cat->pool,
 484                                                  cat->df_sum,
 485                                                  sizeof *cat->reverse_variable_map_short);
 486
 487   cat->reverse_variable_map_long = pool_calloc (cat->pool,
 488                                                 cat->n_cats_total,
 489                                                 sizeof *cat->reverse_variable_map_long);
 490
 491   for (i = 0 ; i < cat->n_iap; ++i)
 492     {
 493       struct interaction_value *ivn = NULL;
 494       int x = 0;
 495       int ii;
 496       struct interact_params *iap = &cat->iap[i];
 497
 498       iap->base_subscript_short = idx_short;
 499       iap->base_subscript_long = idx_long;
 500
 501       iap->reverse_interaction_value_map = pool_calloc (cat->pool, iap->n_cats,
 502                                                         sizeof *iap->reverse_interaction_value_map);
 503
 504       HMAP_FOR_EACH (ivn, struct interaction_value, node, &iap->ivmap)
 505         {
 506           iap->reverse_interaction_value_map[x++] = ivn;
 507         }
 508
 509       assert (x <= iap->n_cats);
 510
 511       /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
 512       sort (iap->reverse_interaction_value_map, x, sizeof (*iap->reverse_interaction_value_map),
 513             compare_interaction_value_3way, iap);
 514
 515       /* Fill the remaining values with null */
 516       for (ii = x ; ii < iap->n_cats; ++ii)
 517         iap->reverse_interaction_value_map[ii] = NULL;
 518
 519       /* Populate the reverse variable maps. */
 520       for (ii = 0; ii < iap->df; ++ii)
 521         cat->reverse_variable_map_short[idx_short++] = i;
 522
 523       for (ii = 0; ii < iap->n_cats; ++ii)
 524         cat->reverse_variable_map_long[idx_long++] = i;
 525     }
 526
 527   assert (cat->n_vars <= cat->n_iap);
 528
 529   //  categoricals_dump (cat);
 530 }
 531
 532
 533 static int
 534 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
 535 {
 536   assert (cat->reverse_variable_map_short);
 537   assert (subscript >= 0);
 538   assert (subscript < cat->df_sum);
 539
 540   return cat->reverse_variable_map_short[subscript];
 541 }
 542
 543 static int
 544 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
 545 {
 546   assert (cat->reverse_variable_map_long);
 547   assert (subscript >= 0);
 548   assert (subscript < cat->n_cats_total);
 549
 550   return cat->reverse_variable_map_long[subscript];
 551 }
 552
 553
 554 /* Return the interaction corresponding to SUBSCRIPT */
 555 const struct interaction *
 556 categoricals_get_interaction_by_subscript (const struct categoricals *cat, int subscript)
 557 {
 558   int index = reverse_variable_lookup_short (cat, subscript);
 559
 560   return cat->iap[index].iact;
 561 }
 562
 563
 564 /* Return the case corresponding to SUBSCRIPT */
 565 static const struct ccase *
 566 categoricals_get_case_by_subscript (const struct categoricals *cat, int subscript)
 567 {
 568   int vindex = reverse_variable_lookup_short (cat, subscript);
 569   const struct interact_params *vp = &cat->iap[vindex];
 570   const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_short];
 571
 572   if ( vn == NULL)
 573     return NULL;
 574
 575   return vn->ccase;
 576 }
 577
 578
 579 double
 580 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
 581 {
 582   int vindex = reverse_variable_lookup_short (cat, subscript);
 583   const struct interact_params *vp = &cat->iap[vindex];
 584
 585   return vp->cc;
 586 }
 587
 588 double
 589 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
 590 {
 591   int vindex = reverse_variable_lookup_short (cat, subscript);
 592   const struct interact_params *vp = &cat->iap[vindex];
 593
 594   const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_short];
 595
 596   if (iv == NULL)
 597     return 0;
 598
 599   return iv->cc;
 600 }
 601
 602 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 603    for that subscript */
 604 double
 605 categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
 606                                       const struct ccase *c)
 607 {
 608   const struct interaction *iact = categoricals_get_interaction_by_subscript (cat, subscript);
 609
 610   const struct ccase *c2 =  categoricals_get_case_by_subscript (cat, subscript);
 611
 612   if ( c2 == NULL)
 613     return 0;
 614
 615   return interaction_case_equal (iact, c, c2);
 616 }
 617
 618
 619 size_t
 620 categoricals_get_n_variables (const struct categoricals *cat)
 621 {
 622   printf ("%s\n", __FUNCTION__);
 623   return cat->n_vars;
 624 }
 625
 626 /* Return a case containing the set of values corresponding to SUBSCRIPT */
 627 const struct ccase *
 628 categoricals_get_case_by_category (const struct categoricals *cat, int subscript)
 629 {
 630   int vindex = reverse_variable_lookup_long (cat, subscript);
 631   const struct interact_params *vp = &cat->iap[vindex];
 632   const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 633
 634   return vn->ccase;
 635 }
 636
 637 void *
 638 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
 639 {
 640   int vindex = reverse_variable_lookup_long (cat, subscript);
 641   const struct interact_params *vp = &cat->iap[vindex];
 642
 643   const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 644   return iv->user_data;
 645 }