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 void get_ssq (struct covariance *, gsl_vector *,
 349                      const struct glm_spec *);
 350
 351 static inline bool
 352 not_dropped (size_t j, const bool *ff)
 353 {
 354   return ! ff[j];
 355 }
 356
 357 static void
 358 fill_submatrix (const gsl_matrix * cov, gsl_matrix * submatrix, bool *dropped_f)
 359 {
 360   size_t i;
 361   size_t j;
 362   size_t n = 0;
 363   size_t m = 0;
 364
 365   for (i = 0; i < cov->size1; i++)
 366     {
 367       if (not_dropped (i, dropped_f))
 368         {
 369           m = 0;
 370           for (j = 0; j < cov->size2; j++)
 371             {
 372               if (not_dropped (j, dropped_f))
 373                 {
 374                   gsl_matrix_set (submatrix, n, m,
 375                                   gsl_matrix_get (cov, i, j));
 376                   m++;
 377                 }
 378             }
 379           n++;
 380         }
 381     }
 382 }
 383
 384 static void
 385 get_ssq (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   for (k = 0; k < cmd->n_interactions; k++)
 395     {
 396       gsl_matrix *model_cov = NULL;
 397       gsl_matrix *submodel_cov = NULL;
 398       size_t n_dropped_model = 0;
 399       size_t n_dropped_submodel = 0;
 400       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
 401         {
 402           const struct interaction * x =
 403             categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars);
 404
 405           model_dropped[i] = false;
 406           submodel_dropped[i] = false;
 407           if (interaction_is_subset (cmd->interactions [k], x))
 408             {
 409               assert (n_dropped_submodel < covariance_dim (cov));
 410               n_dropped_submodel++;
 411               submodel_dropped[i] = true;
 412
 413               if ( cmd->interactions [k]->n_vars < x->n_vars)
 414                 {
 415                   assert (n_dropped_model < covariance_dim (cov));
 416                   n_dropped_model++;
 417                   model_dropped[i] = true;
 418                 }
 419             }
 420         }
 421
 422       model_cov = gsl_matrix_alloc (cm->size1 - n_dropped_model, cm->size2 - n_dropped_model);
 423       submodel_cov = gsl_matrix_alloc (cm->size1 - n_dropped_submodel, cm->size2 - n_dropped_submodel);
 424
 425       fill_submatrix (cm, model_cov,    model_dropped);
 426       fill_submatrix (cm, submodel_cov, submodel_dropped);
 427
 428       reg_sweep (model_cov, 0);
 429       reg_sweep (submodel_cov, 0);
 430
 431       gsl_vector_set (ssq, k + 1,
 432                       gsl_matrix_get (submodel_cov, 0, 0) - gsl_matrix_get (model_cov, 0, 0)
 433                       );
 434
 435       gsl_matrix_free (model_cov);
 436       gsl_matrix_free (submodel_cov);
 437     }
 438
 439   free (model_dropped);
 440   free (submodel_dropped);
 441   gsl_matrix_free (cm);
 442 }
 443
 444 //static  void dump_matrix (const gsl_matrix *m);
 445
 446 static void
 447 run_glm (struct glm_spec *cmd, struct casereader *input,
 448          const struct dataset *ds)
 449 {
 450   bool warn_bad_weight = true;
 451   int v;
 452   struct taint *taint;
 453   struct dictionary *dict = dataset_dict (ds);
 454   struct casereader *reader;
 455   struct ccase *c;
 456
 457   struct glm_workspace ws;
 458   struct covariance *cov;
 459
 460   ws.cats = categoricals_create (cmd->interactions, cmd->n_interactions,
 461                                  cmd->wv, cmd->exclude,
 462                                  NULL, NULL, NULL, NULL);
 463
 464   cov = covariance_2pass_create (cmd->n_dep_vars, cmd->dep_vars,
 465                                  ws.cats, cmd->wv, cmd->exclude);
 466
 467
 468   c = casereader_peek (input, 0);
 469   if (c == NULL)
 470     {
 471       casereader_destroy (input);
 472       return;
 473     }
 474   output_split_file_values (ds, c);
 475   case_unref (c);
 476
 477   taint = taint_clone (casereader_get_taint (input));
 478
 479   ws.totals = moments_create (MOMENT_VARIANCE);
 480
 481   for (reader = casereader_clone (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_one (ws.totals, case_data (c, cmd->dep_vars[v])->f,
 488                           weight);
 489
 490       covariance_accumulate_pass1 (cov, c);
 491     }
 492   casereader_destroy (reader);
 493
 494   if (cmd->dump_coding)
 495     reader = casereader_clone (input);
 496   else
 497     reader = input;
 498
 499   for (;
 500        (c = casereader_read (reader)) != NULL; case_unref (c))
 501     {
 502       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
 503
 504       for (v = 0; v < cmd->n_dep_vars; ++v)
 505         moments_pass_two (ws.totals, case_data (c, cmd->dep_vars[v])->f,
 506                           weight);
 507
 508       covariance_accumulate_pass2 (cov, c);
 509     }
 510   casereader_destroy (reader);
 511
 512
 513   if (cmd->dump_coding)
 514     {
 515       struct tab_table *t =
 516         covariance_dump_enc_header (cov,
 517                                     1 + casereader_count_cases (input));
 518       for (reader = input;
 519            (c = casereader_read (reader)) != NULL; case_unref (c))
 520         {
 521           covariance_dump_enc (cov, c, t);
 522         }
 523       casereader_destroy (reader);
 524       tab_submit (t);
 525     }
 526
 527   {
 528     gsl_matrix *cm = covariance_calculate_unnormalized (cov);
 529
 530     //    dump_matrix (cm);
 531
 532     ws.total_ssq = gsl_matrix_get (cm, 0, 0);
 533
 534     reg_sweep (cm, 0);
 535
 536     /*
 537       Store the overall SSE.
 538     */
 539     ws.ssq = gsl_vector_alloc (cm->size1);
 540     gsl_vector_set (ws.ssq, 0, gsl_matrix_get (cm, 0, 0));
 541     switch (cmd->ss_type)
 542       {
 543       case 1:
 544         break;
 545       case 2:
 546       case 3:
 547         get_ssq (cov, ws.ssq, cmd);
 548         break;
 549       default:
 550         NOT_REACHED ();
 551         break;
 552       }
 553     //    dump_matrix (cm);
 554
 555     gsl_matrix_free (cm);
 556   }
 557
 558   if (!taint_has_tainted_successor (taint))
 559     output_glm (cmd, &ws);
 560
 561   gsl_vector_free (ws.ssq);
 562
 563   covariance_destroy (cov);
 564   moments_destroy (ws.totals);
 565
 566   taint_destroy (taint);
 567 }
 568
 569 static const char *roman[] =
 570   {
 571     "", /* The Romans had no concept of zero */
 572     "I",
 573     "II",
 574     "III",
 575     "IV"
 576   };
 577
 578 static void
 579 output_glm (const struct glm_spec *cmd, const struct glm_workspace *ws)
 580 {
 581   const struct fmt_spec *wfmt =
 582     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
 583
 584   double n_total, mean;
 585   double df_corr = 0.0;
 586   double mse = 0;
 587
 588   int f;
 589   int r;
 590   const int heading_columns = 1;
 591   const int heading_rows = 1;
 592   struct tab_table *t;
 593
 594   const int nc = 6;
 595   int nr = heading_rows + 4 + cmd->n_interactions;
 596   if (cmd->intercept)
 597     nr++;
 598
 599   msg (MW, "GLM is experimental.  Do not rely on these results.");
 600   t = tab_create (nc, nr);
 601   tab_title (t, _("Tests of Between-Subjects Effects"));
 602
 603   tab_headers (t, heading_columns, 0, heading_rows, 0);
 604
 605   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
 606
 607   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
 608   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
 609
 610   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Source"));
 611
 612   /* TRANSLATORS: The parameter is a roman numeral */
 613   tab_text_format (t, 1, 0, TAB_CENTER | TAT_TITLE,
 614                    _("Type %s Sum of Squares"),
 615                    roman[cmd->ss_type]);
 616   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("df"));
 617   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
 618   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("F"));
 619   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
 620
 621   moments_calculate (ws->totals, &n_total, &mean, NULL, NULL, NULL);
 622
 623   if (cmd->intercept)
 624     df_corr += 1.0;
 625
 626   df_corr += categoricals_df_total (ws->cats);
 627
 628   mse = gsl_vector_get (ws->ssq, 0) / (n_total - df_corr);
 629
 630   r = heading_rows;
 631   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Model"));
 632
 633   r++;
 634
 635   if (cmd->intercept)
 636     {
 637       const double intercept = pow2 (mean * n_total) / n_total;
 638       const double df = 1.0;
 639       const double F = intercept / df / mse;
 640       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Intercept"));
 641       tab_double (t, 1, r, 0, intercept, NULL);
 642       tab_double (t, 2, r, 0, 1.00, wfmt);
 643       tab_double (t, 3, r, 0, intercept / df, NULL);
 644       tab_double (t, 4, r, 0, F, NULL);
 645       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
 646                   NULL);
 647       r++;
 648     }
 649
 650   for (f = 0; f < cmd->n_interactions; ++f)
 651     {
 652       struct string str = DS_EMPTY_INITIALIZER;
 653       const double df = categoricals_df (ws->cats, f);
 654       const double ssq = gsl_vector_get (ws->ssq, f + 1);
 655       const double F = ssq / df / mse;
 656       interaction_to_string (cmd->interactions[f], &str);
 657       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
 658       ds_destroy (&str);
 659
 660       tab_double (t, 1, r, 0, ssq, NULL);
 661       tab_double (t, 2, r, 0, df, wfmt);
 662       tab_double (t, 3, r, 0, ssq / df, NULL);
 663       tab_double (t, 4, r, 0, F, NULL);
 664
 665       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
 666                   NULL);
 667       r++;
 668     }
 669
 670   {
 671     /* Corrected Model */
 672     const double df = df_corr - 1.0;
 673     const double ssq = ws->total_ssq - gsl_vector_get (ws->ssq, 0);
 674     const double F = ssq / df / mse;
 675     tab_double (t, 1, heading_rows, 0, ssq, NULL);
 676     tab_double (t, 2, heading_rows, 0, df, wfmt);
 677     tab_double (t, 3, heading_rows, 0, ssq / df, NULL);
 678     tab_double (t, 4, heading_rows, 0, F, NULL);
 679
 680     tab_double (t, 5, heading_rows, 0,
 681                 gsl_cdf_fdist_Q (F, df, n_total - df_corr), NULL);
 682   }
 683
 684   {
 685     const double df = n_total - df_corr;
 686     const double ssq = gsl_vector_get (ws->ssq, 0);
 687     const double mse = ssq / df;
 688     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Error"));
 689     tab_double (t, 1, r, 0, ssq, NULL);
 690     tab_double (t, 2, r, 0, df, wfmt);
 691     tab_double (t, 3, r++, 0, mse, NULL);
 692   }
 693
 694   if (cmd->intercept)
 695     {
 696       const double intercept = pow2 (mean * n_total) / n_total;
 697       const double ssq = intercept + ws->total_ssq;
 698
 699       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Total"));
 700       tab_double (t, 1, r, 0, ssq, NULL);
 701       tab_double (t, 2, r, 0, n_total, wfmt);
 702
 703       r++;
 704     }
 705
 706   tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Total"));
 707
 708
 709   tab_double (t, 1, r, 0, ws->total_ssq, NULL);
 710   tab_double (t, 2, r, 0, n_total - 1.0, wfmt);
 711
 712   tab_submit (t);
 713 }
 714
 715 #if 0
 716 static void
 717 dump_matrix (const gsl_matrix * m)
 718 {
 719   size_t i, j;
 720   for (i = 0; i < m->size1; ++i)
 721     {
 722       for (j = 0; j < m->size2; ++j)
 723         {
 724           double x = gsl_matrix_get (m, i, j);
 725           printf ("%.3f ", x);
 726         }
 727       printf ("\n");
 728     }
 729   printf ("\n");
 730 }
 731 #endif
 732
 733
 734 \f
 735
 736 /* Match a variable.
 737    If the match succeeds, the variable will be placed in VAR.
 738    Returns true if successful */
 739 static bool
 740 lex_match_variable (struct lexer *lexer, const struct glm_spec *glm, const struct variable **var)
 741 {
 742   if (lex_token (lexer) !=  T_ID)
 743     return false;
 744
 745   *var = parse_variable_const  (lexer, glm->dict);
 746
 747   if ( *var == NULL)
 748     return false;
 749   return true;
 750 }
 751
 752 /* An interaction is a variable followed by {*, BY} followed by an interaction */
 753 static bool
 754 parse_design_interaction (struct lexer *lexer, struct glm_spec *glm, struct interaction **iact)
 755 {
 756   const struct variable *v = NULL;
 757   assert (iact);
 758
 759   switch  (lex_next_token (lexer, 1))
 760     {
 761     case T_ENDCMD:
 762     case T_SLASH:
 763     case T_COMMA:
 764     case T_ID:
 765     case T_BY:
 766     case T_ASTERISK:
 767       break;
 768     default:
 769       return false;
 770       break;
 771     }
 772
 773   if (! lex_match_variable (lexer, glm, &v))
 774     {
 775       interaction_destroy (*iact);
 776       *iact = NULL;
 777       return false;
 778     }
 779
 780   assert (v);
 781
 782   if ( *iact == NULL)
 783     *iact = interaction_create (v);
 784   else
 785     interaction_add_variable (*iact, v);
 786
 787   if ( lex_match (lexer, T_ASTERISK) || lex_match (lexer, T_BY))
 788     {
 789       return parse_design_interaction (lexer, glm, iact);
 790     }
 791
 792   return true;
 793 }
 794
 795 static bool
 796 parse_nested_variable (struct lexer *lexer, struct glm_spec *glm)
 797 {
 798   const struct variable *v = NULL;
 799   if ( ! lex_match_variable (lexer, glm, &v))
 800     return false;
 801
 802   if (lex_match (lexer, T_LPAREN))
 803     {
 804       if ( ! parse_nested_variable (lexer, glm))
 805         return false;
 806
 807       if ( ! lex_force_match (lexer, T_RPAREN))
 808         return false;
 809     }
 810
 811   lex_error (lexer, "Nested variables are not yet implemented"); return false;
 812   return true;
 813 }
 814
 815 /* A design term is an interaction OR a nested variable */
 816 static bool
 817 parse_design_term (struct lexer *lexer, struct glm_spec *glm)
 818 {
 819   struct interaction *iact = NULL;
 820   if (parse_design_interaction (lexer, glm, &iact))
 821     {
 822       /* Interaction parsing successful.  Add to list of interactions */
 823       glm->interactions = xrealloc (glm->interactions, sizeof *glm->interactions * ++glm->n_interactions);
 824       glm->interactions[glm->n_interactions - 1] = iact;
 825       return true;
 826     }
 827
 828   if ( parse_nested_variable (lexer, glm))
 829     return true;
 830
 831   return false;
 832 }
 833
 834
 835
 836 /* Parse a complete DESIGN specification.
 837    A design spec is a design term, optionally followed by a comma,
 838    and another design spec.
 839 */
 840 static bool
 841 parse_design_spec (struct lexer *lexer, struct glm_spec *glm)
 842 {
 843   if  (lex_token (lexer) == T_ENDCMD || lex_token (lexer) == T_SLASH)
 844     return true;
 845
 846   if ( ! parse_design_term (lexer, glm))
 847     return false;
 848
 849   lex_match (lexer, T_COMMA);
 850
 851   return parse_design_spec (lexer, glm);
 852 }
 853