GLM: Implemented the Type I sums of squares and added a test for that.
[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 <gsl/gsl_combination.h>
22 #include <math.h>
23
24 #include "data/case.h"
25 #include "data/casegrouper.h"
26 #include "data/casereader.h"
27 #include "data/dataset.h"
28 #include "data/dictionary.h"
29 #include "data/format.h"
30 #include "data/value.h"
31 #include "language/command.h"
32 #include "language/dictionary/split-file.h"
33 #include "language/lexer/lexer.h"
34 #include "language/lexer/value-parser.h"
35 #include "language/lexer/variable-parser.h"
36 #include "libpspp/assertion.h"
37 #include "libpspp/ll.h"
38 #include "libpspp/message.h"
39 #include "libpspp/misc.h"
40 #include "libpspp/taint.h"
41 #include "linreg/sweep.h"
42 #include "math/categoricals.h"
43 #include "math/covariance.h"
44 #include "math/interaction.h"
45 #include "math/moments.h"
46 #include "output/tab.h"
47
48 #include "gettext.h"
49 #define _(msgid) gettext (msgid)
50
51 struct glm_spec
52 {
53   size_t n_dep_vars;
54   const struct variable **dep_vars;
55
56   size_t n_factor_vars;
57   const struct variable **factor_vars;
58
59   size_t n_interactions;
60   struct interaction **interactions;
61
62   enum mv_class exclude;
63
64   /* The weight variable */
65   const struct variable *wv;
66
67   const struct dictionary *dict;
68
69   int ss_type;
70   bool intercept;
71
72   double alpha;
73
74   bool dump_coding;
75 };
76
77 struct glm_workspace
78 {
79   double total_ssq;
80   struct moments *totals;
81
82   struct categoricals *cats;
83
84   /* 
85      Sums of squares due to different variables. Element 0 is the SSE
86      for the entire model. For i > 0, element i is the SS due to
87      variable i.
88    */
89   gsl_vector *ssq;
90 };
91
92
93 /* Default design: all possible interactions */
94 static void
95 design_full (struct glm_spec *glm)
96 {
97   int sz;
98   int i = 0;
99   glm->n_interactions = (1 << glm->n_factor_vars) - 1;
100
101   glm->interactions = xcalloc (glm->n_interactions, sizeof *glm->interactions);
102
103   /* All subsets, with exception of the empty set, of [0, glm->n_factor_vars) */
104   for (sz = 1; sz <= glm->n_factor_vars; ++sz)
105     {
106       gsl_combination *c = gsl_combination_calloc (glm->n_factor_vars, sz);
107
108       do
109         {
110           struct interaction *iact = interaction_create (NULL);
111           int e;
112           for (e = 0 ; e < gsl_combination_k (c); ++e)
113             interaction_add_variable (iact, glm->factor_vars [gsl_combination_get (c, e)]);
114
115           glm->interactions[i++] = iact;
116         }
117       while (gsl_combination_next (c) == GSL_SUCCESS);
118
119       gsl_combination_free (c);
120     }
121 }
122
123 static void output_glm (const struct glm_spec *,
124                         const struct glm_workspace *ws);
125 static void run_glm (struct glm_spec *cmd, struct casereader *input,
126                      const struct dataset *ds);
127
128
129 static bool parse_design_spec (struct lexer *lexer, struct glm_spec *glm);
130
131
132 int
133 cmd_glm (struct lexer *lexer, struct dataset *ds)
134 {
135   int i;
136   struct const_var_set *factors = NULL;
137   struct glm_spec glm;
138   bool design = false;
139   glm.dict = dataset_dict (ds);
140   glm.n_dep_vars = 0;
141   glm.n_factor_vars = 0;
142   glm.n_interactions = 0;
143   glm.interactions = NULL;
144   glm.dep_vars = NULL;
145   glm.factor_vars = NULL;
146   glm.exclude = MV_ANY;
147   glm.intercept = true;
148   glm.wv = dict_get_weight (glm.dict);
149   glm.alpha = 0.05;
150   glm.dump_coding = false;
151   glm.ss_type = 3;
152
153   if (!parse_variables_const (lexer, glm.dict,
154                               &glm.dep_vars, &glm.n_dep_vars,
155                               PV_NO_DUPLICATE | PV_NUMERIC))
156     goto error;
157
158   lex_force_match (lexer, T_BY);
159
160   if (!parse_variables_const (lexer, glm.dict,
161                               &glm.factor_vars, &glm.n_factor_vars,
162                               PV_NO_DUPLICATE | PV_NUMERIC))
163     goto error;
164
165   if (glm.n_dep_vars > 1)
166     {
167       msg (ME, _("Multivariate analysis is not yet implemented"));
168       return CMD_FAILURE;
169     }
170
171   factors =
172     const_var_set_create_from_array (glm.factor_vars, glm.n_factor_vars);
173
174   while (lex_token (lexer) != T_ENDCMD)
175     {
176       lex_match (lexer, T_SLASH);
177
178       if (lex_match_id (lexer, "MISSING"))
179         {
180           lex_match (lexer, T_EQUALS);
181           while (lex_token (lexer) != T_ENDCMD
182                  && lex_token (lexer) != T_SLASH)
183             {
184               if (lex_match_id (lexer, "INCLUDE"))
185                 {
186                   glm.exclude = MV_SYSTEM;
187                 }
188               else if (lex_match_id (lexer, "EXCLUDE"))
189                 {
190                   glm.exclude = MV_ANY;
191                 }
192               else
193                 {
194                   lex_error (lexer, NULL);
195                   goto error;
196                 }
197             }
198         }
199       else if (lex_match_id (lexer, "INTERCEPT"))
200         {
201           lex_match (lexer, T_EQUALS);
202           while (lex_token (lexer) != T_ENDCMD
203                  && lex_token (lexer) != T_SLASH)
204             {
205               if (lex_match_id (lexer, "INCLUDE"))
206                 {
207                   glm.intercept = true;
208                 }
209               else if (lex_match_id (lexer, "EXCLUDE"))
210                 {
211                   glm.intercept = false;
212                 }
213               else
214                 {
215                   lex_error (lexer, NULL);
216                   goto error;
217                 }
218             }
219         }
220       else if (lex_match_id (lexer, "CRITERIA"))
221         {
222           lex_match (lexer, T_EQUALS);
223           if (lex_match_id (lexer, "ALPHA"))
224             {
225               if (lex_force_match (lexer, T_LPAREN))
226                 {
227                   if (! lex_force_num (lexer))
228                     {
229                       lex_error (lexer, NULL);
230                       goto error;
231                     }
232                   
233                   glm.alpha = lex_number (lexer);
234                   lex_get (lexer);
235                   if ( ! lex_force_match (lexer, T_RPAREN))
236                     {
237                       lex_error (lexer, NULL);
238                       goto error;
239                     }
240                 }
241             }
242           else
243             {
244               lex_error (lexer, NULL);
245               goto error;
246             }
247         }
248       else if (lex_match_id (lexer, "METHOD"))
249         {
250           lex_match (lexer, T_EQUALS);
251           if ( !lex_force_match_id (lexer, "SSTYPE"))
252             {
253               lex_error (lexer, NULL);
254               goto error;
255             }
256
257           if ( ! lex_force_match (lexer, T_LPAREN))
258             {
259               lex_error (lexer, NULL);
260               goto error;
261             }
262
263           if ( ! lex_force_int (lexer))
264             {
265               lex_error (lexer, NULL);
266               goto error;
267             }
268
269           glm.ss_type = lex_integer (lexer);
270           if (1 != glm.ss_type  && 2 != glm.ss_type )
271             {
272               msg (ME, _("Only types 1 & 2 sum of squares are currently implemented"));
273               goto error;
274             }
275
276           lex_get (lexer);
277
278           if ( ! lex_force_match (lexer, T_RPAREN))
279             {
280               lex_error (lexer, NULL);
281               goto error;
282             }
283         }
284       else if (lex_match_id (lexer, "DESIGN"))
285         {
286           lex_match (lexer, T_EQUALS);
287
288           if (! parse_design_spec (lexer, &glm))
289             goto error;
290
291           if (glm.n_interactions > 0)
292             design = true;
293         }
294       else if (lex_match_id (lexer, "SHOWCODES"))
295         /* Undocumented debug option */
296         {
297           lex_match (lexer, T_EQUALS);
298
299           glm.dump_coding = true;
300         }
301       else
302         {
303           lex_error (lexer, NULL);
304           goto error;
305         }
306     }
307
308   if ( ! design )
309     {
310       design_full (&glm);
311     }
312
313   {
314     struct casegrouper *grouper;
315     struct casereader *group;
316     bool ok;
317
318     grouper = casegrouper_create_splits (proc_open (ds), glm.dict);
319     while (casegrouper_get_next_group (grouper, &group))
320       run_glm (&glm, group, ds);
321     ok = casegrouper_destroy (grouper);
322     ok = proc_commit (ds) && ok;
323   }
324
325   const_var_set_destroy (factors);
326   free (glm.factor_vars);
327   for (i = 0 ; i < glm.n_interactions; ++i)
328     interaction_destroy (glm.interactions[i]);
329   free (glm.interactions);
330   free (glm.dep_vars);
331
332
333   return CMD_SUCCESS;
334
335 error:
336
337   const_var_set_destroy (factors);
338   free (glm.factor_vars);
339   for (i = 0 ; i < glm.n_interactions; ++i)
340     interaction_destroy (glm.interactions[i]);
341
342   free (glm.interactions);
343   free (glm.dep_vars);
344
345   return CMD_FAILURE;
346 }
347
348 static inline bool
349 not_dropped (size_t j, const bool *ff)
350 {
351   return ! ff[j];
352 }
353
354 static void
355 fill_submatrix (const gsl_matrix * cov, gsl_matrix * submatrix, bool *dropped_f)
356 {
357   size_t i;
358   size_t j;
359   size_t n = 0;
360   size_t m = 0;
361   
362   for (i = 0; i < cov->size1; i++)
363     {
364       if (not_dropped (i, dropped_f))
365         {         
366           m = 0;
367           for (j = 0; j < cov->size2; j++)
368             {
369               if (not_dropped (j, dropped_f))
370                 {
371                   gsl_matrix_set (submatrix, n, m,
372                                   gsl_matrix_get (cov, i, j));
373                   m++;
374                 }       
375             }
376           n++;
377         }
378     }
379 }
380
381
382 /* 
383    Type 1 sums of squares.
384    Populate SSQ with the Type 1 sums of squares according to COV
385  */
386 static void
387 ssq_type1 (struct covariance *cov, gsl_vector *ssq, const struct glm_spec *cmd)
388 {
389   gsl_matrix *cm = covariance_calculate_unnormalized (cov);
390   size_t i;
391   size_t k;
392   bool *model_dropped = xcalloc (covariance_dim (cov), sizeof (*model_dropped));
393   bool *submodel_dropped = xcalloc (covariance_dim (cov), sizeof (*submodel_dropped));
394   const struct categoricals *cats = covariance_get_categoricals (cov);
395
396   size_t n_dropped_model = 0;
397   size_t n_dropped_submodel = 0;
398
399   for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
400     {
401       n_dropped_model++;
402       n_dropped_submodel++;
403       model_dropped[i] = true;
404       submodel_dropped[i] = true;
405     }
406
407   for (k = 0; k < cmd->n_interactions; k++)
408     {
409       gsl_matrix *model_cov = NULL;
410       gsl_matrix *submodel_cov = NULL;
411       
412       n_dropped_submodel = n_dropped_model;
413       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
414         {
415           submodel_dropped[i] = model_dropped[i];
416         }
417
418       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
419         {
420           const struct interaction * x = 
421             categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars);
422
423           if ( x == cmd->interactions [k])
424             {
425               model_dropped[i] = false;
426               n_dropped_model--;
427             }
428         }
429
430       model_cov = gsl_matrix_alloc (cm->size1 - n_dropped_model, cm->size2 - n_dropped_model);
431       submodel_cov = gsl_matrix_alloc (cm->size1 - n_dropped_submodel, cm->size2 - n_dropped_submodel);
432
433       fill_submatrix (cm, model_cov,    model_dropped);
434       fill_submatrix (cm, submodel_cov, submodel_dropped);
435
436       reg_sweep (model_cov, 0);
437       reg_sweep (submodel_cov, 0);
438
439       gsl_vector_set (ssq, k + 1,
440                       gsl_matrix_get (submodel_cov, 0, 0) - gsl_matrix_get (model_cov, 0, 0)
441                       );
442
443       gsl_matrix_free (model_cov);
444       gsl_matrix_free (submodel_cov);
445     }
446
447   free (model_dropped);
448   free (submodel_dropped);
449   gsl_matrix_free (cm);
450 }
451
452 /* 
453    Type 2 sums of squares.
454    Populate SSQ with the Type 2 sums of squares according to COV
455  */
456 static void
457 ssq_type2 (struct covariance *cov, gsl_vector *ssq, const struct glm_spec *cmd)
458 {
459   gsl_matrix *cm = covariance_calculate_unnormalized (cov);
460   size_t i;
461   size_t k;
462   bool *model_dropped = xcalloc (covariance_dim (cov), sizeof (*model_dropped));
463   bool *submodel_dropped = xcalloc (covariance_dim (cov), sizeof (*submodel_dropped));
464   const struct categoricals *cats = covariance_get_categoricals (cov);
465
466   for (k = 0; k < cmd->n_interactions; k++)
467     {
468       gsl_matrix *model_cov = NULL;
469       gsl_matrix *submodel_cov = NULL;
470       size_t n_dropped_model = 0;
471       size_t n_dropped_submodel = 0;
472       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
473         {
474           const struct interaction * x = 
475             categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars);
476
477           model_dropped[i] = false;
478           submodel_dropped[i] = false;
479           if (interaction_is_subset (cmd->interactions [k], x))
480             {
481               assert (n_dropped_submodel < covariance_dim (cov));
482               n_dropped_submodel++;
483               submodel_dropped[i] = true;
484
485               if ( cmd->interactions [k]->n_vars < x->n_vars)
486                 {
487                   assert (n_dropped_model < covariance_dim (cov));
488                   n_dropped_model++;
489                   model_dropped[i] = true;
490                 }
491             }
492         }
493
494       model_cov = gsl_matrix_alloc (cm->size1 - n_dropped_model, cm->size2 - n_dropped_model);
495       submodel_cov = gsl_matrix_alloc (cm->size1 - n_dropped_submodel, cm->size2 - n_dropped_submodel);
496
497       fill_submatrix (cm, model_cov,    model_dropped);
498       fill_submatrix (cm, submodel_cov, submodel_dropped);
499
500       reg_sweep (model_cov, 0);
501       reg_sweep (submodel_cov, 0);
502
503       gsl_vector_set (ssq, k + 1,
504                       gsl_matrix_get (submodel_cov, 0, 0) - gsl_matrix_get (model_cov, 0, 0)
505                       );
506
507       gsl_matrix_free (model_cov);
508       gsl_matrix_free (submodel_cov);
509     }
510
511   free (model_dropped);
512   free (submodel_dropped);
513   gsl_matrix_free (cm);
514 }
515
516 //static  void dump_matrix (const gsl_matrix *m);
517
518 static void
519 run_glm (struct glm_spec *cmd, struct casereader *input,
520          const struct dataset *ds)
521 {
522   bool warn_bad_weight = true;
523   int v;
524   struct taint *taint;
525   struct dictionary *dict = dataset_dict (ds);
526   struct casereader *reader;
527   struct ccase *c;
528
529   struct glm_workspace ws;
530   struct covariance *cov;
531
532   ws.cats = categoricals_create (cmd->interactions, cmd->n_interactions,
533                                  cmd->wv, cmd->exclude,
534                                  NULL, NULL, NULL, NULL);
535
536   cov = covariance_2pass_create (cmd->n_dep_vars, cmd->dep_vars,
537                                  ws.cats, cmd->wv, cmd->exclude);
538
539
540   c = casereader_peek (input, 0);
541   if (c == NULL)
542     {
543       casereader_destroy (input);
544       return;
545     }
546   output_split_file_values (ds, c);
547   case_unref (c);
548
549   taint = taint_clone (casereader_get_taint (input));
550
551   ws.totals = moments_create (MOMENT_VARIANCE);
552
553   for (reader = casereader_clone (input);
554        (c = casereader_read (reader)) != NULL; case_unref (c))
555     {
556       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
557
558       for (v = 0; v < cmd->n_dep_vars; ++v)
559         moments_pass_one (ws.totals, case_data (c, cmd->dep_vars[v])->f,
560                           weight);
561
562       covariance_accumulate_pass1 (cov, c);
563     }
564   casereader_destroy (reader);
565
566   if (cmd->dump_coding)
567     reader = casereader_clone (input);
568   else
569     reader = input;
570
571   for (;
572        (c = casereader_read (reader)) != NULL; case_unref (c))
573     {
574       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
575
576       for (v = 0; v < cmd->n_dep_vars; ++v)
577         moments_pass_two (ws.totals, case_data (c, cmd->dep_vars[v])->f,
578                           weight);
579
580       covariance_accumulate_pass2 (cov, c);
581     }
582   casereader_destroy (reader);
583
584
585   if (cmd->dump_coding)
586     {
587       struct tab_table *t =
588         covariance_dump_enc_header (cov,
589                                     1 + casereader_count_cases (input));
590       for (reader = input;
591            (c = casereader_read (reader)) != NULL; case_unref (c))
592         {
593           covariance_dump_enc (cov, c, t);
594         }
595       casereader_destroy (reader);
596       tab_submit (t);
597     }
598
599   {
600     gsl_matrix *cm = covariance_calculate_unnormalized (cov);
601
602     //    dump_matrix (cm);
603
604     ws.total_ssq = gsl_matrix_get (cm, 0, 0);
605
606     reg_sweep (cm, 0);
607
608     /*
609       Store the overall SSE.
610     */
611     ws.ssq = gsl_vector_alloc (cm->size1);
612     gsl_vector_set (ws.ssq, 0, gsl_matrix_get (cm, 0, 0));
613     switch (cmd->ss_type)
614       {
615       case 1:
616         ssq_type1 (cov, ws.ssq, cmd);
617         break;
618       case 2:
619       case 3:
620         /* Type 3 is not yet implemented :( but for balanced designs it is the same as type 2 */
621         ssq_type2 (cov, ws.ssq, cmd);
622         break;
623       default:
624         NOT_REACHED ();
625         break;
626       }
627     //    dump_matrix (cm);
628
629     gsl_matrix_free (cm);
630   }
631
632   if (!taint_has_tainted_successor (taint))
633     output_glm (cmd, &ws);
634
635   gsl_vector_free (ws.ssq);
636
637   covariance_destroy (cov);
638   moments_destroy (ws.totals);
639
640   taint_destroy (taint);
641 }
642
643 static const char *roman[] = 
644   {
645     "", /* The Romans had no concept of zero */
646     "I",
647     "II",
648     "III",
649     "IV"
650   };
651
652 static void
653 output_glm (const struct glm_spec *cmd, const struct glm_workspace *ws)
654 {
655   const struct fmt_spec *wfmt =
656     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
657
658   double n_total, mean;
659   double df_corr = 0.0;
660   double mse = 0;
661
662   int f;
663   int r;
664   const int heading_columns = 1;
665   const int heading_rows = 1;
666   struct tab_table *t;
667
668   const int nc = 6;
669   int nr = heading_rows + 4 + cmd->n_interactions;
670   if (cmd->intercept)
671     nr++;
672
673   msg (MW, "GLM is experimental.  Do not rely on these results.");
674   t = tab_create (nc, nr);
675   tab_title (t, _("Tests of Between-Subjects Effects"));
676
677   tab_headers (t, heading_columns, 0, heading_rows, 0);
678
679   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
680
681   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
682   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
683
684   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Source"));
685
686   /* TRANSLATORS: The parameter is a roman numeral */
687   tab_text_format (t, 1, 0, TAB_CENTER | TAT_TITLE,
688                    _("Type %s Sum of Squares"), 
689                    roman[cmd->ss_type]);
690   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("df"));
691   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
692   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("F"));
693   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
694
695   moments_calculate (ws->totals, &n_total, &mean, NULL, NULL, NULL);
696
697   if (cmd->intercept)
698     df_corr += 1.0;
699
700   df_corr += categoricals_df_total (ws->cats);
701
702   mse = gsl_vector_get (ws->ssq, 0) / (n_total - df_corr);
703
704   r = heading_rows;
705   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Model"));
706
707   r++;
708
709   if (cmd->intercept)
710     {
711       const double intercept = pow2 (mean * n_total) / n_total;
712       const double df = 1.0;
713       const double F = intercept / df / mse;
714       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Intercept"));
715       tab_double (t, 1, r, 0, intercept, NULL);
716       tab_double (t, 2, r, 0, 1.00, wfmt);
717       tab_double (t, 3, r, 0, intercept / df, NULL);
718       tab_double (t, 4, r, 0, F, NULL);
719       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
720                   NULL);
721       r++;
722     }
723
724   for (f = 0; f < cmd->n_interactions; ++f)
725     {
726       struct string str = DS_EMPTY_INITIALIZER;
727       const double df = categoricals_df (ws->cats, f);
728       const double ssq = gsl_vector_get (ws->ssq, f + 1);
729       const double F = ssq / df / mse;
730       interaction_to_string (cmd->interactions[f], &str);
731       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
732       ds_destroy (&str);
733
734       tab_double (t, 1, r, 0, ssq, NULL);
735       tab_double (t, 2, r, 0, df, wfmt);
736       tab_double (t, 3, r, 0, ssq / df, NULL);
737       tab_double (t, 4, r, 0, F, NULL);
738
739       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
740                   NULL);
741       r++;
742     }
743
744   {
745     /* Corrected Model */
746     const double df = df_corr - 1.0;
747     const double ssq = ws->total_ssq - gsl_vector_get (ws->ssq, 0);
748     const double F = ssq / df / mse;
749     tab_double (t, 1, heading_rows, 0, ssq, NULL);
750     tab_double (t, 2, heading_rows, 0, df, wfmt);
751     tab_double (t, 3, heading_rows, 0, ssq / df, NULL);
752     tab_double (t, 4, heading_rows, 0, F, NULL);
753
754     tab_double (t, 5, heading_rows, 0,
755                 gsl_cdf_fdist_Q (F, df, n_total - df_corr), NULL);
756   }
757
758   {
759     const double df = n_total - df_corr;
760     const double ssq = gsl_vector_get (ws->ssq, 0);
761     const double mse = ssq / df;
762     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Error"));
763     tab_double (t, 1, r, 0, ssq, NULL);
764     tab_double (t, 2, r, 0, df, wfmt);
765     tab_double (t, 3, r++, 0, mse, NULL);
766   }
767
768   if (cmd->intercept)
769     {
770       const double intercept = pow2 (mean * n_total) / n_total;
771       const double ssq = intercept + ws->total_ssq;
772
773       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Total"));
774       tab_double (t, 1, r, 0, ssq, NULL);
775       tab_double (t, 2, r, 0, n_total, wfmt);
776
777       r++;
778     }
779
780   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Total"));
781
782
783   tab_double (t, 1, r, 0, ws->total_ssq, NULL);
784   tab_double (t, 2, r, 0, n_total - 1.0, wfmt);
785
786   tab_submit (t);
787 }
788
789 #if 0
790 static void
791 dump_matrix (const gsl_matrix * m)
792 {
793   size_t i, j;
794   for (i = 0; i < m->size1; ++i)
795     {
796       for (j = 0; j < m->size2; ++j)
797         {
798           double x = gsl_matrix_get (m, i, j);
799           printf ("%.3f ", x);
800         }
801       printf ("\n");
802     }
803   printf ("\n");
804 }
805 #endif
806
807
808 \f
809
810 /* Match a variable.
811    If the match succeeds, the variable will be placed in VAR.
812    Returns true if successful */
813 static bool
814 lex_match_variable (struct lexer *lexer, const struct glm_spec *glm, const struct variable **var)
815 {
816   if (lex_token (lexer) !=  T_ID)
817     return false;
818
819   *var = parse_variable_const  (lexer, glm->dict);
820
821   if ( *var == NULL)
822     return false;
823   return true;
824 }
825
826 /* An interaction is a variable followed by {*, BY} followed by an interaction */
827 static bool
828 parse_design_interaction (struct lexer *lexer, struct glm_spec *glm, struct interaction **iact)
829 {
830   const struct variable *v = NULL;
831   assert (iact);
832
833   switch  (lex_next_token (lexer, 1))
834     {
835     case T_ENDCMD:
836     case T_SLASH:
837     case T_COMMA:
838     case T_ID:
839     case T_BY:
840     case T_ASTERISK:
841       break;
842     default:
843       return false;
844       break;
845     }
846
847   if (! lex_match_variable (lexer, glm, &v))
848     {
849       interaction_destroy (*iact);
850       *iact = NULL;
851       return false;
852     }
853   
854   assert (v);
855
856   if ( *iact == NULL)
857     *iact = interaction_create (v);
858   else
859     interaction_add_variable (*iact, v);
860
861   if ( lex_match (lexer, T_ASTERISK) || lex_match (lexer, T_BY))
862     {
863       return parse_design_interaction (lexer, glm, iact);
864     }
865
866   return true;
867 }
868
869 static bool
870 parse_nested_variable (struct lexer *lexer, struct glm_spec *glm)
871 {
872   const struct variable *v = NULL;
873   if ( ! lex_match_variable (lexer, glm, &v))
874     return false;
875
876   if (lex_match (lexer, T_LPAREN))
877     {
878       if ( ! parse_nested_variable (lexer, glm))
879         return false;
880
881       if ( ! lex_force_match (lexer, T_RPAREN))
882         return false;
883     }
884
885   lex_error (lexer, "Nested variables are not yet implemented"); return false;  
886   return true;
887 }
888
889 /* A design term is an interaction OR a nested variable */
890 static bool
891 parse_design_term (struct lexer *lexer, struct glm_spec *glm)
892 {
893   struct interaction *iact = NULL;
894   if (parse_design_interaction (lexer, glm, &iact))
895     {
896       /* Interaction parsing successful.  Add to list of interactions */
897       glm->interactions = xrealloc (glm->interactions, sizeof *glm->interactions * ++glm->n_interactions);
898       glm->interactions[glm->n_interactions - 1] = iact;
899       return true;
900     }
901
902   if ( parse_nested_variable (lexer, glm))
903     return true;
904
905   return false;
906 }
907
908
909
910 /* Parse a complete DESIGN specification.
911    A design spec is a design term, optionally followed by a comma,
912    and another design spec.
913 */
914 static bool
915 parse_design_spec (struct lexer *lexer, struct glm_spec *glm)
916 {
917   if  (lex_token (lexer) == T_ENDCMD || lex_token (lexer) == T_SLASH)
918     return true;
919
920   if ( ! parse_design_term (lexer, glm))
921     return false;
922
923   lex_match (lexer, T_COMMA);
924
925   return parse_design_spec (lexer, glm);
926 }
927