pintos-os.org Git - pspp/blob - src/language/stats/regression.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2005, 2009, 2010, 2011, 2012, 2013, 2014,
   3    2016, 2017, 2019 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  17
  18 #include <config.h>
  19
  20 #include <float.h>
  21 #include <stdbool.h>
  22
  23 #include <gsl/gsl_math.h>
  24 #include <gsl/gsl_cdf.h>
  25 #include <gsl/gsl_matrix.h>
  26
  27 #include <data/dataset.h>
  28 #include <data/casewriter.h>
  29
  30 #include "language/command.h"
  31 #include "language/lexer/lexer.h"
  32 #include "language/lexer/value-parser.h"
  33 #include "language/lexer/variable-parser.h"
  34
  35
  36 #include "data/casegrouper.h"
  37 #include "data/casereader.h"
  38 #include "data/dictionary.h"
  39
  40 #include "math/covariance.h"
  41 #include "math/linreg.h"
  42 #include "math/moments.h"
  43
  44 #include "libpspp/message.h"
  45 #include "libpspp/taint.h"
  46
  47 #include "output/pivot-table.h"
  48
  49 #include "gl/intprops.h"
  50 #include "gl/minmax.h"
  51
  52 #include "gettext.h"
  53 #define _(msgid) gettext (msgid)
  54 #define N_(msgid) msgid
  55
  56
  57 #define STATS_R      1
  58 #define STATS_COEFF  2
  59 #define STATS_ANOVA  4
  60 #define STATS_OUTS   8
  61 #define STATS_CI    16
  62 #define STATS_BCOV  32
  63 #define STATS_TOL   64
  64
  65 #define STATS_DEFAULT  (STATS_R | STATS_COEFF | STATS_ANOVA | STATS_OUTS)
  66
  67
  68
  69 struct regression
  70 {
  71   struct dataset *ds;
  72
  73   const struct variable **vars;
  74   size_t n_vars;
  75
  76   const struct variable **dep_vars;
  77   size_t n_dep_vars;
  78
  79   unsigned int stats;
  80   double ci;
  81
  82   bool resid;
  83   bool pred;
  84
  85   bool origin;
  86 };
  87
  88 struct regression_workspace
  89 {
  90   /* The new variables which will be introduced by /SAVE */
  91   const struct variable **predvars;
  92   const struct variable **residvars;
  93
  94   /* A reader/writer pair to temporarily hold the
  95      values of the new variables */
  96   struct casewriter *writer;
  97   struct casereader *reader;
  98
  99   /* Indeces of the new values in the reader/writer (-1 if not applicable) */
 100   int res_idx;
 101   int pred_idx;
 102
 103   /* 0, 1 or 2 depending on what new variables are to be created */
 104   int extras;
 105 };
 106
 107 static void run_regression (const struct regression *cmd,
 108                             struct regression_workspace *ws,
 109                             struct casereader *input);
 110
 111
 112 /* Return a string based on PREFIX which may be used as the name
 113    of a new variable in DICT */
 114 static char *
 115 reg_get_name (const struct dictionary *dict, const char *prefix)
 116 {
 117   char *name;
 118   int i;
 119
 120   /* XXX handle too-long prefixes */
 121   name = xmalloc (strlen (prefix) + INT_BUFSIZE_BOUND (i) + 1);
 122   for (i = 1;; i++)
 123     {
 124       sprintf (name, "%s%d", prefix, i);
 125       if (dict_lookup_var (dict, name) == NULL)
 126         return name;
 127     }
 128 }
 129
 130
 131 static const struct variable *
 132 create_aux_var (struct dataset *ds, const char *prefix)
 133 {
 134   struct variable *var;
 135   struct dictionary *dict = dataset_dict (ds);
 136   char *name = reg_get_name (dict, prefix);
 137   var = dict_create_var_assert (dict, name, 0);
 138   free (name);
 139   return var;
 140 }
 141
 142 /* Auxiliary data for transformation when /SAVE is entered */
 143 struct save_trans_data
 144 {
 145   int n_dep_vars;
 146   struct regression_workspace *ws;
 147 };
 148
 149 static bool
 150 save_trans_free (void *aux)
 151 {
 152   struct save_trans_data *save_trans_data = aux;
 153   free (save_trans_data->ws->predvars);
 154   free (save_trans_data->ws->residvars);
 155
 156   casereader_destroy (save_trans_data->ws->reader);
 157   free (save_trans_data->ws);
 158   free (save_trans_data);
 159   return true;
 160 }
 161
 162 static enum trns_result
 163 save_trans_func (void *aux, struct ccase **c, casenumber x UNUSED)
 164 {
 165   struct save_trans_data *save_trans_data = aux;
 166   struct regression_workspace *ws = save_trans_data->ws;
 167   struct ccase *in =  casereader_read (ws->reader);
 168
 169   if (in)
 170     {
 171       int k;
 172       *c = case_unshare (*c);
 173
 174       for (k = 0; k < save_trans_data->n_dep_vars; ++k)
 175         {
 176           if (ws->pred_idx != -1)
 177             {
 178               double pred = case_num_idx (in, ws->extras * k + ws->pred_idx);
 179               *case_num_rw (*c, ws->predvars[k]) = pred;
 180             }
 181
 182           if (ws->res_idx != -1)
 183             {
 184               double resid = case_num_idx (in, ws->extras * k + ws->res_idx);
 185               *case_num_rw (*c, ws->residvars[k]) = resid;
 186             }
 187         }
 188       case_unref (in);
 189     }
 190
 191   return TRNS_CONTINUE;
 192 }
 193
 194 int
 195 cmd_regression (struct lexer *lexer, struct dataset *ds)
 196 {
 197   struct regression_workspace workspace;
 198   struct regression regression;
 199   const struct dictionary *dict = dataset_dict (ds);
 200   bool save;
 201
 202   memset (&regression, 0, sizeof (struct regression));
 203
 204   regression.ci = 0.95;
 205   regression.stats = STATS_DEFAULT;
 206   regression.pred = false;
 207   regression.resid = false;
 208
 209   regression.ds = ds;
 210   regression.origin = false;
 211
 212   bool variables_seen = false;
 213   bool method_seen = false;
 214   bool dependent_seen = false;
 215   while (lex_token (lexer) != T_ENDCMD)
 216     {
 217       lex_match (lexer, T_SLASH);
 218
 219       if (lex_match_id (lexer, "VARIABLES"))
 220         {
 221           if (method_seen)
 222             {
 223               msg (SE, _("VARIABLES may not appear after %s"), "METHOD");
 224               goto error;
 225             }
 226           if (dependent_seen)
 227             {
 228               msg (SE, _("VARIABLES may not appear after %s"), "DEPENDENT");
 229               goto error;
 230             }
 231           variables_seen = true;
 232           lex_match (lexer, T_EQUALS);
 233
 234           if (!parse_variables_const (lexer, dict,
 235                                       &regression.vars, &regression.n_vars,
 236                                       PV_NO_DUPLICATE | PV_NUMERIC))
 237             goto error;
 238         }
 239       else if (lex_match_id (lexer, "DEPENDENT"))
 240         {
 241           dependent_seen = true;
 242           lex_match (lexer, T_EQUALS);
 243
 244           free (regression.dep_vars);
 245           regression.n_dep_vars = 0;
 246
 247           if (!parse_variables_const (lexer, dict,
 248                                       &regression.dep_vars,
 249                                       &regression.n_dep_vars,
 250                                       PV_NO_DUPLICATE | PV_NUMERIC))
 251             goto error;
 252         }
 253       else if (lex_match_id (lexer, "ORIGIN"))
 254         {
 255           regression.origin = true;
 256         }
 257       else if (lex_match_id (lexer, "NOORIGIN"))
 258         {
 259           regression.origin = false;
 260         }
 261       else if (lex_match_id (lexer, "METHOD"))
 262         {
 263           method_seen = true;
 264           lex_match (lexer, T_EQUALS);
 265
 266           if (!lex_force_match_id (lexer, "ENTER"))
 267             {
 268               goto error;
 269             }
 270
 271           if (! variables_seen)
 272             {
 273               if (!parse_variables_const (lexer, dict,
 274                                           &regression.vars, &regression.n_vars,
 275                                           PV_NO_DUPLICATE | PV_NUMERIC))
 276                 goto error;
 277             }
 278         }
 279       else if (lex_match_id (lexer, "STATISTICS"))
 280         {
 281           unsigned long statistics = 0;
 282           lex_match (lexer, T_EQUALS);
 283
 284           while (lex_token (lexer) != T_ENDCMD
 285                  && lex_token (lexer) != T_SLASH)
 286             {
 287               if (lex_match (lexer, T_ALL))
 288                 {
 289                   statistics = ~0;
 290                 }
 291               else if (lex_match_id (lexer, "DEFAULTS"))
 292                 {
 293                   statistics |= STATS_DEFAULT;
 294                 }
 295               else if (lex_match_id (lexer, "R"))
 296                 {
 297                   statistics |= STATS_R;
 298                 }
 299               else if (lex_match_id (lexer, "COEFF"))
 300                 {
 301                   statistics |= STATS_COEFF;
 302                 }
 303               else if (lex_match_id (lexer, "ANOVA"))
 304                 {
 305                   statistics |= STATS_ANOVA;
 306                 }
 307               else if (lex_match_id (lexer, "BCOV"))
 308                 {
 309                   statistics |= STATS_BCOV;
 310                 }
 311               else if (lex_match_id (lexer, "TOL"))
 312                 {
 313                   statistics |= STATS_TOL;
 314                 }
 315               else if (lex_match_id (lexer, "CI"))
 316                 {
 317                   statistics |= STATS_CI;
 318
 319                   if (lex_match (lexer, T_LPAREN) &&
 320                       lex_force_num (lexer))
 321                     {
 322                       regression.ci = lex_number (lexer) / 100.0;
 323                       lex_get (lexer);
 324                       if (! lex_force_match (lexer, T_RPAREN))
 325                         goto error;
 326                     }
 327                 }
 328               else
 329                 {
 330                   lex_error (lexer, NULL);
 331                   goto error;
 332                 }
 333             }
 334
 335           if (statistics)
 336             regression.stats = statistics;
 337
 338         }
 339       else if (lex_match_id (lexer, "SAVE"))
 340         {
 341           lex_match (lexer, T_EQUALS);
 342
 343           while (lex_token (lexer) != T_ENDCMD
 344                  && lex_token (lexer) != T_SLASH)
 345             {
 346               if (lex_match_id (lexer, "PRED"))
 347                 {
 348                   regression.pred = true;
 349                 }
 350               else if (lex_match_id (lexer, "RESID"))
 351                 {
 352                   regression.resid = true;
 353                 }
 354               else
 355                 {
 356                   lex_error (lexer, NULL);
 357                   goto error;
 358                 }
 359             }
 360         }
 361       else
 362         {
 363           lex_error (lexer, NULL);
 364           goto error;
 365         }
 366     }
 367
 368   if (!regression.vars)
 369     {
 370       dict_get_vars (dict, &regression.vars, &regression.n_vars, 0);
 371     }
 372
 373   save = regression.pred || regression.resid;
 374   workspace.extras = 0;
 375   workspace.res_idx = -1;
 376   workspace.pred_idx = -1;
 377   workspace.writer = NULL;
 378   workspace.reader = NULL;
 379   workspace.residvars = NULL;
 380   workspace.predvars = NULL;
 381   if (save)
 382     {
 383       int i;
 384       struct caseproto *proto = caseproto_create ();
 385
 386       if (regression.resid)
 387         {
 388           workspace.res_idx = workspace.extras ++;
 389           workspace.residvars = xcalloc (regression.n_dep_vars, sizeof (*workspace.residvars));
 390
 391           for (i = 0; i < regression.n_dep_vars; ++i)
 392             {
 393               workspace.residvars[i] = create_aux_var (ds, "RES");
 394               proto = caseproto_add_width (proto, 0);
 395             }
 396         }
 397
 398       if (regression.pred)
 399         {
 400           workspace.pred_idx = workspace.extras ++;
 401           workspace.predvars = xcalloc (regression.n_dep_vars, sizeof (*workspace.predvars));
 402
 403           for (i = 0; i < regression.n_dep_vars; ++i)
 404             {
 405               workspace.predvars[i] = create_aux_var (ds, "PRED");
 406               proto = caseproto_add_width (proto, 0);
 407             }
 408         }
 409
 410       if (proc_make_temporary_transformations_permanent (ds))
 411         msg (SW, _("REGRESSION with SAVE ignores TEMPORARY.  "
 412                    "Temporary transformations will be made permanent."));
 413
 414       if (dict_get_filter (dict))
 415         msg (SW, _("REGRESSION with SAVE ignores FILTER.  "
 416                    "All cases will be processed."));
 417
 418       workspace.writer = autopaging_writer_create (proto);
 419       caseproto_unref (proto);
 420     }
 421
 422
 423   {
 424     struct casegrouper *grouper;
 425     struct casereader *group;
 426     bool ok;
 427
 428     grouper = casegrouper_create_splits (proc_open_filtering (ds, !save), dict);
 429
 430
 431     while (casegrouper_get_next_group (grouper, &group))
 432       {
 433         run_regression (&regression,
 434                         &workspace,
 435                         group);
 436
 437       }
 438     ok = casegrouper_destroy (grouper);
 439     ok = proc_commit (ds) && ok;
 440   }
 441
 442   if (workspace.writer)
 443     {
 444       struct save_trans_data *save_trans_data = xmalloc (sizeof *save_trans_data);
 445       struct casereader *r = casewriter_make_reader (workspace.writer);
 446       workspace.writer = NULL;
 447       workspace.reader = r;
 448       save_trans_data->ws = xmalloc (sizeof (workspace));
 449       memcpy (save_trans_data->ws, &workspace, sizeof (workspace));
 450       save_trans_data->n_dep_vars = regression.n_dep_vars;
 451
 452       add_transformation (ds, save_trans_func, save_trans_free, save_trans_data);
 453     }
 454
 455
 456   free (regression.vars);
 457   free (regression.dep_vars);
 458   return CMD_SUCCESS;
 459
 460 error:
 461
 462   free (regression.vars);
 463   free (regression.dep_vars);
 464   return CMD_FAILURE;
 465 }
 466
 467 /* Return the size of the union of dependent and independent variables */
 468 static size_t
 469 get_n_all_vars (const struct regression *cmd)
 470 {
 471   size_t result = cmd->n_vars;
 472   size_t i;
 473   size_t j;
 474
 475   result += cmd->n_dep_vars;
 476   for (i = 0; i < cmd->n_dep_vars; i++)
 477     {
 478       for (j = 0; j < cmd->n_vars; j++)
 479         {
 480           if (cmd->vars[j] == cmd->dep_vars[i])
 481             {
 482               result--;
 483             }
 484         }
 485     }
 486   return result;
 487 }
 488
 489 /* Fill VARS with the union of dependent and independent variables */
 490 static void
 491 fill_all_vars (const struct variable **vars, const struct regression *cmd)
 492 {
 493   size_t x = 0;
 494   size_t i;
 495   for (i = 0; i < cmd->n_vars; i++)
 496     {
 497       vars[i] = cmd->vars[i];
 498     }
 499
 500   for (i = 0; i < cmd->n_dep_vars; i++)
 501     {
 502       size_t j;
 503       bool absent = true;
 504       for (j = 0; j < cmd->n_vars; j++)
 505         {
 506           if (cmd->dep_vars[i] == cmd->vars[j])
 507             {
 508               absent = false;
 509               break;
 510             }
 511         }
 512       if (absent)
 513         {
 514           vars[cmd->n_vars + x++] = cmd->dep_vars[i];
 515         }
 516     }
 517 }
 518
 519
 520 /* Fill the array VARS, with all the predictor variables from CMD, except
 521    variable X */
 522 static void
 523 fill_predictor_x (const struct variable **vars, const struct variable *x, const struct regression *cmd)
 524 {
 525   size_t i;
 526   size_t n = 0;
 527
 528   for (i = 0; i < cmd->n_vars; i++)
 529     {
 530       if (cmd->vars[i] == x)
 531         continue;
 532
 533       vars[n++] = cmd->vars[i];
 534     }
 535 }
 536
 537 /*
 538   Is variable k the dependent variable?
 539 */
 540 static bool
 541 is_depvar (const struct regression *cmd, size_t k, const struct variable *v)
 542 {
 543   return v == cmd->vars[k];
 544 }
 545
 546
 547 /* Identify the explanatory variables in v_variables.  Returns
 548    the number of independent variables. */
 549 static int
 550 identify_indep_vars (const struct regression *cmd,
 551                      const struct variable **indep_vars,
 552                      const struct variable *depvar)
 553 {
 554   int n_indep_vars = 0;
 555   int i;
 556
 557   for (i = 0; i < cmd->n_vars; i++)
 558     if (!is_depvar (cmd, i, depvar))
 559       indep_vars[n_indep_vars++] = cmd->vars[i];
 560   if ((n_indep_vars < 1) && is_depvar (cmd, 0, depvar))
 561     {
 562       /*
 563          There is only one independent variable, and it is the same
 564          as the dependent variable. Print a warning and continue.
 565        */
 566       msg (SW,
 567            gettext
 568            ("The dependent variable is equal to the independent variable. "
 569             "The least squares line is therefore Y=X. "
 570             "Standard errors and related statistics may be meaningless."));
 571       n_indep_vars = 1;
 572       indep_vars[0] = cmd->vars[0];
 573     }
 574   return n_indep_vars;
 575 }
 576
 577 static double
 578 fill_covariance (gsl_matrix * cov, struct covariance *all_cov,
 579                  const struct variable **vars,
 580                  size_t n_vars, const struct variable *dep_var,
 581                  const struct variable **all_vars, size_t n_all_vars,
 582                  double *means)
 583 {
 584   size_t i;
 585   size_t j;
 586   size_t dep_subscript = SIZE_MAX;
 587   size_t *rows;
 588   const gsl_matrix *ssizes;
 589   const gsl_matrix *mean_matrix;
 590   const gsl_matrix *ssize_matrix;
 591   double result = 0.0;
 592
 593   const gsl_matrix *cm = covariance_calculate_unnormalized (all_cov);
 594
 595   if (cm == NULL)
 596     return 0;
 597
 598   rows = xnmalloc (cov->size1 - 1, sizeof (*rows));
 599
 600   for (i = 0; i < n_all_vars; i++)
 601     {
 602       for (j = 0; j < n_vars; j++)
 603         {
 604           if (vars[j] == all_vars[i])
 605             {
 606               rows[j] = i;
 607             }
 608         }
 609       if (all_vars[i] == dep_var)
 610         {
 611           dep_subscript = i;
 612         }
 613     }
 614   assert (dep_subscript != SIZE_MAX);
 615
 616   mean_matrix = covariance_moments (all_cov, MOMENT_MEAN);
 617   ssize_matrix = covariance_moments (all_cov, MOMENT_NONE);
 618   for (i = 0; i < cov->size1 - 1; i++)
 619     {
 620       means[i] = gsl_matrix_get (mean_matrix, rows[i], 0)
 621         / gsl_matrix_get (ssize_matrix, rows[i], 0);
 622       for (j = 0; j < cov->size2 - 1; j++)
 623         {
 624           gsl_matrix_set (cov, i, j, gsl_matrix_get (cm, rows[i], rows[j]));
 625           gsl_matrix_set (cov, j, i, gsl_matrix_get (cm, rows[j], rows[i]));
 626         }
 627     }
 628   means[cov->size1 - 1] = gsl_matrix_get (mean_matrix, dep_subscript, 0)
 629     / gsl_matrix_get (ssize_matrix, dep_subscript, 0);
 630   ssizes = covariance_moments (all_cov, MOMENT_NONE);
 631   result = gsl_matrix_get (ssizes, dep_subscript, rows[0]);
 632   for (i = 0; i < cov->size1 - 1; i++)
 633     {
 634       gsl_matrix_set (cov, i, cov->size1 - 1,
 635                       gsl_matrix_get (cm, rows[i], dep_subscript));
 636       gsl_matrix_set (cov, cov->size1 - 1, i,
 637                       gsl_matrix_get (cm, rows[i], dep_subscript));
 638       if (result > gsl_matrix_get (ssizes, rows[i], dep_subscript))
 639         {
 640           result = gsl_matrix_get (ssizes, rows[i], dep_subscript);
 641         }
 642     }
 643   gsl_matrix_set (cov, cov->size1 - 1, cov->size1 - 1,
 644                   gsl_matrix_get (cm, dep_subscript, dep_subscript));
 645   free (rows);
 646   return result;
 647 }
 648
 649 \f
 650
 651 struct model_container
 652 {
 653   struct linreg **models;
 654 };
 655
 656 /*
 657   STATISTICS subcommand output functions.
 658 */
 659 static void reg_stats_r (const struct linreg *,     const struct variable *);
 660 static void reg_stats_coeff (const struct regression *, const struct linreg *,
 661                              const struct model_container *, const gsl_matrix *,
 662                              const struct variable *);
 663 static void reg_stats_anova (const struct linreg *, const struct variable *);
 664 static void reg_stats_bcov (const struct linreg *,  const struct variable *);
 665
 666
 667 static struct linreg **
 668 run_regression_get_models (const struct regression *cmd,
 669                            struct casereader *input,
 670                            bool output)
 671 {
 672   size_t i;
 673   struct model_container *model_container = XCALLOC (cmd->n_vars, struct model_container);
 674
 675   struct ccase *c;
 676   struct covariance *cov;
 677   struct casereader *reader;
 678
 679   if (cmd->stats & STATS_TOL)
 680     {
 681       for (i = 0; i < cmd->n_vars; i++)
 682         {
 683           struct regression subreg;
 684           subreg.origin = cmd->origin;
 685           subreg.ds = cmd->ds;
 686           subreg.n_vars = cmd->n_vars - 1;
 687           subreg.n_dep_vars = 1;
 688           subreg.vars = xmalloc (sizeof (*subreg.vars) * cmd->n_vars - 1);
 689           subreg.dep_vars = xmalloc (sizeof (*subreg.dep_vars));
 690           fill_predictor_x (subreg.vars, cmd->vars[i], cmd);
 691           subreg.dep_vars[0] = cmd->vars[i];
 692           subreg.stats = STATS_R;
 693           subreg.ci = 0;
 694           subreg.resid = false;
 695           subreg.pred = false;
 696
 697           model_container[i].models =
 698             run_regression_get_models (&subreg, input, false);
 699           free (subreg.vars);
 700           free (subreg.dep_vars);
 701         }
 702     }
 703
 704   size_t n_all_vars = get_n_all_vars (cmd);
 705   const struct variable **all_vars = xnmalloc (n_all_vars, sizeof (*all_vars));
 706
 707   /* In the (rather pointless) case where the dependent variable is
 708      the independent variable, n_all_vars == 1.
 709      However this would result in a buffer overflow so we must
 710      over-allocate the space required in this malloc call.
 711      See bug #58599  */
 712   double *means = xnmalloc (n_all_vars <= 1 ? 2 : n_all_vars,
 713                             sizeof (*means));
 714   fill_all_vars (all_vars, cmd);
 715   cov = covariance_1pass_create (n_all_vars, all_vars,
 716                                  dict_get_weight (dataset_dict (cmd->ds)),
 717                                  MV_ANY, cmd->origin == false);
 718
 719   reader = casereader_clone (input);
 720   reader = casereader_create_filter_missing (reader, all_vars, n_all_vars,
 721                                              MV_ANY, NULL, NULL);
 722 {
 723     struct casereader *r = casereader_clone (reader);
 724
 725     for (; (c = casereader_read (r)) != NULL; case_unref (c))
 726       {
 727         covariance_accumulate (cov, c);
 728       }
 729     casereader_destroy (r);
 730   }
 731
 732   struct linreg **models = XCALLOC (cmd->n_dep_vars, struct linreg*);
 733
 734   for (int k = 0; k < cmd->n_dep_vars; k++)
 735     {
 736       const struct variable **vars = xnmalloc (cmd->n_vars, sizeof (*vars));
 737       const struct variable *dep_var = cmd->dep_vars[k];
 738       int n_indep = identify_indep_vars (cmd, vars, dep_var);
 739       gsl_matrix *cov_matrix = gsl_matrix_alloc (n_indep + 1, n_indep + 1);
 740       double n_data = fill_covariance (cov_matrix, cov, vars, n_indep,
 741                                 dep_var, all_vars, n_all_vars, means);
 742       models[k] = linreg_alloc (dep_var, vars,  n_data, n_indep, cmd->origin);
 743       for (i = 0; i < n_indep; i++)
 744         {
 745           linreg_set_indep_variable_mean (models[k], i, means[i]);
 746         }
 747       linreg_set_depvar_mean (models[k], means[i]);
 748       if (n_data > 0)
 749         {
 750           linreg_fit (cov_matrix, models[k]);
 751
 752           if (output && !taint_has_tainted_successor (casereader_get_taint (input)))
 753             {
 754               /*
 755                 Find the least-squares estimates and other statistics.
 756               */
 757               if (cmd->stats & STATS_R)
 758                 reg_stats_r (models[k], dep_var);
 759
 760               if (cmd->stats & STATS_ANOVA)
 761                 reg_stats_anova (models[k], dep_var);
 762
 763               if (cmd->stats & STATS_COEFF)
 764                 reg_stats_coeff (cmd, models[k],
 765                                  model_container,
 766                                  cov_matrix, dep_var);
 767
 768               if (cmd->stats & STATS_BCOV)
 769                 reg_stats_bcov  (models[k], dep_var);
 770             }
 771         }
 772       else
 773         {
 774           msg (SE, _("No valid data found. This command was skipped."));
 775         }
 776       free (vars);
 777       gsl_matrix_free (cov_matrix);
 778     }
 779
 780   casereader_destroy (reader);
 781
 782   for (int i = 0; i < cmd->n_vars; i++)
 783     {
 784       if (model_container[i].models)
 785         {
 786           linreg_unref (model_container[i].models[0]);
 787         }
 788       free (model_container[i].models);
 789     }
 790   free (model_container);
 791
 792   free (all_vars);
 793   free (means);
 794   covariance_destroy (cov);
 795   return models;
 796 }
 797
 798 static void
 799 run_regression (const struct regression *cmd,
 800                 struct regression_workspace *ws,
 801                 struct casereader *input)
 802 {
 803   struct linreg **models = run_regression_get_models (cmd, input, true);
 804
 805   if (ws->extras > 0)
 806    {
 807      struct ccase *c;
 808       struct casereader *r = casereader_clone (input);
 809
 810       for (; (c = casereader_read (r)) != NULL; case_unref (c))
 811         {
 812           struct ccase *outc = case_create (casewriter_get_proto (ws->writer));
 813           for (int k = 0; k < cmd->n_dep_vars; k++)
 814             {
 815               const struct variable **vars = xnmalloc (cmd->n_vars, sizeof (*vars));
 816               const struct variable *dep_var = cmd->dep_vars[k];
 817               int n_indep = identify_indep_vars (cmd, vars, dep_var);
 818               double *vals = xnmalloc (n_indep, sizeof (*vals));
 819               for (int i = 0; i < n_indep; i++)
 820                 {
 821                   const union value *tmp = case_data (c, vars[i]);
 822                   vals[i] = tmp->f;
 823                 }
 824
 825               if (cmd->pred)
 826                 {
 827                   double pred = linreg_predict (models[k], vals, n_indep);
 828                   *case_num_rw_idx (outc, k * ws->extras + ws->pred_idx) = pred;
 829                 }
 830
 831               if (cmd->resid)
 832                 {
 833                   double obs = case_num (c, linreg_dep_var (models[k]));
 834                   double res = linreg_residual (models[k], obs,  vals, n_indep);
 835                   *case_num_rw_idx (outc, k * ws->extras + ws->res_idx) = res;
 836                 }
 837               free (vals);
 838               free (vars);
 839             }
 840           casewriter_write (ws->writer, outc);
 841         }
 842       casereader_destroy (r);
 843     }
 844
 845   for (int k = 0; k < cmd->n_dep_vars; k++)
 846     {
 847       linreg_unref (models[k]);
 848     }
 849
 850   free (models);
 851   casereader_destroy (input);
 852 }
 853
 854 \f
 855
 856
 857 static void
 858 reg_stats_r (const struct linreg * c, const struct variable *var)
 859 {
 860   struct pivot_table *table = pivot_table_create__ (
 861     pivot_value_new_text_format (N_("Model Summary (%s)"),
 862                                  var_to_string (var)),
 863     "Model Summary");
 864
 865   pivot_dimension_create (table, PIVOT_AXIS_COLUMN, N_("Statistics"),
 866                           N_("R"), N_("R Square"), N_("Adjusted R Square"),
 867                           N_("Std. Error of the Estimate"));
 868
 869   double rsq = linreg_ssreg (c) / linreg_sst (c);
 870   double adjrsq = (rsq -
 871                    (1.0 - rsq) * linreg_n_coeffs (c)
 872                    / (linreg_n_obs (c) - linreg_n_coeffs (c) - 1));
 873   double std_error = sqrt (linreg_mse (c));
 874
 875   double entries[] = {
 876     sqrt (rsq), rsq, adjrsq, std_error
 877   };
 878   for (size_t i = 0; i < sizeof entries / sizeof *entries; i++)
 879     pivot_table_put1 (table, i, pivot_value_new_number (entries[i]));
 880
 881   pivot_table_submit (table);
 882 }
 883
 884 /*
 885   Table showing estimated regression coefficients.
 886 */
 887 static void
 888 reg_stats_coeff (const struct regression *cmd, const struct linreg *c,
 889                  const struct model_container *mc, const gsl_matrix *cov,
 890                  const struct variable *var)
 891 {
 892   struct pivot_table *table = pivot_table_create__ (
 893     pivot_value_new_text_format (N_("Coefficients (%s)"), var_to_string (var)),
 894     "Coefficients");
 895
 896   struct pivot_dimension *statistics = pivot_dimension_create (
 897     table, PIVOT_AXIS_COLUMN, N_("Statistics"));
 898   pivot_category_create_group (statistics->root,
 899                                N_("Unstandardized Coefficients"),
 900                                N_("B"), N_("Std. Error"));
 901   pivot_category_create_group (statistics->root,
 902                                N_("Standardized Coefficients"), N_("Beta"));
 903   pivot_category_create_leaves (statistics->root, N_("t"),
 904                                 N_("Sig."), PIVOT_RC_SIGNIFICANCE);
 905   if (cmd->stats & STATS_CI)
 906     {
 907       struct pivot_category *interval = pivot_category_create_group__ (
 908         statistics->root, pivot_value_new_text_format (
 909           N_("%g%% Confidence Interval for B"),
 910           cmd->ci * 100.0));
 911       pivot_category_create_leaves (interval, N_("Lower Bound"),
 912                                     N_("Upper Bound"));
 913     }
 914
 915   if (cmd->stats & STATS_TOL)
 916     pivot_category_create_group (statistics->root,
 917                                  N_("Collinearity Statistics"),
 918                                  N_("Tolerance"), N_("VIF"));
 919
 920
 921   struct pivot_dimension *variables = pivot_dimension_create (
 922     table, PIVOT_AXIS_ROW, N_("Variables"));
 923
 924   double df = linreg_n_obs (c) - linreg_n_coeffs (c) - 1;
 925   double q = (1 - cmd->ci) / 2.0;  /* 2-tailed test */
 926   double tval = gsl_cdf_tdist_Qinv (q, df);
 927
 928   if (!cmd->origin)
 929     {
 930       int var_idx = pivot_category_create_leaf (
 931         variables->root, pivot_value_new_text (N_("(Constant)")));
 932
 933       double std_err = sqrt (gsl_matrix_get (linreg_cov (c), 0, 0));
 934       double t_stat = linreg_intercept (c) / std_err;
 935       double base_entries[] = {
 936         linreg_intercept (c),
 937         std_err,
 938         0.0,
 939         t_stat,
 940         2.0 * gsl_cdf_tdist_Q (fabs (t_stat),
 941                                linreg_n_obs (c) - linreg_n_coeffs (c)),
 942       };
 943
 944       size_t col = 0;
 945       for (size_t i = 0; i < sizeof base_entries / sizeof *base_entries; i++)
 946         pivot_table_put2 (table, col++, var_idx,
 947                           pivot_value_new_number (base_entries[i]));
 948
 949       if (cmd->stats & STATS_CI)
 950         {
 951           double interval_entries[] = {
 952             linreg_intercept (c) - tval * std_err,
 953             linreg_intercept (c) + tval * std_err,
 954           };
 955
 956           for (size_t i = 0; i < sizeof interval_entries / sizeof *interval_entries; i++)
 957             pivot_table_put2 (table, col++, var_idx,
 958                               pivot_value_new_number (interval_entries[i]));
 959         }
 960     }
 961
 962   for (size_t j = 0; j < linreg_n_coeffs (c); j++)
 963     {
 964       const struct variable *v = linreg_indep_var (c, j);
 965       int var_idx = pivot_category_create_leaf (
 966         variables->root, pivot_value_new_variable (v));
 967
 968       double std_err = sqrt (gsl_matrix_get (linreg_cov (c), j + 1, j + 1));
 969       double t_stat = linreg_coeff (c, j) / std_err;
 970       double base_entries[] = {
 971         linreg_coeff (c, j),
 972         sqrt (gsl_matrix_get (linreg_cov (c), j + 1, j + 1)),
 973         (sqrt (gsl_matrix_get (cov, j, j)) * linreg_coeff (c, j) /
 974          sqrt (gsl_matrix_get (cov, cov->size1 - 1, cov->size2 - 1))),
 975         t_stat,
 976         2 * gsl_cdf_tdist_Q (fabs (t_stat), df)
 977       };
 978
 979       size_t col = 0;
 980       for (size_t i = 0; i < sizeof base_entries / sizeof *base_entries; i++)
 981         pivot_table_put2 (table, col++, var_idx,
 982                           pivot_value_new_number (base_entries[i]));
 983
 984       if (cmd->stats & STATS_CI)
 985         {
 986           double interval_entries[] = {
 987             linreg_coeff (c, j)  - tval * std_err,
 988             linreg_coeff (c, j)  + tval * std_err,
 989           };
 990
 991
 992           for (size_t i = 0; i < sizeof interval_entries / sizeof *interval_entries; i++)
 993             pivot_table_put2 (table, col++, var_idx,
 994                               pivot_value_new_number (interval_entries[i]));
 995         }
 996
 997       if (cmd->stats & STATS_TOL)
 998         {
 999           {
1000             struct linreg *m = mc[j].models[0];
1001             double rsq = linreg_ssreg (m) / linreg_sst (m);
1002             pivot_table_put2 (table, col++, var_idx, pivot_value_new_number (1.0 - rsq));
1003             pivot_table_put2 (table, col++, var_idx, pivot_value_new_number (1.0 / (1.0 - rsq)));
1004           }
1005         }
1006     }
1007
1008   pivot_table_submit (table);
1009 }
1010
1011 /*
1012   Display the ANOVA table.
1013 */
1014 static void
1015 reg_stats_anova (const struct linreg * c, const struct variable *var)
1016 {
1017   struct pivot_table *table = pivot_table_create__ (
1018     pivot_value_new_text_format (N_("ANOVA (%s)"), var_to_string (var)),
1019     "ANOVA");
1020
1021   pivot_dimension_create (table, PIVOT_AXIS_COLUMN, N_("Statistics"),
1022                           N_("Sum of Squares"), PIVOT_RC_OTHER,
1023                           N_("df"), PIVOT_RC_INTEGER,
1024                           N_("Mean Square"), PIVOT_RC_OTHER,
1025                           N_("F"), PIVOT_RC_OTHER,
1026                           N_("Sig."), PIVOT_RC_SIGNIFICANCE);
1027
1028   pivot_dimension_create (table, PIVOT_AXIS_ROW, N_("Source"),
1029                           N_("Regression"), N_("Residual"), N_("Total"));
1030
1031   double msm = linreg_ssreg (c) / linreg_dfmodel (c);
1032   double mse = linreg_mse (c);
1033   double F = msm / mse;
1034
1035   struct entry
1036     {
1037       int stat_idx;
1038       int source_idx;
1039       double x;
1040     }
1041   entries[] = {
1042     /* Sums of Squares. */
1043     { 0, 0, linreg_ssreg (c) },
1044     { 0, 1, linreg_sse (c) },
1045     { 0, 2, linreg_sst (c) },
1046     /* Degrees of freedom. */
1047     { 1, 0, linreg_dfmodel (c) },
1048     { 1, 1, linreg_dferror (c) },
1049     { 1, 2, linreg_dftotal (c) },
1050     /* Mean Squares. */
1051     { 2, 0, msm },
1052     { 2, 1, mse },
1053     /* F */
1054     { 3, 0, F },
1055     /* Significance. */
1056     { 4, 0, gsl_cdf_fdist_Q (F, linreg_dfmodel (c), linreg_dferror (c)) },
1057   };
1058   for (size_t i = 0; i < sizeof entries / sizeof *entries; i++)
1059     {
1060       const struct entry *e = &entries[i];
1061       pivot_table_put2 (table, e->stat_idx, e->source_idx,
1062                         pivot_value_new_number (e->x));
1063     }
1064
1065   pivot_table_submit (table);
1066 }
1067
1068
1069 static void
1070 reg_stats_bcov (const struct linreg * c, const struct variable *var)
1071 {
1072   struct pivot_table *table = pivot_table_create__ (
1073     pivot_value_new_text_format (N_("Coefficient Correlations (%s)"),
1074                                  var_to_string (var)),
1075     "Coefficient Correlations");
1076
1077   for (size_t i = 0; i < 2; i++)
1078     {
1079       struct pivot_dimension *models = pivot_dimension_create (
1080         table, i ? PIVOT_AXIS_ROW : PIVOT_AXIS_COLUMN, N_("Models"));
1081       for (size_t j = 0; j < linreg_n_coeffs (c); j++)
1082         pivot_category_create_leaf (
1083           models->root, pivot_value_new_variable (
1084             linreg_indep_var (c, j)));
1085     }
1086
1087   pivot_dimension_create (table, PIVOT_AXIS_ROW, N_("Statistics"),
1088                           N_("Covariances"));
1089
1090   for (size_t i = 0; i < linreg_n_coeffs (c); i++)
1091     for (size_t k = 0; k < linreg_n_coeffs (c); k++)
1092       {
1093         double cov = gsl_matrix_get (linreg_cov (c), MIN (i, k), MAX (i, k));
1094         pivot_table_put3 (table, k, i, 0, pivot_value_new_number (cov));
1095       }
1096
1097   pivot_table_submit (table);
1098 }