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