pintos-os.org Git - pspp/blob - src/math/categoricals.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2010, 2011, 2012, 2014 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 <float.h>
  23 #include <stdio.h>
  24
  25 #include "data/case.h"
  26 #include "data/value.h"
  27 #include "data/variable.h"
  28 #include "libpspp/array.h"
  29 #include "libpspp/hmap.h"
  30 #include "libpspp/pool.h"
  31 #include "libpspp/str.h"
  32 #include "libpspp/hash-functions.h"
  33
  34 #include "gl/xalloc.h"
  35
  36 #define CATEGORICALS_DEBUG 0
  37
  38 struct value_node
  39 {
  40   struct hmap_node node;      /* Node in hash map. */
  41
  42   union value val;            /* The value */
  43
  44   int index;                  /* A zero based unique index for this value */
  45 };
  46
  47
  48 struct interaction_value
  49 {
  50   struct hmap_node node;      /* Node in hash map */
  51
  52   struct ccase *ccase;        /* A case (probably the first in the dataset) which matches
  53                                  this value */
  54
  55   double cc;                  /* Total of the weights of cases matching this interaction */
  56
  57   void *user_data;            /* A pointer to data which the caller can store stuff */
  58 };
  59
  60 static struct value_node *
  61 lookup_value (const struct hmap *map, const union value *val, unsigned int hash, int width)
  62 {
  63   struct value_node *vn = NULL;
  64   HMAP_FOR_EACH_WITH_HASH (vn, struct value_node, node, hash, map)
  65     {
  66       if (value_equal (&vn->val, val, width))
  67         break;
  68     }
  69
  70   return vn;
  71 }
  72
  73 struct variable_node
  74 {
  75   struct hmap_node node;      /* Node in hash map. */
  76   const struct variable *var; /* The variable */
  77
  78   struct hmap valmap;         /* A map of value nodes */
  79   int n_vals;                 /* Number of values for this variable */
  80 };
  81
  82
  83 /* Comparison function to sort value_nodes in ascending order */
  84 static int
  85 compare_value_node_3way (const void *vn1_, const void *vn2_, const void *aux)
  86 {
  87   const struct value_node *const *vn1p = vn1_;
  88   const struct value_node *const *vn2p = vn2_;
  89
  90   const struct variable_node *vn = aux;
  91
  92
  93   return value_compare_3way (&(*vn1p)->val, &(*vn2p)->val, var_get_width (vn->var));
  94 }
  95
  96
  97
  98 static struct variable_node *
  99 lookup_variable (const struct hmap *map, const struct variable *var, unsigned int hash)
 100 {
 101   struct variable_node *vn = NULL;
 102   HMAP_FOR_EACH_WITH_HASH (vn, struct variable_node, node, hash, map)
 103     {
 104       if (vn->var == var)
 105         break;
 106
 107       fprintf (stderr, "%s:%d Warning: Hash table collision\n", __FILE__, __LINE__);
 108     }
 109
 110   return vn;
 111 }
 112
 113
 114 struct interact_params
 115 {
 116   /* A map of cases indexed by a interaction_value */
 117   struct hmap ivmap;
 118
 119   const struct interaction *iact;
 120
 121   int base_subscript_short;
 122   int base_subscript_long;
 123
 124   /* The number of distinct values of this interaction */
 125   int n_cats;
 126
 127   /* An array of integers df_n * df_{n-1} * df_{n-2} ...
 128      These are the products of the degrees of freedom for the current
 129      variable and all preceding variables */
 130   int *df_prod;
 131
 132   double *enc_sum;
 133
 134   /* A map of interaction_values indexed by subscript */
 135   struct interaction_value **reverse_interaction_value_map;
 136
 137   double cc;
 138 };
 139
 140
 141 /* Comparison function to sort the reverse_value_map in ascending order */
 142 static int
 143 compare_interaction_value_3way (const void *vn1_, const void *vn2_, const void *aux)
 144 {
 145   const struct interaction_value *const *vn1p = vn1_;
 146   const struct interaction_value *const *vn2p = vn2_;
 147
 148   const struct interact_params *iap = aux;
 149
 150   return interaction_case_cmp_3way (iap->iact, (*vn1p)->ccase, (*vn2p)->ccase);
 151 }
 152
 153 struct categoricals
 154 {
 155   /* The weight variable */
 156   const struct variable *wv;
 157
 158   /* An array of interact_params */
 159   struct interact_params *iap;
 160
 161   /* Map whose members are the union of the variables which comprise IAP */
 162   struct hmap varmap;
 163
 164   /* The size of IAP. (ie, the number of interactions involved.) */
 165   size_t n_iap;
 166
 167   /* The number of categorical variables which contain entries.
 168      In the absence of missing values, this will be equal to N_IAP */
 169   size_t n_vars;
 170
 171   size_t df_sum;
 172
 173   /* A map to enable the lookup of variables indexed by subscript.
 174      This map considers only the N - 1 of the N variables.
 175   */
 176   int *reverse_variable_map_short;
 177
 178   /* Like the above, but uses all N variables */
 179   int *reverse_variable_map_long;
 180
 181   size_t n_cats_total;
 182
 183   struct pool *pool;
 184
 185   /* Missing values in the factor variables to be excluded */
 186   enum mv_class fctr_excl;
 187
 188   const void *aux1;
 189   void *aux2;
 190
 191   bool sane;
 192
 193   const struct payload *payload;
 194 };
 195
 196
 197 bool
 198 categoricals_isbalanced (const struct categoricals *cat)
 199 {
 200   int i;
 201
 202   for (i = 0 ; i < cat->n_iap; ++i)
 203     {
 204       int v;
 205       const struct interact_params *iap = &cat->iap[i];
 206
 207       double oval = -1.0;
 208       for (v = 0; v < hmap_count (&iap->ivmap); ++v)
 209         {
 210           const struct interaction_value *iv = iap->reverse_interaction_value_map[v];
 211           if (oval == -1.0)
 212             oval = iv->cc;
 213           if (oval != iv->cc)
 214             return false;
 215         }
 216     }
 217   return true;
 218 }
 219
 220
 221 static void
 222 categoricals_dump (const struct categoricals *cat)
 223 {
 224   if (CATEGORICALS_DEBUG)
 225     {
 226       int i;
 227
 228       printf ("Reverse Variable Map (short):\n");
 229       for (i = 0; i < cat->df_sum; ++i)
 230         {
 231           printf (" %d", cat->reverse_variable_map_short[i]);
 232         }
 233       printf ("\n");
 234
 235       printf ("Reverse Variable Map (long):\n");
 236       for (i = 0; i < cat->n_cats_total; ++i)
 237         {
 238           printf (" %d", cat->reverse_variable_map_long[i]);
 239         }
 240       printf ("\n");
 241
 242       printf ("Number of interactions %zu\n", cat->n_iap);
 243       for (i = 0 ; i < cat->n_iap; ++i)
 244         {
 245           int v;
 246           struct string str;
 247           const struct interact_params *iap = &cat->iap[i];
 248           const struct interaction *iact = iap->iact;
 249
 250           ds_init_empty (&str);
 251           interaction_to_string (iact, &str);
 252
 253           printf ("\nInteraction: \"%s\" (number of categories: %d); ", ds_cstr (&str), iap->n_cats);
 254           ds_destroy (&str);
 255           printf ("Base index (short/long): %d/%d\n", iap->base_subscript_short, iap->base_subscript_long);
 256
 257           printf ("\t(");
 258           for (v = 0; v < hmap_count (&iap->ivmap); ++v)
 259             {
 260               int vv;
 261               const struct interaction_value *iv = iap->reverse_interaction_value_map[v];
 262
 263               if (v > 0)  printf ("   ");
 264               printf ("{");
 265               for (vv = 0; vv < iact->n_vars; ++vv)
 266                 {
 267                   const struct variable *var = iact->vars[vv];
 268                   const union value *val = case_data (iv->ccase, var);
 269                   unsigned int varhash = hash_pointer (var, 0);
 270                   struct variable_node *vn = lookup_variable (&cat->varmap, var, varhash);
 271
 272                   const int width = var_get_width (var);
 273                   unsigned int valhash = value_hash (val, width, 0);
 274                   struct value_node *valn = lookup_value (&vn->valmap, val, valhash, width);
 275
 276                   assert (vn->var == var);
 277
 278                   printf ("%.*g(%d)", DBL_DIG + 1, val->f, valn->index);
 279                   if (vv < iact->n_vars - 1)
 280                     printf (", ");
 281                 }
 282               printf ("}");
 283             }
 284           printf (")\n");
 285         }
 286     }
 287 }
 288
 289 void
 290 categoricals_destroy (struct categoricals *cat)
 291 {
 292   struct variable_node *vn = NULL;
 293   int i;
 294   if (NULL == cat)
 295     return;
 296
 297   for (i = 0; i < cat->n_iap; ++i)
 298     {
 299       struct interaction_value *iv = NULL;
 300       /* Interate over each interaction value, and unref any cases that we reffed */
 301       HMAP_FOR_EACH (iv, struct interaction_value, node, &cat->iap[i].ivmap)
 302         {
 303           if (cat->payload && cat->payload->destroy)
 304             cat->payload->destroy (cat->aux1, cat->aux2, iv->user_data);
 305           case_unref (iv->ccase);
 306         }
 307
 308       free (cat->iap[i].enc_sum);
 309       free (cat->iap[i].df_prod);
 310       hmap_destroy (&cat->iap[i].ivmap);
 311     }
 312
 313   /* Interate over each variable and delete its value map */
 314   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
 315     {
 316       hmap_destroy (&vn->valmap);
 317     }
 318
 319   hmap_destroy (&cat->varmap);
 320
 321   pool_destroy (cat->pool);
 322
 323   free (cat);
 324 }
 325
 326
 327
 328 static struct interaction_value *
 329 lookup_case (const struct hmap *map, const struct interaction *iact, const struct ccase *c)
 330 {
 331   struct interaction_value *iv = NULL;
 332   size_t hash = interaction_case_hash (iact, c, 0);
 333
 334   HMAP_FOR_EACH_WITH_HASH (iv, struct interaction_value, node, hash, map)
 335     {
 336       if (interaction_case_equal (iact, c, iv->ccase))
 337         break;
 338
 339       fprintf (stderr, "Warning: Hash table collision\n");
 340     }
 341
 342   return iv;
 343 }
 344
 345 bool
 346 categoricals_sane (const struct categoricals *cat)
 347 {
 348   return cat->sane;
 349 }
 350
 351 struct categoricals *
 352 categoricals_create (struct interaction *const*inter, size_t n_inter,
 353                      const struct variable *wv, enum mv_class fctr_excl)
 354 {
 355   size_t i;
 356   struct categoricals *cat = xmalloc (sizeof *cat);
 357
 358   cat->n_iap = n_inter;
 359   cat->wv = wv;
 360   cat->n_cats_total = 0;
 361   cat->n_vars = 0;
 362   cat->reverse_variable_map_short = NULL;
 363   cat->reverse_variable_map_long = NULL;
 364   cat->pool = pool_create ();
 365   cat->fctr_excl = fctr_excl;
 366   cat->payload = NULL;
 367   cat->aux2 = NULL;
 368   cat->sane = false;
 369
 370   cat->iap = pool_calloc (cat->pool, cat->n_iap, sizeof *cat->iap);
 371
 372   hmap_init (&cat->varmap);
 373   for (i = 0 ; i < cat->n_iap; ++i)
 374     {
 375       int v;
 376       hmap_init (&cat->iap[i].ivmap);
 377       cat->iap[i].iact = inter[i];
 378       cat->iap[i].cc = 0.0;
 379       for (v = 0; v < inter[i]->n_vars; ++v)
 380         {
 381           const struct variable *var = inter[i]->vars[v];
 382           unsigned int hash = hash_pointer (var, 0);
 383           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash);
 384           if (vn == NULL)
 385             {
 386               vn = pool_malloc (cat->pool, sizeof *vn);
 387               vn->var = var;
 388               vn->n_vals = 0;
 389               hmap_init (&vn->valmap);
 390
 391               hmap_insert (&cat->varmap, &vn->node,  hash);
 392             }
 393         }
 394     }
 395
 396   return cat;
 397 }
 398
 399
 400
 401 void
 402 categoricals_update (struct categoricals *cat, const struct ccase *c)
 403 {
 404   int i;
 405   struct variable_node *vn = NULL;
 406   double weight;
 407
 408   if (NULL == cat)
 409     return;
 410
 411   weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
 412   weight = var_force_valid_weight (cat->wv, weight, NULL);
 413
 414   assert (NULL == cat->reverse_variable_map_short);
 415   assert (NULL == cat->reverse_variable_map_long);
 416
 417   /* Interate over each variable, and add the value of that variable
 418      to the appropriate map, if it's not already present. */
 419   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
 420     {
 421       const int width = var_get_width (vn->var);
 422       const union value *val = case_data (c, vn->var);
 423       unsigned int hash = value_hash (val, width, 0);
 424
 425       struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
 426       if (valn == NULL)
 427         {
 428           valn = pool_malloc (cat->pool, sizeof *valn);
 429           valn->index = -1;
 430           vn->n_vals++;
 431           value_init (&valn->val, width);
 432           value_copy (&valn->val, val, width);
 433           hmap_insert (&vn->valmap, &valn->node, hash);
 434         }
 435     }
 436
 437   for (i = 0 ; i < cat->n_iap; ++i)
 438     {
 439       const struct interaction *iact = cat->iap[i].iact;
 440
 441       size_t hash;
 442       struct interaction_value *node;
 443
 444       if ( interaction_case_is_missing (iact, c, cat->fctr_excl))
 445         continue;
 446
 447       hash = interaction_case_hash (iact, c, 0);
 448       node = lookup_case (&cat->iap[i].ivmap, iact, c);
 449
 450       if ( NULL == node)
 451         {
 452           node = pool_malloc (cat->pool, sizeof *node);
 453           node->ccase = case_ref (c);
 454           node->cc = weight;
 455
 456           hmap_insert (&cat->iap[i].ivmap, &node->node, hash);
 457
 458           if (cat->payload)
 459             {
 460               node->user_data = cat->payload->create (cat->aux1, cat->aux2);
 461             }
 462         }
 463       else
 464         {
 465           node->cc += weight;
 466         }
 467       cat->iap[i].cc += weight;
 468
 469       if (cat->payload)
 470         {
 471           cat->payload->update (cat->aux1, cat->aux2, node->user_data, c, weight);
 472         }
 473     }
 474 }
 475
 476 /* Return the number of categories (distinct values) for interction N */
 477 size_t
 478 categoricals_n_count (const struct categoricals *cat, size_t n)
 479 {
 480   return hmap_count (&cat->iap[n].ivmap);
 481 }
 482
 483
 484 size_t
 485 categoricals_df (const struct categoricals *cat, size_t n)
 486 {
 487   const struct interact_params *iap = &cat->iap[n];
 488   return iap->df_prod[iap->iact->n_vars - 1];
 489 }
 490
 491
 492 /* Return the total number of categories */
 493 size_t
 494 categoricals_n_total (const struct categoricals *cat)
 495 {
 496   if (!categoricals_is_complete (cat))
 497     return 0;
 498
 499   return cat->n_cats_total;
 500 }
 501
 502 size_t
 503 categoricals_df_total (const struct categoricals *cat)
 504 {
 505   if (NULL == cat)
 506     return 0;
 507
 508   return cat->df_sum;
 509 }
 510
 511 bool
 512 categoricals_is_complete (const struct categoricals *cat)
 513 {
 514   return (NULL != cat->reverse_variable_map_short);
 515 }
 516
 517
 518 /* This function must be called *before* any call to categoricals_get_*_by subscript and
 519  *after* all calls to categoricals_update */
 520 void
 521 categoricals_done (const struct categoricals *cat_)
 522 {
 523   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
 524      uses it will be more efficient that using a tree based structure, since it
 525      is called only once, and means that subsequent lookups will be O(1).
 526
 527      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
 528   */
 529   struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
 530   int v;
 531   int i;
 532   int idx_short = 0;
 533   int idx_long = 0;
 534
 535   if (NULL == cat)
 536     return;
 537
 538   cat->df_sum = 0;
 539   cat->n_cats_total = 0;
 540
 541   /* Calculate the degrees of freedom, and the number of categories */
 542   for (i = 0 ; i < cat->n_iap; ++i)
 543     {
 544       int df = 1;
 545       const struct interaction *iact = cat->iap[i].iact;
 546
 547       cat->iap[i].df_prod = iact->n_vars ? xcalloc (iact->n_vars, sizeof (int)) : NULL;
 548
 549       cat->iap[i].n_cats = 1;
 550
 551       for (v = 0 ; v < iact->n_vars; ++v)
 552         {
 553           int x;
 554           const struct variable *var = iact->vars[v];
 555
 556           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
 557
 558           struct value_node *valnd = NULL;
 559           struct value_node **array ;
 560
 561           assert (vn->n_vals == hmap_count (&vn->valmap));
 562
 563           if  (vn->n_vals == 0)
 564             {
 565               cat->sane = false;
 566               return;
 567             }
 568
 569           /* Sort the VALMAP here */
 570           array = xcalloc (sizeof *array, vn->n_vals);
 571           x = 0;
 572           HMAP_FOR_EACH (valnd, struct value_node, node, &vn->valmap)
 573             {
 574               /* Note: This loop is probably superfluous, it could be done in the
 575                update stage (at the expense of a realloc) */
 576               array[x++] = valnd;
 577             }
 578
 579           sort (array, vn->n_vals, sizeof (*array),
 580                 compare_value_node_3way, vn);
 581
 582           for (x = 0; x <  vn->n_vals; ++x)
 583             {
 584               struct value_node *vvv = array[x];
 585               vvv->index = x;
 586             }
 587           free (array);
 588
 589           cat->iap[i].df_prod[v] = df * (vn->n_vals - 1);
 590           df = cat->iap[i].df_prod[v];
 591
 592           cat->iap[i].n_cats *= vn->n_vals;
 593         }
 594
 595       if (v > 0)
 596         cat->df_sum += cat->iap[i].df_prod [v - 1];
 597
 598       cat->n_cats_total += cat->iap[i].n_cats;
 599     }
 600
 601
 602   cat->reverse_variable_map_short = pool_calloc (cat->pool,
 603                                                  cat->df_sum,
 604                                                  sizeof *cat->reverse_variable_map_short);
 605
 606   cat->reverse_variable_map_long = pool_calloc (cat->pool,
 607                                                 cat->n_cats_total,
 608                                                 sizeof *cat->reverse_variable_map_long);
 609
 610   for (i = 0 ; i < cat->n_iap; ++i)
 611     {
 612       struct interaction_value *ivn = NULL;
 613       int x = 0;
 614       int ii;
 615       struct interact_params *iap = &cat->iap[i];
 616
 617       iap->base_subscript_short = idx_short;
 618       iap->base_subscript_long = idx_long;
 619
 620       iap->reverse_interaction_value_map = pool_calloc (cat->pool, iap->n_cats,
 621                                                         sizeof *iap->reverse_interaction_value_map);
 622
 623       HMAP_FOR_EACH (ivn, struct interaction_value, node, &iap->ivmap)
 624         {
 625           iap->reverse_interaction_value_map[x++] = ivn;
 626         }
 627
 628       assert (x <= iap->n_cats);
 629
 630       /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
 631       sort (iap->reverse_interaction_value_map, x, sizeof (*iap->reverse_interaction_value_map),
 632             compare_interaction_value_3way, iap);
 633
 634       /* Fill the remaining values with null */
 635       for (ii = x ; ii < iap->n_cats; ++ii)
 636         iap->reverse_interaction_value_map[ii] = NULL;
 637
 638       /* Populate the reverse variable maps. */
 639       if (iap->df_prod)
 640         {
 641           for (ii = 0; ii < iap->df_prod [iap->iact->n_vars - 1]; ++ii)
 642             cat->reverse_variable_map_short[idx_short++] = i;
 643         }
 644
 645       for (ii = 0; ii < iap->n_cats; ++ii)
 646         cat->reverse_variable_map_long[idx_long++] = i;
 647     }
 648
 649   assert (cat->n_vars <= cat->n_iap);
 650
 651   categoricals_dump (cat);
 652
 653   /* Tally up the sums for all the encodings */
 654   for (i = 0 ; i < cat->n_iap; ++i)
 655     {
 656       int x, y;
 657       struct interact_params *iap = &cat->iap[i];
 658       const struct interaction *iact = iap->iact;
 659
 660       const int df = iap->df_prod ? iap->df_prod [iact->n_vars - 1] : 0;
 661
 662       iap->enc_sum = xcalloc (df, sizeof (*(iap->enc_sum)));
 663
 664       for (y = 0; y < hmap_count (&iap->ivmap); ++y)
 665         {
 666           struct interaction_value *iv = iap->reverse_interaction_value_map[y];
 667           for (x = iap->base_subscript_short; x < iap->base_subscript_short + df ;++x)
 668             {
 669               const double bin = categoricals_get_effects_code_for_case (cat, x, iv->ccase);
 670               iap->enc_sum [x - iap->base_subscript_short] += bin * iv->cc;
 671             }
 672           if (cat->payload && cat->payload->calculate)
 673             cat->payload->calculate (cat->aux1, cat->aux2, iv->user_data);
 674         }
 675     }
 676
 677   cat->sane = true;
 678 }
 679
 680
 681 static int
 682 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
 683 {
 684   assert (cat->reverse_variable_map_short);
 685   assert (subscript >= 0);
 686   assert (subscript < cat->df_sum);
 687
 688   return cat->reverse_variable_map_short[subscript];
 689 }
 690
 691 static int
 692 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
 693 {
 694   assert (cat->reverse_variable_map_long);
 695   assert (subscript >= 0);
 696   assert (subscript < cat->n_cats_total);
 697
 698   return cat->reverse_variable_map_long[subscript];
 699 }
 700
 701
 702 /* Return the interaction corresponding to SUBSCRIPT */
 703 const struct interaction *
 704 categoricals_get_interaction_by_subscript (const struct categoricals *cat, int subscript)
 705 {
 706   int index = reverse_variable_lookup_short (cat, subscript);
 707
 708   return cat->iap[index].iact;
 709 }
 710
 711 double
 712 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
 713 {
 714   int vindex = reverse_variable_lookup_short (cat, subscript);
 715   const struct interact_params *vp = &cat->iap[vindex];
 716
 717   return vp->cc;
 718 }
 719
 720 double
 721 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
 722 {
 723   int vindex = reverse_variable_lookup_short (cat, subscript);
 724   const struct interact_params *vp = &cat->iap[vindex];
 725
 726   return   vp->enc_sum[subscript - vp->base_subscript_short];
 727 }
 728
 729
 730 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 731    for that subscript */
 732 static double
 733 categoricals_get_code_for_case (const struct categoricals *cat, int subscript,
 734                                 const struct ccase *c,
 735                                 bool effects_coding)
 736 {
 737   const struct interaction *iact = categoricals_get_interaction_by_subscript (cat, subscript);
 738
 739   const int i = reverse_variable_lookup_short (cat, subscript);
 740
 741   const int base_index = cat->iap[i].base_subscript_short;
 742
 743   int v;
 744   double result = 1.0;
 745
 746   const struct interact_params *iap = &cat->iap[i];
 747
 748   double dfp = 1.0;
 749   for (v = 0; v < iact->n_vars; ++v)
 750     {
 751       const struct variable *var = iact->vars[v];
 752
 753       const union value *val = case_data (c, var);
 754       const int width = var_get_width (var);
 755       const struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
 756
 757       const unsigned int hash = value_hash (val, width, 0);
 758       const struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
 759
 760       double bin = 1.0;
 761
 762       const double df = iap->df_prod[v] / dfp;
 763
 764       /* Translate the subscript into an index for the individual variable */
 765       const int index = ((subscript - base_index) % iap->df_prod[v] ) / dfp;
 766       dfp = iap->df_prod [v];
 767
 768       if (effects_coding && valn->index == df )
 769         bin = -1.0;
 770       else if ( valn->index != index )
 771         bin = 0;
 772
 773       result *= bin;
 774     }
 775
 776   return result;
 777 }
 778
 779
 780 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 781    for that subscript */
 782 double
 783 categoricals_get_dummy_code_for_case (const struct categoricals *cat, int subscript,
 784                                      const struct ccase *c)
 785 {
 786   return categoricals_get_code_for_case (cat, subscript, c, false);
 787 }
 788
 789 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 790    for that subscript.
 791    Else if it is the last category, return -1.
 792    Otherwise return 0.
 793  */
 794 double
 795 categoricals_get_effects_code_for_case (const struct categoricals *cat, int subscript,
 796                                         const struct ccase *c)
 797 {
 798   return categoricals_get_code_for_case (cat, subscript, c, true);
 799 }
 800
 801
 802 size_t
 803 categoricals_get_n_variables (const struct categoricals *cat)
 804 {
 805   printf ("%s\n", __FUNCTION__);
 806   return cat->n_vars;
 807 }
 808
 809
 810 /* Return a case containing the set of values corresponding to
 811    the Nth Category of the IACTth interaction */
 812 const struct ccase *
 813 categoricals_get_case_by_category_real (const struct categoricals *cat, int iact, int n)
 814 {
 815   const struct interaction_value *vn;
 816
 817   const struct interact_params *vp = &cat->iap[iact];
 818
 819   if ( n >= hmap_count (&vp->ivmap))
 820     return NULL;
 821
 822   vn = vp->reverse_interaction_value_map [n];
 823
 824   return vn->ccase;
 825 }
 826
 827 /* Return a the user data corresponding to the Nth Category of the IACTth interaction. */
 828 void *
 829 categoricals_get_user_data_by_category_real (const struct categoricals *cat, int iact, int n)
 830 {
 831   const struct interact_params *vp = &cat->iap[iact];
 832   const struct interaction_value *iv ;
 833
 834   if ( n >= hmap_count (&vp->ivmap))
 835     return NULL;
 836
 837   iv = vp->reverse_interaction_value_map [n];
 838
 839   return iv->user_data;
 840 }
 841
 842
 843
 844 /* Return a case containing the set of values corresponding to SUBSCRIPT */
 845 const struct ccase *
 846 categoricals_get_case_by_category (const struct categoricals *cat, int subscript)
 847 {
 848   int vindex = reverse_variable_lookup_long (cat, subscript);
 849   const struct interact_params *vp = &cat->iap[vindex];
 850   const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 851
 852   return vn->ccase;
 853 }
 854
 855 void *
 856 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
 857 {
 858   int vindex = reverse_variable_lookup_long (cat, subscript);
 859   const struct interact_params *vp = &cat->iap[vindex];
 860
 861   const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 862   return iv->user_data;
 863 }
 864
 865
 866 \f
 867
 868 void
 869 categoricals_set_payload (struct categoricals *cat, const struct payload *p,
 870                           const void *aux1, void *aux2)
 871 {
 872   cat->payload = p;
 873   cat->aux1 = aux1;
 874   cat->aux2 = aux2;
 875 }