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