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