Merge 'master' into 'psppsheet'.
[pspp] / src / language / stats / glm.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2010, 2011, 2012 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  && 3 < glm.ss_type )
271             {
272               msg (ME, _("Only types 1, 2 & 3 sums 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   free (glm.interactions);
328   free (glm.dep_vars);
329
330
331   return CMD_SUCCESS;
332
333 error:
334
335   const_var_set_destroy (factors);
336   free (glm.factor_vars);
337   for (i = 0 ; i < glm.n_interactions; ++i)
338     interaction_destroy (glm.interactions[i]);
339
340   free (glm.interactions);
341   free (glm.dep_vars);
342
343   return CMD_FAILURE;
344 }
345
346 static inline bool
347 not_dropped (size_t j, const bool *ff)
348 {
349   return ! ff[j];
350 }
351
352 static void
353 fill_submatrix (const gsl_matrix * cov, gsl_matrix * submatrix, bool *dropped_f)
354 {
355   size_t i;
356   size_t j;
357   size_t n = 0;
358   size_t m = 0;
359   
360   for (i = 0; i < cov->size1; i++)
361     {
362       if (not_dropped (i, dropped_f))
363         {         
364           m = 0;
365           for (j = 0; j < cov->size2; j++)
366             {
367               if (not_dropped (j, dropped_f))
368                 {
369                   gsl_matrix_set (submatrix, n, m,
370                                   gsl_matrix_get (cov, i, j));
371                   m++;
372                 }       
373             }
374           n++;
375         }
376     }
377 }
378
379
380 /* 
381    Type 1 sums of squares.
382    Populate SSQ with the Type 1 sums of squares according to COV
383  */
384 static void
385 ssq_type1 (struct covariance *cov, gsl_vector *ssq, const struct glm_spec *cmd)
386 {
387   gsl_matrix *cm = covariance_calculate_unnormalized (cov);
388   size_t i;
389   size_t k;
390   bool *model_dropped = xcalloc (covariance_dim (cov), sizeof (*model_dropped));
391   bool *submodel_dropped = xcalloc (covariance_dim (cov), sizeof (*submodel_dropped));
392   const struct categoricals *cats = covariance_get_categoricals (cov);
393
394   size_t n_dropped_model = 0;
395   size_t n_dropped_submodel = 0;
396
397   for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
398     {
399       n_dropped_model++;
400       n_dropped_submodel++;
401       model_dropped[i] = true;
402       submodel_dropped[i] = true;
403     }
404
405   for (k = 0; k < cmd->n_interactions; k++)
406     {
407       gsl_matrix *model_cov = NULL;
408       gsl_matrix *submodel_cov = NULL;
409       
410       n_dropped_submodel = n_dropped_model;
411       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
412         {
413           submodel_dropped[i] = model_dropped[i];
414         }
415
416       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
417         {
418           const struct interaction * x = 
419             categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars);
420
421           if ( x == cmd->interactions [k])
422             {
423               model_dropped[i] = false;
424               n_dropped_model--;
425             }
426         }
427
428       model_cov = gsl_matrix_alloc (cm->size1 - n_dropped_model, cm->size2 - n_dropped_model);
429       submodel_cov = gsl_matrix_alloc (cm->size1 - n_dropped_submodel, cm->size2 - n_dropped_submodel);
430
431       fill_submatrix (cm, model_cov,    model_dropped);
432       fill_submatrix (cm, submodel_cov, submodel_dropped);
433
434       reg_sweep (model_cov, 0);
435       reg_sweep (submodel_cov, 0);
436
437       gsl_vector_set (ssq, k + 1,
438                       gsl_matrix_get (submodel_cov, 0, 0) - gsl_matrix_get (model_cov, 0, 0)
439                       );
440
441       gsl_matrix_free (model_cov);
442       gsl_matrix_free (submodel_cov);
443     }
444
445   free (model_dropped);
446   free (submodel_dropped);
447   gsl_matrix_free (cm);
448 }
449
450 /* 
451    Type 2 sums of squares.
452    Populate SSQ with the Type 2 sums of squares according to COV
453  */
454 static void
455 ssq_type2 (struct covariance *cov, gsl_vector *ssq, const struct glm_spec *cmd)
456 {
457   gsl_matrix *cm = covariance_calculate_unnormalized (cov);
458   size_t i;
459   size_t k;
460   bool *model_dropped = xcalloc (covariance_dim (cov), sizeof (*model_dropped));
461   bool *submodel_dropped = xcalloc (covariance_dim (cov), sizeof (*submodel_dropped));
462   const struct categoricals *cats = covariance_get_categoricals (cov);
463
464   for (k = 0; k < cmd->n_interactions; k++)
465     {
466       gsl_matrix *model_cov = NULL;
467       gsl_matrix *submodel_cov = NULL;
468       size_t n_dropped_model = 0;
469       size_t n_dropped_submodel = 0;
470       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
471         {
472           const struct interaction * x = 
473             categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars);
474
475           model_dropped[i] = false;
476           submodel_dropped[i] = false;
477           if (interaction_is_subset (cmd->interactions [k], x))
478             {
479               assert (n_dropped_submodel < covariance_dim (cov));
480               n_dropped_submodel++;
481               submodel_dropped[i] = true;
482
483               if ( cmd->interactions [k]->n_vars < x->n_vars)
484                 {
485                   assert (n_dropped_model < covariance_dim (cov));
486                   n_dropped_model++;
487                   model_dropped[i] = true;
488                 }
489             }
490         }
491
492       model_cov = gsl_matrix_alloc (cm->size1 - n_dropped_model, cm->size2 - n_dropped_model);
493       submodel_cov = gsl_matrix_alloc (cm->size1 - n_dropped_submodel, cm->size2 - n_dropped_submodel);
494
495       fill_submatrix (cm, model_cov,    model_dropped);
496       fill_submatrix (cm, submodel_cov, submodel_dropped);
497
498       reg_sweep (model_cov, 0);
499       reg_sweep (submodel_cov, 0);
500
501       gsl_vector_set (ssq, k + 1,
502                       gsl_matrix_get (submodel_cov, 0, 0) - gsl_matrix_get (model_cov, 0, 0)
503                       );
504
505       gsl_matrix_free (model_cov);
506       gsl_matrix_free (submodel_cov);
507     }
508
509   free (model_dropped);
510   free (submodel_dropped);
511   gsl_matrix_free (cm);
512 }
513
514 /* 
515    Type 3 sums of squares.
516    Populate SSQ with the Type 2 sums of squares according to COV
517  */
518 static void
519 ssq_type3 (struct covariance *cov, gsl_vector *ssq, const struct glm_spec *cmd)
520 {
521   gsl_matrix *cm = covariance_calculate_unnormalized (cov);
522   size_t i;
523   size_t k;
524   bool *model_dropped = xcalloc (covariance_dim (cov), sizeof (*model_dropped));
525   bool *submodel_dropped = xcalloc (covariance_dim (cov), sizeof (*submodel_dropped));
526   const struct categoricals *cats = covariance_get_categoricals (cov);
527
528   double ss0;
529   gsl_matrix *submodel_cov = gsl_matrix_alloc (cm->size1, cm->size2);
530   fill_submatrix (cm, submodel_cov, submodel_dropped);
531   reg_sweep (submodel_cov, 0);
532   ss0 = gsl_matrix_get (submodel_cov, 0, 0);
533   gsl_matrix_free (submodel_cov);
534   free (submodel_dropped);
535
536   for (k = 0; k < cmd->n_interactions; k++)
537     {
538       gsl_matrix *model_cov = NULL;
539       size_t n_dropped_model = 0;
540
541       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
542         {
543           const struct interaction * x = 
544             categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars);
545
546           model_dropped[i] = false;
547
548           if ( cmd->interactions [k] == x)
549             {
550               assert (n_dropped_model < covariance_dim (cov));
551               n_dropped_model++;
552               model_dropped[i] = true;
553             }
554         }
555
556       model_cov = gsl_matrix_alloc (cm->size1 - n_dropped_model, cm->size2 - n_dropped_model);
557
558       fill_submatrix (cm, model_cov,    model_dropped);
559
560       reg_sweep (model_cov, 0);
561
562       gsl_vector_set (ssq, k + 1,
563                       gsl_matrix_get (model_cov, 0, 0) - ss0);
564
565       gsl_matrix_free (model_cov);
566     }
567   free (model_dropped);
568
569   gsl_matrix_free (cm);
570 }
571
572
573
574 //static  void dump_matrix (const gsl_matrix *m);
575
576 static void
577 run_glm (struct glm_spec *cmd, struct casereader *input,
578          const struct dataset *ds)
579 {
580   bool warn_bad_weight = true;
581   int v;
582   struct taint *taint;
583   struct dictionary *dict = dataset_dict (ds);
584   struct casereader *reader;
585   struct ccase *c;
586
587   struct glm_workspace ws;
588   struct covariance *cov;
589
590   ws.cats = categoricals_create (cmd->interactions, cmd->n_interactions,
591                                  cmd->wv, cmd->exclude, MV_ANY);
592
593   cov = covariance_2pass_create (cmd->n_dep_vars, cmd->dep_vars,
594                                  ws.cats, cmd->wv, cmd->exclude);
595
596
597   c = casereader_peek (input, 0);
598   if (c == NULL)
599     {
600       casereader_destroy (input);
601       return;
602     }
603   output_split_file_values (ds, c);
604   case_unref (c);
605
606   taint = taint_clone (casereader_get_taint (input));
607
608   ws.totals = moments_create (MOMENT_VARIANCE);
609
610   for (reader = casereader_clone (input);
611        (c = casereader_read (reader)) != NULL; case_unref (c))
612     {
613       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
614
615       for (v = 0; v < cmd->n_dep_vars; ++v)
616         moments_pass_one (ws.totals, case_data (c, cmd->dep_vars[v])->f,
617                           weight);
618
619       covariance_accumulate_pass1 (cov, c);
620     }
621   casereader_destroy (reader);
622
623   if (cmd->dump_coding)
624     reader = casereader_clone (input);
625   else
626     reader = input;
627
628   for (;
629        (c = casereader_read (reader)) != NULL; case_unref (c))
630     {
631       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
632
633       for (v = 0; v < cmd->n_dep_vars; ++v)
634         moments_pass_two (ws.totals, case_data (c, cmd->dep_vars[v])->f,
635                           weight);
636
637       covariance_accumulate_pass2 (cov, c);
638     }
639   casereader_destroy (reader);
640
641
642   if (cmd->dump_coding)
643     {
644       struct tab_table *t =
645         covariance_dump_enc_header (cov,
646                                     1 + casereader_count_cases (input));
647       for (reader = input;
648            (c = casereader_read (reader)) != NULL; case_unref (c))
649         {
650           covariance_dump_enc (cov, c, t);
651         }
652       casereader_destroy (reader);
653       tab_submit (t);
654     }
655
656   {
657     gsl_matrix *cm = covariance_calculate_unnormalized (cov);
658
659     //    dump_matrix (cm);
660
661     ws.total_ssq = gsl_matrix_get (cm, 0, 0);
662
663     reg_sweep (cm, 0);
664
665     /*
666       Store the overall SSE.
667     */
668     ws.ssq = gsl_vector_alloc (cm->size1);
669     gsl_vector_set (ws.ssq, 0, gsl_matrix_get (cm, 0, 0));
670     switch (cmd->ss_type)
671       {
672       case 1:
673         ssq_type1 (cov, ws.ssq, cmd);
674         break;
675       case 2:
676         ssq_type2 (cov, ws.ssq, cmd);
677         break;
678       case 3:
679         ssq_type3 (cov, ws.ssq, cmd);
680         break;
681       default:
682         NOT_REACHED ();
683         break;
684       }
685     //    dump_matrix (cm);
686
687     gsl_matrix_free (cm);
688   }
689
690   if (!taint_has_tainted_successor (taint))
691     output_glm (cmd, &ws);
692
693   gsl_vector_free (ws.ssq);
694
695   covariance_destroy (cov);
696   moments_destroy (ws.totals);
697
698   taint_destroy (taint);
699 }
700
701 static const char *roman[] = 
702   {
703     "", /* The Romans had no concept of zero */
704     "I",
705     "II",
706     "III",
707     "IV"
708   };
709
710 static void
711 output_glm (const struct glm_spec *cmd, const struct glm_workspace *ws)
712 {
713   const struct fmt_spec *wfmt =
714     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
715
716   double intercept_ssq;
717   double ssq_effects;
718   double n_total, mean;
719   double df_corr = 1.0;
720   double mse = 0;
721
722   int f;
723   int r;
724   const int heading_columns = 1;
725   const int heading_rows = 1;
726   struct tab_table *t;
727
728   const int nc = 6;
729   int nr = heading_rows + 3 + cmd->n_interactions;
730   if (cmd->intercept)
731     nr += 2;
732
733   msg (MW, "GLM is experimental.  Do not rely on these results.");
734   t = tab_create (nc, nr);
735   tab_title (t, _("Tests of Between-Subjects Effects"));
736
737   tab_headers (t, heading_columns, 0, heading_rows, 0);
738
739   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
740
741   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
742   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
743
744   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Source"));
745
746   /* TRANSLATORS: The parameter is a roman numeral */
747   tab_text_format (t, 1, 0, TAB_CENTER | TAT_TITLE,
748                    _("Type %s Sum of Squares"), 
749                    roman[cmd->ss_type]);
750   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("df"));
751   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
752   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("F"));
753   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
754
755   moments_calculate (ws->totals, &n_total, &mean, NULL, NULL, NULL);
756
757   df_corr += categoricals_df_total (ws->cats);
758
759   r = heading_rows;
760   if (cmd->intercept)
761     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Model"));
762   else
763     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Model"));
764
765   r++;
766
767   mse = gsl_vector_get (ws->ssq, 0) / (n_total - df_corr);
768
769   intercept_ssq = pow2 (mean * n_total) / n_total;
770
771   ssq_effects = 0.0;
772   if (cmd->intercept)
773     {
774       const double df = 1.0;
775       const double F = intercept_ssq / df / mse;
776       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Intercept"));
777       tab_double (t, 1, r, 0, intercept_ssq, NULL);
778       tab_double (t, 2, r, 0, 1.00, wfmt);
779       tab_double (t, 3, r, 0, intercept_ssq / df, NULL);
780       tab_double (t, 4, r, 0, F, NULL);
781       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
782                   NULL);
783       r++;
784     }
785
786   for (f = 0; f < cmd->n_interactions; ++f)
787     {
788       struct string str = DS_EMPTY_INITIALIZER;
789       double df = categoricals_df (ws->cats, f);
790
791       double ssq = gsl_vector_get (ws->ssq, f + 1);
792       double F;
793
794       ssq_effects += ssq;
795
796       if (! cmd->intercept) 
797         {
798           df++;
799           ssq += intercept_ssq;
800         }
801
802       F = ssq / df / mse;
803       interaction_to_string (cmd->interactions[f], &str);
804       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
805       ds_destroy (&str);
806
807       tab_double (t, 1, r, 0, ssq, NULL);
808       tab_double (t, 2, r, 0, df, wfmt);
809       tab_double (t, 3, r, 0, ssq / df, NULL);
810       tab_double (t, 4, r, 0, F, NULL);
811
812       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
813                   NULL);
814       r++;
815     }
816
817   {
818     /* Model / Corrected Model */
819     double df = df_corr;
820     double ssq = ws->total_ssq - gsl_vector_get (ws->ssq, 0);
821     double F;
822
823     if ( cmd->intercept )
824       df --;
825     else
826       ssq += intercept_ssq;
827
828     F = ssq / df / mse;
829     tab_double (t, 1, heading_rows, 0, ssq, NULL);
830     tab_double (t, 2, heading_rows, 0, df, wfmt);
831     tab_double (t, 3, heading_rows, 0, ssq / df, NULL);
832     tab_double (t, 4, heading_rows, 0, F, NULL);
833
834     tab_double (t, 5, heading_rows, 0,
835                 gsl_cdf_fdist_Q (F, df, n_total - df_corr), NULL);
836   }
837
838   {
839     const double df = n_total - df_corr;
840     const double ssq = gsl_vector_get (ws->ssq, 0);
841     const double mse = ssq / df;
842     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Error"));
843     tab_double (t, 1, r, 0, ssq, NULL);
844     tab_double (t, 2, r, 0, df, wfmt);
845     tab_double (t, 3, r++, 0, mse, NULL);
846   }
847
848   {
849     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Total"));
850     tab_double (t, 1, r, 0, ws->total_ssq + intercept_ssq, NULL);
851     tab_double (t, 2, r, 0, n_total, wfmt);
852     
853     r++;
854   }
855
856   if (cmd->intercept)
857     {
858       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Total"));
859       tab_double (t, 1, r, 0, ws->total_ssq, NULL);
860       tab_double (t, 2, r, 0, n_total - 1.0, wfmt);
861     }
862
863   tab_submit (t);
864 }
865
866 #if 0
867 static void
868 dump_matrix (const gsl_matrix * m)
869 {
870   size_t i, j;
871   for (i = 0; i < m->size1; ++i)
872     {
873       for (j = 0; j < m->size2; ++j)
874         {
875           double x = gsl_matrix_get (m, i, j);
876           printf ("%.3f ", x);
877         }
878       printf ("\n");
879     }
880   printf ("\n");
881 }
882 #endif
883
884
885 \f
886
887 /* Match a variable.
888    If the match succeeds, the variable will be placed in VAR.
889    Returns true if successful */
890 static bool
891 lex_match_variable (struct lexer *lexer, const struct glm_spec *glm, const struct variable **var)
892 {
893   if (lex_token (lexer) !=  T_ID)
894     return false;
895
896   *var = parse_variable_const  (lexer, glm->dict);
897
898   if ( *var == NULL)
899     return false;
900   return true;
901 }
902
903 /* An interaction is a variable followed by {*, BY} followed by an interaction */
904 static bool
905 parse_design_interaction (struct lexer *lexer, struct glm_spec *glm, struct interaction **iact)
906 {
907   const struct variable *v = NULL;
908   assert (iact);
909
910   switch  (lex_next_token (lexer, 1))
911     {
912     case T_ENDCMD:
913     case T_SLASH:
914     case T_COMMA:
915     case T_ID:
916     case T_BY:
917     case T_ASTERISK:
918       break;
919     default:
920       return false;
921       break;
922     }
923
924   if (! lex_match_variable (lexer, glm, &v))
925     {
926       interaction_destroy (*iact);
927       *iact = NULL;
928       return false;
929     }
930   
931   assert (v);
932
933   if ( *iact == NULL)
934     *iact = interaction_create (v);
935   else
936     interaction_add_variable (*iact, v);
937
938   if ( lex_match (lexer, T_ASTERISK) || lex_match (lexer, T_BY))
939     {
940       return parse_design_interaction (lexer, glm, iact);
941     }
942
943   return true;
944 }
945
946 static bool
947 parse_nested_variable (struct lexer *lexer, struct glm_spec *glm)
948 {
949   const struct variable *v = NULL;
950   if ( ! lex_match_variable (lexer, glm, &v))
951     return false;
952
953   if (lex_match (lexer, T_LPAREN))
954     {
955       if ( ! parse_nested_variable (lexer, glm))
956         return false;
957
958       if ( ! lex_force_match (lexer, T_RPAREN))
959         return false;
960     }
961
962   lex_error (lexer, "Nested variables are not yet implemented"); return false;  
963   return true;
964 }
965
966 /* A design term is an interaction OR a nested variable */
967 static bool
968 parse_design_term (struct lexer *lexer, struct glm_spec *glm)
969 {
970   struct interaction *iact = NULL;
971   if (parse_design_interaction (lexer, glm, &iact))
972     {
973       /* Interaction parsing successful.  Add to list of interactions */
974       glm->interactions = xrealloc (glm->interactions, sizeof *glm->interactions * ++glm->n_interactions);
975       glm->interactions[glm->n_interactions - 1] = iact;
976       return true;
977     }
978
979   if ( parse_nested_variable (lexer, glm))
980     return true;
981
982   return false;
983 }
984
985
986
987 /* Parse a complete DESIGN specification.
988    A design spec is a design term, optionally followed by a comma,
989    and another design spec.
990 */
991 static bool
992 parse_design_spec (struct lexer *lexer, struct glm_spec *glm)
993 {
994   if  (lex_token (lexer) == T_ENDCMD || lex_token (lexer) == T_SLASH)
995     return true;
996
997   if ( ! parse_design_term (lexer, glm))
998     return false;
999
1000   lex_match (lexer, T_COMMA);
1001
1002   return parse_design_spec (lexer, glm);
1003 }
1004