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