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