b7e51751a5b8492fe1a5057d5b5c254577ecb879
[pspp-builds.git] / src / math / categoricals.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2009 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 <stdio.h>
20
21 #include "categoricals.h"
22
23 #include <gl/xalloc.h>
24 #include <data/variable.h>
25 #include <data/case.h>
26 #include <data/value.h>
27 #include <libpspp/hmap.h>
28 #include <libpspp/pool.h>
29
30 #include <libpspp/str.h>
31
32 struct value_node
33 {
34   struct hmap_node node;      /* Node in hash map. */
35   union value value;          /* The value being labeled. */
36   double cc;                  /* The total of the weights of cases with this value */
37   int subscript;              /* A zero based integer, unique within the variable.
38                                  Can be used as an index into an array */
39 };
40
41
42 struct var_params
43 {
44   /* A map indexed by a union values */
45   struct hmap map;
46
47   const struct variable *var;
48
49   int base_subscript;
50
51   /* The number of distinct values of this variable */
52   int n_cats;
53
54   /* A map of values indexed by subscript */
55   const struct value_node **reverse_value_map;
56
57   /* Total of the weights of this variable */
58   double cc; 
59 };
60
61
62 struct categoricals
63 {
64   /* The weight variable */
65   const struct variable *wv;
66
67
68   /* An array of var_params */
69   struct var_params *vp;
70
71   /* The size of VP. (ie, the number of variables involved.) */
72   size_t n_vp;
73
74   /* The number of categorical variables which contain entries.
75      In the absence of missing values, this will be equal to N_VP */
76   size_t n_vars;
77
78   /* A map to enable the lookup of variables indexed by subscript */
79   int *reverse_variable_map;
80
81   size_t n_cats_total;
82
83   struct pool *pool;
84
85   /* Missing values to be excluded */
86   enum mv_class exclude;
87 };
88
89
90 void
91 categoricals_destroy ( struct categoricals *cat)
92 {
93   int i;
94   for (i = 0 ; i < cat->n_vp; ++i)
95     hmap_destroy (&cat->vp[i].map);
96
97   pool_destroy (cat->pool);
98   free (cat);
99 }
100
101
102 void
103 categoricals_dump (const struct categoricals *cat)
104 {
105   int v;
106
107   for (v = 0 ; v < cat->n_vp; ++v)
108     {
109       const struct var_params *vp = &cat->vp[v];
110       const struct hmap *m = &vp->map;
111       struct hmap_node *node ;
112       int x;
113      
114       printf ("\n%s (%d)  CC=%g n_cats=%d:\n", 
115               var_get_name (vp->var), vp->base_subscript, vp->cc, vp->n_cats);
116
117       printf ("Reverse map\n");
118       for (x = 0 ; x < vp->n_cats; ++x)
119         {
120           struct string s;
121           const struct value_node *vn = vp->reverse_value_map[x];
122           ds_init_empty (&s);
123           var_append_value_name (vp->var, &vn->value, &s);
124           printf ("Value for %d is %s\n", x, ds_cstr(&s));
125           ds_destroy (&s);
126         }
127
128       printf ("\nForward map\n");
129       for (node = hmap_first (m); node; node = hmap_next (m, node))
130         {
131           struct string s;
132           ds_init_empty (&s);
133           const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
134           var_append_value_name (vp->var, &vn->value, &s);
135           printf ("Value: %s; Index %d; CC %g\n",
136                   ds_cstr (&s),
137                   vn->subscript, vn->cc);
138           ds_destroy (&s);
139         }
140     }
141
142   assert (cat->n_vars <= cat->n_vp);
143
144   printf ("\n");
145   printf ("Number of categorical variables: %d\n", cat->n_vp);
146   printf ("Number of non-empty categorical variables: %d\n", cat->n_vars);
147   printf ("Total number of categories: %d\n", cat->n_cats_total);
148 }
149
150
151
152 static struct value_node *
153 lookup_value (const struct hmap *map, const struct variable *var, const union value *val)
154 {
155   struct value_node *foo;
156   unsigned int width = var_get_width (var);
157   size_t hash = value_hash (val, width, 0);
158
159   HMAP_FOR_EACH_WITH_HASH (foo, struct value_node, node, hash, map)
160     {
161       if (value_equal (val, &foo->value, width))
162         break;
163
164       fprintf (stderr, "Warning: Hash table collision\n");
165     }
166
167   return foo;
168 }
169
170
171
172 struct categoricals *
173 categoricals_create (const struct variable **v, size_t n_vars,
174                      const struct variable *wv, enum mv_class exclude)
175 {
176   size_t i;
177   struct categoricals *cat = xmalloc (sizeof *cat);
178   
179   cat->n_vp = n_vars;
180   cat->wv = wv;
181   cat->n_cats_total = 0;
182   cat->n_vars = 0;
183   cat->reverse_variable_map = NULL;
184   cat->pool = pool_create ();
185   cat->exclude = exclude;
186
187   cat->vp = pool_calloc (cat->pool, cat->n_vp, sizeof *cat->vp);
188
189   for (i = 0 ; i < cat->n_vp; ++i)
190     {
191       hmap_init (&cat->vp[i].map);
192       cat->vp[i].var = v[i];
193     }
194
195   return cat;
196 }
197
198
199
200 void
201 categoricals_update (struct categoricals *cat, const struct ccase *c)
202 {
203   size_t i;
204   
205   const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
206
207   assert (NULL == cat->reverse_variable_map);
208
209   for (i = 0 ; i < cat->n_vp; ++i)
210     {
211       const struct variable *var = cat->vp[i].var;
212       unsigned int width = var_get_width (var);
213       const union value *val = case_data (c, var);
214       size_t hash;
215       struct value_node *node ;
216
217       if ( var_is_value_missing (var, val, cat->exclude))
218         continue;
219
220       hash = value_hash (val, width, 0);
221       node = lookup_value (&cat->vp[i].map, var, val);
222
223       if ( NULL == node)
224         {
225           node = pool_malloc (cat->pool, sizeof *node);
226
227           value_init (&node->value, width);
228           value_copy (&node->value, val, width);
229           node->cc = 0.0;
230
231           hmap_insert (&cat->vp[i].map, &node->node,  hash);
232           cat->n_cats_total++;
233           
234           if ( 0 == cat->vp[i].n_cats)
235             cat->n_vars++;
236
237           node->subscript = cat->vp[i].n_cats++ ;
238         }
239
240       node->cc += weight;
241       cat->vp[i].cc += weight;
242     }
243 }
244
245 /* Return the number of categories (distinct values) for variable N */
246 size_t
247 categoricals_n_count (const struct categoricals *cat, size_t n)
248 {
249   return hmap_count (&cat->vp[n].map);
250 }
251
252
253 /* Return the total number of categories */
254 size_t
255 categoricals_total (const struct categoricals *cat)
256 {
257   return cat->n_cats_total;
258 }
259
260
261 /* This function must be called *before* any call to categoricals_get_*_by subscript an
262  *after* all calls to categoricals_update */
263 void
264 categoricals_done (struct categoricals *cat)
265 {
266   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
267      uses it will be more efficient that using a tree based structure, since it
268      is called only once, and means that subsequent lookups will be O(1).
269
270      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
271   */
272   int v;
273   int idx = 0;
274   cat->reverse_variable_map = pool_calloc (cat->pool, cat->n_cats_total, sizeof *cat->reverse_variable_map);
275   
276   for (v = 0 ; v < cat->n_vp; ++v)
277     {
278       int i;
279       struct var_params *vp = &cat->vp[v];
280       int n_cats_total = categoricals_n_count (cat, v);
281       struct hmap_node *node ;
282
283       vp->reverse_value_map = pool_calloc (cat->pool, n_cats_total, sizeof *vp->reverse_value_map);
284
285       vp->base_subscript = idx;
286
287       for (node = hmap_first (&vp->map); node; node = hmap_next (&vp->map, node))
288         {
289           const struct value_node *vn = HMAP_DATA (node, struct value_node, node);
290           vp->reverse_value_map[vn->subscript] = vn;
291         }
292
293       for (i = 0; i < vp->n_cats; ++i)
294         cat->reverse_variable_map[idx++] = v;
295     }
296
297   assert (cat->n_vars <= cat->n_vp);
298 }
299
300
301
302 /* Return the categorical variable corresponding to SUBSCRIPT */
303 const struct variable *
304 categoricals_get_variable_by_subscript (const struct categoricals *cat, int subscript)
305 {
306   int index;
307
308   assert (cat->reverse_variable_map);
309   
310   index = cat->reverse_variable_map[subscript];
311
312   return cat->vp[index].var;
313 }
314
315
316 /* Return the value corresponding to SUBSCRIPT */
317 const union value *
318 categoricals_get_value_by_subscript (const struct categoricals *cat, int subscript)
319 {
320   int vindex = cat->reverse_variable_map[subscript];
321   const struct var_params *vp = &cat->vp[vindex];
322   const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
323
324   return &vn->value;
325 }
326
327
328 double
329 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
330 {
331   int vindex = cat->reverse_variable_map[subscript];
332   const struct var_params *vp = &cat->vp[vindex];
333
334   return vp->cc;
335 }
336
337 double
338 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
339 {
340   int vindex = cat->reverse_variable_map[subscript];
341   const struct var_params *vp = &cat->vp[vindex];
342
343   const struct value_node *vn = vp->reverse_value_map [subscript - vp->base_subscript];
344   return vn->cc;
345 }
346
347
348 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
349    for that subscript */
350 double
351 categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
352                                       const struct ccase *c)
353 {
354   const struct variable *var = categoricals_get_variable_by_subscript (cat, subscript);
355   int width = var_get_width (var);
356
357   const union value *val = case_data (c, var);
358
359   return value_equal (val, categoricals_get_value_by_subscript (cat, subscript), width);
360 }
361
362
363 size_t
364 categoricals_get_n_variables (const struct categoricals *cat)
365 {
366   return cat->n_vars;
367 }