Constness
[pspp] / src / language / stats / glm.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 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 <gsl/gsl_cdf.h>
20 #include <gsl/gsl_matrix.h>
21 #include <math.h>
22
23 #include "data/case.h"
24 #include "data/casegrouper.h"
25 #include "data/casereader.h"
26 #include "data/dataset.h"
27 #include "data/dictionary.h"
28 #include "data/format.h"
29 #include "data/value.h"
30 #include "language/command.h"
31 #include "language/dictionary/split-file.h"
32 #include "language/lexer/lexer.h"
33 #include "language/lexer/value-parser.h"
34 #include "language/lexer/variable-parser.h"
35 #include "libpspp/ll.h"
36 #include "libpspp/message.h"
37 #include "libpspp/misc.h"
38 #include "libpspp/taint.h"
39 #include "linreg/sweep.h"
40 #include "math/categoricals.h"
41 #include "math/covariance.h"
42 #include "math/interaction.h"
43 #include "math/moments.h"
44 #include "output/tab.h"
45
46 #include "gettext.h"
47 #define _(msgid) gettext (msgid)
48
49 struct glm_spec
50 {
51   size_t n_dep_vars;
52   const struct variable **dep_vars;
53
54   size_t n_factor_vars;
55   const struct variable **factor_vars;
56
57   size_t n_interactions;
58   struct interaction **interactions;
59
60   enum mv_class exclude;
61
62   /* The weight variable */
63   const struct variable *wv;
64
65   const struct dictionary *dict;
66
67   bool intercept;
68
69   double alpha;
70 };
71
72 struct glm_workspace
73 {
74   double total_ssq;
75   struct moments *totals;
76
77   struct categoricals *cats;
78
79   /* 
80      Sums of squares due to different variables. Element 0 is the SSE
81      for the entire model. For i > 0, element i is the SS due to
82      variable i.
83    */
84   gsl_vector *ssq;
85 };
86
87 static void output_glm (const struct glm_spec *,
88                         const struct glm_workspace *ws);
89 static void run_glm (struct glm_spec *cmd, struct casereader *input,
90                      const struct dataset *ds);
91
92
93 static bool parse_design_spec (struct lexer *lexer, struct glm_spec *glm);
94
95
96 int
97 cmd_glm (struct lexer *lexer, struct dataset *ds)
98 {
99   int i;
100   struct const_var_set *factors = NULL;
101   struct glm_spec glm;
102   bool design = false;
103   glm.dict = dataset_dict (ds);
104   glm.n_dep_vars = 0;
105   glm.n_factor_vars = 0;
106   glm.n_interactions = 0;
107   glm.interactions = NULL;
108   glm.dep_vars = NULL;
109   glm.factor_vars = NULL;
110   glm.exclude = MV_ANY;
111   glm.intercept = true;
112   glm.wv = dict_get_weight (glm.dict);
113   glm.alpha = 0.05;
114
115   if (!parse_variables_const (lexer, glm.dict,
116                               &glm.dep_vars, &glm.n_dep_vars,
117                               PV_NO_DUPLICATE | PV_NUMERIC))
118     goto error;
119
120   lex_force_match (lexer, T_BY);
121
122   if (!parse_variables_const (lexer, glm.dict,
123                               &glm.factor_vars, &glm.n_factor_vars,
124                               PV_NO_DUPLICATE | PV_NUMERIC))
125     goto error;
126
127   if (glm.n_dep_vars > 1)
128     {
129       msg (ME, _("Multivariate analysis is not yet implemented"));
130       return CMD_FAILURE;
131     }
132
133   factors =
134     const_var_set_create_from_array (glm.factor_vars, glm.n_factor_vars);
135
136   while (lex_token (lexer) != T_ENDCMD)
137     {
138       lex_match (lexer, T_SLASH);
139
140       if (lex_match_id (lexer, "MISSING"))
141         {
142           lex_match (lexer, T_EQUALS);
143           while (lex_token (lexer) != T_ENDCMD
144                  && lex_token (lexer) != T_SLASH)
145             {
146               if (lex_match_id (lexer, "INCLUDE"))
147                 {
148                   glm.exclude = MV_SYSTEM;
149                 }
150               else if (lex_match_id (lexer, "EXCLUDE"))
151                 {
152                   glm.exclude = MV_ANY;
153                 }
154               else
155                 {
156                   lex_error (lexer, NULL);
157                   goto error;
158                 }
159             }
160         }
161       else if (lex_match_id (lexer, "INTERCEPT"))
162         {
163           lex_match (lexer, T_EQUALS);
164           while (lex_token (lexer) != T_ENDCMD
165                  && lex_token (lexer) != T_SLASH)
166             {
167               if (lex_match_id (lexer, "INCLUDE"))
168                 {
169                   glm.intercept = true;
170                 }
171               else if (lex_match_id (lexer, "EXCLUDE"))
172                 {
173                   glm.intercept = false;
174                 }
175               else
176                 {
177                   lex_error (lexer, NULL);
178                   goto error;
179                 }
180             }
181         }
182       else if (lex_match_id (lexer, "CRITERIA"))
183         {
184           lex_match (lexer, T_EQUALS);
185           if (lex_match_id (lexer, "ALPHA"))
186             {
187               if (lex_force_match (lexer, T_LPAREN))
188                 {
189                   if (! lex_force_num (lexer))
190                     {
191                       lex_error (lexer, NULL);
192                       goto error;
193                     }
194                   
195                   glm.alpha = lex_number (lexer);
196                   lex_get (lexer);
197                   if ( ! lex_force_match (lexer, T_RPAREN))
198                     {
199                       lex_error (lexer, NULL);
200                       goto error;
201                     }
202                 }
203             }
204           else
205             {
206               lex_error (lexer, NULL);
207               goto error;
208             }
209         }
210       else if (lex_match_id (lexer, "METHOD"))
211         {
212           lex_match (lexer, T_EQUALS);
213           if ( !lex_force_match_id (lexer, "SSTYPE"))
214             {
215               lex_error (lexer, NULL);
216               goto error;
217             }
218
219           if ( ! lex_force_match (lexer, T_LPAREN))
220             {
221               lex_error (lexer, NULL);
222               goto error;
223             }
224
225           if ( ! lex_force_int (lexer))
226             {
227               lex_error (lexer, NULL);
228               goto error;
229             }
230
231           if (3 != lex_integer (lexer))
232             {
233               msg (ME, _("Only type 3 sum of squares are currently implemented"));
234               goto error;
235             }
236
237           lex_get (lexer);
238
239           if ( ! lex_force_match (lexer, T_RPAREN))
240             {
241               lex_error (lexer, NULL);
242               goto error;
243             }
244         }
245       else if (lex_match_id (lexer, "DESIGN"))
246         {
247           lex_match (lexer, T_EQUALS);
248
249           if (! parse_design_spec (lexer, &glm))
250             goto error;
251           
252           if ( glm.n_interactions == 0)
253             {
254               msg (ME, _("One or more design  variables must be given"));
255               goto error;
256             }
257           
258           design = true;
259         }
260       else
261         {
262           lex_error (lexer, NULL);
263           goto error;
264         }
265     }
266
267   if ( ! design )
268     {
269       lex_error (lexer, _("/DESIGN is mandatory in GLM"));
270       goto error;
271     }
272
273   {
274     struct casegrouper *grouper;
275     struct casereader *group;
276     bool ok;
277
278     grouper = casegrouper_create_splits (proc_open (ds), glm.dict);
279     while (casegrouper_get_next_group (grouper, &group))
280       run_glm (&glm, group, ds);
281     ok = casegrouper_destroy (grouper);
282     ok = proc_commit (ds) && ok;
283   }
284
285   const_var_set_destroy (factors);
286   free (glm.factor_vars);
287   for (i = 0 ; i < glm.n_interactions; ++i)
288     interaction_destroy (glm.interactions[i]);
289   free (glm.interactions);
290   free (glm.dep_vars);
291
292
293   return CMD_SUCCESS;
294
295 error:
296
297   const_var_set_destroy (factors);
298   free (glm.factor_vars);
299   for (i = 0 ; i < glm.n_interactions; ++i)
300     interaction_destroy (glm.interactions[i]);
301
302   free (glm.interactions);
303   free (glm.dep_vars);
304
305   return CMD_FAILURE;
306 }
307
308 static void get_ssq (struct covariance *, gsl_vector *,
309                      const struct glm_spec *);
310
311 static bool
312 not_dropped (size_t j, size_t * dropped, size_t n_dropped)
313 {
314   size_t i;
315
316   for (i = 0; i < n_dropped; i++)
317     {
318       if (j == dropped[i])
319         return false;
320     }
321   return true;
322 }
323
324 static void
325 get_ssq (struct covariance *cov, gsl_vector *ssq, const struct glm_spec *cmd)
326 {
327   gsl_matrix *cm = covariance_calculate_unnormalized (cov);
328   size_t i;
329   size_t j;
330   size_t k;
331   size_t *dropped = xcalloc (covariance_dim (cov), sizeof (*dropped));
332   const struct categoricals *cats = covariance_get_categoricals (cov);
333
334   for (k = 0; k < cmd->n_interactions; k++)
335     {
336       size_t n = 0;
337       size_t m = 0;
338       gsl_matrix *small_cov = NULL;
339       size_t n_dropped = 0;
340       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
341         {
342           if (categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars)
343               == cmd->interactions[k])
344             {
345               assert (n_dropped < covariance_dim (cov));
346               dropped[n_dropped++] = i;
347             }
348         }
349       small_cov =
350         gsl_matrix_alloc (cm->size1 - n_dropped, cm->size2 - n_dropped);
351       gsl_matrix_set (small_cov, 0, 0, gsl_matrix_get (cm, 0, 0));
352       for (i = 0; i < cm->size1; i++)
353         {
354           if (not_dropped (i, dropped, n_dropped))
355             {
356               m = 0;
357               for (j = 0; j < cm->size2; j++)
358                 {
359                   if (not_dropped (j, dropped, n_dropped))
360                     {
361                       gsl_matrix_set (small_cov, n, m,
362                                       gsl_matrix_get (cm, i, j));
363                       m++;
364                     }
365                 }
366               n++;
367             }
368         }
369       reg_sweep (small_cov, 0);
370       gsl_vector_set (ssq, k + 1,
371                       gsl_matrix_get (small_cov, 0, 0)
372                       - gsl_vector_get (ssq, 0));
373       gsl_matrix_free (small_cov);
374     }
375
376   free (dropped);
377   gsl_matrix_free (cm);
378 }
379
380 //static  void dump_matrix (const gsl_matrix *m);
381
382 static void
383 run_glm (struct glm_spec *cmd, struct casereader *input,
384          const struct dataset *ds)
385 {
386   bool warn_bad_weight = true;
387   int v;
388   struct taint *taint;
389   struct dictionary *dict = dataset_dict (ds);
390   struct casereader *reader;
391   struct ccase *c;
392
393   struct glm_workspace ws;
394   struct covariance *cov;
395
396   ws.cats = categoricals_create (cmd->interactions, cmd->n_interactions,
397                                  cmd->wv, cmd->exclude,
398                                  NULL, NULL, NULL, NULL);
399
400   cov = covariance_2pass_create (cmd->n_dep_vars, cmd->dep_vars,
401                                  ws.cats, cmd->wv, cmd->exclude);
402
403
404   c = casereader_peek (input, 0);
405   if (c == NULL)
406     {
407       casereader_destroy (input);
408       return;
409     }
410   output_split_file_values (ds, c);
411   case_unref (c);
412
413   taint = taint_clone (casereader_get_taint (input));
414
415   ws.totals = moments_create (MOMENT_VARIANCE);
416
417   for (reader = casereader_clone (input);
418        (c = casereader_read (reader)) != NULL; case_unref (c))
419     {
420       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
421
422       for (v = 0; v < cmd->n_dep_vars; ++v)
423         moments_pass_one (ws.totals, case_data (c, cmd->dep_vars[v])->f,
424                           weight);
425
426       covariance_accumulate_pass1 (cov, c);
427     }
428   casereader_destroy (reader);
429
430   categoricals_done (ws.cats);
431
432   for (reader = input;
433        (c = casereader_read (reader)) != NULL; case_unref (c))
434     {
435       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
436
437       for (v = 0; v < cmd->n_dep_vars; ++v)
438         moments_pass_two (ws.totals, case_data (c, cmd->dep_vars[v])->f,
439                           weight);
440
441       covariance_accumulate_pass2 (cov, c);
442     }
443   casereader_destroy (reader);
444
445   {
446     gsl_matrix *cm = covariance_calculate_unnormalized (cov);
447
448     //    dump_matrix (cm);
449
450     ws.total_ssq = gsl_matrix_get (cm, 0, 0);
451
452     reg_sweep (cm, 0);
453
454     /*
455       Store the overall SSE.
456     */
457     ws.ssq = gsl_vector_alloc (cm->size1);
458     gsl_vector_set (ws.ssq, 0, gsl_matrix_get (cm, 0, 0));
459     get_ssq (cov, ws.ssq, cmd);
460     //    dump_matrix (cm);
461
462     gsl_matrix_free (cm);
463   }
464
465   if (!taint_has_tainted_successor (taint))
466     output_glm (cmd, &ws);
467
468   gsl_vector_free (ws.ssq);
469
470   covariance_destroy (cov);
471   moments_destroy (ws.totals);
472
473   taint_destroy (taint);
474 }
475
476 static void
477 output_glm (const struct glm_spec *cmd, const struct glm_workspace *ws)
478 {
479   const struct fmt_spec *wfmt =
480     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
481
482   double n_total, mean;
483   double df_corr = 0.0;
484   double mse = 0;
485
486   int f;
487   int r;
488   const int heading_columns = 1;
489   const int heading_rows = 1;
490   struct tab_table *t;
491
492   const int nc = 6;
493   int nr = heading_rows + 4 + cmd->n_interactions;
494   if (cmd->intercept)
495     nr++;
496
497   t = tab_create (nc, nr);
498   tab_title (t, _("Tests of Between-Subjects Effects"));
499
500   tab_headers (t, heading_columns, 0, heading_rows, 0);
501
502   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
503
504   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
505   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
506
507   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Source"));
508
509   /* TRANSLATORS: The parameter is a roman numeral */
510   tab_text_format (t, 1, 0, TAB_CENTER | TAT_TITLE,
511                    _("Type %s Sum of Squares"), "III");
512   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("df"));
513   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
514   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("F"));
515   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
516
517   moments_calculate (ws->totals, &n_total, &mean, NULL, NULL, NULL);
518
519   if (cmd->intercept)
520     df_corr += 1.0;
521
522   df_corr += categoricals_df_total (ws->cats);
523
524   mse = gsl_vector_get (ws->ssq, 0) / (n_total - df_corr);
525
526   r = heading_rows;
527   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Model"));
528
529   r++;
530
531   if (cmd->intercept)
532     {
533       const double intercept = pow2 (mean * n_total) / n_total;
534       const double df = 1.0;
535       const double F = intercept / df / mse;
536       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Intercept"));
537       tab_double (t, 1, r, 0, intercept, NULL);
538       tab_double (t, 2, r, 0, 1.00, wfmt);
539       tab_double (t, 3, r, 0, intercept / df, NULL);
540       tab_double (t, 4, r, 0, F, NULL);
541       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
542                   NULL);
543       r++;
544     }
545
546   for (f = 0; f < cmd->n_interactions; ++f)
547     {
548       struct string str = DS_EMPTY_INITIALIZER;
549       const double df = categoricals_df (ws->cats, f);
550       const double ssq = gsl_vector_get (ws->ssq, f + 1);
551       const double F = ssq / df / mse;
552       interaction_to_string (cmd->interactions[f], &str);
553       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
554       ds_destroy (&str);
555
556       tab_double (t, 1, r, 0, ssq, NULL);
557       tab_double (t, 2, r, 0, df, wfmt);
558       tab_double (t, 3, r, 0, ssq / df, NULL);
559       tab_double (t, 4, r, 0, F, NULL);
560
561       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
562                   NULL);
563       r++;
564     }
565
566   {
567     /* Corrected Model */
568     const double df = df_corr - 1.0;
569     const double ssq = ws->total_ssq - gsl_vector_get (ws->ssq, 0);
570     const double F = ssq / df / mse;
571     tab_double (t, 1, heading_rows, 0, ssq, NULL);
572     tab_double (t, 2, heading_rows, 0, df, wfmt);
573     tab_double (t, 3, heading_rows, 0, ssq / df, NULL);
574     tab_double (t, 4, heading_rows, 0, F, NULL);
575
576     tab_double (t, 5, heading_rows, 0,
577                 gsl_cdf_fdist_Q (F, df, n_total - df_corr), NULL);
578   }
579
580   {
581     const double df = n_total - df_corr;
582     const double ssq = gsl_vector_get (ws->ssq, 0);
583     const double mse = ssq / df;
584     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Error"));
585     tab_double (t, 1, r, 0, ssq, NULL);
586     tab_double (t, 2, r, 0, df, wfmt);
587     tab_double (t, 3, r++, 0, mse, NULL);
588   }
589
590   if (cmd->intercept)
591     {
592       const double intercept = pow2 (mean * n_total) / n_total;
593       const double ssq = intercept + ws->total_ssq;
594
595       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Total"));
596       tab_double (t, 1, r, 0, ssq, NULL);
597       tab_double (t, 2, r, 0, n_total, wfmt);
598
599       r++;
600     }
601
602   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Total"));
603
604
605   tab_double (t, 1, r, 0, ws->total_ssq, NULL);
606   tab_double (t, 2, r, 0, n_total - 1.0, wfmt);
607
608   tab_submit (t);
609 }
610
611 #if 0
612 static void
613 dump_matrix (const gsl_matrix * m)
614 {
615   size_t i, j;
616   for (i = 0; i < m->size1; ++i)
617     {
618       for (j = 0; j < m->size2; ++j)
619         {
620           double x = gsl_matrix_get (m, i, j);
621           printf ("%.3f ", x);
622         }
623       printf ("\n");
624     }
625   printf ("\n");
626 }
627 #endif
628
629
630 \f
631
632 /* Match a variable.
633    If the match succeeds, the variable will be placed in VAR.
634    Returns true if successful */
635 static bool
636 lex_match_variable (struct lexer *lexer, const struct glm_spec *glm, const struct variable **var)
637 {
638   if (lex_token (lexer) !=  T_ID)
639     return false;
640
641   *var = parse_variable_const  (lexer, glm->dict);
642
643   if ( *var == NULL)
644     return false;
645   return true;
646 }
647
648 /* An interaction is a variable followed by {*, BY} followed by an interaction */
649 static bool
650 parse_design_interaction (struct lexer *lexer, struct glm_spec *glm, struct interaction **iact)
651 {
652   const struct variable *v = NULL;
653   assert (iact);
654
655   switch  (lex_next_token (lexer, 1))
656     {
657     case T_ENDCMD:
658     case T_SLASH:
659     case T_COMMA:
660     case T_ID:
661     case T_BY:
662     case T_ASTERISK:
663       break;
664     default:
665       return false;
666       break;
667     }
668
669   if (! lex_match_variable (lexer, glm, &v))
670     {
671       interaction_destroy (*iact);
672       *iact = NULL;
673       return false;
674     }
675   
676   assert (v);
677
678   if ( *iact == NULL)
679     *iact = interaction_create (v);
680   else
681     interaction_add_variable (*iact, v);
682
683   if ( lex_match (lexer, T_ASTERISK) || lex_match (lexer, T_BY))
684     {
685       // lex_error (lexer, "Interactions are not yet implemented"); return false;
686       return parse_design_interaction (lexer, glm, iact);
687     }
688
689   return true;
690 }
691
692 static bool
693 parse_nested_variable (struct lexer *lexer, struct glm_spec *glm)
694 {
695   const struct variable *v = NULL;
696   if ( ! lex_match_variable (lexer, glm, &v))
697     return false;
698
699   if (lex_match (lexer, T_LPAREN))
700     {
701       if ( ! parse_nested_variable (lexer, glm))
702         return false;
703
704       if ( ! lex_force_match (lexer, T_RPAREN))
705         return false;
706     }
707
708   lex_error (lexer, "Nested variables are not yet implemented"); return false;  
709   return true;
710 }
711
712 /* A design term is an interaction OR a nested variable */
713 static bool
714 parse_design_term (struct lexer *lexer, struct glm_spec *glm)
715 {
716   struct interaction *iact = NULL;
717   if (parse_design_interaction (lexer, glm, &iact))
718     {
719       /* Interaction parsing successful.  Add to list of interactions */
720       glm->interactions = xrealloc (glm->interactions, sizeof *glm->interactions * ++glm->n_interactions);
721       glm->interactions[glm->n_interactions - 1] = iact;
722       return true;
723     }
724
725   if ( parse_nested_variable (lexer, glm))
726     return true;
727
728   return false;
729 }
730
731
732
733 /* Parse a complete DESIGN specification.
734    A design spec is a design term, optionally followed by a comma,
735    and another design spec.
736 */
737 static bool
738 parse_design_spec (struct lexer *lexer, struct glm_spec *glm)
739 {
740   if  (lex_token (lexer) == T_ENDCMD || lex_token (lexer) == T_SLASH)
741     return true;
742
743   if ( ! parse_design_term (lexer, glm))
744     return false;
745
746   lex_match (lexer, T_COMMA);
747
748   return parse_design_spec (lexer, glm);
749 }
750