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 of cases indexed by a interaction_value */
 100   struct hmap ivmap;
 101
 102   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   bool sane;
 178
 179   const struct payload *payload;
 180 };
 181
 182 static void
 183 categoricals_dump (const struct categoricals *cat)
 184 {
 185   if (CATEGORICALS_DEBUG)
 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); ", ds_cstr (&str), iap->n_cats);
 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           if (cat->payload && cat->payload->destroy)
 257             cat->payload->destroy (cat->aux1, cat->aux2, iv->user_data);
 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 bool
 300 categoricals_sane (const struct categoricals *cat)
 301 {
 302   return cat->sane;
 303 }
 304
 305 struct categoricals *
 306 categoricals_create (struct interaction *const*inter, size_t n_inter,
 307                      const struct variable *wv, enum mv_class dep_excl, enum mv_class fctr_excl)
 308 {
 309   size_t i;
 310   struct categoricals *cat = xmalloc (sizeof *cat);
 311
 312   cat->n_iap = n_inter;
 313   cat->wv = wv;
 314   cat->n_cats_total = 0;
 315   cat->n_vars = 0;
 316   cat->reverse_variable_map_short = NULL;
 317   cat->reverse_variable_map_long = NULL;
 318   cat->pool = pool_create ();
 319   cat->dep_excl = dep_excl;
 320   cat->fctr_excl = fctr_excl;
 321   cat->payload = NULL;
 322   cat->aux2 = NULL;
 323   cat->sane = false;
 324
 325   cat->iap = pool_calloc (cat->pool, cat->n_iap, sizeof *cat->iap);
 326
 327   hmap_init (&cat->varmap);
 328   for (i = 0 ; i < cat->n_iap; ++i)
 329     {
 330       int v;
 331       hmap_init (&cat->iap[i].ivmap);
 332       cat->iap[i].iact = inter[i];
 333       cat->iap[i].cc = 0.0;
 334       for (v = 0; v < inter[i]->n_vars; ++v)
 335         {
 336           const struct variable *var = inter[i]->vars[v];
 337           unsigned int hash = hash_pointer (var, 0);
 338           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash);
 339           if (vn == NULL)
 340             {
 341               vn = pool_malloc (cat->pool, sizeof *vn);
 342               vn->var = var;
 343               vn->n_vals = 0;
 344               hmap_init (&vn->valmap);
 345
 346               hmap_insert (&cat->varmap, &vn->node,  hash);
 347             }
 348         }
 349     }
 350
 351   return cat;
 352 }
 353
 354
 355
 356 void
 357 categoricals_update (struct categoricals *cat, const struct ccase *c)
 358 {
 359   int i;
 360   struct variable_node *vn = NULL;
 361   double weight;
 362
 363   if (NULL == cat)
 364     return;
 365
 366   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       size_t hash;
 395       struct interaction_value *node;
 396
 397       if ( interaction_case_is_missing (iact, c, cat->fctr_excl))
 398         continue;
 399
 400       hash = interaction_case_hash (iact, c, 0);
 401       node = lookup_case (&cat->iap[i].ivmap, iact, c);
 402
 403       if ( NULL == node)
 404         {
 405           node = pool_malloc (cat->pool, sizeof *node);
 406
 407           node->ccase = case_ref (c);
 408           node->cc = weight;
 409
 410           hmap_insert (&cat->iap[i].ivmap, &node->node, hash);
 411
 412           if (cat->payload)
 413             {
 414               node->user_data = cat->payload->create (cat->aux1, cat->aux2);
 415             }
 416         }
 417       else
 418         {
 419           node->cc += weight;
 420         }
 421       cat->iap[i].cc += weight;
 422
 423       if (cat->payload)
 424         {
 425           double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
 426           cat->payload->update (cat->aux1, cat->aux2, node->user_data, c, weight);
 427         }
 428
 429     }
 430 }
 431
 432 /* Return the number of categories (distinct values) for interction N */
 433 size_t
 434 categoricals_n_count (const struct categoricals *cat, size_t n)
 435 {
 436   return hmap_count (&cat->iap[n].ivmap);
 437 }
 438
 439
 440 size_t
 441 categoricals_df (const struct categoricals *cat, size_t n)
 442 {
 443   const struct interact_params *iap = &cat->iap[n];
 444   return iap->df_prod[iap->iact->n_vars - 1];
 445 }
 446
 447
 448 /* Return the total number of categories */
 449 size_t
 450 categoricals_n_total (const struct categoricals *cat)
 451 {
 452   if (!categoricals_is_complete (cat))
 453     return 0;
 454
 455   return cat->n_cats_total;
 456 }
 457
 458 size_t
 459 categoricals_df_total (const struct categoricals *cat)
 460 {
 461   if (NULL == cat)
 462     return 0;
 463
 464   return cat->df_sum;
 465 }
 466
 467 bool
 468 categoricals_is_complete (const struct categoricals *cat)
 469 {
 470   return (NULL != cat->reverse_variable_map_short);
 471 }
 472
 473
 474 /* This function must be called *before* any call to categoricals_get_*_by subscript and
 475  *after* all calls to categoricals_update */
 476 void
 477 categoricals_done (const struct categoricals *cat_)
 478 {
 479   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
 480      uses it will be more efficient that using a tree based structure, since it
 481      is called only once, and means that subsequent lookups will be O(1).
 482
 483      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
 484   */
 485   struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
 486   int v;
 487   int i;
 488   int idx_short = 0;
 489   int idx_long = 0;
 490
 491   if (NULL == cat)
 492     return;
 493
 494   cat->df_sum = 0;
 495   cat->n_cats_total = 0;
 496
 497   /* Calculate the degrees of freedom, and the number of categories */
 498   for (i = 0 ; i < cat->n_iap; ++i)
 499     {
 500       int df = 1;
 501       const struct interaction *iact = cat->iap[i].iact;
 502
 503       cat->iap[i].df_prod = iact->n_vars ? xcalloc (iact->n_vars, sizeof (int)) : NULL;
 504
 505       cat->iap[i].n_cats = 1;
 506
 507       for (v = 0 ; v < iact->n_vars; ++v)
 508         {
 509           const struct variable *var = iact->vars[v];
 510
 511           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
 512
 513           if  (hmap_count (&vn->valmap) == 0)
 514             {
 515               cat->sane = false;
 516               return;
 517             }
 518
 519           cat->iap[i].df_prod[v] = df * (hmap_count (&vn->valmap) - 1);
 520           df = cat->iap[i].df_prod[v];
 521
 522           cat->iap[i].n_cats *= hmap_count (&vn->valmap);
 523         }
 524
 525       assert (v == iact->n_vars);
 526       if (v > 0)
 527         cat->df_sum += cat->iap[i].df_prod [v - 1];
 528
 529       cat->n_cats_total += cat->iap[i].n_cats;
 530     }
 531
 532
 533   cat->reverse_variable_map_short = pool_calloc (cat->pool,
 534                                                  cat->df_sum,
 535                                                  sizeof *cat->reverse_variable_map_short);
 536
 537   cat->reverse_variable_map_long = pool_calloc (cat->pool,
 538                                                 cat->n_cats_total,
 539                                                 sizeof *cat->reverse_variable_map_long);
 540
 541   for (i = 0 ; i < cat->n_iap; ++i)
 542     {
 543       struct interaction_value *ivn = NULL;
 544       int x = 0;
 545       int ii;
 546       struct interact_params *iap = &cat->iap[i];
 547
 548       iap->base_subscript_short = idx_short;
 549       iap->base_subscript_long = idx_long;
 550
 551       iap->reverse_interaction_value_map = pool_calloc (cat->pool, iap->n_cats,
 552                                                         sizeof *iap->reverse_interaction_value_map);
 553
 554       HMAP_FOR_EACH (ivn, struct interaction_value, node, &iap->ivmap)
 555         {
 556           iap->reverse_interaction_value_map[x++] = ivn;
 557         }
 558
 559       assert (x <= iap->n_cats);
 560
 561       /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
 562       sort (iap->reverse_interaction_value_map, x, sizeof (*iap->reverse_interaction_value_map),
 563             compare_interaction_value_3way, iap);
 564
 565       /* Fill the remaining values with null */
 566       for (ii = x ; ii < iap->n_cats; ++ii)
 567         iap->reverse_interaction_value_map[ii] = NULL;
 568
 569       /* Populate the reverse variable maps. */
 570       if (iap->df_prod)
 571         {
 572           for (ii = 0; ii < iap->df_prod [iap->iact->n_vars - 1]; ++ii)
 573             cat->reverse_variable_map_short[idx_short++] = i;
 574         }
 575
 576       for (ii = 0; ii < iap->n_cats; ++ii)
 577         cat->reverse_variable_map_long[idx_long++] = i;
 578     }
 579
 580   assert (cat->n_vars <= cat->n_iap);
 581
 582   categoricals_dump (cat);
 583
 584   /* Tally up the sums for all the encodings */
 585   for (i = 0 ; i < cat->n_iap; ++i)
 586     {
 587       int x, y;
 588       struct interact_params *iap = &cat->iap[i];
 589       const struct interaction *iact = iap->iact;
 590
 591       const int df = iap->df_prod ? iap->df_prod [iact->n_vars - 1] : 0;
 592
 593       iap->enc_sum = xcalloc (df, sizeof (*(iap->enc_sum)));
 594
 595       for (y = 0; y < hmap_count (&iap->ivmap); ++y)
 596         {
 597           struct interaction_value *iv = iap->reverse_interaction_value_map[y];
 598           for (x = iap->base_subscript_short; x < iap->base_subscript_short + df ;++x)
 599             {
 600               const double bin = categoricals_get_code_for_case (cat, x, iv->ccase); \
 601               iap->enc_sum [x - iap->base_subscript_short] += bin * iv->cc;
 602             }
 603           if (cat->payload && cat->payload->calculate)
 604             cat->payload->calculate (cat->aux1, cat->aux2, iv->user_data);
 605         }
 606     }
 607
 608   cat->sane = true;
 609 }
 610
 611
 612 static int
 613 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
 614 {
 615   assert (cat->reverse_variable_map_short);
 616   assert (subscript >= 0);
 617   assert (subscript < cat->df_sum);
 618
 619   return cat->reverse_variable_map_short[subscript];
 620 }
 621
 622 static int
 623 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
 624 {
 625   assert (cat->reverse_variable_map_long);
 626   assert (subscript >= 0);
 627   assert (subscript < cat->n_cats_total);
 628
 629   return cat->reverse_variable_map_long[subscript];
 630 }
 631
 632
 633 /* Return the interaction corresponding to SUBSCRIPT */
 634 const struct interaction *
 635 categoricals_get_interaction_by_subscript (const struct categoricals *cat, int subscript)
 636 {
 637   int index = reverse_variable_lookup_short (cat, subscript);
 638
 639   return cat->iap[index].iact;
 640 }
 641
 642 double
 643 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
 644 {
 645   int vindex = reverse_variable_lookup_short (cat, subscript);
 646   const struct interact_params *vp = &cat->iap[vindex];
 647
 648   return vp->cc;
 649 }
 650
 651 double
 652 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
 653 {
 654   int vindex = reverse_variable_lookup_short (cat, subscript);
 655   const struct interact_params *vp = &cat->iap[vindex];
 656
 657   return   vp->enc_sum[subscript - vp->base_subscript_short];
 658 }
 659
 660 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 661    for that subscript */
 662 double
 663 categoricals_get_code_for_case (const struct categoricals *cat, int subscript,
 664                                 const struct ccase *c)
 665 {
 666   const struct interaction *iact = categoricals_get_interaction_by_subscript (cat, subscript);
 667
 668   const int i = reverse_variable_lookup_short (cat, subscript);
 669
 670   const int base_index = cat->iap[i].base_subscript_short;
 671
 672   int v;
 673   double result = 1.0;
 674
 675   const struct interact_params *iap = &cat->iap[i];
 676
 677   double dfp = 1.0;
 678   for (v = 0; v < iact->n_vars; ++v)
 679     {
 680       const struct variable *var = iact->vars[v];
 681
 682       const union value *val = case_data (c, var);
 683       const int width = var_get_width (var);
 684       const struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
 685
 686       const unsigned int hash = value_hash (val, width, 0);
 687       const struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
 688
 689       double bin = 1.0;
 690
 691       const double df = iap->df_prod[v] / dfp;
 692
 693       /* Translate the subscript into an index for the individual variable */
 694       const int index = ((subscript - base_index) % iap->df_prod[v] ) / dfp;
 695       dfp = iap->df_prod [v];
 696
 697 #if EFFECTS_CODING
 698       if ( valn->index == df )
 699         bin = -1.0;
 700       else
 701 #endif
 702         if ( valn->index  != index )
 703           bin = 0;
 704
 705       result *= bin;
 706     }
 707
 708   return result;
 709 }
 710
 711
 712 size_t
 713 categoricals_get_n_variables (const struct categoricals *cat)
 714 {
 715   printf ("%s\n", __FUNCTION__);
 716   return cat->n_vars;
 717 }
 718
 719
 720 /* Return a case containing the set of values corresponding to
 721    the Nth Category of the IACTth interaction */
 722 const struct ccase *
 723 categoricals_get_case_by_category_real (const struct categoricals *cat, int iact, int n)
 724 {
 725   const struct interaction_value *vn;
 726
 727   const struct interact_params *vp = &cat->iap[iact];
 728
 729   if ( n >= hmap_count (&vp->ivmap))
 730     return NULL;
 731
 732   vn = vp->reverse_interaction_value_map [n];
 733
 734   return vn->ccase;
 735 }
 736
 737 /* Return a the user data corresponding to the Nth Category of the IACTth interaction. */
 738 void *
 739 categoricals_get_user_data_by_category_real (const struct categoricals *cat, int iact, int n)
 740 {
 741   const struct interact_params *vp = &cat->iap[iact];
 742   const struct interaction_value *iv ;
 743
 744   if ( n >= hmap_count (&vp->ivmap))
 745     return NULL;
 746
 747   iv = vp->reverse_interaction_value_map [n];
 748
 749   return iv->user_data;
 750 }
 751
 752
 753
 754 /* Return a case containing the set of values corresponding to SUBSCRIPT */
 755 const struct ccase *
 756 categoricals_get_case_by_category (const struct categoricals *cat, int subscript)
 757 {
 758   int vindex = reverse_variable_lookup_long (cat, subscript);
 759   const struct interact_params *vp = &cat->iap[vindex];
 760   const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 761
 762   return vn->ccase;
 763 }
 764
 765 void *
 766 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
 767 {
 768   int vindex = reverse_variable_lookup_long (cat, subscript);
 769   const struct interact_params *vp = &cat->iap[vindex];
 770
 771   const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 772   return iv->user_data;
 773 }
 774
 775
 776 \f
 777
 778 void
 779 categoricals_set_payload (struct categoricals *cat, const struct payload *p,
 780                           const void *aux1, void *aux2)
 781 {
 782   cat->payload = p;
 783   cat->aux1 = aux1;
 784   cat->aux2 = aux2;
 785 }