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 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 static struct variable_node *
  80 lookup_variable (const struct hmap *map, const struct variable *var, unsigned int hash)
  81 {
  82   struct variable_node *vn = NULL;
  83   HMAP_FOR_EACH_WITH_HASH (vn, struct variable_node, node, hash, map)
  84     {
  85       if (vn->var == var)
  86         break;
  87
  88       fprintf (stderr, "Warning: Hash table collision\n");
  89     }
  90
  91   return vn;
  92 }
  93
  94
  95 struct interact_params
  96 {
  97   /* A map of cases indexed by a interaction_value */
  98   struct hmap ivmap;
  99
 100   struct interaction *iact;
 101
 102   int base_subscript_short;
 103   int base_subscript_long;
 104
 105   /* The number of distinct values of this interaction */
 106   int n_cats;
 107
 108   /* An array of integers df_n * df_{n-1} * df_{n-2} ...
 109      These are the products of the degrees of freedom for the current
 110      variable and all preceeding variables */
 111   int *df_prod;
 112
 113   double *enc_sum;
 114
 115   /* A map of interaction_values indexed by subscript */
 116   struct interaction_value **reverse_interaction_value_map;
 117
 118   double cc;
 119 };
 120
 121
 122 /* Comparison function to sort the reverse_value_map in ascending order */
 123 static int
 124 compare_interaction_value_3way (const void *vn1_, const void *vn2_, const void *aux)
 125 {
 126   const struct interaction_value *const *vn1p = vn1_;
 127   const struct interaction_value *const *vn2p = vn2_;
 128
 129   const struct interact_params *iap = aux;
 130
 131   return interaction_case_cmp_3way (iap->iact, (*vn1p)->ccase, (*vn2p)->ccase);
 132 }
 133
 134 struct categoricals
 135 {
 136   /* The weight variable */
 137   const struct variable *wv;
 138
 139   /* An array of interact_params */
 140   struct interact_params *iap;
 141
 142   /* Map whose members are the union of the variables which comprise IAP */
 143   struct hmap varmap;
 144
 145   /* The size of IAP. (ie, the number of interactions involved.) */
 146   size_t n_iap;
 147
 148   /* The number of categorical variables which contain entries.
 149      In the absence of missing values, this will be equal to N_IAP */
 150   size_t n_vars;
 151
 152   size_t df_sum;
 153
 154   /* A map to enable the lookup of variables indexed by subscript.
 155      This map considers only the N - 1 of the N variables.
 156   */
 157   int *reverse_variable_map_short;
 158
 159   /* Like the above, but uses all N variables */
 160   int *reverse_variable_map_long;
 161
 162   size_t n_cats_total;
 163
 164   struct pool *pool;
 165
 166   /* Missing values in the dependent varirable to be excluded */
 167   enum mv_class dep_excl;
 168
 169   /* Missing values in the factor variables to be excluded */
 170   enum mv_class fctr_excl;
 171
 172   const void *aux1;
 173   void *aux2;
 174
 175   bool sane;
 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 (cat->payload && cat->payload->destroy)
 255             cat->payload->destroy (cat->aux1, cat->aux2, iv->user_data);
 256           case_unref (iv->ccase);
 257         }
 258
 259       free (cat->iap[i].enc_sum);
 260       free (cat->iap[i].df_prod);
 261       hmap_destroy (&cat->iap[i].ivmap);
 262       interaction_destroy (cat->iap[i].iact);
 263     }
 264
 265   /* Interate over each variable and delete its value map */
 266   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
 267     {
 268       hmap_destroy (&vn->valmap);
 269     }
 270
 271   hmap_destroy (&cat->varmap);
 272
 273   pool_destroy (cat->pool);
 274
 275   free (cat);
 276 }
 277
 278
 279
 280 static struct interaction_value *
 281 lookup_case (const struct hmap *map, const struct interaction *iact, const struct ccase *c)
 282 {
 283   struct interaction_value *iv = NULL;
 284   size_t hash = interaction_case_hash (iact, c, 0);
 285
 286   HMAP_FOR_EACH_WITH_HASH (iv, struct interaction_value, node, hash, map)
 287     {
 288       if (interaction_case_equal (iact, c, iv->ccase))
 289         break;
 290
 291       fprintf (stderr, "Warning: Hash table collision\n");
 292     }
 293
 294   return iv;
 295 }
 296
 297 bool
 298 categoricals_sane (const struct categoricals *cat)
 299 {
 300   return cat->sane;
 301 }
 302
 303 struct categoricals *
 304 categoricals_create (struct interaction *const*inter, size_t n_inter,
 305                      const struct variable *wv, enum mv_class dep_excl, enum mv_class fctr_excl)
 306 {
 307   size_t i;
 308   struct categoricals *cat = xmalloc (sizeof *cat);
 309
 310   cat->n_iap = n_inter;
 311   cat->wv = wv;
 312   cat->n_cats_total = 0;
 313   cat->n_vars = 0;
 314   cat->reverse_variable_map_short = NULL;
 315   cat->reverse_variable_map_long = NULL;
 316   cat->pool = pool_create ();
 317   cat->dep_excl = dep_excl;
 318   cat->fctr_excl = fctr_excl;
 319   cat->payload = NULL;
 320   cat->aux2 = NULL;
 321   cat->sane = false;
 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   double weight;
 360
 361   if (NULL == cat)
 362     return;
 363
 364   weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
 365
 366   assert (NULL == cat->reverse_variable_map_short);
 367   assert (NULL == cat->reverse_variable_map_long);
 368
 369   /* Interate over each variable, and add the value of that variable
 370      to the appropriate map, if it's not already present. */
 371   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
 372     {
 373       const int width = var_get_width (vn->var);
 374       const union value *val = case_data (c, vn->var);
 375       unsigned int hash = value_hash (val, width, 0);
 376
 377       struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
 378       if (valn == NULL)
 379         {
 380           valn = pool_malloc (cat->pool, sizeof *valn);
 381           valn->index = vn->n_vals++;
 382           value_init (&valn->val, width);
 383           value_copy (&valn->val, val, width);
 384           hmap_insert (&vn->valmap, &valn->node, hash);
 385         }
 386     }
 387
 388   for (i = 0 ; i < cat->n_iap; ++i)
 389     {
 390       const struct interaction *iact = cat->iap[i].iact;
 391
 392       size_t hash;
 393       struct interaction_value *node;
 394
 395       if ( interaction_case_is_missing (iact, c, cat->fctr_excl))
 396         continue;
 397
 398       hash = interaction_case_hash (iact, c, 0);
 399       node = lookup_case (&cat->iap[i].ivmap, iact, c);
 400
 401       if ( NULL == node)
 402         {
 403           node = pool_malloc (cat->pool, sizeof *node);
 404
 405           node->ccase = case_ref (c);
 406           node->cc = weight;
 407
 408           hmap_insert (&cat->iap[i].ivmap, &node->node, hash);
 409
 410           if (cat->payload)
 411             {
 412               node->user_data = cat->payload->create (cat->aux1, cat->aux2);
 413             }
 414         }
 415       else
 416         {
 417           node->cc += weight;
 418         }
 419       cat->iap[i].cc += weight;
 420
 421       if (cat->payload)
 422         {
 423           double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
 424           cat->payload->update (cat->aux1, cat->aux2, node->user_data, c, weight);
 425         }
 426
 427     }
 428 }
 429
 430 /* Return the number of categories (distinct values) for interction N */
 431 size_t
 432 categoricals_n_count (const struct categoricals *cat, size_t n)
 433 {
 434   return hmap_count (&cat->iap[n].ivmap);
 435 }
 436
 437
 438 size_t
 439 categoricals_df (const struct categoricals *cat, size_t n)
 440 {
 441   const struct interact_params *iap = &cat->iap[n];
 442   return iap->df_prod[iap->iact->n_vars - 1];
 443 }
 444
 445
 446 /* Return the total number of categories */
 447 size_t
 448 categoricals_n_total (const struct categoricals *cat)
 449 {
 450   if (!categoricals_is_complete (cat))
 451     return 0;
 452
 453   return cat->n_cats_total;
 454 }
 455
 456 size_t
 457 categoricals_df_total (const struct categoricals *cat)
 458 {
 459   if (NULL == cat)
 460     return 0;
 461
 462   return cat->df_sum;
 463 }
 464
 465 bool
 466 categoricals_is_complete (const struct categoricals *cat)
 467 {
 468   return (NULL != cat->reverse_variable_map_short);
 469 }
 470
 471
 472 /* This function must be called *before* any call to categoricals_get_*_by subscript and
 473  *after* all calls to categoricals_update */
 474 void
 475 categoricals_done (const struct categoricals *cat_)
 476 {
 477   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
 478      uses it will be more efficient that using a tree based structure, since it
 479      is called only once, and means that subsequent lookups will be O(1).
 480
 481      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
 482   */
 483   struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
 484   int v;
 485   int i;
 486   int idx_short = 0;
 487   int idx_long = 0;
 488
 489   if (NULL == cat)
 490     return;
 491
 492   cat->df_sum = 0;
 493   cat->n_cats_total = 0;
 494
 495   /* Calculate the degrees of freedom, and the number of categories */
 496   for (i = 0 ; i < cat->n_iap; ++i)
 497     {
 498       int df = 1;
 499       const struct interaction *iact = cat->iap[i].iact;
 500
 501       cat->iap[i].df_prod = iact->n_vars ? xcalloc (iact->n_vars, sizeof (int)) : NULL;
 502
 503       cat->iap[i].n_cats = 1;
 504
 505       for (v = 0 ; v < iact->n_vars; ++v)
 506         {
 507           const struct variable *var = iact->vars[v];
 508
 509           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
 510
 511           if  (hmap_count (&vn->valmap) == 0)
 512             {
 513               cat->sane = false;
 514               return;
 515             }
 516
 517           cat->iap[i].df_prod[v] = df * (hmap_count (&vn->valmap) - 1);
 518           df = cat->iap[i].df_prod[v];
 519
 520           cat->iap[i].n_cats *= hmap_count (&vn->valmap);
 521         }
 522
 523       assert (v == iact->n_vars);
 524       if (v > 0)
 525         cat->df_sum += cat->iap[i].df_prod [v - 1];
 526
 527       cat->n_cats_total += cat->iap[i].n_cats;
 528     }
 529
 530
 531   cat->reverse_variable_map_short = pool_calloc (cat->pool,
 532                                                  cat->df_sum,
 533                                                  sizeof *cat->reverse_variable_map_short);
 534
 535   cat->reverse_variable_map_long = pool_calloc (cat->pool,
 536                                                 cat->n_cats_total,
 537                                                 sizeof *cat->reverse_variable_map_long);
 538
 539   for (i = 0 ; i < cat->n_iap; ++i)
 540     {
 541       struct interaction_value *ivn = NULL;
 542       int x = 0;
 543       int ii;
 544       struct interact_params *iap = &cat->iap[i];
 545
 546       iap->base_subscript_short = idx_short;
 547       iap->base_subscript_long = idx_long;
 548
 549       iap->reverse_interaction_value_map = pool_calloc (cat->pool, iap->n_cats,
 550                                                         sizeof *iap->reverse_interaction_value_map);
 551
 552       HMAP_FOR_EACH (ivn, struct interaction_value, node, &iap->ivmap)
 553         {
 554           iap->reverse_interaction_value_map[x++] = ivn;
 555         }
 556
 557       assert (x <= iap->n_cats);
 558
 559       /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
 560       sort (iap->reverse_interaction_value_map, x, sizeof (*iap->reverse_interaction_value_map),
 561             compare_interaction_value_3way, iap);
 562
 563       /* Fill the remaining values with null */
 564       for (ii = x ; ii < iap->n_cats; ++ii)
 565         iap->reverse_interaction_value_map[ii] = NULL;
 566
 567       /* Populate the reverse variable maps. */
 568       if (iap->df_prod)
 569         {
 570           for (ii = 0; ii < iap->df_prod [iap->iact->n_vars - 1]; ++ii)
 571             cat->reverse_variable_map_short[idx_short++] = i;
 572         }
 573
 574       for (ii = 0; ii < iap->n_cats; ++ii)
 575         cat->reverse_variable_map_long[idx_long++] = i;
 576     }
 577
 578   assert (cat->n_vars <= cat->n_iap);
 579
 580   categoricals_dump (cat);
 581
 582   /* Tally up the sums for all the encodings */
 583   for (i = 0 ; i < cat->n_iap; ++i)
 584     {
 585       int x, y;
 586       struct interact_params *iap = &cat->iap[i];
 587       const struct interaction *iact = iap->iact;
 588
 589       const int df = iap->df_prod ? iap->df_prod [iact->n_vars - 1] : 0;
 590
 591       iap->enc_sum = xcalloc (df, sizeof (*(iap->enc_sum)));
 592
 593       for (y = 0; y < hmap_count (&iap->ivmap); ++y)
 594         {
 595           struct interaction_value *iv = iap->reverse_interaction_value_map[y];
 596           for (x = iap->base_subscript_short; x < iap->base_subscript_short + df ;++x)
 597             {
 598               const double bin = categoricals_get_effects_code_for_case (cat, x, iv->ccase);
 599               iap->enc_sum [x - iap->base_subscript_short] += bin * iv->cc;
 600             }
 601           if (cat->payload && cat->payload->calculate)
 602             cat->payload->calculate (cat->aux1, cat->aux2, iv->user_data);
 603         }
 604     }
 605
 606   cat->sane = true;
 607 }
 608
 609
 610 static int
 611 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
 612 {
 613   assert (cat->reverse_variable_map_short);
 614   assert (subscript >= 0);
 615   assert (subscript < cat->df_sum);
 616
 617   return cat->reverse_variable_map_short[subscript];
 618 }
 619
 620 static int
 621 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
 622 {
 623   assert (cat->reverse_variable_map_long);
 624   assert (subscript >= 0);
 625   assert (subscript < cat->n_cats_total);
 626
 627   return cat->reverse_variable_map_long[subscript];
 628 }
 629
 630
 631 /* Return the interaction corresponding to SUBSCRIPT */
 632 const struct interaction *
 633 categoricals_get_interaction_by_subscript (const struct categoricals *cat, int subscript)
 634 {
 635   int index = reverse_variable_lookup_short (cat, subscript);
 636
 637   return cat->iap[index].iact;
 638 }
 639
 640 double
 641 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
 642 {
 643   int vindex = reverse_variable_lookup_short (cat, subscript);
 644   const struct interact_params *vp = &cat->iap[vindex];
 645
 646   return vp->cc;
 647 }
 648
 649 double
 650 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
 651 {
 652   int vindex = reverse_variable_lookup_short (cat, subscript);
 653   const struct interact_params *vp = &cat->iap[vindex];
 654
 655   return   vp->enc_sum[subscript - vp->base_subscript_short];
 656 }
 657
 658
 659 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 660    for that subscript */
 661 static double
 662 categoricals_get_code_for_case (const struct categoricals *cat, int subscript,
 663                                 const struct ccase *c,
 664                                 bool effects_coding)
 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 && valn->index == df )
 698         bin = -1.0;
 699       else if ( valn->index  != index )
 700         bin = 0;
 701
 702       result *= bin;
 703     }
 704
 705   return result;
 706 }
 707
 708
 709 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 710    for that subscript */
 711 double
 712 categoricals_get_dummy_code_for_case (const struct categoricals *cat, int subscript,
 713                                      const struct ccase *c)
 714 {
 715   return categoricals_get_code_for_case (cat, subscript, c, false);
 716 }
 717
 718 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
 719    for that subscript.
 720    Else if it is the last category, return -1.
 721    Otherwise return 0.
 722  */
 723 double
 724 categoricals_get_effects_code_for_case (const struct categoricals *cat, int subscript,
 725                                         const struct ccase *c)
 726 {
 727   return categoricals_get_code_for_case (cat, subscript, c, true);
 728 }
 729
 730
 731 size_t
 732 categoricals_get_n_variables (const struct categoricals *cat)
 733 {
 734   printf ("%s\n", __FUNCTION__);
 735   return cat->n_vars;
 736 }
 737
 738
 739 /* Return a case containing the set of values corresponding to
 740    the Nth Category of the IACTth interaction */
 741 const struct ccase *
 742 categoricals_get_case_by_category_real (const struct categoricals *cat, int iact, int n)
 743 {
 744   const struct interaction_value *vn;
 745
 746   const struct interact_params *vp = &cat->iap[iact];
 747
 748   if ( n >= hmap_count (&vp->ivmap))
 749     return NULL;
 750
 751   vn = vp->reverse_interaction_value_map [n];
 752
 753   return vn->ccase;
 754 }
 755
 756 /* Return a the user data corresponding to the Nth Category of the IACTth interaction. */
 757 void *
 758 categoricals_get_user_data_by_category_real (const struct categoricals *cat, int iact, int n)
 759 {
 760   const struct interact_params *vp = &cat->iap[iact];
 761   const struct interaction_value *iv ;
 762
 763   if ( n >= hmap_count (&vp->ivmap))
 764     return NULL;
 765
 766   iv = vp->reverse_interaction_value_map [n];
 767
 768   return iv->user_data;
 769 }
 770
 771
 772
 773 /* Return a case containing the set of values corresponding to SUBSCRIPT */
 774 const struct ccase *
 775 categoricals_get_case_by_category (const struct categoricals *cat, int subscript)
 776 {
 777   int vindex = reverse_variable_lookup_long (cat, subscript);
 778   const struct interact_params *vp = &cat->iap[vindex];
 779   const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 780
 781   return vn->ccase;
 782 }
 783
 784 void *
 785 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
 786 {
 787   int vindex = reverse_variable_lookup_long (cat, subscript);
 788   const struct interact_params *vp = &cat->iap[vindex];
 789
 790   const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
 791   return iv->user_data;
 792 }
 793
 794
 795 \f
 796
 797 void
 798 categoricals_set_payload (struct categoricals *cat, const struct payload *p,
 799                           const void *aux1, void *aux2)
 800 {
 801   cat->payload = p;
 802   cat->aux1 = aux1;
 803   cat->aux2 = aux2;
 804 }