GLM: get_ssq: replace hardcoded 1 with cmd->n_dep_vars
[pspp-builds.git] / 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 variable **vars = xcalloc (covariance_dim (cov), sizeof (*vars));
333
334   covariance_get_var_indices (cov, vars);
335
336   for (k = 0; k < cmd->n_interactions; k++)
337     {
338       size_t n = 0;
339       size_t m = 0;
340       gsl_matrix *small_cov = NULL;
341       size_t n_dropped = 0;
342       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
343         {
344           if (vars[i] == cmd->interactions[k]->vars[0])
345             {
346               assert (n_dropped < covariance_dim (cov));
347               dropped[n_dropped++] = i;
348             }
349         }
350       small_cov =
351         gsl_matrix_alloc (cm->size1 - n_dropped, cm->size2 - n_dropped);
352       gsl_matrix_set (small_cov, 0, 0, gsl_matrix_get (cm, 0, 0));
353       for (i = 0; i < cm->size1; i++)
354         {
355           if (not_dropped (i, dropped, n_dropped))
356             {
357               m = 0;
358               for (j = 0; j < cm->size2; j++)
359                 {
360                   if (not_dropped (j, dropped, n_dropped))
361                     {
362                       gsl_matrix_set (small_cov, n, m,
363                                       gsl_matrix_get (cm, i, j));
364                       m++;
365                     }
366                 }
367               n++;
368             }
369         }
370       reg_sweep (small_cov, 0);
371       gsl_vector_set (ssq, k + 1,
372                       gsl_matrix_get (small_cov, 0, 0)
373                       - gsl_vector_get (ssq, 0));
374       gsl_matrix_free (small_cov);
375     }
376
377   free (dropped);
378   free (vars);
379   gsl_matrix_free (cm);
380 }
381
382 //static  void dump_matrix (const gsl_matrix *m);
383
384 static void
385 run_glm (struct glm_spec *cmd, struct casereader *input,
386          const struct dataset *ds)
387 {
388   bool warn_bad_weight = true;
389   int v;
390   struct taint *taint;
391   struct dictionary *dict = dataset_dict (ds);
392   struct casereader *reader;
393   struct ccase *c;
394
395   struct glm_workspace ws;
396   struct covariance *cov;
397
398   ws.cats = categoricals_create (cmd->interactions, cmd->n_interactions,
399                                  cmd->wv, cmd->exclude,
400                                  NULL, NULL, NULL, NULL);
401
402   cov = covariance_2pass_create (cmd->n_dep_vars, cmd->dep_vars,
403                                  ws.cats, cmd->wv, cmd->exclude);
404
405
406   c = casereader_peek (input, 0);
407   if (c == NULL)
408     {
409       casereader_destroy (input);
410       return;
411     }
412   output_split_file_values (ds, c);
413   case_unref (c);
414
415   taint = taint_clone (casereader_get_taint (input));
416
417   ws.totals = moments_create (MOMENT_VARIANCE);
418
419   for (reader = casereader_clone (input);
420        (c = casereader_read (reader)) != NULL; case_unref (c))
421     {
422       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
423
424       for (v = 0; v < cmd->n_dep_vars; ++v)
425         moments_pass_one (ws.totals, case_data (c, cmd->dep_vars[v])->f,
426                           weight);
427
428       covariance_accumulate_pass1 (cov, c);
429     }
430   casereader_destroy (reader);
431
432   categoricals_done (ws.cats);
433
434   for (reader = input;
435        (c = casereader_read (reader)) != NULL; case_unref (c))
436     {
437       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
438
439       for (v = 0; v < cmd->n_dep_vars; ++v)
440         moments_pass_two (ws.totals, case_data (c, cmd->dep_vars[v])->f,
441                           weight);
442
443       covariance_accumulate_pass2 (cov, c);
444     }
445   casereader_destroy (reader);
446
447   {
448     gsl_matrix *cm = covariance_calculate_unnormalized (cov);
449
450     //    dump_matrix (cm);
451
452     ws.total_ssq = gsl_matrix_get (cm, 0, 0);
453
454     reg_sweep (cm, 0);
455
456     /*
457       Store the overall SSE.
458     */
459     ws.ssq = gsl_vector_alloc (cm->size1);
460     gsl_vector_set (ws.ssq, 0, gsl_matrix_get (cm, 0, 0));
461     get_ssq (cov, ws.ssq, cmd);
462     //    dump_matrix (cm);
463
464     gsl_matrix_free (cm);
465   }
466
467   if (!taint_has_tainted_successor (taint))
468     output_glm (cmd, &ws);
469
470   gsl_vector_free (ws.ssq);
471
472   covariance_destroy (cov);
473   moments_destroy (ws.totals);
474
475   taint_destroy (taint);
476 }
477
478 static void
479 output_glm (const struct glm_spec *cmd, const struct glm_workspace *ws)
480 {
481   const struct fmt_spec *wfmt =
482     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
483
484   double n_total, mean;
485   double df_corr = 0.0;
486   double mse = 0;
487
488   int f;
489   int r;
490   const int heading_columns = 1;
491   const int heading_rows = 1;
492   struct tab_table *t;
493
494   const int nc = 6;
495   int nr = heading_rows + 4 + cmd->n_interactions;
496   if (cmd->intercept)
497     nr++;
498
499   t = tab_create (nc, nr);
500   tab_title (t, _("Tests of Between-Subjects Effects"));
501
502   tab_headers (t, heading_columns, 0, heading_rows, 0);
503
504   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
505
506   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
507   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
508
509   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Source"));
510
511   /* TRANSLATORS: The parameter is a roman numeral */
512   tab_text_format (t, 1, 0, TAB_CENTER | TAT_TITLE,
513                    _("Type %s Sum of Squares"), "III");
514   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("df"));
515   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
516   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("F"));
517   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
518
519   moments_calculate (ws->totals, &n_total, &mean, NULL, NULL, NULL);
520
521   if (cmd->intercept)
522     df_corr += 1.0;
523
524   for (f = 0; f < cmd->n_interactions; ++f)
525     df_corr += categoricals_n_count (ws->cats, f) - 1.0;
526
527   mse = gsl_vector_get (ws->ssq, 0) / (n_total - df_corr);
528
529   r = heading_rows;
530   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Model"));
531
532   r++;
533
534   if (cmd->intercept)
535     {
536       const double intercept = pow2 (mean * n_total) / n_total;
537       const double df = 1.0;
538       const double F = intercept / df / mse;
539       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Intercept"));
540       tab_double (t, 1, r, 0, intercept, NULL);
541       tab_double (t, 2, r, 0, 1.00, wfmt);
542       tab_double (t, 3, r, 0, intercept / df, NULL);
543       tab_double (t, 4, r, 0, F, NULL);
544       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
545                   NULL);
546       r++;
547     }
548
549   for (f = 0; f < cmd->n_interactions; ++f)
550     {
551       struct string str = DS_EMPTY_INITIALIZER;
552       const double df = categoricals_n_count (ws->cats, f) - 1.0;
553       const double ssq = gsl_vector_get (ws->ssq, f + 1);
554       const double F = ssq / df / mse;
555       interaction_to_string (cmd->interactions[f], &str);
556       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
557       ds_destroy (&str);
558
559       tab_double (t, 1, r, 0, ssq, NULL);
560       tab_double (t, 2, r, 0, df, wfmt);
561       tab_double (t, 3, r, 0, ssq / df, NULL);
562       tab_double (t, 4, r, 0, F, NULL);
563
564       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
565                   NULL);
566       r++;
567     }
568
569   {
570     /* Corrected Model */
571     const double df = df_corr - 1.0;
572     const double ssq = ws->total_ssq - gsl_vector_get (ws->ssq, 0);
573     const double F = ssq / df / mse;
574     tab_double (t, 1, heading_rows, 0, ssq, NULL);
575     tab_double (t, 2, heading_rows, 0, df, wfmt);
576     tab_double (t, 3, heading_rows, 0, ssq / df, NULL);
577     tab_double (t, 4, heading_rows, 0, F, NULL);
578
579     tab_double (t, 5, heading_rows, 0,
580                 gsl_cdf_fdist_Q (F, df, n_total - df_corr), NULL);
581   }
582
583   {
584     const double df = n_total - df_corr;
585     const double ssq = gsl_vector_get (ws->ssq, 0);
586     const double mse = ssq / df;
587     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Error"));
588     tab_double (t, 1, r, 0, ssq, NULL);
589     tab_double (t, 2, r, 0, df, wfmt);
590     tab_double (t, 3, r++, 0, mse, NULL);
591   }
592
593   if (cmd->intercept)
594     {
595       const double intercept = pow2 (mean * n_total) / n_total;
596       const double ssq = intercept + ws->total_ssq;
597
598       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Total"));
599       tab_double (t, 1, r, 0, ssq, NULL);
600       tab_double (t, 2, r, 0, n_total, wfmt);
601
602       r++;
603     }
604
605   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Total"));
606
607
608   tab_double (t, 1, r, 0, ws->total_ssq, NULL);
609   tab_double (t, 2, r, 0, n_total - 1.0, wfmt);
610
611   tab_submit (t);
612 }
613
614 #if 0
615 static void
616 dump_matrix (const gsl_matrix * m)
617 {
618   size_t i, j;
619   for (i = 0; i < m->size1; ++i)
620     {
621       for (j = 0; j < m->size2; ++j)
622         {
623           double x = gsl_matrix_get (m, i, j);
624           printf ("%.3f ", x);
625         }
626       printf ("\n");
627     }
628   printf ("\n");
629 }
630 #endif
631
632
633 \f
634
635 /* Match a variable.
636    If the match succeeds, the variable will be placed in VAR.
637    Returns true if successful */
638 static bool
639 lex_match_variable (struct lexer *lexer, const struct glm_spec *glm, const struct variable **var)
640 {
641   if (lex_token (lexer) !=  T_ID)
642     return false;
643
644   *var = parse_variable_const  (lexer, glm->dict);
645
646   if ( *var == NULL)
647     return false;
648   return true;
649 }
650
651 /* An interaction is a variable followed by {*, BY} followed by an interaction */
652 static bool
653 parse_design_interaction (struct lexer *lexer, struct glm_spec *glm, struct interaction **iact)
654 {
655   const struct variable *v = NULL;
656   assert (iact);
657
658   switch  (lex_next_token (lexer, 1))
659     {
660     case T_ENDCMD:
661     case T_SLASH:
662     case T_COMMA:
663     case T_ID:
664     case T_BY:
665     case T_ASTERISK:
666       break;
667     default:
668       return false;
669       break;
670     }
671
672   if (! lex_match_variable (lexer, glm, &v))
673     {
674       interaction_destroy (*iact);
675       *iact = NULL;
676       return false;
677     }
678   
679   assert (v);
680
681   if ( *iact == NULL)
682     *iact = interaction_create (v);
683   else
684     interaction_add_variable (*iact, v);
685
686   if ( lex_match (lexer, T_ASTERISK) || lex_match (lexer, T_BY))
687     {
688       // lex_error (lexer, "Interactions are not yet implemented"); return false;
689       return parse_design_interaction (lexer, glm, iact);
690     }
691
692   return true;
693 }
694
695 static bool
696 parse_nested_variable (struct lexer *lexer, struct glm_spec *glm)
697 {
698   const struct variable *v = NULL;
699   if ( ! lex_match_variable (lexer, glm, &v))
700     return false;
701
702   if (lex_match (lexer, T_LPAREN))
703     {
704       if ( ! parse_nested_variable (lexer, glm))
705         return false;
706
707       if ( ! lex_force_match (lexer, T_RPAREN))
708         return false;
709     }
710
711   lex_error (lexer, "Nested variables are not yet implemented"); return false;  
712   return true;
713 }
714
715 /* A design term is an interaction OR a nested variable */
716 static bool
717 parse_design_term (struct lexer *lexer, struct glm_spec *glm)
718 {
719   struct interaction *iact = NULL;
720   if (parse_design_interaction (lexer, glm, &iact))
721     {
722       /* Interaction parsing successful.  Add to list of interactions */
723       glm->interactions = xrealloc (glm->interactions, sizeof *glm->interactions * ++glm->n_interactions);
724       glm->interactions[glm->n_interactions - 1] = iact;
725       return true;
726     }
727
728   if ( parse_nested_variable (lexer, glm))
729     return true;
730
731   return false;
732 }
733
734
735
736 /* Parse a complete DESIGN specification.
737    A design spec is a design term, optionally followed by a comma,
738    and another design spec.
739 */
740 static bool
741 parse_design_spec (struct lexer *lexer, struct glm_spec *glm)
742 {
743   if  (lex_token (lexer) == T_ENDCMD || lex_token (lexer) == T_SLASH)
744     return true;
745
746   if ( ! parse_design_term (lexer, glm))
747     return false;
748
749   lex_match (lexer, T_COMMA);
750
751   return parse_design_spec (lexer, glm);
752 }
753