Fix warnings
[pspp] / src / math / categoricals.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2009, 2010, 2011 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 struct value_node
36 {
37   struct hmap_node node;      /* Node in hash map. */
38
39   union value val;            /* The value */
40
41 };
42
43 struct interaction_value
44 {
45   struct hmap_node node;        /* Node in hash map. */
46
47   struct ccase *ccase;          /* A case (probably the first in the dataset) which matches this value */
48
49   /* Total of the weights of cases matching this interaction */
50   double cc; 
51
52   void *user_data;            /* A pointer to data which the caller can store stuff */
53 };
54
55 static struct value_node *
56 lookup_value (const struct hmap *map, const union value *val, unsigned int hash, int width)
57 {
58   struct value_node *vn = NULL;
59   HMAP_FOR_EACH_WITH_HASH (vn, struct value_node, node, hash, map)
60     {
61       if (value_equal (&vn->val, val, width))
62         break;
63     }
64   
65   return vn;
66 }
67
68 struct variable_node
69 {
70   struct hmap_node node;      /* Node in hash map. */
71   const struct variable *var; /* The variable */
72
73   struct hmap valmap;         /* A map of value nodes */
74 };
75
76 #if 0
77 static void
78 dump_interaction (const struct interaction *iact)
79 {
80   struct string str = DS_EMPTY_INITIALIZER;
81   interaction_to_string (iact, &str);
82   printf ("Interaction: %s\n", ds_cstr (&str));
83   ds_destroy (&str);
84 }
85 #endif
86
87
88 static struct variable_node *
89 lookup_variable (const struct hmap *map, const struct variable *var, unsigned int hash)
90 {
91   struct variable_node *vn = NULL;
92   HMAP_FOR_EACH_WITH_HASH (vn, struct variable_node, node, hash, map)
93     {
94       if (vn->var == var)
95         break;
96       
97       fprintf (stderr, "Warning: Hash table collision\n");
98     }
99   
100   return vn;
101 }
102
103
104 struct interact_params
105 {
106   /* A map indexed by a interaction_value */
107   struct hmap ivmap;
108
109   const struct interaction *iact;
110
111   int base_subscript_short;
112   int base_subscript_long;
113
114   /* The number of distinct values of this interaction */
115   int n_cats;
116
117   /* The degrees of freedom for this interaction */
118   int df; 
119
120   /* A map of interaction_values indexed by subscript */
121   struct interaction_value **reverse_interaction_value_map;
122
123   double cc;
124 };
125
126
127 /* Comparison function to sort the reverse_value_map in ascending order */
128 static int
129 compare_interaction_value_3way (const void *vn1_, const void *vn2_, const void *aux)
130 {
131   const struct interaction_value *const *vn1p = vn1_;
132   const struct interaction_value *const *vn2p = vn2_;
133
134   const struct interact_params *iap = aux;
135
136   return interaction_case_cmp_3way (iap->iact, (*vn1p)->ccase, (*vn2p)->ccase);
137 }
138
139 struct categoricals
140 {
141   /* The weight variable */
142   const struct variable *wv;
143
144   /* An array of interact_params */
145   struct interact_params *iap;
146
147   /* Map whose members are the union of the variables which comprise IAP */
148   struct hmap varmap;
149
150   /* The size of IAP. (ie, the number of interactions involved.) */
151   size_t n_iap;
152
153   /* The number of categorical variables which contain entries.
154      In the absence of missing values, this will be equal to N_IAP */
155   size_t n_vars;
156
157   size_t df_sum;
158
159   /* A map to enable the lookup of variables indexed by subscript.
160      This map considers only the N - 1 of the N variables.
161    */
162   int *reverse_variable_map_short;
163
164   /* Like the above, but uses all N variables */
165   int *reverse_variable_map_long;
166
167   size_t n_cats_total;
168
169   struct pool *pool;
170
171   /* Missing values to be excluded */
172   enum mv_class exclude;
173
174   /* Function to be called on each update */
175   update_func *update;
176
177   /* Function specified by the caller to create user_data */
178   user_data_create_func *user_data_create;
179
180   /* Auxilliary data to be passed to update and user_data_create_func*/
181   void *aux1;
182   void *aux2;
183 };
184
185 #if 0
186 static void
187 categoricals_dump (const struct categoricals *cat)
188 {
189   int i;
190
191   printf ("Reverse Variable Map (short):\n");
192   for (i = 0; i < cat->df_sum; ++i)
193     {
194       printf (" %d", cat->reverse_variable_map_short[i]);
195     }
196   printf ("\n");
197
198   printf ("Reverse Variable Map (long):\n");
199   for (i = 0; i < cat->n_cats_total; ++i)
200     {
201       printf (" %d", cat->reverse_variable_map_long[i]);
202     }
203   printf ("\n");
204
205
206   printf ("Number of interactions %d\n", cat->n_iap);
207   for (i = 0 ; i < cat->n_iap; ++i)
208     {
209       int v;
210       struct string str;
211       const struct interact_params *iap = &cat->iap[i];
212       const struct interaction *iact = iap->iact;
213
214       ds_init_empty (&str);
215       interaction_to_string (iact, &str);
216
217       printf ("\nInteraction: %s (n: %d; df: %d ); ", ds_cstr (&str), iap->n_cats, iap->df);
218       ds_destroy (&str);
219       printf ("Base subscript: %d\n", iap->base_subscript_short);
220
221       printf ("\t(");
222       for (v = 0; v < hmap_count (&iap->ivmap); ++v)
223         {
224           int vv;
225           const struct interaction_value *iv = iap->reverse_interaction_value_map[v];
226           
227           if (v > 0)  printf ("   ");
228           printf ("{");
229           for (vv = 0; vv < iact->n_vars; ++vv)
230             {
231               const struct variable *var = iact->vars[vv];
232               const union value *val = case_data (iv->ccase, var);
233               
234               printf ("%g", val->f);
235               if (vv < iact->n_vars - 1)
236                 printf (", ");
237             }
238           printf ("}");
239         }
240       printf (")\n");
241     }
242 }
243 #endif
244
245 void
246 categoricals_destroy (struct categoricals *cat)
247 {
248   struct variable_node *vn = NULL;
249   int i;
250   if (NULL == cat)
251     return;
252   for (i = 0; i < cat->n_iap; ++i)
253     {
254       struct interaction_value *iv = NULL;
255       /* Interate over each interaction value, and unref any cases that we reffed */
256       HMAP_FOR_EACH (iv, struct interaction_value, node, &cat->iap[i].ivmap)
257         {
258           case_unref (iv->ccase);
259         }
260       hmap_destroy (&cat->iap[i].ivmap);
261     }
262
263   /* Interate over each variable and delete its value map */
264   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
265     {
266       hmap_destroy (&vn->valmap);
267     }
268
269   hmap_destroy (&cat->varmap);
270
271   pool_destroy (cat->pool);
272
273   free (cat);
274 }
275
276
277
278 static struct interaction_value *
279 lookup_case (const struct hmap *map, const struct interaction *iact, const struct ccase *c)
280 {
281   struct interaction_value *iv = NULL;
282   size_t hash = interaction_case_hash (iact, c);
283
284   HMAP_FOR_EACH_WITH_HASH (iv, struct interaction_value, node, hash, map)
285     {
286       if (interaction_case_equal (iact, c, iv->ccase))
287         break;
288
289       fprintf (stderr, "Warning: Hash table collision\n");
290     }
291
292   return iv;
293 }
294
295
296 struct categoricals *
297 categoricals_create (struct interaction *const*inter, size_t n_inter,
298                      const struct variable *wv, enum mv_class exclude,
299                      user_data_create_func *udf,
300                      update_func *update, void *aux1, void *aux2
301                      )
302 {
303   size_t i;
304   struct categoricals *cat = xmalloc (sizeof *cat);
305   
306   cat->n_iap = n_inter;
307   cat->wv = wv;
308   cat->n_cats_total = 0;
309   cat->n_vars = 0;
310   cat->reverse_variable_map_short = NULL;
311   cat->reverse_variable_map_long = NULL;
312   cat->pool = pool_create ();
313   cat->exclude = exclude;
314   cat->update = update;
315   cat->user_data_create = udf;
316
317   cat->aux1 = aux1;
318   cat->aux2 = aux2;
319
320   cat->iap = pool_calloc (cat->pool, cat->n_iap, sizeof *cat->iap);
321
322   hmap_init (&cat->varmap);
323   for (i = 0 ; i < cat->n_iap; ++i)
324     {
325       int v;
326       hmap_init (&cat->iap[i].ivmap);
327       cat->iap[i].iact = inter[i];
328       cat->iap[i].cc = 0.0;
329       for (v = 0; v < inter[i]->n_vars; ++v)
330         {
331           const struct variable *var = inter[i]->vars[v];
332           unsigned int hash = hash_pointer (var, 0);
333           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash);
334           if (vn == NULL)
335             {
336               vn = pool_malloc (cat->pool, sizeof *vn);
337               vn->var = var;
338               hmap_init (&vn->valmap);
339
340               hmap_insert (&cat->varmap, &vn->node,  hash);
341             }
342         }
343     }
344
345   return cat;
346 }
347
348
349
350 void
351 categoricals_update (struct categoricals *cat, const struct ccase *c)
352 {
353   int i;
354   struct variable_node *vn = NULL;
355   const double weight = cat->wv ? case_data (c, cat->wv)->f : 1.0;
356
357   assert (NULL == cat->reverse_variable_map_short);
358   assert (NULL == cat->reverse_variable_map_long);
359
360   /* Interate over each variable, and add the value of that variable
361      to the appropriate map, if it's not already present. */
362   HMAP_FOR_EACH (vn, struct variable_node, node, &cat->varmap)
363     {
364       const int width = var_get_width (vn->var);
365       const union value *val = case_data (c, vn->var);
366       unsigned int hash = value_hash (val, width, 0);
367
368       struct value_node *valn = lookup_value (&vn->valmap, val, hash, width);
369       if (valn == NULL)
370         {
371           valn = pool_malloc (cat->pool, sizeof *valn);
372           value_init (&valn->val, width);
373           value_copy (&valn->val, val, width);
374           hmap_insert (&vn->valmap, &valn->node, hash);
375         }
376     }     
377   
378
379   for (i = 0 ; i < cat->n_iap; ++i)
380     {
381       const struct interaction *iact = cat->iap[i].iact;
382
383       //      if ( interaction_case_is_missing (iact, c, cat->exclude))
384       //         continue;
385
386       size_t hash = interaction_case_hash (iact, c);
387       struct interaction_value *node = lookup_case (&cat->iap[i].ivmap, iact, c);
388
389       if ( NULL == node)
390         {
391           node = pool_malloc (cat->pool, sizeof *node);
392
393           node->ccase = case_ref (c);
394           node->cc = weight;
395
396           hmap_insert (&cat->iap[i].ivmap, &node->node, hash);
397
398           if (cat->user_data_create)
399             node->user_data = cat->user_data_create (cat->aux1, cat->aux2);
400         }
401       else
402         {
403           node->cc += weight;
404         }
405       cat->iap[i].cc += weight;
406
407       if (cat->update)
408         cat->update (node->user_data, cat->exclude, cat->wv, NULL, c, cat->aux1, cat->aux2);
409     }
410 }
411
412 /* Return the number of categories (distinct values) for interction N */
413 size_t
414 categoricals_n_count (const struct categoricals *cat, size_t n)
415 {
416   return hmap_count (&cat->iap[n].ivmap);
417 }
418
419
420 size_t
421 categoricals_df (const struct categoricals *cat, size_t n)
422 {
423   return cat->iap[n].df;
424 }
425
426
427 /* Return the total number of categories */
428 size_t
429 categoricals_n_total (const struct categoricals *cat)
430 {
431   assert (cat->reverse_variable_map_long);
432
433   return cat->n_cats_total;
434 }
435
436 size_t
437 categoricals_df_total (const struct categoricals *cat)
438 {
439   return cat->df_sum;
440 }
441
442 /* This function must be called *before* any call to categoricals_get_*_by subscript and
443  *after* all calls to categoricals_update */
444 void
445 categoricals_done (const struct categoricals *cat_)
446 {
447   /* Implementation Note: Whilst this function is O(n) in cat->n_cats_total, in most
448      uses it will be more efficient that using a tree based structure, since it
449      is called only once, and means that subsequent lookups will be O(1).
450
451      1 call of O(n) + 10^9 calls of O(1) is better than 10^9 calls of O(log n).
452   */
453   struct categoricals *cat = CONST_CAST (struct categoricals *, cat_);
454   int v;
455   int i;
456   int idx_short = 0;
457   int idx_long = 0;
458   cat->df_sum = 0;
459   cat->n_cats_total = 0;
460
461   /* Calculate the degrees of freedom, and the number of categories */
462   for (i = 0 ; i < cat->n_iap; ++i)
463     {
464       const struct interaction *iact = cat->iap[i].iact;
465
466       cat->iap[i].df = 1;
467       cat->iap[i].n_cats = 1;
468
469       for (v = 0 ; v < iact->n_vars; ++v)
470         {
471           const struct variable *var = iact->vars[v];
472
473           struct variable_node *vn = lookup_variable (&cat->varmap, var, hash_pointer (var, 0));
474
475           cat->iap[i].df *= hmap_count (&vn->valmap) - 1;
476           cat->iap[i].n_cats *= hmap_count (&vn->valmap);
477         }
478
479       cat->df_sum += cat->iap[i].df;
480       cat->n_cats_total += cat->iap[i].n_cats;
481     }
482
483
484   cat->reverse_variable_map_short = pool_calloc (cat->pool,
485                                                  cat->df_sum,
486                                                  sizeof *cat->reverse_variable_map_short);
487
488   cat->reverse_variable_map_long = pool_calloc (cat->pool,
489                                                 cat->n_cats_total,
490                                                 sizeof *cat->reverse_variable_map_long);
491
492   for (i = 0 ; i < cat->n_iap; ++i)
493     {
494       struct interaction_value *ivn = NULL;
495       int x = 0;
496       int ii;
497       struct interact_params *iap = &cat->iap[i];
498
499       iap->base_subscript_short = idx_short;
500       iap->base_subscript_long = idx_long;
501
502       iap->reverse_interaction_value_map = pool_calloc (cat->pool, iap->n_cats,
503                                                         sizeof *iap->reverse_interaction_value_map);
504
505       HMAP_FOR_EACH (ivn, struct interaction_value, node, &iap->ivmap)
506         {
507           iap->reverse_interaction_value_map[x++] = ivn;
508         }
509
510       assert (x <= iap->n_cats);
511
512       /* For some purposes (eg CONTRASTS in ONEWAY) the values need to be sorted */
513       sort (iap->reverse_interaction_value_map, x, sizeof (*iap->reverse_interaction_value_map),
514             compare_interaction_value_3way, iap);
515
516       /* Fill the remaining values with null */
517       for (ii = x ; ii < iap->n_cats; ++ii)
518         iap->reverse_interaction_value_map[ii] = NULL;
519
520       /* Populate the reverse variable maps. */
521       for (ii = 0; ii < iap->df; ++ii)
522         cat->reverse_variable_map_short[idx_short++] = i;
523
524       for (ii = 0; ii < iap->n_cats; ++ii)
525         cat->reverse_variable_map_long[idx_long++] = i;
526     }
527
528   assert (cat->n_vars <= cat->n_iap);
529
530   //  categoricals_dump (cat);
531 }
532
533
534 static int
535 reverse_variable_lookup_short (const struct categoricals *cat, int subscript)
536 {
537   assert (cat->reverse_variable_map_short);
538   assert (subscript >= 0);
539   assert (subscript < cat->df_sum);
540
541   return cat->reverse_variable_map_short[subscript];
542 }
543
544 static int
545 reverse_variable_lookup_long (const struct categoricals *cat, int subscript)
546 {
547   assert (cat->reverse_variable_map_long);
548   assert (subscript >= 0);
549   assert (subscript < cat->n_cats_total);
550
551   return cat->reverse_variable_map_long[subscript];
552 }
553
554
555 /* Return the interaction corresponding to SUBSCRIPT */
556 const struct interaction *
557 categoricals_get_interaction_by_subscript (const struct categoricals *cat, int subscript)
558 {
559   int index = reverse_variable_lookup_short (cat, subscript);
560
561   return cat->iap[index].iact;
562 }
563
564
565 /* Return the case corresponding to SUBSCRIPT */
566 static const struct ccase *
567 categoricals_get_case_by_subscript (const struct categoricals *cat, int subscript)
568 {
569   int vindex = reverse_variable_lookup_short (cat, subscript);
570   const struct interact_params *vp = &cat->iap[vindex];
571   const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_short];
572
573   if ( vn == NULL)
574     return NULL;
575
576   return vn->ccase;
577 }
578
579
580 double
581 categoricals_get_weight_by_subscript (const struct categoricals *cat, int subscript)
582 {
583   int vindex = reverse_variable_lookup_short (cat, subscript);
584   const struct interact_params *vp = &cat->iap[vindex];
585
586   return vp->cc;
587 }
588
589 double
590 categoricals_get_sum_by_subscript (const struct categoricals *cat, int subscript)
591 {
592   int vindex = reverse_variable_lookup_short (cat, subscript);
593   const struct interact_params *vp = &cat->iap[vindex];
594
595   const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_short];
596
597   if (iv == NULL)
598     return 0;
599
600   return iv->cc;
601 }
602
603 /* Returns unity if the value in case C at SUBSCRIPT is equal to the category
604    for that subscript */
605 double
606 categoricals_get_binary_by_subscript (const struct categoricals *cat, int subscript,
607                                       const struct ccase *c)
608 {
609   const struct interaction *iact = categoricals_get_interaction_by_subscript (cat, subscript);
610
611   const struct ccase *c2 =  categoricals_get_case_by_subscript (cat, subscript);
612
613   if ( c2 == NULL)
614     return 0;
615
616   return interaction_case_equal (iact, c, c2);
617 }
618
619
620 size_t
621 categoricals_get_n_variables (const struct categoricals *cat)
622 {
623   printf ("%s\n", __FUNCTION__);
624   return cat->n_vars;
625 }
626
627 /* Return a case containing the set of values corresponding to SUBSCRIPT */
628 const struct ccase *
629 categoricals_get_case_by_category (const struct categoricals *cat, int subscript)
630 {
631   int vindex = reverse_variable_lookup_long (cat, subscript);
632   const struct interact_params *vp = &cat->iap[vindex];
633   const struct interaction_value *vn = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
634
635   return vn->ccase;
636 }
637
638 void *
639 categoricals_get_user_data_by_category (const struct categoricals *cat, int subscript)
640 {
641   int vindex = reverse_variable_lookup_long (cat, subscript);
642   const struct interact_params *vp = &cat->iap[vindex];
643
644   const struct interaction_value *iv = vp->reverse_interaction_value_map [subscript - vp->base_subscript_long];
645   return iv->user_data;
646 }