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   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 /*
 517    Type 3 sums of squares.
 518    Populate SSQ with the Type 2 sums of squares according to COV
 519  */
 520 static void
 521 ssq_type3 (struct covariance *cov, gsl_vector *ssq, const struct glm_spec *cmd)
 522 {
 523   gsl_matrix *cm = covariance_calculate_unnormalized (cov);
 524   size_t i;
 525   size_t k;
 526   bool *model_dropped = xcalloc (covariance_dim (cov), sizeof (*model_dropped));
 527   bool *submodel_dropped = xcalloc (covariance_dim (cov), sizeof (*submodel_dropped));
 528   const struct categoricals *cats = covariance_get_categoricals (cov);
 529
 530   double ss0;
 531   gsl_matrix *submodel_cov = gsl_matrix_alloc (cm->size1, cm->size2);
 532   fill_submatrix (cm, submodel_cov, submodel_dropped);
 533   reg_sweep (submodel_cov, 0);
 534   ss0 = gsl_matrix_get (submodel_cov, 0, 0);
 535   gsl_matrix_free (submodel_cov);
 536   free (submodel_dropped);
 537
 538   for (k = 0; k < cmd->n_interactions; k++)
 539     {
 540       gsl_matrix *model_cov = NULL;
 541       size_t n_dropped_model = 0;
 542
 543       for (i = cmd->n_dep_vars; i < covariance_dim (cov); i++)
 544         {
 545           const struct interaction * x =
 546             categoricals_get_interaction_by_subscript (cats, i - cmd->n_dep_vars);
 547
 548           model_dropped[i] = false;
 549
 550           if ( cmd->interactions [k] == x)
 551             {
 552               assert (n_dropped_model < covariance_dim (cov));
 553               n_dropped_model++;
 554               model_dropped[i] = true;
 555             }
 556         }
 557
 558       model_cov = gsl_matrix_alloc (cm->size1 - n_dropped_model, cm->size2 - n_dropped_model);
 559
 560       fill_submatrix (cm, model_cov,    model_dropped);
 561
 562       reg_sweep (model_cov, 0);
 563
 564       gsl_vector_set (ssq, k + 1,
 565                       gsl_matrix_get (model_cov, 0, 0) - ss0);
 566
 567       gsl_matrix_free (model_cov);
 568     }
 569   free (model_dropped);
 570
 571   gsl_matrix_free (cm);
 572 }
 573
 574
 575
 576 //static  void dump_matrix (const gsl_matrix *m);
 577
 578 static void
 579 run_glm (struct glm_spec *cmd, struct casereader *input,
 580          const struct dataset *ds)
 581 {
 582   bool warn_bad_weight = true;
 583   int v;
 584   struct taint *taint;
 585   struct dictionary *dict = dataset_dict (ds);
 586   struct casereader *reader;
 587   struct ccase *c;
 588
 589   struct glm_workspace ws;
 590   struct covariance *cov;
 591
 592   ws.cats = categoricals_create (cmd->interactions, cmd->n_interactions,
 593                                  cmd->wv, cmd->exclude);
 594
 595   cov = covariance_2pass_create (cmd->n_dep_vars, cmd->dep_vars,
 596                                  ws.cats, cmd->wv, cmd->exclude);
 597
 598
 599   c = casereader_peek (input, 0);
 600   if (c == NULL)
 601     {
 602       casereader_destroy (input);
 603       return;
 604     }
 605   output_split_file_values (ds, c);
 606   case_unref (c);
 607
 608   taint = taint_clone (casereader_get_taint (input));
 609
 610   ws.totals = moments_create (MOMENT_VARIANCE);
 611
 612   for (reader = casereader_clone (input);
 613        (c = casereader_read (reader)) != NULL; case_unref (c))
 614     {
 615       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
 616
 617       for (v = 0; v < cmd->n_dep_vars; ++v)
 618         moments_pass_one (ws.totals, case_data (c, cmd->dep_vars[v])->f,
 619                           weight);
 620
 621       covariance_accumulate_pass1 (cov, c);
 622     }
 623   casereader_destroy (reader);
 624
 625   if (cmd->dump_coding)
 626     reader = casereader_clone (input);
 627   else
 628     reader = input;
 629
 630   for (;
 631        (c = casereader_read (reader)) != NULL; case_unref (c))
 632     {
 633       double weight = dict_get_case_weight (dict, c, &warn_bad_weight);
 634
 635       for (v = 0; v < cmd->n_dep_vars; ++v)
 636         moments_pass_two (ws.totals, case_data (c, cmd->dep_vars[v])->f,
 637                           weight);
 638
 639       covariance_accumulate_pass2 (cov, c);
 640     }
 641   casereader_destroy (reader);
 642
 643
 644   if (cmd->dump_coding)
 645     {
 646       struct tab_table *t =
 647         covariance_dump_enc_header (cov,
 648                                     1 + casereader_count_cases (input));
 649       for (reader = input;
 650            (c = casereader_read (reader)) != NULL; case_unref (c))
 651         {
 652           covariance_dump_enc (cov, c, t);
 653         }
 654       casereader_destroy (reader);
 655       tab_submit (t);
 656     }
 657
 658   {
 659     gsl_matrix *cm = covariance_calculate_unnormalized (cov);
 660
 661     //    dump_matrix (cm);
 662
 663     ws.total_ssq = gsl_matrix_get (cm, 0, 0);
 664
 665     reg_sweep (cm, 0);
 666
 667     /*
 668       Store the overall SSE.
 669     */
 670     ws.ssq = gsl_vector_alloc (cm->size1);
 671     gsl_vector_set (ws.ssq, 0, gsl_matrix_get (cm, 0, 0));
 672     switch (cmd->ss_type)
 673       {
 674       case 1:
 675         ssq_type1 (cov, ws.ssq, cmd);
 676         break;
 677       case 2:
 678         ssq_type2 (cov, ws.ssq, cmd);
 679         break;
 680       case 3:
 681         ssq_type3 (cov, ws.ssq, cmd);
 682         break;
 683       default:
 684         NOT_REACHED ();
 685         break;
 686       }
 687     //    dump_matrix (cm);
 688
 689     gsl_matrix_free (cm);
 690   }
 691
 692   if (!taint_has_tainted_successor (taint))
 693     output_glm (cmd, &ws);
 694
 695   gsl_vector_free (ws.ssq);
 696
 697   covariance_destroy (cov);
 698   moments_destroy (ws.totals);
 699
 700   taint_destroy (taint);
 701 }
 702
 703 static const char *roman[] =
 704   {
 705     "", /* The Romans had no concept of zero */
 706     "I",
 707     "II",
 708     "III",
 709     "IV"
 710   };
 711
 712 static void
 713 output_glm (const struct glm_spec *cmd, const struct glm_workspace *ws)
 714 {
 715   const struct fmt_spec *wfmt =
 716     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
 717
 718   double intercept_ssq;
 719   double ssq_effects;
 720   double n_total, mean;
 721   double df_corr = 1.0;
 722   double mse = 0;
 723
 724   int f;
 725   int r;
 726   const int heading_columns = 1;
 727   const int heading_rows = 1;
 728   struct tab_table *t;
 729
 730   const int nc = 6;
 731   int nr = heading_rows + 3 + cmd->n_interactions;
 732   if (cmd->intercept)
 733     nr += 2;
 734
 735   msg (MW, "GLM is experimental.  Do not rely on these results.");
 736   t = tab_create (nc, nr);
 737   tab_title (t, _("Tests of Between-Subjects Effects"));
 738
 739   tab_headers (t, heading_columns, 0, heading_rows, 0);
 740
 741   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
 742
 743   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
 744   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
 745
 746   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Source"));
 747
 748   /* TRANSLATORS: The parameter is a roman numeral */
 749   tab_text_format (t, 1, 0, TAB_CENTER | TAT_TITLE,
 750                    _("Type %s Sum of Squares"),
 751                    roman[cmd->ss_type]);
 752   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("df"));
 753   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
 754   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("F"));
 755   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
 756
 757   moments_calculate (ws->totals, &n_total, &mean, NULL, NULL, NULL);
 758
 759   df_corr += categoricals_df_total (ws->cats);
 760
 761   r = heading_rows;
 762   if (cmd->intercept)
 763     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Model"));
 764   else
 765     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Model"));
 766
 767   r++;
 768
 769   mse = gsl_vector_get (ws->ssq, 0) / (n_total - df_corr);
 770
 771   intercept_ssq = pow2 (mean * n_total) / n_total;
 772
 773   ssq_effects = 0.0;
 774   if (cmd->intercept)
 775     {
 776       const double df = 1.0;
 777       const double F = intercept_ssq / df / mse;
 778       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Intercept"));
 779       tab_double (t, 1, r, 0, intercept_ssq, NULL);
 780       tab_double (t, 2, r, 0, 1.00, wfmt);
 781       tab_double (t, 3, r, 0, intercept_ssq / df, NULL);
 782       tab_double (t, 4, r, 0, F, NULL);
 783       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
 784                   NULL);
 785       r++;
 786     }
 787
 788   for (f = 0; f < cmd->n_interactions; ++f)
 789     {
 790       struct string str = DS_EMPTY_INITIALIZER;
 791       double df = categoricals_df (ws->cats, f);
 792
 793       double ssq = gsl_vector_get (ws->ssq, f + 1);
 794       double F;
 795
 796       ssq_effects += ssq;
 797
 798       if (! cmd->intercept)
 799         {
 800           df++;
 801           ssq += intercept_ssq;
 802         }
 803
 804       F = ssq / df / mse;
 805       interaction_to_string (cmd->interactions[f], &str);
 806       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
 807       ds_destroy (&str);
 808
 809       tab_double (t, 1, r, 0, ssq, NULL);
 810       tab_double (t, 2, r, 0, df, wfmt);
 811       tab_double (t, 3, r, 0, ssq / df, NULL);
 812       tab_double (t, 4, r, 0, F, NULL);
 813
 814       tab_double (t, 5, r, 0, gsl_cdf_fdist_Q (F, df, n_total - df_corr),
 815                   NULL);
 816       r++;
 817     }
 818
 819   {
 820     /* Model / Corrected Model */
 821     double df = df_corr;
 822     double ssq = ws->total_ssq - gsl_vector_get (ws->ssq, 0);
 823     double F;
 824
 825     if ( cmd->intercept )
 826       df --;
 827     else
 828       ssq += intercept_ssq;
 829
 830     F = ssq / df / mse;
 831     tab_double (t, 1, heading_rows, 0, ssq, NULL);
 832     tab_double (t, 2, heading_rows, 0, df, wfmt);
 833     tab_double (t, 3, heading_rows, 0, ssq / df, NULL);
 834     tab_double (t, 4, heading_rows, 0, F, NULL);
 835
 836     tab_double (t, 5, heading_rows, 0,
 837                 gsl_cdf_fdist_Q (F, df, n_total - df_corr), NULL);
 838   }
 839
 840   {
 841     const double df = n_total - df_corr;
 842     const double ssq = gsl_vector_get (ws->ssq, 0);
 843     const double mse = ssq / df;
 844     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Error"));
 845     tab_double (t, 1, r, 0, ssq, NULL);
 846     tab_double (t, 2, r, 0, df, wfmt);
 847     tab_double (t, 3, r++, 0, mse, NULL);
 848   }
 849
 850   {
 851     tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Total"));
 852     tab_double (t, 1, r, 0, ws->total_ssq + intercept_ssq, NULL);
 853     tab_double (t, 2, r, 0, n_total, wfmt);
 854
 855     r++;
 856   }
 857
 858   if (cmd->intercept)
 859     {
 860       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Corrected Total"));
 861       tab_double (t, 1, r, 0, ws->total_ssq, NULL);
 862       tab_double (t, 2, r, 0, n_total - 1.0, wfmt);
 863     }
 864
 865   tab_submit (t);
 866 }
 867
 868 #if 0
 869 static void
 870 dump_matrix (const gsl_matrix * m)
 871 {
 872   size_t i, j;
 873   for (i = 0; i < m->size1; ++i)
 874     {
 875       for (j = 0; j < m->size2; ++j)
 876         {
 877           double x = gsl_matrix_get (m, i, j);
 878           printf ("%.3f ", x);
 879         }
 880       printf ("\n");
 881     }
 882   printf ("\n");
 883 }
 884 #endif
 885
 886
 887 \f
 888
 889 /* Match a variable.
 890    If the match succeeds, the variable will be placed in VAR.
 891    Returns true if successful */
 892 static bool
 893 lex_match_variable (struct lexer *lexer, const struct glm_spec *glm, const struct variable **var)
 894 {
 895   if (lex_token (lexer) !=  T_ID)
 896     return false;
 897
 898   *var = parse_variable_const  (lexer, glm->dict);
 899
 900   if ( *var == NULL)
 901     return false;
 902   return true;
 903 }
 904
 905 /* An interaction is a variable followed by {*, BY} followed by an interaction */
 906 static bool
 907 parse_design_interaction (struct lexer *lexer, struct glm_spec *glm, struct interaction **iact)
 908 {
 909   const struct variable *v = NULL;
 910   assert (iact);
 911
 912   switch  (lex_next_token (lexer, 1))
 913     {
 914     case T_ENDCMD:
 915     case T_SLASH:
 916     case T_COMMA:
 917     case T_ID:
 918     case T_BY:
 919     case T_ASTERISK:
 920       break;
 921     default:
 922       return false;
 923       break;
 924     }
 925
 926   if (! lex_match_variable (lexer, glm, &v))
 927     {
 928       interaction_destroy (*iact);
 929       *iact = NULL;
 930       return false;
 931     }
 932
 933   assert (v);
 934
 935   if ( *iact == NULL)
 936     *iact = interaction_create (v);
 937   else
 938     interaction_add_variable (*iact, v);
 939
 940   if ( lex_match (lexer, T_ASTERISK) || lex_match (lexer, T_BY))
 941     {
 942       return parse_design_interaction (lexer, glm, iact);
 943     }
 944
 945   return true;
 946 }
 947
 948 static bool
 949 parse_nested_variable (struct lexer *lexer, struct glm_spec *glm)
 950 {
 951   const struct variable *v = NULL;
 952   if ( ! lex_match_variable (lexer, glm, &v))
 953     return false;
 954
 955   if (lex_match (lexer, T_LPAREN))
 956     {
 957       if ( ! parse_nested_variable (lexer, glm))
 958         return false;
 959
 960       if ( ! lex_force_match (lexer, T_RPAREN))
 961         return false;
 962     }
 963
 964   lex_error (lexer, "Nested variables are not yet implemented"); return false;
 965   return true;
 966 }
 967
 968 /* A design term is an interaction OR a nested variable */
 969 static bool
 970 parse_design_term (struct lexer *lexer, struct glm_spec *glm)
 971 {
 972   struct interaction *iact = NULL;
 973   if (parse_design_interaction (lexer, glm, &iact))
 974     {
 975       /* Interaction parsing successful.  Add to list of interactions */
 976       glm->interactions = xrealloc (glm->interactions, sizeof *glm->interactions * ++glm->n_interactions);
 977       glm->interactions[glm->n_interactions - 1] = iact;
 978       return true;
 979     }
 980
 981   if ( parse_nested_variable (lexer, glm))
 982     return true;
 983
 984   return false;
 985 }
 986
 987
 988
 989 /* Parse a complete DESIGN specification.
 990    A design spec is a design term, optionally followed by a comma,
 991    and another design spec.
 992 */
 993 static bool
 994 parse_design_spec (struct lexer *lexer, struct glm_spec *glm)
 995 {
 996   if  (lex_token (lexer) == T_ENDCMD || lex_token (lexer) == T_SLASH)
 997     return true;
 998
 999   if ( ! parse_design_term (lexer, glm))
1000     return false;
1001
1002   lex_match (lexer, T_COMMA);
1003
1004   return parse_design_spec (lexer, glm);
1005 }
1006