1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 2009, 2010, 2011 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"
32 #include "gl/xalloc.h"
36 struct hmap_node node; /* Node in hash map. */
38 double cc; /* The total of the weights of cases with this value */
40 void *user_data; /* A pointer to data which the caller can store stuff */
42 int subscript; /* A zero based integer, unique within the variable.
43 Can be used as an index into an array */
46 struct interact_params
48 /* A map indexed by a union values */
51 const struct interaction *iact;
53 int base_subscript_short;
54 int base_subscript_long;
56 /* The number of distinct values of this variable */
59 /* A map of values indexed by subscript */
60 const struct value_node **reverse_value_map;
62 /* Total of the weights of this variable */
67 /* Comparison function to sort the reverse_value_map in ascending order */
69 compare_value_node (const void *vn1_, const void *vn2_, const void *aux)
71 const struct value_node * const *vn1 = vn1_;
72 const struct value_node * const *vn2 = vn2_;
73 const struct interact_params *vp = aux;
75 return interaction_case_cmp_3way (vp->iact, (*vn1)->ccase, (*vn2)->ccase);
81 /* The weight variable */
82 const struct variable *wv;
84 /* An array of interact_params */
85 struct interact_params *iap;
87 /* The size of IAP. (ie, the number of interactions involved.) */
90 /* The number of categorical variables which contain entries.
91 In the absence of missing values, this will be equal to N_IAP */
94 /* A map to enable the lookup of variables indexed by subscript.
95 This map considers only the N - 1 of the N variables.
97 int *reverse_variable_map_short;
99 /* Like the above, but uses all N variables */
100 int *reverse_variable_map_long;
106 /* Missing values to be excluded */
107 enum mv_class exclude;
109 /* Function to be called on each update */
112 /* Function specified by the caller to create user_data */
113 user_data_create_func *user_data_create;
115 /* Auxilliary data to be passed to update and user_data_create_func*/
122 categoricals_destroy ( struct categoricals *cat)
127 for (i = 0 ; i < cat->n_iap; ++i)
129 struct hmap *map = &cat->iap[i].map;
130 struct value_node *nn;
132 HMAP_FOR_EACH (nn, struct value_node, node, map)
134 case_unref (nn->ccase);
140 pool_destroy (cat->pool);
148 categoricals_dump (const struct categoricals *cat)
152 for (v = 0 ; v < cat->n_iap; ++v)
154 const struct interact_params *vp = &cat->iap[v];
155 const struct hmap *m = &vp->map;
156 struct hmap_node *node ;
159 ds_init_empty (&str);
161 interaction_to_string (vp->iact, &str);
162 printf ("\n%s (%d) CC=%g n_cats=%d:\n",
164 vp->base_subscript_long, vp->cc, vp->n_cats);
167 printf ("Reverse map\n");
168 for (x = 0 ; x < vp->n_cats; ++x)
171 const struct value_node *vn = vp->reverse_value_map[x];
173 var_append_value_name (vp->var, &vn->value, &s);
174 printf ("Value for %d is %s\n", x, ds_cstr(&s));
178 printf ("\nForward map\n");
179 for (node = hmap_first (m); node; node = hmap_next (m, node))
182 const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
184 var_append_value_name (vp->var, &vn->value, &s);
185 printf ("Value: %s; Index %d; CC %g\n",
187 vn->subscript, vn->cc);
193 assert (cat->n_vars <= cat->n_iap);
196 printf ("Number of interactions: %d\n", cat->n_iap);
197 printf ("Number of non-empty categorical variables: %d\n", cat->n_vars);
198 printf ("Total number of categories: %d\n", cat->n_cats_total);
200 printf ("\nReverse variable map (short):\n");
201 for (v = 0 ; v < cat->n_cats_total - cat->n_vars; ++v)
202 printf ("%d ", cat->reverse_variable_map_short[v]);
204 printf ("\nReverse variable map (long):\n");
205 for (v = 0 ; v < cat->n_cats_total; ++v)
206 printf ("%d ", cat->reverse_variable_map_long[v]);
213 static struct value_node *
214 lookup_case (const struct hmap *map, const struct interaction *iact, const struct ccase *c)
216 struct value_node *nn;
217 size_t hash = interaction_case_hash (iact, c);
219 HMAP_FOR_EACH_WITH_HASH (nn, struct value_node, node, hash, map)
221 if (interaction_case_equal (iact, c, nn->ccase))
224 fprintf (stderr, "Warning: Hash table collision\n");
231 struct categoricals *
232 categoricals_create (const struct interaction **inter, size_t n_inter,
233 const struct variable *wv, enum mv_class exclude,
234 user_data_create_func *udf,
235 update_func *update, void *aux1, void *aux2
239 struct categoricals *cat = xmalloc (sizeof *cat);
241 cat->n_iap = n_inter;
243 cat->n_cats_total = 0;
245 cat->reverse_variable_map_short = NULL;
246 cat->reverse_variable_map_long = NULL;
247 cat->pool = pool_create ();
248 cat->exclude = exclude;
249 cat->update = update;
250 cat->user_data_create = udf;
256 cat->iap = pool_calloc (cat->pool, cat->n_iap, sizeof *cat->iap);
258 for (i = 0 ; i < cat->n_iap; ++i)
260 hmap_init (&cat->iap[i].map);
261 cat->iap[i].iact = inter[i];
270 categoricals_update (struct categoricals *cat, const struct ccase *c)
274 const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
276 assert (NULL == cat->reverse_variable_map_short);
277 assert (NULL == cat->reverse_variable_map_long);
279 for (i = 0 ; i < cat->n_iap; ++i)
281 const struct interaction *iact = cat->iap[i].iact;
283 struct value_node *node ;
285 if ( interaction_case_is_missing (iact, c, cat->exclude))
288 hash = interaction_case_hash (iact, c);
289 node = lookup_case (&cat->iap[i].map, iact, c);
293 node = pool_malloc (cat->pool, sizeof *node);
295 node->ccase = case_ref (c);
298 hmap_insert (&cat->iap[i].map, &node->node, hash);
301 if ( 0 == cat->iap[i].n_cats)
304 node->subscript = cat->iap[i].n_cats++ ;
306 if (cat->user_data_create)
307 node->user_data = cat->user_data_create (cat->aux1, cat->aux2);
311 cat->iap[i].cc += weight;
314 cat->update (node->user_data, cat->exclude, cat->wv, NULL, c, cat->aux1, cat->aux2);
318 /* Return the number of categories (distinct values) for variable N */
320 categoricals_n_count (const struct categoricals *cat, size_t n)
322 return hmap_count (&cat->iap[n].map);
326 /* Return the total number of categories */
328 categoricals_total (const struct categoricals *cat)
330 return cat->n_cats_total;
334 /* This function must be called *before* any call to categoricals_get_*_by subscript and
335 *after* all calls to categoricals_update */
337 categoricals_done (const struct categoricals *cat_)
339 /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
340 uses it will be more efficient that using a tree based structure, since it
341 is called only once, and means that subsequent lookups will be O(1).
343 1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
345 struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
349 cat->reverse_variable_map_short = pool_calloc (cat->pool,
350 cat->n_cats_total - cat->n_vars,
351 sizeof *cat->reverse_variable_map_short);
353 cat->reverse_variable_map_long = pool_calloc (cat->pool,
355 sizeof *cat->reverse_variable_map_long);
357 for (v = 0 ; v < cat->n_iap; ++v)
360 struct interact_params *vp = &cat->iap[v];
361 int n_cats_total = categoricals_n_count (cat, v);
362 struct hmap_node *node ;
364 vp->reverse_value_map = pool_calloc (cat->pool, n_cats_total, sizeof *vp->reverse_value_map);
366 vp->base_subscript_short = idx_short;
367 vp->base_subscript_long = idx_long;
369 for (node = hmap_first (&vp->map); node; node = hmap_next (&vp->map, node))
371 const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
372 vp->reverse_value_map[vn->subscript] = vn;
375 /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
376 sort (vp->reverse_value_map, vp->n_cats, sizeof (const struct value_node *),
377 compare_value_node, vp);
379 /* Populate the reverse variable maps. */
380 for (i = 0; i < vp->n_cats - 1; ++i)
381 cat->reverse_variable_map_short[idx_short++] = v;
383 for (i = 0; i < vp->n_cats; ++i)
384 cat->reverse_variable_map_long[idx_long++] = v;
387 assert (cat->n_vars <= cat->n_iap);
392 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
394 assert (cat->reverse_variable_map_short);
395 assert (subscript >= 0);
396 assert (subscript < cat->n_cats_total - cat->n_vars);
398 return cat->reverse_variable_map_short[subscript];
402 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
404 assert (cat->reverse_variable_map_long);
405 assert (subscript >= 0);
406 assert (subscript < cat->n_cats_total);
408 return cat->reverse_variable_map_long[subscript];
412 /* Return the interaction corresponding to SUBSCRIPT */
413 const struct interaction *
414 categoricals_get_interaction_by_subscript (const struct categoricals *cat, int subscript)
416 int index = reverse_variable_lookup_short (cat, subscript);
418 return cat->iap[index].iact;
422 /* Return the case corresponding to SUBSCRIPT */
423 static const struct ccase *
424 categoricals_get_case_by_subscript (const struct categoricals *cat, int subscript)
426 int vindex = reverse_variable_lookup_short (cat, subscript);
427 const struct interact_params *vp = &cat->iap[vindex];
428 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_short];
435 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
437 int vindex = reverse_variable_lookup_short (cat, subscript);
438 const struct interact_params *vp = &cat->iap[vindex];
444 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
446 int vindex = reverse_variable_lookup_short (cat, subscript);
447 const struct interact_params *vp = &cat->iap[vindex];
449 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_short];
454 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
455 for that subscript */
457 categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
458 const struct ccase *c)
460 const struct interaction *iact = categoricals_get_interaction_by_subscript (cat, subscript);
462 const struct ccase *c2 = categoricals_get_case_by_subscript (cat, subscript);
464 return interaction_case_equal (iact, c, c2);
469 categoricals_get_n_variables (const struct categoricals *cat)
475 /* Return a case containing the set of values corresponding to SUBSCRIPT */
477 categoricals_get_case_by_category (const struct categoricals *cat, int subscript)
479 int vindex = reverse_variable_lookup_long (cat, subscript);
480 const struct interact_params *vp = &cat->iap[vindex];
481 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_long];
488 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
490 int vindex = reverse_variable_lookup_long (cat, subscript);
491 const struct interact_params *vp = &cat->iap[vindex];
493 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_long];
494 return vn->user_data;