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"
23 #include "data/case.h"
24 #include "data/value.h"
25 #include "data/variable.h"
26 #include "libpspp/array.h"
27 #include "libpspp/hmap.h"
28 #include "libpspp/pool.h"
29 #include "libpspp/str.h"
31 #include "gl/xalloc.h"
35 struct hmap_node node; /* Node in hash map. */
36 union value value; /* The value being labeled. */
37 double cc; /* The total of the weights of cases with this value */
39 void *user_data; /* A pointer to data which the caller can store stuff */
41 int subscript; /* A zero based integer, unique within the variable.
42 Can be used as an index into an array */
47 /* A map indexed by a union values */
50 const struct variable *var;
52 int base_subscript_short;
53 int base_subscript_long;
55 /* The number of distinct values of this variable */
58 /* A map of values indexed by subscript */
59 const struct value_node **reverse_value_map;
61 /* Total of the weights of this variable */
66 /* Comparison function to sort the reverse_value_map in ascending order */
68 compare_value_node (const void *vn1_, const void *vn2_, const void *aux)
70 const struct value_node * const *vn1 = vn1_;
71 const struct value_node * const *vn2 = vn2_;
72 const struct var_params *vp = aux;
74 return value_compare_3way (&(*vn1)->value, &(*vn2)->value, var_get_width (vp->var));
80 /* The weight variable */
81 const struct variable *wv;
84 /* An array of var_params */
85 struct var_params *vp;
87 /* The size of VP. (ie, the number of variables involved.) */
90 /* The number of categorical variables which contain entries.
91 In the absence of missing values, this will be equal to N_VP */
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_vp; ++i)
128 hmap_destroy (&cat->vp[i].map);
130 pool_destroy (cat->pool);
138 categoricals_dump (const struct categoricals *cat)
142 for (v = 0 ; v < cat->n_vp; ++v)
144 const struct var_params *vp = &cat->vp[v];
145 const struct hmap *m = &vp->map;
146 struct hmap_node *node ;
149 printf ("\n%s (%d) CC=%g n_cats=%d:\n",
150 var_get_name (vp->var), vp->base_subscript_long, vp->cc, vp->n_cats);
152 printf ("Reverse map\n");
153 for (x = 0 ; x < vp->n_cats; ++x)
156 const struct value_node *vn = vp->reverse_value_map[x];
158 var_append_value_name (vp->var, &vn->value, &s);
159 printf ("Value for %d is %s\n", x, ds_cstr(&s));
163 printf ("\nForward map\n");
164 for (node = hmap_first (m); node; node = hmap_next (m, node))
167 const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
169 var_append_value_name (vp->var, &vn->value, &s);
170 printf ("Value: %s; Index %d; CC %g\n",
172 vn->subscript, vn->cc);
177 assert (cat->n_vars <= cat->n_vp);
180 printf ("Number of categorical variables: %d\n", cat->n_vp);
181 printf ("Number of non-empty categorical variables: %d\n", cat->n_vars);
182 printf ("Total number of categories: %d\n", cat->n_cats_total);
184 printf ("\nReverse variable map (short):\n");
185 for (v = 0 ; v < cat->n_cats_total - cat->n_vars; ++v)
186 printf ("%d ", cat->reverse_variable_map_short[v]);
188 printf ("\nReverse variable map (long):\n");
189 for (v = 0 ; v < cat->n_cats_total; ++v)
190 printf ("%d ", cat->reverse_variable_map_long[v]);
198 static struct value_node *
199 lookup_value (const struct hmap *map, const struct variable *var, const union value *val)
201 struct value_node *foo;
202 unsigned int width = var_get_width (var);
203 size_t hash = value_hash (val, width, 0);
205 HMAP_FOR_EACH_WITH_HASH (foo, struct value_node, node, hash, map)
207 if (value_equal (val, &foo->value, width))
210 fprintf (stderr, "Warning: Hash table collision\n");
217 struct categoricals *
218 categoricals_create (const struct variable *const *v, size_t n_vars,
219 const struct variable *wv, enum mv_class exclude,
220 user_data_create_func *udf,
221 update_func *update, void *aux1, void *aux2
225 struct categoricals *cat = xmalloc (sizeof *cat);
229 cat->n_cats_total = 0;
231 cat->reverse_variable_map_short = NULL;
232 cat->reverse_variable_map_long = NULL;
233 cat->pool = pool_create ();
234 cat->exclude = exclude;
235 cat->update = update;
236 cat->user_data_create = udf;
242 cat->vp = pool_calloc (cat->pool, cat->n_vp, sizeof *cat->vp);
244 for (i = 0 ; i < cat->n_vp; ++i)
246 hmap_init (&cat->vp[i].map);
247 cat->vp[i].var = v[i];
256 categoricals_update (struct categoricals *cat, const struct ccase *c)
260 const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
262 assert (NULL == cat->reverse_variable_map_short);
263 assert (NULL == cat->reverse_variable_map_long);
265 for (i = 0 ; i < cat->n_vp; ++i)
267 const struct variable *var = cat->vp[i].var;
268 unsigned int width = var_get_width (var);
269 const union value *val = case_data (c, var);
271 struct value_node *node ;
273 if ( var_is_value_missing (var, val, cat->exclude))
276 hash = value_hash (val, width, 0);
277 node = lookup_value (&cat->vp[i].map, var, val);
281 node = pool_malloc (cat->pool, sizeof *node);
283 value_init (&node->value, width);
284 value_copy (&node->value, val, width);
287 hmap_insert (&cat->vp[i].map, &node->node, hash);
290 if ( 0 == cat->vp[i].n_cats)
293 node->subscript = cat->vp[i].n_cats++ ;
295 if (cat->user_data_create)
296 node->user_data = cat->user_data_create (cat->aux1, cat->aux2);
300 cat->vp[i].cc += weight;
303 cat->update (node->user_data, cat->exclude, cat->wv, var, c, cat->aux1, cat->aux2);
307 /* Return the number of categories (distinct values) for variable N */
309 categoricals_n_count (const struct categoricals *cat, size_t n)
311 return hmap_count (&cat->vp[n].map);
315 /* Return the total number of categories */
317 categoricals_total (const struct categoricals *cat)
319 return cat->n_cats_total;
323 /* This function must be called *before* any call to categoricals_get_*_by subscript and
324 *after* all calls to categoricals_update */
326 categoricals_done (const struct categoricals *cat_)
328 /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
329 uses it will be more efficient that using a tree based structure, since it
330 is called only once, and means that subsequent lookups will be O(1).
332 1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
334 struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
338 cat->reverse_variable_map_short = pool_calloc (cat->pool,
339 cat->n_cats_total - cat->n_vars,
340 sizeof *cat->reverse_variable_map_short);
342 cat->reverse_variable_map_long = pool_calloc (cat->pool,
344 sizeof *cat->reverse_variable_map_long);
346 for (v = 0 ; v < cat->n_vp; ++v)
349 struct var_params *vp = &cat->vp[v];
350 int n_cats_total = categoricals_n_count (cat, v);
351 struct hmap_node *node ;
353 vp->reverse_value_map = pool_calloc (cat->pool, n_cats_total, sizeof *vp->reverse_value_map);
355 vp->base_subscript_short = idx_short;
356 vp->base_subscript_long = idx_long;
358 for (node = hmap_first (&vp->map); node; node = hmap_next (&vp->map, node))
360 const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
361 vp->reverse_value_map[vn->subscript] = vn;
364 /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
365 sort (vp->reverse_value_map, vp->n_cats, sizeof (const struct value_node *),
366 compare_value_node, vp);
368 /* Populate the reverse variable maps. */
369 for (i = 0; i < vp->n_cats - 1; ++i)
370 cat->reverse_variable_map_short[idx_short++] = v;
372 for (i = 0; i < vp->n_cats; ++i)
373 cat->reverse_variable_map_long[idx_long++] = v;
376 assert (cat->n_vars <= cat->n_vp);
381 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
383 assert (cat->reverse_variable_map_short);
384 assert (subscript >= 0);
385 assert (subscript < cat->n_cats_total - cat->n_vars);
387 return cat->reverse_variable_map_short[subscript];
391 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
393 assert (cat->reverse_variable_map_long);
394 assert (subscript >= 0);
395 assert (subscript < cat->n_cats_total);
397 return cat->reverse_variable_map_long[subscript];
402 /* Return the categorical variable corresponding to SUBSCRIPT */
403 const struct variable *
404 categoricals_get_variable_by_subscript (const struct categoricals *cat, int subscript)
406 int index = reverse_variable_lookup_short (cat, subscript);
408 return cat->vp[index].var;
411 /* Return the value corresponding to SUBSCRIPT */
412 static const union value *
413 categoricals_get_value_by_subscript (const struct categoricals *cat, int subscript)
415 int vindex = reverse_variable_lookup_short (cat, subscript);
416 const struct var_params *vp = &cat->vp[vindex];
417 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_short];
424 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
426 int vindex = reverse_variable_lookup_short (cat, subscript);
427 const struct var_params *vp = &cat->vp[vindex];
433 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
435 int vindex = reverse_variable_lookup_short (cat, subscript);
436 const struct var_params *vp = &cat->vp[vindex];
438 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_short];
443 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
444 for that subscript */
446 categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
447 const struct ccase *c)
449 const struct variable *var = categoricals_get_variable_by_subscript (cat, subscript);
450 int width = var_get_width (var);
452 const union value *val = case_data (c, var);
454 return value_equal (val, categoricals_get_value_by_subscript (cat, subscript), width);
459 categoricals_get_n_variables (const struct categoricals *cat)
466 /* Return the value corresponding to SUBSCRIPT */
468 categoricals_get_value_by_category (const struct categoricals *cat, int subscript)
470 int vindex = reverse_variable_lookup_long (cat, subscript);
471 const struct var_params *vp = &cat->vp[vindex];
472 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_long];
479 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
481 int vindex = reverse_variable_lookup_long (cat, subscript);
482 const struct var_params *vp = &cat->vp[vindex];
484 const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript_long];
485 return vn->user_data;