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