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           lex_match (lexer, T_EQUALS);
 229
 230           free (regression.dep_vars);
 231           regression.n_dep_vars = 0;
 232
 233           if (!parse_variables_const (lexer, dict,
 234                                       &regression.dep_vars,
 235                                       &regression.n_dep_vars,
 236                                       PV_NO_DUPLICATE | PV_NUMERIC))
 237             goto error;
 238         }
 239       else if (lex_match_id (lexer, "METHOD"))
 240         {
 241           lex_match (lexer, T_EQUALS);
 242
 243           if (!lex_force_match_id (lexer, "ENTER"))
 244             {
 245               goto error;
 246             }
 247         }
 248       else if (lex_match_id (lexer, "STATISTICS"))
 249         {
 250           unsigned long statistics = 0;
 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                   statistics = ~0;
 259                 }
 260               else if (lex_match_id (lexer, "DEFAULTS"))
 261                 {
 262                   statistics |= STATS_DEFAULT;
 263                 }
 264               else if (lex_match_id (lexer, "R"))
 265                 {
 266                   statistics |= STATS_R;
 267                 }
 268               else if (lex_match_id (lexer, "COEFF"))
 269                 {
 270                   statistics |= STATS_COEFF;
 271                 }
 272               else if (lex_match_id (lexer, "ANOVA"))
 273                 {
 274                   statistics |= STATS_ANOVA;
 275                 }
 276               else if (lex_match_id (lexer, "BCOV"))
 277                 {
 278                   statistics |= STATS_BCOV;
 279                 }
 280               else if (lex_match_id (lexer, "CI"))
 281                 {
 282                   statistics |= 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           if (statistics)
 299             regression.stats = statistics;
 300
 301         }
 302       else if (lex_match_id (lexer, "SAVE"))
 303         {
 304           lex_match (lexer, T_EQUALS);
 305
 306           while (lex_token (lexer) != T_ENDCMD
 307                  && lex_token (lexer) != T_SLASH)
 308             {
 309               if (lex_match_id (lexer, "PRED"))
 310                 {
 311                   regression.pred = true;
 312                 }
 313               else if (lex_match_id (lexer, "RESID"))
 314                 {
 315                   regression.resid = true;
 316                 }
 317               else
 318                 {
 319                   lex_error (lexer, NULL);
 320                   goto error;
 321                 }
 322             }
 323         }
 324       else
 325         {
 326           lex_error (lexer, NULL);
 327           goto error;
 328         }
 329     }
 330
 331   if (!regression.vars)
 332     {
 333       dict_get_vars (dict, &regression.vars, &regression.n_vars, 0);
 334     }
 335
 336   save = regression.pred || regression.resid;
 337   workspace.extras = 0;
 338   workspace.res_idx = -1;
 339   workspace.pred_idx = -1;
 340   workspace.writer = NULL;
 341   workspace.reader = NULL;
 342   workspace.residvars = NULL;
 343   workspace.predvars = NULL;
 344   if (save)
 345     {
 346       int i;
 347       struct caseproto *proto = caseproto_create ();
 348
 349       if (regression.resid)
 350         {
 351           workspace.extras ++;
 352           workspace.res_idx = 0;
 353           workspace.residvars = xcalloc (regression.n_dep_vars, sizeof (*workspace.residvars));
 354
 355           for (i = 0; i < regression.n_dep_vars; ++i)
 356             {
 357               workspace.residvars[i] = create_aux_var (ds, "RES");
 358               proto = caseproto_add_width (proto, 0);
 359             }
 360         }
 361
 362       if (regression.pred)
 363         {
 364           workspace.extras ++;
 365           workspace.pred_idx = 1;
 366           workspace.predvars = xcalloc (regression.n_dep_vars, sizeof (*workspace.predvars));
 367
 368           for (i = 0; i < regression.n_dep_vars; ++i)
 369             {
 370               workspace.predvars[i] = create_aux_var (ds, "PRED");
 371               proto = caseproto_add_width (proto, 0);
 372             }
 373         }
 374
 375       if (proc_make_temporary_transformations_permanent (ds))
 376         msg (SW, _("REGRESSION with SAVE ignores TEMPORARY.  "
 377                    "Temporary transformations will be made permanent."));
 378
 379       workspace.writer = autopaging_writer_create (proto);
 380       caseproto_unref (proto);
 381     }
 382
 383
 384   {
 385     struct casegrouper *grouper;
 386     struct casereader *group;
 387     bool ok;
 388
 389     grouper = casegrouper_create_splits (proc_open_filtering (ds, !save), dict);
 390
 391
 392     while (casegrouper_get_next_group (grouper, &group))
 393       {
 394         run_regression (&regression,
 395                         &workspace,
 396                         group);
 397
 398       }
 399     ok = casegrouper_destroy (grouper);
 400     ok = proc_commit (ds) && ok;
 401   }
 402
 403   if (workspace.writer)
 404     {
 405       struct save_trans_data *save_trans_data = xmalloc (sizeof *save_trans_data);
 406       struct casereader *r = casewriter_make_reader (workspace.writer);
 407       workspace.writer = NULL;
 408       workspace.reader = r;
 409       save_trans_data->ws = xmalloc (sizeof (workspace));
 410       memcpy (save_trans_data->ws, &workspace, sizeof (workspace));
 411       save_trans_data->n_dep_vars = regression.n_dep_vars;
 412
 413       add_transformation (ds, save_trans_func, save_trans_free, save_trans_data);
 414     }
 415
 416
 417   free (regression.vars);
 418   free (regression.dep_vars);
 419   return CMD_SUCCESS;
 420
 421 error:
 422
 423   free (regression.vars);
 424   free (regression.dep_vars);
 425   return CMD_FAILURE;
 426 }
 427
 428 /* Return the size of the union of dependent and independent variables */
 429 static size_t
 430 get_n_all_vars (const struct regression *cmd)
 431 {
 432   size_t result = cmd->n_vars;
 433   size_t i;
 434   size_t j;
 435
 436   result += cmd->n_dep_vars;
 437   for (i = 0; i < cmd->n_dep_vars; i++)
 438     {
 439       for (j = 0; j < cmd->n_vars; j++)
 440         {
 441           if (cmd->vars[j] == cmd->dep_vars[i])
 442             {
 443               result--;
 444             }
 445         }
 446     }
 447   return result;
 448 }
 449
 450 /* Fill VARS with the union of dependent and independent variables */
 451 static void
 452 fill_all_vars (const struct variable **vars, const struct regression *cmd)
 453 {
 454   size_t x = 0;
 455   size_t i;
 456   for (i = 0; i < cmd->n_vars; i++)
 457     {
 458       vars[i] = cmd->vars[i];
 459     }
 460
 461   for (i = 0; i < cmd->n_dep_vars; i++)
 462     {
 463       size_t j;
 464       bool absent = true;
 465       for (j = 0; j < cmd->n_vars; j++)
 466         {
 467           if (cmd->dep_vars[i] == cmd->vars[j])
 468             {
 469               absent = false;
 470               break;
 471             }
 472         }
 473       if (absent)
 474         {
 475           vars[cmd->n_vars + x++] = cmd->dep_vars[i];
 476         }
 477     }
 478 }
 479
 480 /*
 481   Is variable k the dependent variable?
 482 */
 483 static bool
 484 is_depvar (const struct regression *cmd, size_t k, const struct variable *v)
 485 {
 486   return v == cmd->vars[k];
 487 }
 488
 489
 490 /* Identify the explanatory variables in v_variables.  Returns
 491    the number of independent variables. */
 492 static int
 493 identify_indep_vars (const struct regression *cmd,
 494                      const struct variable **indep_vars,
 495                      const struct variable *depvar)
 496 {
 497   int n_indep_vars = 0;
 498   int i;
 499
 500   for (i = 0; i < cmd->n_vars; i++)
 501     if (!is_depvar (cmd, i, depvar))
 502       indep_vars[n_indep_vars++] = cmd->vars[i];
 503   if ((n_indep_vars < 1) && is_depvar (cmd, 0, depvar))
 504     {
 505       /*
 506          There is only one independent variable, and it is the same
 507          as the dependent variable. Print a warning and continue.
 508        */
 509       msg (SW,
 510            gettext
 511            ("The dependent variable is equal to the independent variable. "
 512             "The least squares line is therefore Y=X. "
 513             "Standard errors and related statistics may be meaningless."));
 514       n_indep_vars = 1;
 515       indep_vars[0] = cmd->vars[0];
 516     }
 517   return n_indep_vars;
 518 }
 519
 520
 521 static double
 522 fill_covariance (gsl_matrix * cov, struct covariance *all_cov,
 523                  const struct variable **vars,
 524                  size_t n_vars, const struct variable *dep_var,
 525                  const struct variable **all_vars, size_t n_all_vars,
 526                  double *means)
 527 {
 528   size_t i;
 529   size_t j;
 530   size_t dep_subscript;
 531   size_t *rows;
 532   const gsl_matrix *ssizes;
 533   const gsl_matrix *mean_matrix;
 534   const gsl_matrix *ssize_matrix;
 535   double result = 0.0;
 536
 537   const gsl_matrix *cm = covariance_calculate_unnormalized (all_cov);
 538
 539   if (cm == NULL)
 540     return 0;
 541
 542   rows = xnmalloc (cov->size1 - 1, sizeof (*rows));
 543
 544   for (i = 0; i < n_all_vars; i++)
 545     {
 546       for (j = 0; j < n_vars; j++)
 547         {
 548           if (vars[j] == all_vars[i])
 549             {
 550               rows[j] = i;
 551             }
 552         }
 553       if (all_vars[i] == dep_var)
 554         {
 555           dep_subscript = i;
 556         }
 557     }
 558   mean_matrix = covariance_moments (all_cov, MOMENT_MEAN);
 559   ssize_matrix = covariance_moments (all_cov, MOMENT_NONE);
 560   for (i = 0; i < cov->size1 - 1; i++)
 561     {
 562       means[i] = gsl_matrix_get (mean_matrix, rows[i], 0)
 563         / gsl_matrix_get (ssize_matrix, rows[i], 0);
 564       for (j = 0; j < cov->size2 - 1; j++)
 565         {
 566           gsl_matrix_set (cov, i, j, gsl_matrix_get (cm, rows[i], rows[j]));
 567           gsl_matrix_set (cov, j, i, gsl_matrix_get (cm, rows[j], rows[i]));
 568         }
 569     }
 570   means[cov->size1 - 1] = gsl_matrix_get (mean_matrix, dep_subscript, 0)
 571     / gsl_matrix_get (ssize_matrix, dep_subscript, 0);
 572   ssizes = covariance_moments (all_cov, MOMENT_NONE);
 573   result = gsl_matrix_get (ssizes, dep_subscript, rows[0]);
 574   for (i = 0; i < cov->size1 - 1; i++)
 575     {
 576       gsl_matrix_set (cov, i, cov->size1 - 1,
 577                       gsl_matrix_get (cm, rows[i], dep_subscript));
 578       gsl_matrix_set (cov, cov->size1 - 1, i,
 579                       gsl_matrix_get (cm, rows[i], dep_subscript));
 580       if (result > gsl_matrix_get (ssizes, rows[i], dep_subscript))
 581         {
 582           result = gsl_matrix_get (ssizes, rows[i], dep_subscript);
 583         }
 584     }
 585   gsl_matrix_set (cov, cov->size1 - 1, cov->size1 - 1,
 586                   gsl_matrix_get (cm, dep_subscript, dep_subscript));
 587   free (rows);
 588   return result;
 589 }
 590
 591 \f
 592
 593 /*
 594   STATISTICS subcommand output functions.
 595 */
 596 static void reg_stats_r (const linreg *,     const struct variable *);
 597 static void reg_stats_coeff (const linreg *, const gsl_matrix *, const struct variable *, const struct regression *);
 598 static void reg_stats_anova (const linreg *, const struct variable *);
 599 static void reg_stats_bcov (const linreg *,  const struct variable *);
 600
 601
 602 static void
 603 subcommand_statistics (const struct regression *cmd, const linreg * c, const gsl_matrix * cm,
 604                        const struct variable *var)
 605 {
 606   if (cmd->stats & STATS_R)
 607     reg_stats_r     (c, var);
 608
 609   if (cmd->stats & STATS_ANOVA)
 610     reg_stats_anova (c, var);
 611
 612   if (cmd->stats & STATS_COEFF)
 613     reg_stats_coeff (c, cm, var, cmd);
 614
 615   if (cmd->stats & STATS_BCOV)
 616     reg_stats_bcov  (c, var);
 617 }
 618
 619
 620 static void
 621 run_regression (const struct regression *cmd,
 622                 struct regression_workspace *ws,
 623                 struct casereader *input)
 624 {
 625   size_t i;
 626   linreg **models;
 627
 628   int k;
 629   struct ccase *c;
 630   struct covariance *cov;
 631   struct casereader *reader;
 632   size_t n_all_vars = get_n_all_vars (cmd);
 633   const struct variable **all_vars = xnmalloc (n_all_vars, sizeof (*all_vars));
 634
 635   double *means = xnmalloc (n_all_vars, sizeof (*means));
 636
 637   fill_all_vars (all_vars, cmd);
 638   cov = covariance_1pass_create (n_all_vars, all_vars,
 639                                  dict_get_weight (dataset_dict (cmd->ds)),
 640                                  MV_ANY);
 641
 642   reader = casereader_clone (input);
 643   reader = casereader_create_filter_missing (reader, all_vars, n_all_vars,
 644                                              MV_ANY, NULL, NULL);
 645
 646
 647   {
 648     struct casereader *r = casereader_clone (reader);
 649
 650     for (; (c = casereader_read (r)) != NULL; case_unref (c))
 651       {
 652         covariance_accumulate (cov, c);
 653       }
 654     casereader_destroy (r);
 655   }
 656
 657   models = xcalloc (cmd->n_dep_vars, sizeof (*models));
 658   for (k = 0; k < cmd->n_dep_vars; k++)
 659     {
 660       const struct variable **vars = xnmalloc (cmd->n_vars, sizeof (*vars));
 661       const struct variable *dep_var = cmd->dep_vars[k];
 662       int n_indep = identify_indep_vars (cmd, vars, dep_var);
 663       gsl_matrix *this_cm = gsl_matrix_alloc (n_indep + 1, n_indep + 1);
 664       double n_data = fill_covariance (this_cm, cov, vars, n_indep,
 665                                 dep_var, all_vars, n_all_vars, means);
 666       models[k] = linreg_alloc (dep_var, vars,  n_data, n_indep);
 667       models[k]->depvar = dep_var;
 668       for (i = 0; i < n_indep; i++)
 669         {
 670           linreg_set_indep_variable_mean (models[k], i, means[i]);
 671         }
 672       linreg_set_depvar_mean (models[k], means[i]);
 673       /*
 674          For large data sets, use QR decomposition.
 675        */
 676       if (n_data > sqrt (n_indep) && n_data > REG_LARGE_DATA)
 677         {
 678           models[k]->method = LINREG_QR;
 679         }
 680
 681       if (n_data > 0)
 682         {
 683           /*
 684              Find the least-squares estimates and other statistics.
 685            */
 686           linreg_fit (this_cm, models[k]);
 687
 688           if (!taint_has_tainted_successor (casereader_get_taint (input)))
 689             {
 690               subcommand_statistics (cmd, models[k], this_cm, dep_var);
 691             }
 692         }
 693       else
 694         {
 695           msg (SE, _("No valid data found. This command was skipped."));
 696         }
 697       gsl_matrix_free (this_cm);
 698       free (vars);
 699     }
 700
 701
 702   if (ws->extras > 0)
 703    {
 704       struct casereader *r = casereader_clone (reader);
 705
 706       for (; (c = casereader_read (r)) != NULL; case_unref (c))
 707         {
 708           struct ccase *outc = case_clone (c);
 709           for (k = 0; k < cmd->n_dep_vars; k++)
 710             {
 711               const struct variable **vars = xnmalloc (cmd->n_vars, sizeof (*vars));
 712               const struct variable *dep_var = cmd->dep_vars[k];
 713               int n_indep = identify_indep_vars (cmd, vars, dep_var);
 714               double *vals = xnmalloc (n_indep, sizeof (*vals));
 715               for (i = 0; i < n_indep; i++)
 716                 {
 717                   const union value *tmp = case_data (c, vars[i]);
 718                   vals[i] = tmp->f;
 719                 }
 720
 721               if (cmd->pred)
 722                 {
 723                   double pred = linreg_predict (models[k], vals, n_indep);
 724                   case_data_rw_idx (outc, k * ws->extras + ws->pred_idx)->f = pred;
 725                 }
 726
 727               if (cmd->resid)
 728                 {
 729                   double obs = case_data (c, models[k]->depvar)->f;
 730                   double res = linreg_residual (models[k], obs,  vals, n_indep);
 731                   case_data_rw_idx (outc, k * ws->extras + ws->res_idx)->f = res;
 732                 }
 733               free (vals);
 734               free (vars);
 735             }
 736           casewriter_write (ws->writer, outc);
 737         }
 738       casereader_destroy (r);
 739     }
 740
 741   casereader_destroy (reader);
 742
 743   for (k = 0; k < cmd->n_dep_vars; k++)
 744     {
 745       linreg_unref (models[k]);
 746     }
 747   free (models);
 748
 749   free (all_vars);
 750   free (means);
 751   casereader_destroy (input);
 752   covariance_destroy (cov);
 753 }
 754
 755 \f
 756
 757
 758 static void
 759 reg_stats_r (const linreg * c, const struct variable *var)
 760 {
 761   struct tab_table *t;
 762   int n_rows = 2;
 763   int n_cols = 5;
 764   double rsq;
 765   double adjrsq;
 766   double std_error;
 767
 768   assert (c != NULL);
 769   rsq = linreg_ssreg (c) / linreg_sst (c);
 770   adjrsq = rsq -
 771     (1.0 - rsq) * linreg_n_coeffs (c) / (linreg_n_obs (c) -
 772                                          linreg_n_coeffs (c) - 1);
 773   std_error = sqrt (linreg_mse (c));
 774   t = tab_create (n_cols, n_rows);
 775   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
 776   tab_hline (t, TAL_2, 0, n_cols - 1, 1);
 777   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
 778   tab_vline (t, TAL_0, 1, 0, 0);
 779
 780   tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("R"));
 781   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("R Square"));
 782   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Adjusted R Square"));
 783   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("Std. Error of the Estimate"));
 784   tab_double (t, 1, 1, TAB_RIGHT, sqrt (rsq), NULL, RC_OTHER);
 785   tab_double (t, 2, 1, TAB_RIGHT, rsq, NULL, RC_OTHER);
 786   tab_double (t, 3, 1, TAB_RIGHT, adjrsq, NULL, RC_OTHER);
 787   tab_double (t, 4, 1, TAB_RIGHT, std_error, NULL, RC_OTHER);
 788   tab_title (t, _("Model Summary (%s)"), var_to_string (var));
 789   tab_submit (t);
 790 }
 791
 792 /*
 793   Table showing estimated regression coefficients.
 794 */
 795 static void
 796 reg_stats_coeff (const linreg * c, const gsl_matrix *cov, const struct variable *var, const struct regression *cmd)
 797 {
 798   size_t j;
 799   int n_cols = 7;
 800   const int heading_rows = 2;
 801   int n_rows;
 802   int this_row;
 803   double t_stat;
 804   double pval;
 805   double std_err;
 806   double beta;
 807   const char *label;
 808
 809   const struct variable *v;
 810   struct tab_table *t;
 811
 812   const double df = linreg_n_obs (c) - linreg_n_coeffs (c) - 1;
 813   double q = (1 - cmd->ci) / 2.0;  /* 2-tailed test */
 814   double tval = gsl_cdf_tdist_Qinv (q, df);
 815
 816   assert (c != NULL);
 817   n_rows = linreg_n_coeffs (c) + heading_rows + 1;
 818
 819   if (cmd->stats & STATS_CI)
 820     n_cols += 2;
 821
 822   t = tab_create (n_cols, n_rows);
 823   tab_headers (t, 2, 0, 1, 0);
 824   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
 825   tab_hline (t, TAL_2, 0, n_cols - 1, heading_rows);
 826   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
 827   tab_vline (t, TAL_0, 1, 0, 0);
 828
 829
 830   tab_hline (t, TAL_1, 2, 4, 1);
 831   tab_joint_text (t, 2, 0, 3, 0, TAB_CENTER | TAT_TITLE, _("Unstandardized Coefficients"));
 832   tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("B"));
 833   tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Std. Error"));
 834   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("Standardized Coefficients"));
 835   tab_text (t, 4, 1, TAB_CENTER | TAT_TITLE, _("Beta"));
 836   tab_text (t, 5, 1, TAB_CENTER | TAT_TITLE, _("t"));
 837   tab_text (t, 6, 1, TAB_CENTER | TAT_TITLE, _("Sig."));
 838   tab_text (t, 1, heading_rows, TAB_LEFT | TAT_TITLE, _("(Constant)"));
 839   tab_double (t, 2, heading_rows, 0, linreg_intercept (c), NULL, RC_OTHER);
 840   std_err = sqrt (gsl_matrix_get (linreg_cov (c), 0, 0));
 841
 842   if (cmd->stats & STATS_CI)
 843     {
 844       double lower = linreg_intercept (c) - tval * std_err ;
 845       double upper = linreg_intercept (c) + tval * std_err ;
 846       tab_double (t, 7, heading_rows, 0, lower, NULL, RC_OTHER);
 847       tab_double (t, 8, heading_rows, 0, upper, NULL, RC_OTHER);
 848
 849       tab_joint_text_format (t, 7, 0, 8, 0, TAB_CENTER | TAT_TITLE, _("%g%% Confidence Interval for B"), cmd->ci * 100);
 850       tab_hline (t, TAL_1, 7, 8, 1);
 851       tab_text (t, 7, 1, TAB_CENTER | TAT_TITLE, _("Lower Bound"));
 852       tab_text (t, 8, 1, TAB_CENTER | TAT_TITLE, _("Upper Bound"));
 853     }
 854   tab_double (t, 3, heading_rows, 0, std_err, NULL, RC_OTHER);
 855   tab_double (t, 4, heading_rows, 0, 0.0, NULL, RC_OTHER);
 856   t_stat = linreg_intercept (c) / std_err;
 857   tab_double (t, 5, heading_rows, 0, t_stat, NULL, RC_OTHER);
 858   pval =
 859     2 * gsl_cdf_tdist_Q (fabs (t_stat),
 860                          (double) (linreg_n_obs (c) - linreg_n_coeffs (c)));
 861   tab_double (t, 6, heading_rows, 0, pval, NULL, RC_PVALUE);
 862
 863   for (j = 0; j < linreg_n_coeffs (c); j++)
 864     {
 865       struct string tstr;
 866       ds_init_empty (&tstr);
 867       this_row = j + heading_rows + 1;
 868
 869       v = linreg_indep_var (c, j);
 870       label = var_to_string (v);
 871       /* Do not overwrite the variable's name. */
 872       ds_put_cstr (&tstr, label);
 873       tab_text (t, 1, this_row, TAB_LEFT, ds_cstr (&tstr));
 874       /*
 875          Regression coefficients.
 876        */
 877       tab_double (t, 2, this_row, 0, linreg_coeff (c, j), NULL, RC_OTHER);
 878       /*
 879          Standard error of the coefficients.
 880        */
 881       std_err = sqrt (gsl_matrix_get (linreg_cov (c), j + 1, j + 1));
 882       tab_double (t, 3, this_row, 0, std_err, NULL, RC_OTHER);
 883       /*
 884          Standardized coefficient, i.e., regression coefficient
 885          if all variables had unit variance.
 886        */
 887       beta = sqrt (gsl_matrix_get (cov, j, j));
 888       beta *= linreg_coeff (c, j) /
 889         sqrt (gsl_matrix_get (cov, cov->size1 - 1, cov->size2 - 1));
 890       tab_double (t, 4, this_row, 0, beta, NULL, RC_OTHER);
 891
 892       /*
 893          Test statistic for H0: coefficient is 0.
 894        */
 895       t_stat = linreg_coeff (c, j) / std_err;
 896       tab_double (t, 5, this_row, 0, t_stat, NULL, RC_OTHER);
 897       /*
 898          P values for the test statistic above.
 899        */
 900       pval = 2 * gsl_cdf_tdist_Q (fabs (t_stat), df);
 901       tab_double (t, 6, this_row, 0, pval, NULL, RC_PVALUE);
 902       ds_destroy (&tstr);
 903
 904       if (cmd->stats & STATS_CI)
 905         {
 906           double lower = linreg_coeff (c, j)  - tval * std_err ;
 907           double upper = linreg_coeff (c, j)  + tval * std_err ;
 908
 909           tab_double (t, 7, this_row, 0, lower, NULL, RC_OTHER);
 910           tab_double (t, 8, this_row, 0, upper, NULL, RC_OTHER);
 911         }
 912     }
 913   tab_title (t, _("Coefficients (%s)"), var_to_string (var));
 914   tab_submit (t);
 915 }
 916
 917 /*
 918   Display the ANOVA table.
 919 */
 920 static void
 921 reg_stats_anova (const linreg * c, const struct variable *var)
 922 {
 923   int n_cols = 7;
 924   int n_rows = 4;
 925   const double msm = linreg_ssreg (c) / linreg_dfmodel (c);
 926   const double mse = linreg_mse (c);
 927   const double F = msm / mse;
 928   const double pval = gsl_cdf_fdist_Q (F, c->dfm, c->dfe);
 929
 930   struct tab_table *t;
 931
 932   assert (c != NULL);
 933   t = tab_create (n_cols, n_rows);
 934   tab_headers (t, 2, 0, 1, 0);
 935
 936   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
 937
 938   tab_hline (t, TAL_2, 0, n_cols - 1, 1);
 939   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
 940   tab_vline (t, TAL_0, 1, 0, 0);
 941
 942   tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Sum of Squares"));
 943   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("df"));
 944   tab_text (t, 4, 0, TAB_CENTER | TAT_TITLE, _("Mean Square"));
 945   tab_text (t, 5, 0, TAB_CENTER | TAT_TITLE, _("F"));
 946   tab_text (t, 6, 0, TAB_CENTER | TAT_TITLE, _("Sig."));
 947
 948   tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Regression"));
 949   tab_text (t, 1, 2, TAB_LEFT | TAT_TITLE, _("Residual"));
 950   tab_text (t, 1, 3, TAB_LEFT | TAT_TITLE, _("Total"));
 951
 952   /* Sums of Squares */
 953   tab_double (t, 2, 1, 0, linreg_ssreg (c), NULL, RC_OTHER);
 954   tab_double (t, 2, 3, 0, linreg_sst (c), NULL, RC_OTHER);
 955   tab_double (t, 2, 2, 0, linreg_sse (c), NULL, RC_OTHER);
 956
 957
 958   /* Degrees of freedom */
 959   tab_text_format (t, 3, 1, TAB_RIGHT, "%.*g", DBL_DIG + 1, c->dfm);
 960   tab_text_format (t, 3, 2, TAB_RIGHT, "%.*g", DBL_DIG + 1, c->dfe);
 961   tab_text_format (t, 3, 3, TAB_RIGHT, "%.*g", DBL_DIG + 1, c->dft);
 962
 963   /* Mean Squares */
 964   tab_double (t, 4, 1, TAB_RIGHT, msm, NULL, RC_OTHER);
 965   tab_double (t, 4, 2, TAB_RIGHT, mse, NULL, RC_OTHER);
 966
 967   tab_double (t, 5, 1, 0, F, NULL, RC_OTHER);
 968
 969   tab_double (t, 6, 1, 0, pval, NULL, RC_PVALUE);
 970
 971   tab_title (t, _("ANOVA (%s)"), var_to_string (var));
 972   tab_submit (t);
 973 }
 974
 975
 976 static void
 977 reg_stats_bcov (const linreg * c, const struct variable *var)
 978 {
 979   int n_cols;
 980   int n_rows;
 981   int i;
 982   int k;
 983   int row;
 984   int col;
 985   const char *label;
 986   struct tab_table *t;
 987
 988   assert (c != NULL);
 989   n_cols = c->n_indeps + 1 + 2;
 990   n_rows = 2 * (c->n_indeps + 1);
 991   t = tab_create (n_cols, n_rows);
 992   tab_headers (t, 2, 0, 1, 0);
 993   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, n_cols - 1, n_rows - 1);
 994   tab_hline (t, TAL_2, 0, n_cols - 1, 1);
 995   tab_vline (t, TAL_2, 2, 0, n_rows - 1);
 996   tab_vline (t, TAL_0, 1, 0, 0);
 997   tab_text (t, 0, 0, TAB_CENTER | TAT_TITLE, _("Model"));
 998   tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Covariances"));
 999   for (i = 0; i < linreg_n_coeffs (c); i++)
1000     {
1001       const struct variable *v = linreg_indep_var (c, i);
1002       label = var_to_string (v);
1003       tab_text (t, 2, i, TAB_CENTER, label);
1004       tab_text (t, i + 2, 0, TAB_CENTER, label);
1005       for (k = 1; k < linreg_n_coeffs (c); k++)
1006         {
1007           col = (i <= k) ? k : i;
1008           row = (i <= k) ? i : k;
1009           tab_double (t, k + 2, i, TAB_CENTER,
1010                       gsl_matrix_get (c->cov, row, col), NULL, RC_OTHER);
1011         }
1012     }
1013   tab_title (t, _("Coefficient Correlations (%s)"), var_to_string (var));
1014   tab_submit (t);
1015 }
1016