1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
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.
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.
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/>. */
19 #include "math/categoricals.h"
20 #include "math/interaction.h"
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"
33 #include "gl/xalloc.h"
35 #define CATEGORICALS_DEBUG 0
37 #define EFFECTS_CODING 1
41 struct hmap_node node; /* Node in hash map. */
43 union value val; /* The value */
45 int index; /* A zero based unique index for this value */
48 struct interaction_value
50 struct hmap_node node; /* Node in hash map */
52 struct ccase *ccase; /* A case (probably the first in the dataset) which matches this value */
54 double cc; /* Total of the weights of cases matching this interaction */
56 void *user_data; /* A pointer to data which the caller can store stuff */
59 static struct value_node *
60 lookup_value (const struct hmap *map, const union value *val, unsigned int hash, int width)
62 struct value_node *vn = NULL;
63 HMAP_FOR_EACH_WITH_HASH (vn, struct value_node, node, hash, map)
65 if (value_equal (&vn->val, val, width))
74 struct hmap_node node; /* Node in hash map. */
75 const struct variable *var; /* The variable */
77 struct hmap valmap; /* A map of value nodes */
78 int n_vals; /* Number of values for this variable */
81 static struct variable_node *
82 lookup_variable (const struct hmap *map, const struct variable *var, unsigned int hash)
84 struct variable_node *vn = NULL;
85 HMAP_FOR_EACH_WITH_HASH (vn, struct variable_node, node, hash, map)
90 fprintf (stderr, "Warning: Hash table collision\n");
97 struct interact_params
99 /* A map indexed by a interaction_value */
102 struct interaction *iact;
104 int base_subscript_short;
105 int base_subscript_long;
107 /* The number of distinct values of this interaction */
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 */
117 /* A map of interaction_values indexed by subscript */
118 struct interaction_value **reverse_interaction_value_map;
124 /* Comparison function to sort the reverse_value_map in ascending order */
126 compare_interaction_value_3way (const void *vn1_, const void *vn2_, const void *aux)
128 const struct interaction_value *const *vn1p = vn1_;
129 const struct interaction_value *const *vn2p = vn2_;
131 const struct interact_params *iap = aux;
133 return interaction_case_cmp_3way (iap->iact, (*vn1p)->ccase, (*vn2p)->ccase);
138 /* The weight variable */
139 const struct variable *wv;
141 /* An array of interact_params */
142 struct interact_params *iap;
144 /* Map whose members are the union of the variables which comprise IAP */
147 /* The size of IAP. (ie, the number of interactions involved.) */
150 /* The number of categorical variables which contain entries.
151 In the absence of missing values, this will be equal to N_IAP */
156 /* A map to enable the lookup of variables indexed by subscript.
157 This map considers only the N - 1 of the N variables.
159 int *reverse_variable_map_short;
161 /* Like the above, but uses all N variables */
162 int *reverse_variable_map_long;
168 /* Missing values in the dependent varirable to be excluded */
169 enum mv_class dep_excl;
171 /* Missing values in the factor variables to be excluded */
172 enum mv_class fctr_excl;
179 const struct payload *payload;
183 categoricals_dump (const struct categoricals *cat)
185 if (CATEGORICALS_DEBUG)
189 printf ("Reverse Variable Map (short):\n");
190 for (i = 0; i < cat->df_sum; ++i)
192 printf (" %d", cat->reverse_variable_map_short[i]);
196 printf ("Reverse Variable Map (long):\n");
197 for (i = 0; i < cat->n_cats_total; ++i)
199 printf (" %d", cat->reverse_variable_map_long[i]);
204 printf ("Number of interactions %d\n", cat->n_iap);
205 for (i = 0 ; i < cat->n_iap; ++i)
209 const struct interact_params *iap = &cat->iap[i];
210 const struct interaction *iact = iap->iact;
212 ds_init_empty (&str);
213 interaction_to_string (iact, &str);
215 printf ("\nInteraction: %s (n: %d); ", ds_cstr (&str), iap->n_cats);
217 printf ("Base subscript: %d\n", iap->base_subscript_short);
220 for (v = 0; v < hmap_count (&iap->ivmap); ++v)
223 const struct interaction_value *iv = iap->reverse_interaction_value_map[v];
225 if (v > 0) printf (" ");
227 for (vv = 0; vv < iact->n_vars; ++vv)
229 const struct variable *var = iact->vars[vv];
230 const union value *val = case_data (iv->ccase, var);
232 printf ("%g", val->f);
233 if (vv < iact->n_vars - 1)
244 categoricals_destroy (struct categoricals *cat)
246 struct variable_node *vn = NULL;
250 for (i = 0; i < cat->n_iap; ++i)
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)
256 if (cat->payload && cat->payload->destroy)
257 cat->payload->destroy (cat->aux1, iv->user_data);
258 case_unref (iv->ccase);
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);
267 /* Interate over each variable and delete its value map */
268 HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
270 hmap_destroy (&vn->valmap);
273 hmap_destroy (&cat->varmap);
275 pool_destroy (cat->pool);
282 static struct interaction_value *
283 lookup_case (const struct hmap *map, const struct interaction *iact, const struct ccase *c)
285 struct interaction_value *iv = NULL;
286 size_t hash = interaction_case_hash (iact, c, 0);
288 HMAP_FOR_EACH_WITH_HASH (iv, struct interaction_value, node, hash, map)
290 if (interaction_case_equal (iact, c, iv->ccase))
293 fprintf (stderr, "Warning: Hash table collision\n");
300 categoricals_sane (const struct categoricals *cat)
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)
310 struct categoricals *cat = xmalloc (sizeof *cat);
312 cat->n_iap = n_inter;
314 cat->n_cats_total = 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;
325 cat->iap = pool_calloc (cat->pool, cat->n_iap, sizeof *cat->iap);
327 hmap_init (&cat->varmap);
328 for (i = 0 ; i < cat->n_iap; ++i)
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)
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);
341 vn = pool_malloc (cat->pool, sizeof *vn);
344 hmap_init (&vn->valmap);
346 hmap_insert (&cat->varmap, &vn->node, hash);
357 categoricals_update (struct categoricals *cat, const struct ccase *c)
360 struct variable_node *vn = NULL;
361 const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
363 assert (NULL == cat->reverse_variable_map_short);
364 assert (NULL == cat->reverse_variable_map_long);
366 /* Interate over each variable, and add the value of that variable
367 to the appropriate map, if it's not already present. */
368 HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
370 const int width = var_get_width (vn->var);
371 const union value *val = case_data (c, vn->var);
372 unsigned int hash = value_hash (val, width, 0);
374 struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
377 valn = pool_malloc (cat->pool, sizeof *valn);
378 valn->index = vn->n_vals++;
379 value_init (&valn->val, width);
380 value_copy (&valn->val, val, width);
381 hmap_insert (&vn->valmap, &valn->node, hash);
385 for (i = 0 ; i < cat->n_iap; ++i)
387 const struct interaction *iact = cat->iap[i].iact;
390 struct interaction_value *node;
392 if ( interaction_case_is_missing (iact, c, cat->fctr_excl))
395 hash = interaction_case_hash (iact, c, 0);
396 node = lookup_case (&cat->iap[i].ivmap, iact, c);
400 node = pool_malloc (cat->pool, sizeof *node);
402 node->ccase = case_ref (c);
405 hmap_insert (&cat->iap[i].ivmap, &node->node, hash);
409 node->user_data = cat->payload->create (cat->aux1, cat->aux2);
416 cat->iap[i].cc += weight;
420 double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
421 cat->payload->update (cat->aux1, cat->aux2, node->user_data, c, weight);
427 /* Return the number of categories (distinct values) for interction N */
429 categoricals_n_count (const struct categoricals *cat, size_t n)
431 return hmap_count (&cat->iap[n].ivmap);
436 categoricals_df (const struct categoricals *cat, size_t n)
438 const struct interact_params *iap = &cat->iap[n];
439 return iap->df_prod[iap->iact->n_vars - 1];
443 /* Return the total number of categories */
445 categoricals_n_total (const struct categoricals *cat)
447 if (!categoricals_is_complete (cat))
450 return cat->n_cats_total;
454 categoricals_df_total (const struct categoricals *cat)
460 categoricals_is_complete (const struct categoricals *cat)
462 return (NULL != cat->reverse_variable_map_short);
466 /* This function must be called *before* any call to categoricals_get_*_by subscript and
467 *after* all calls to categoricals_update */
469 categoricals_done (const struct categoricals *cat_)
471 /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
472 uses it will be more efficient that using a tree based structure, since it
473 is called only once, and means that subsequent lookups will be O(1).
475 1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
477 struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
483 cat->n_cats_total = 0;
485 /* Calculate the degrees of freedom, and the number of categories */
486 for (i = 0 ; i < cat->n_iap; ++i)
489 const struct interaction *iact = cat->iap[i].iact;
491 cat->iap[i].df_prod = iact->n_vars ? xcalloc (iact->n_vars, sizeof (int)) : NULL;
493 cat->iap[i].n_cats = 1;
495 for (v = 0 ; v < iact->n_vars; ++v)
497 const struct variable *var = iact->vars[v];
499 struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
501 if (hmap_count (&vn->valmap) == 0)
507 cat->iap[i].df_prod[v] = df * (hmap_count (&vn->valmap) - 1);
508 df = cat->iap[i].df_prod[v];
510 cat->iap[i].n_cats *= hmap_count (&vn->valmap);
513 assert (v == iact->n_vars);
515 cat->df_sum += cat->iap[i].df_prod [v - 1];
517 cat->n_cats_total += cat->iap[i].n_cats;
521 cat->reverse_variable_map_short = pool_calloc (cat->pool,
523 sizeof *cat->reverse_variable_map_short);
525 cat->reverse_variable_map_long = pool_calloc (cat->pool,
527 sizeof *cat->reverse_variable_map_long);
529 for (i = 0 ; i < cat->n_iap; ++i)
531 struct interaction_value *ivn = NULL;
534 struct interact_params *iap = &cat->iap[i];
536 iap->base_subscript_short = idx_short;
537 iap->base_subscript_long = idx_long;
539 iap->reverse_interaction_value_map = pool_calloc (cat->pool, iap->n_cats,
540 sizeof *iap->reverse_interaction_value_map);
542 HMAP_FOR_EACH (ivn, struct interaction_value, node, &iap->ivmap)
544 iap->reverse_interaction_value_map[x++] = ivn;
548 assert (x <= iap->n_cats);
550 /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
551 sort (iap->reverse_interaction_value_map, x, sizeof (*iap->reverse_interaction_value_map),
552 compare_interaction_value_3way, iap);
554 /* Fill the remaining values with null */
555 for (ii = x ; ii < iap->n_cats; ++ii)
556 iap->reverse_interaction_value_map[ii] = NULL;
558 /* Populate the reverse variable maps. */
561 for (ii = 0; ii < iap->df_prod [iap->iact->n_vars - 1]; ++ii)
562 cat->reverse_variable_map_short[idx_short++] = i;
565 for (ii = 0; ii < iap->n_cats; ++ii)
566 cat->reverse_variable_map_long[idx_long++] = i;
569 assert (cat->n_vars <= cat->n_iap);
571 categoricals_dump (cat);
573 /* Tally up the sums for all the encodings */
574 for (i = 0 ; i < cat->n_iap; ++i)
577 struct interact_params *iap = &cat->iap[i];
578 const struct interaction *iact = iap->iact;
580 const int df = iap->df_prod ? iap->df_prod [iact->n_vars - 1] : 0;
582 iap->enc_sum = xcalloc (df, sizeof (*(iap->enc_sum)));
584 for (y = 0; y < hmap_count (&iap->ivmap); ++y)
586 struct interaction_value *iv = iap->reverse_interaction_value_map[y];
587 for (x = iap->base_subscript_short; x < iap->base_subscript_short + df ;++x)
589 const double bin = categoricals_get_code_for_case (cat, x, iv->ccase); \
590 iap->enc_sum [x - iap->base_subscript_short] += bin * iv->cc;
592 if (cat->payload && cat->payload->calculate)
593 cat->payload->calculate (cat->aux1, cat->aux2, iv->user_data);
602 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
604 assert (cat->reverse_variable_map_short);
605 assert (subscript >= 0);
606 assert (subscript < cat->df_sum);
608 return cat->reverse_variable_map_short[subscript];
612 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
614 assert (cat->reverse_variable_map_long);
615 assert (subscript >= 0);
616 assert (subscript < cat->n_cats_total);
618 return cat->reverse_variable_map_long[subscript];
622 /* Return the interaction corresponding to SUBSCRIPT */
623 const struct interaction *
624 categoricals_get_interaction_by_subscript (const struct categoricals *cat, int subscript)
626 int index = reverse_variable_lookup_short (cat, subscript);
628 return cat->iap[index].iact;
632 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
634 int vindex = reverse_variable_lookup_short (cat, subscript);
635 const struct interact_params *vp = &cat->iap[vindex];
641 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
643 int vindex = reverse_variable_lookup_short (cat, subscript);
644 const struct interact_params *vp = &cat->iap[vindex];
646 return vp->enc_sum[subscript - vp->base_subscript_short];
649 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
650 for that subscript */
652 categoricals_get_code_for_case (const struct categoricals *cat, int subscript,
653 const struct ccase *c)
655 const struct interaction *iact = categoricals_get_interaction_by_subscript (cat, subscript);
657 const int i = reverse_variable_lookup_short (cat, subscript);
659 const int base_index = cat->iap[i].base_subscript_short;
664 const struct interact_params *iap = &cat->iap[i];
667 for (v = 0; v < iact->n_vars; ++v)
669 const struct variable *var = iact->vars[v];
671 const union value *val = case_data (c, var);
672 const int width = var_get_width (var);
673 const struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
675 const unsigned int hash = value_hash (val, width, 0);
676 const struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
680 const double df = iap->df_prod[v] / dfp;
682 /* Translate the subscript into an index for the individual variable */
683 const int index = ((subscript - base_index) % iap->df_prod[v] ) / dfp;
684 dfp = iap->df_prod [v];
687 if ( valn->index == df )
691 if ( valn->index != index )
702 categoricals_get_n_variables (const struct categoricals *cat)
704 printf ("%s\n", __FUNCTION__);
709 /* Return a case containing the set of values corresponding to
710 the Nth Category of the IACTth interaction */
712 categoricals_get_case_by_category_real (const struct categoricals *cat, int iact, int n)
714 const struct interaction_value *vn;
716 const struct interact_params *vp = &cat->iap[iact];
718 if ( n >= hmap_count (&vp->ivmap))
721 vn = vp->reverse_interaction_value_map [n];
726 /* Return a the user data corresponding to the Nth Category of the IACTth interaction. */
728 categoricals_get_user_data_by_category_real (const struct categoricals *cat, int iact, int n)
730 const struct interact_params *vp = &cat->iap[iact];
731 const struct interaction_value *iv ;
733 if ( n >= hmap_count (&vp->ivmap))
736 iv = vp->reverse_interaction_value_map [n];
738 return iv->user_data;
743 /* Return a case containing the set of values corresponding to SUBSCRIPT */
745 categoricals_get_case_by_category (const struct categoricals *cat, int subscript)
747 int vindex = reverse_variable_lookup_long (cat, subscript);
748 const struct interact_params *vp = &cat->iap[vindex];
749 const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
755 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
757 int vindex = reverse_variable_lookup_long (cat, subscript);
758 const struct interact_params *vp = &cat->iap[vindex];
760 const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
761 return iv->user_data;
768 categoricals_set_payload (struct categoricals *cat, const struct payload *p,
769 const void *aux1, void *aux2)