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

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