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

   1 /* pspp - a program for statistical analysis.
   2    Copyright (C) 2012 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17
  18 /*
  19    References:
  20    1. "Coding Logistic Regression with Newton-Raphson", James McCaffrey
  21    http://msdn.microsoft.com/en-us/magazine/jj618304.aspx
  22
  23    2. "SPSS Statistical Algorithms" Chapter LOGISTIC REGRESSION Algorithms
  24
  25
  26    The Newton Raphson method finds successive approximations to $\bf b$ where
  27    approximation ${\bf b}_t$ is (hopefully) better than the previous ${\bf b}_{t-1}$.
  28
  29    $ {\bf b}_t = {\bf b}_{t -1} + ({\bf X}^T{\bf W}_{t-1}{\bf X})^{-1}{\bf X}^T({\bf y} - {\bf \pi}_{t-1})$
  30    where:
  31
  32    $\bf X$ is the $n \times p$ design matrix, $n$ being the number of cases,
  33    $p$ the number of parameters, \par
  34    $\bf W$ is the diagonal matrix whose diagonal elements are
  35    $\hat{\pi}_0(1 - \hat{\pi}_0), \, \hat{\pi}_1(1 - \hat{\pi}_2)\dots \hat{\pi}_{n-1}(1 - \hat{\pi}_{n-1})$
  36    \par
  37
  38 */
  39
  40 #include <config.h>
  41
  42 #include <gsl/gsl_blas.h>
  43
  44 #include <gsl/gsl_linalg.h>
  45 #include <gsl/gsl_cdf.h>
  46 #include <gsl/gsl_matrix.h>
  47 #include <gsl/gsl_vector.h>
  48 #include <math.h>
  49
  50 #include "data/case.h"
  51 #include "data/casegrouper.h"
  52 #include "data/casereader.h"
  53 #include "data/dataset.h"
  54 #include "data/dictionary.h"
  55 #include "data/format.h"
  56 #include "data/value.h"
  57 #include "language/command.h"
  58 #include "language/dictionary/split-file.h"
  59 #include "language/lexer/lexer.h"
  60 #include "language/lexer/value-parser.h"
  61 #include "language/lexer/variable-parser.h"
  62 #include "libpspp/assertion.h"
  63 #include "libpspp/ll.h"
  64 #include "libpspp/message.h"
  65 #include "libpspp/misc.h"
  66 #include "math/categoricals.h"
  67 #include "math/interaction.h"
  68 #include "libpspp/hmap.h"
  69 #include "libpspp/hash-functions.h"
  70
  71 #include "output/tab.h"
  72
  73 #include "gettext.h"
  74 #define _(msgid) gettext (msgid)
  75
  76
  77
  78
  79 #define   PRINT_EACH_STEP  0x01
  80 #define   PRINT_SUMMARY    0x02
  81 #define   PRINT_CORR       0x04
  82 #define   PRINT_ITER       0x08
  83 #define   PRINT_GOODFIT    0x10
  84 #define   PRINT_CI         0x20
  85
  86
  87 #define PRINT_DEFAULT (PRINT_SUMMARY | PRINT_EACH_STEP)
  88
  89 /*
  90   The constant parameters of the procedure.
  91   That is, those which are set by the user.
  92 */
  93 struct lr_spec
  94 {
  95   /* The dependent variable */
  96   const struct variable *dep_var;
  97
  98   /* The predictor variables (excluding categorical ones) */
  99   const struct variable **predictor_vars;
 100   size_t n_predictor_vars;
 101
 102   /* The categorical predictors */
 103   struct interaction **cat_predictors;
 104   size_t n_cat_predictors;
 105
 106
 107   /* The union of the categorical and non-categorical variables */
 108   const struct variable **indep_vars;
 109   size_t n_indep_vars;
 110
 111
 112   /* Which classes of missing vars are to be excluded */
 113   enum mv_class exclude;
 114
 115   /* The weight variable */
 116   const struct variable *wv;
 117
 118   /* The dictionary of the dataset */
 119   const struct dictionary *dict;
 120
 121   /* True iff the constant (intercept) is to be included in the model */
 122   bool constant;
 123
 124   /* Ths maximum number of iterations */
 125   int max_iter;
 126
 127   /* Other iteration limiting conditions */
 128   double bcon;
 129   double min_epsilon;
 130   double lcon;
 131
 132   /* The confidence interval (in percent) */
 133   int confidence;
 134
 135   /* What results should be presented */
 136   unsigned int print;
 137
 138   /* Inverse logit of the cut point */
 139   double ilogit_cut_point;
 140 };
 141
 142
 143 /* The results and intermediate result of the procedure.
 144    These are mutated as the procedure runs. Used for
 145    temporary variables etc.
 146 */
 147 struct lr_result
 148 {
 149   /* Used to indicate if a pass should flag a warning when
 150      invalid (ie negative or missing) weight values are encountered */
 151   bool warn_bad_weight;
 152
 153   /* The two values of the dependent variable. */
 154   union value y0;
 155   union value y1;
 156
 157
 158   /* The sum of caseweights */
 159   double cc;
 160
 161   /* The number of missing and nonmissing cases */
 162   casenumber n_missing;
 163   casenumber n_nonmissing;
 164
 165
 166   gsl_matrix *hessian;
 167
 168   /* The categoricals and their payload. Null if  the analysis has no
 169    categorical predictors */
 170   struct categoricals *cats;
 171   struct payload cp;
 172
 173
 174   /* The estimates of the predictor coefficients */
 175   gsl_vector *beta_hat;
 176
 177   /* The predicted classifications:
 178      True Negative, True Positive, False Negative, False Positive */
 179   double tn, tp, fn, fp;
 180 };
 181
 182
 183 /*
 184   Convert INPUT into a dichotomous scalar, according to how the dependent variable's
 185   values are mapped.
 186   For simple cases, this is a 1:1 mapping
 187   The return value is always either 0 or 1
 188 */
 189 static double
 190 map_dependent_var (const struct lr_spec *cmd, const struct lr_result *res, const union value *input)
 191 {
 192   const int width = var_get_width (cmd->dep_var);
 193   if (value_equal (input, &res->y0, width))
 194     return 0;
 195
 196   if (value_equal (input, &res->y1, width))
 197     return 1;
 198
 199   /* This should never happen.  If it does,  then y0 and/or y1 have probably not been set */
 200   NOT_REACHED ();
 201
 202   return SYSMIS;
 203 }
 204
 205 static void output_classification_table (const struct lr_spec *cmd, const struct lr_result *res);
 206
 207 static void output_categories (const struct lr_spec *cmd, const struct lr_result *res);
 208
 209 static void output_depvarmap (const struct lr_spec *cmd, const struct lr_result *);
 210
 211 static void output_variables (const struct lr_spec *cmd,
 212                               const struct lr_result *);
 213
 214 static void output_model_summary (const struct lr_result *,
 215                                   double initial_likelihood, double likelihood);
 216
 217 static void case_processing_summary (const struct lr_result *);
 218
 219
 220 /* Return the value of case C corresponding to the INDEX'th entry in the
 221    model */
 222 static double
 223 predictor_value (const struct ccase *c,
 224                     const struct variable **x, size_t n_x,
 225                     const struct categoricals *cats,
 226                     size_t index)
 227 {
 228   /* Values of the scalar predictor variables */
 229   if (index < n_x)
 230     return case_data (c, x[index])->f;
 231
 232   /* Coded values of categorical predictor variables (or interactions) */
 233   if (cats && index - n_x  < categoricals_df_total (cats))
 234     {
 235       double x = categoricals_get_dummy_code_for_case (cats, index - n_x, c);
 236       return x;
 237     }
 238
 239   /* The constant term */
 240   return 1.0;
 241 }
 242
 243
 244 /*
 245   Return the probability beta_hat (that is the estimator logit(y) )
 246   corresponding to the coefficient estimator for case C
 247 */
 248 static double
 249 pi_hat (const struct lr_spec *cmd,
 250         const struct lr_result *res,
 251         const struct variable **x, size_t n_x,
 252         const struct ccase *c)
 253 {
 254   int v0;
 255   double pi = 0;
 256   size_t n_coeffs = res->beta_hat->size;
 257
 258   if (cmd->constant)
 259     {
 260       pi += gsl_vector_get (res->beta_hat, res->beta_hat->size - 1);
 261       n_coeffs--;
 262     }
 263
 264   for (v0 = 0; v0 < n_coeffs; ++v0)
 265     {
 266       pi += gsl_vector_get (res->beta_hat, v0) *
 267         predictor_value (c, x, n_x, res->cats, v0);
 268     }
 269
 270   pi = 1.0 / (1.0 + exp(-pi));
 271
 272   return pi;
 273 }
 274
 275
 276 /*
 277   Calculates the Hessian matrix X' V  X,
 278   where: X is the n by N_X matrix comprising the n cases in INPUT
 279   V is a diagonal matrix { (pi_hat_0)(1 - pi_hat_0), (pi_hat_1)(1 - pi_hat_1), ... (pi_hat_{N-1})(1 - pi_hat_{N-1})}
 280   (the partial derivative of the predicted values)
 281
 282   If ALL predicted values derivatives are close to zero or one, then CONVERGED
 283   will be set to true.
 284 */
 285 static void
 286 hessian (const struct lr_spec *cmd,
 287          struct lr_result *res,
 288          struct casereader *input,
 289          const struct variable **x, size_t n_x,
 290          bool *converged)
 291 {
 292   struct casereader *reader;
 293   struct ccase *c;
 294
 295   double max_w = -DBL_MAX;
 296
 297   gsl_matrix_set_zero (res->hessian);
 298
 299   for (reader = casereader_clone (input);
 300        (c = casereader_read (reader)) != NULL; case_unref (c))
 301     {
 302       int v0, v1;
 303       double pi = pi_hat (cmd, res, x, n_x, c);
 304
 305       double weight = dict_get_case_weight (cmd->dict, c, &res->warn_bad_weight);
 306       double w = pi * (1 - pi);
 307       if (w > max_w)
 308         max_w = w;
 309       w *= weight;
 310
 311       for (v0 = 0; v0 < res->beta_hat->size; ++v0)
 312         {
 313           double in0 = predictor_value (c, x, n_x, res->cats, v0);
 314           for (v1 = 0; v1 < res->beta_hat->size; ++v1)
 315             {
 316               double in1 = predictor_value (c, x, n_x, res->cats, v1);
 317               double *o = gsl_matrix_ptr (res->hessian, v0, v1);
 318               *o += in0 * w * in1;
 319             }
 320         }
 321     }
 322   casereader_destroy (reader);
 323
 324   if ( max_w < cmd->min_epsilon)
 325     {
 326       *converged = true;
 327       msg (MN, _("All predicted values are either 1 or 0"));
 328     }
 329 }
 330
 331
 332 /* Calculates the value  X' (y - pi)
 333    where X is the design model,
 334    y is the vector of observed independent variables
 335    pi is the vector of estimates for y
 336
 337    Side effects:
 338      the likelihood is stored in LIKELIHOOD;
 339      the predicted values are placed in the respective tn, fn, tp fp values in RES
 340 */
 341 static gsl_vector *
 342 xt_times_y_pi (const struct lr_spec *cmd,
 343                struct lr_result *res,
 344                struct casereader *input,
 345                const struct variable **x, size_t n_x,
 346                const struct variable *y_var,
 347                double *llikelihood)
 348 {
 349   struct casereader *reader;
 350   struct ccase *c;
 351   gsl_vector *output = gsl_vector_calloc (res->beta_hat->size);
 352
 353   *llikelihood = 0.0;
 354   res->tn = res->tp = res->fn = res->fp = 0;
 355   for (reader = casereader_clone (input);
 356        (c = casereader_read (reader)) != NULL; case_unref (c))
 357     {
 358       double pred_y = 0;
 359       int v0;
 360       double pi = pi_hat (cmd, res, x, n_x, c);
 361       double weight = dict_get_case_weight (cmd->dict, c, &res->warn_bad_weight);
 362
 363
 364       double y = map_dependent_var (cmd, res, case_data (c, y_var));
 365
 366       *llikelihood += (weight * y) * log (pi) + log (1 - pi) * weight * (1 - y);
 367
 368       for (v0 = 0; v0 < res->beta_hat->size; ++v0)
 369         {
 370           double in0 = predictor_value (c, x, n_x, res->cats, v0);
 371           double *o = gsl_vector_ptr (output, v0);
 372           *o += in0 * (y - pi) * weight;
 373           pred_y += gsl_vector_get (res->beta_hat, v0) * in0;
 374         }
 375
 376       /* Count the number of cases which would be correctly/incorrectly classified by this
 377          estimated model */
 378       if (pred_y <= cmd->ilogit_cut_point)
 379         {
 380           if (y == 0)
 381             res->tn += weight;
 382           else
 383             res->fn += weight;
 384         }
 385       else
 386         {
 387           if (y == 0)
 388             res->fp += weight;
 389           else
 390             res->tp += weight;
 391         }
 392     }
 393
 394   casereader_destroy (reader);
 395
 396   return output;
 397 }
 398
 399 \f
 400
 401 /* "payload" functions for the categoricals.
 402    The only function is to accumulate the frequency of each
 403    category.
 404  */
 405
 406 static void *
 407 frq_create  (const void *aux1 UNUSED, void *aux2 UNUSED)
 408 {
 409   return xzalloc (sizeof (double));
 410 }
 411
 412 static void
 413 frq_update  (const void *aux1 UNUSED, void *aux2 UNUSED,
 414              void *ud, const struct ccase *c UNUSED , double weight)
 415 {
 416   double *freq = ud;
 417   *freq += weight;
 418 }
 419
 420 static void
 421 frq_destroy (const void *aux1 UNUSED, void *aux2 UNUSED, void *user_data UNUSED)
 422 {
 423   free (user_data);
 424 }
 425
 426 \f
 427
 428 /*
 429    Makes an initial pass though the data, doing the following:
 430
 431    * Checks that the dependent variable is  dichotomous,
 432    * Creates and initialises the categoricals,
 433    * Accumulates summary results,
 434    * Calculates necessary initial values.
 435    * Creates an initial value for \hat\beta the vector of beta_hats of \beta
 436
 437    Returns true if successful
 438 */
 439 static bool
 440 initial_pass (const struct lr_spec *cmd, struct lr_result *res, struct casereader *input)
 441 {
 442   const int width = var_get_width (cmd->dep_var);
 443
 444   struct ccase *c;
 445   struct casereader *reader;
 446
 447   double sum;
 448   double sumA = 0.0;
 449   double sumB = 0.0;
 450
 451   bool v0set = false;
 452   bool v1set = false;
 453
 454   size_t n_coefficients = cmd->n_predictor_vars;
 455   if (cmd->constant)
 456     n_coefficients++;
 457
 458   /* Create categoricals if appropriate */
 459   if (cmd->n_cat_predictors > 0)
 460     {
 461       res->cp.create = frq_create;
 462       res->cp.update = frq_update;
 463       res->cp.calculate = NULL;
 464       res->cp.destroy = frq_destroy;
 465
 466       res->cats = categoricals_create (cmd->cat_predictors, cmd->n_cat_predictors,
 467                                        cmd->wv, cmd->exclude, MV_ANY);
 468
 469       categoricals_set_payload (res->cats, &res->cp, cmd, res);
 470     }
 471
 472   res->cc = 0;
 473   for (reader = casereader_clone (input);
 474        (c = casereader_read (reader)) != NULL; case_unref (c))
 475     {
 476       int v;
 477       bool missing = false;
 478       double weight = dict_get_case_weight (cmd->dict, c, &res->warn_bad_weight);
 479       const union value *depval = case_data (c, cmd->dep_var);
 480
 481       if (var_is_value_missing (cmd->dep_var, depval, cmd->exclude))
 482         {
 483           missing = true;
 484         }
 485       else
 486       for (v = 0; v < cmd->n_indep_vars; ++v)
 487         {
 488           const union value *val = case_data (c, cmd->indep_vars[v]);
 489           if (var_is_value_missing (cmd->indep_vars[v], val, cmd->exclude))
 490             {
 491               missing = true;
 492               break;
 493             }
 494         }
 495
 496       /* Accumulate the missing and non-missing counts */
 497       if (missing)
 498         {
 499           res->n_missing++;
 500           continue;
 501         }
 502       res->n_nonmissing++;
 503
 504       /* Find the values of the dependent variable */
 505       if (!v0set)
 506         {
 507           value_clone (&res->y0, depval, width);
 508           v0set = true;
 509         }
 510       else if (!v1set)
 511         {
 512           if ( !value_equal (&res->y0, depval, width))
 513             {
 514               value_clone (&res->y1, depval, width);
 515               v1set = true;
 516             }
 517         }
 518       else
 519         {
 520           if (! value_equal (&res->y0, depval, width)
 521               &&
 522               ! value_equal (&res->y1, depval, width)
 523               )
 524             {
 525               msg (ME, _("Dependent variable's values are not dichotomous."));
 526               case_unref (c);
 527               goto error;
 528             }
 529         }
 530
 531       if (v0set && value_equal (&res->y0, depval, width))
 532           sumA += weight;
 533
 534       if (v1set && value_equal (&res->y1, depval, width))
 535           sumB += weight;
 536
 537
 538       res->cc += weight;
 539
 540       categoricals_update (res->cats, c);
 541     }
 542   casereader_destroy (reader);
 543
 544   categoricals_done (res->cats);
 545
 546   sum = sumB;
 547
 548   /* Ensure that Y0 is less than Y1.  Otherwise the mapping gets
 549      inverted, which is confusing to users */
 550   if (var_is_numeric (cmd->dep_var) && value_compare_3way (&res->y0, &res->y1, width) > 0)
 551     {
 552       union value tmp;
 553       value_clone (&tmp, &res->y0, width);
 554       value_copy (&res->y0, &res->y1, width);
 555       value_copy (&res->y1, &tmp, width);
 556       value_destroy (&tmp, width);
 557       sum = sumA;
 558     }
 559
 560   n_coefficients += categoricals_df_total (res->cats);
 561   res->beta_hat = gsl_vector_calloc (n_coefficients);
 562
 563   if (cmd->constant)
 564     {
 565       double mean = sum / res->cc;
 566       gsl_vector_set (res->beta_hat, res->beta_hat->size - 1, log (mean / (1 - mean)));
 567     }
 568
 569   return true;
 570
 571  error:
 572   casereader_destroy (reader);
 573   return false;
 574 }
 575
 576
 577
 578 /* Start of the logistic regression routine proper */
 579 static bool
 580 run_lr (const struct lr_spec *cmd, struct casereader *input,
 581         const struct dataset *ds UNUSED)
 582 {
 583   int i;
 584
 585   bool converged = false;
 586
 587   /* Set the log likelihoods to a sentinel value */
 588   double log_likelihood = SYSMIS;
 589   double prev_log_likelihood = SYSMIS;
 590   double initial_log_likelihood = SYSMIS;
 591
 592   struct lr_result work;
 593   work.n_missing = 0;
 594   work.n_nonmissing = 0;
 595   work.warn_bad_weight = true;
 596   work.cats = NULL;
 597   work.beta_hat = NULL;
 598   work.hessian = NULL;
 599
 600   /* Get the initial estimates of \beta and their standard errors.
 601      And perform other auxilliary initialisation.  */
 602   if (! initial_pass (cmd, &work, input))
 603     goto error;
 604
 605   for (i = 0; i < cmd->n_cat_predictors; ++i)
 606     {
 607       if (1 >= categoricals_n_count (work.cats, i))
 608         {
 609           struct string str;
 610           ds_init_empty (&str);
 611
 612           interaction_to_string (cmd->cat_predictors[i], &str);
 613
 614           msg (ME, _("Category %s does not have at least two distinct values. Logistic regression will not be run."),
 615                ds_cstr(&str));
 616           ds_destroy (&str);
 617           goto error;
 618         }
 619     }
 620
 621   output_depvarmap (cmd, &work);
 622
 623   case_processing_summary (&work);
 624
 625
 626   input = casereader_create_filter_missing (input,
 627                                             cmd->indep_vars,
 628                                             cmd->n_indep_vars,
 629                                             cmd->exclude,
 630                                             NULL,
 631                                             NULL);
 632
 633   input = casereader_create_filter_missing (input,
 634                                             &cmd->dep_var,
 635                                             1,
 636                                             cmd->exclude,
 637                                             NULL,
 638                                             NULL);
 639
 640   work.hessian = gsl_matrix_calloc (work.beta_hat->size, work.beta_hat->size);
 641
 642   /* Start the Newton Raphson iteration process... */
 643   for( i = 0 ; i < cmd->max_iter ; ++i)
 644     {
 645       double min, max;
 646       gsl_vector *v ;
 647
 648
 649       hessian (cmd, &work, input,
 650                cmd->predictor_vars, cmd->n_predictor_vars,
 651                &converged);
 652
 653       gsl_linalg_cholesky_decomp (work.hessian);
 654       gsl_linalg_cholesky_invert (work.hessian);
 655
 656       v = xt_times_y_pi (cmd, &work, input,
 657                          cmd->predictor_vars, cmd->n_predictor_vars,
 658                          cmd->dep_var,
 659                          &log_likelihood);
 660
 661       {
 662         /* delta = M.v */
 663         gsl_vector *delta = gsl_vector_alloc (v->size);
 664         gsl_blas_dgemv (CblasNoTrans, 1.0, work.hessian, v, 0, delta);
 665         gsl_vector_free (v);
 666
 667
 668         gsl_vector_add (work.beta_hat, delta);
 669
 670         gsl_vector_minmax (delta, &min, &max);
 671
 672         if ( fabs (min) < cmd->bcon && fabs (max) < cmd->bcon)
 673           {
 674             msg (MN, _("Estimation terminated at iteration number %d because parameter estimates changed by less than %g"),
 675                  i + 1, cmd->bcon);
 676             converged = true;
 677           }
 678
 679         gsl_vector_free (delta);
 680       }
 681
 682       if (i > 0)
 683         {
 684           if (-log_likelihood > -(1.0 - cmd->lcon) * prev_log_likelihood)
 685             {
 686               msg (MN, _("Estimation terminated at iteration number %d because Log Likelihood decreased by less than %g%%"), i + 1, 100 * cmd->lcon);
 687               converged = true;
 688             }
 689         }
 690       if (i == 0)
 691         initial_log_likelihood = log_likelihood;
 692       prev_log_likelihood = log_likelihood;
 693
 694       if (converged)
 695         break;
 696     }
 697
 698
 699
 700   if ( ! converged)
 701     msg (MW, _("Estimation terminated at iteration number %d because maximum iterations has been reached"), i );
 702
 703
 704   output_model_summary (&work, initial_log_likelihood, log_likelihood);
 705
 706   if (work.cats)
 707     output_categories (cmd, &work);
 708
 709   output_classification_table (cmd, &work);
 710   output_variables (cmd, &work);
 711
 712   casereader_destroy (input);
 713   gsl_matrix_free (work.hessian);
 714   gsl_vector_free (work.beta_hat);
 715   categoricals_destroy (work.cats);
 716
 717   return true;
 718
 719  error:
 720   casereader_destroy (input);
 721   gsl_matrix_free (work.hessian);
 722   gsl_vector_free (work.beta_hat);
 723   categoricals_destroy (work.cats);
 724
 725   return false;
 726 }
 727
 728 struct variable_node
 729 {
 730   struct hmap_node node;      /* Node in hash map. */
 731   const struct variable *var; /* The variable */
 732 };
 733
 734 static struct variable_node *
 735 lookup_variable (const struct hmap *map, const struct variable *var, unsigned int hash)
 736 {
 737   struct variable_node *vn = NULL;
 738   HMAP_FOR_EACH_WITH_HASH (vn, struct variable_node, node, hash, map)
 739     {
 740       if (vn->var == var)
 741         break;
 742
 743       fprintf (stderr, "Warning: Hash table collision\n");
 744     }
 745
 746   return vn;
 747 }
 748
 749
 750 /* Parse the LOGISTIC REGRESSION command syntax */
 751 int
 752 cmd_logistic (struct lexer *lexer, struct dataset *ds)
 753 {
 754   int i;
 755   /* Temporary location for the predictor variables.
 756      These may or may not include the categorical predictors */
 757   const struct variable **pred_vars;
 758   size_t n_pred_vars;
 759   double cp = 0.5;
 760
 761   int v, x;
 762   struct lr_spec lr;
 763   lr.dict = dataset_dict (ds);
 764   lr.n_predictor_vars = 0;
 765   lr.predictor_vars = NULL;
 766   lr.exclude = MV_ANY;
 767   lr.wv = dict_get_weight (lr.dict);
 768   lr.max_iter = 20;
 769   lr.lcon = 0.0000;
 770   lr.bcon = 0.001;
 771   lr.min_epsilon = 0.00000001;
 772   lr.constant = true;
 773   lr.confidence = 95;
 774   lr.print = PRINT_DEFAULT;
 775   lr.cat_predictors = NULL;
 776   lr.n_cat_predictors = 0;
 777   lr.indep_vars = NULL;
 778
 779
 780   if (lex_match_id (lexer, "VARIABLES"))
 781     lex_match (lexer, T_EQUALS);
 782
 783   if (! (lr.dep_var = parse_variable_const (lexer, lr.dict)))
 784     goto error;
 785
 786   lex_force_match (lexer, T_WITH);
 787
 788   if (!parse_variables_const (lexer, lr.dict,
 789                               &pred_vars, &n_pred_vars,
 790                               PV_NO_DUPLICATE))
 791     goto error;
 792
 793
 794   while (lex_token (lexer) != T_ENDCMD)
 795     {
 796       lex_match (lexer, T_SLASH);
 797
 798       if (lex_match_id (lexer, "MISSING"))
 799         {
 800           lex_match (lexer, T_EQUALS);
 801           while (lex_token (lexer) != T_ENDCMD
 802                  && lex_token (lexer) != T_SLASH)
 803             {
 804               if (lex_match_id (lexer, "INCLUDE"))
 805                 {
 806                   lr.exclude = MV_SYSTEM;
 807                 }
 808               else if (lex_match_id (lexer, "EXCLUDE"))
 809                 {
 810                   lr.exclude = MV_ANY;
 811                 }
 812               else
 813                 {
 814                   lex_error (lexer, NULL);
 815                   goto error;
 816                 }
 817             }
 818         }
 819       else if (lex_match_id (lexer, "ORIGIN"))
 820         {
 821           lr.constant = false;
 822         }
 823       else if (lex_match_id (lexer, "NOORIGIN"))
 824         {
 825           lr.constant = true;
 826         }
 827       else if (lex_match_id (lexer, "NOCONST"))
 828         {
 829           lr.constant = false;
 830         }
 831       else if (lex_match_id (lexer, "EXTERNAL"))
 832         {
 833           /* This is for compatibility.  It does nothing */
 834         }
 835       else if (lex_match_id (lexer, "CATEGORICAL"))
 836         {
 837           lex_match (lexer, T_EQUALS);
 838           do
 839             {
 840               lr.cat_predictors = xrealloc (lr.cat_predictors,
 841                                   sizeof (*lr.cat_predictors) * ++lr.n_cat_predictors);
 842               lr.cat_predictors[lr.n_cat_predictors - 1] = 0;
 843             }
 844           while (parse_design_interaction (lexer, lr.dict,
 845                                            lr.cat_predictors + lr.n_cat_predictors - 1));
 846           lr.n_cat_predictors--;
 847         }
 848       else if (lex_match_id (lexer, "PRINT"))
 849         {
 850           lex_match (lexer, T_EQUALS);
 851           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
 852             {
 853               if (lex_match_id (lexer, "DEFAULT"))
 854                 {
 855                   lr.print |= PRINT_DEFAULT;
 856                 }
 857               else if (lex_match_id (lexer, "SUMMARY"))
 858                 {
 859                   lr.print |= PRINT_SUMMARY;
 860                 }
 861 #if 0
 862               else if (lex_match_id (lexer, "CORR"))
 863                 {
 864                   lr.print |= PRINT_CORR;
 865                 }
 866               else if (lex_match_id (lexer, "ITER"))
 867                 {
 868                   lr.print |= PRINT_ITER;
 869                 }
 870               else if (lex_match_id (lexer, "GOODFIT"))
 871                 {
 872                   lr.print |= PRINT_GOODFIT;
 873                 }
 874 #endif
 875               else if (lex_match_id (lexer, "CI"))
 876                 {
 877                   lr.print |= PRINT_CI;
 878                   if (lex_force_match (lexer, T_LPAREN))
 879                     {
 880                       if (! lex_force_num (lexer))
 881                         {
 882                           lex_error (lexer, NULL);
 883                           goto error;
 884                         }
 885                       lr.confidence = lex_number (lexer);
 886                       lex_get (lexer);
 887                       if ( ! lex_force_match (lexer, T_RPAREN))
 888                         {
 889                           lex_error (lexer, NULL);
 890                           goto error;
 891                         }
 892                     }
 893                 }
 894               else if (lex_match_id (lexer, "ALL"))
 895                 {
 896                   lr.print = ~0x0000;
 897                 }
 898               else
 899                 {
 900                   lex_error (lexer, NULL);
 901                   goto error;
 902                 }
 903             }
 904         }
 905       else if (lex_match_id (lexer, "CRITERIA"))
 906         {
 907           lex_match (lexer, T_EQUALS);
 908           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
 909             {
 910               if (lex_match_id (lexer, "BCON"))
 911                 {
 912                   if (lex_force_match (lexer, T_LPAREN))
 913                     {
 914                       if (! lex_force_num (lexer))
 915                         {
 916                           lex_error (lexer, NULL);
 917                           goto error;
 918                         }
 919                       lr.bcon = lex_number (lexer);
 920                       lex_get (lexer);
 921                       if ( ! lex_force_match (lexer, T_RPAREN))
 922                         {
 923                           lex_error (lexer, NULL);
 924                           goto error;
 925                         }
 926                     }
 927                 }
 928               else if (lex_match_id (lexer, "ITERATE"))
 929                 {
 930                   if (lex_force_match (lexer, T_LPAREN))
 931                     {
 932                       if (! lex_force_int (lexer))
 933                         {
 934                           lex_error (lexer, NULL);
 935                           goto error;
 936                         }
 937                       lr.max_iter = lex_integer (lexer);
 938                       lex_get (lexer);
 939                       if ( ! lex_force_match (lexer, T_RPAREN))
 940                         {
 941                           lex_error (lexer, NULL);
 942                           goto error;
 943                         }
 944                     }
 945                 }
 946               else if (lex_match_id (lexer, "LCON"))
 947                 {
 948                   if (lex_force_match (lexer, T_LPAREN))
 949                     {
 950                       if (! lex_force_num (lexer))
 951                         {
 952                           lex_error (lexer, NULL);
 953                           goto error;
 954                         }
 955                       lr.lcon = lex_number (lexer);
 956                       lex_get (lexer);
 957                       if ( ! lex_force_match (lexer, T_RPAREN))
 958                         {
 959                           lex_error (lexer, NULL);
 960                           goto error;
 961                         }
 962                     }
 963                 }
 964               else if (lex_match_id (lexer, "EPS"))
 965                 {
 966                   if (lex_force_match (lexer, T_LPAREN))
 967                     {
 968                       if (! lex_force_num (lexer))
 969                         {
 970                           lex_error (lexer, NULL);
 971                           goto error;
 972                         }
 973                       lr.min_epsilon = lex_number (lexer);
 974                       lex_get (lexer);
 975                       if ( ! lex_force_match (lexer, T_RPAREN))
 976                         {
 977                           lex_error (lexer, NULL);
 978                           goto error;
 979                         }
 980                     }
 981                 }
 982               else if (lex_match_id (lexer, "CUT"))
 983                 {
 984                   if (lex_force_match (lexer, T_LPAREN))
 985                     {
 986                       if (! lex_force_num (lexer))
 987                         {
 988                           lex_error (lexer, NULL);
 989                           goto error;
 990                         }
 991                       cp = lex_number (lexer);
 992
 993                       if (cp < 0 || cp > 1.0)
 994                         {
 995                           msg (ME, _("Cut point value must be in the range [0,1]"));
 996                           goto error;
 997                         }
 998                       lex_get (lexer);
 999                       if ( ! lex_force_match (lexer, T_RPAREN))
1000                         {
1001                           lex_error (lexer, NULL);
1002                           goto error;
1003                         }
1004                     }
1005                 }
1006               else
1007                 {
1008                   lex_error (lexer, NULL);
1009                   goto error;
1010                 }
1011             }
1012         }
1013       else
1014         {
1015           lex_error (lexer, NULL);
1016           goto error;
1017         }
1018     }
1019
1020   lr.ilogit_cut_point = - log (1/cp - 1);
1021
1022
1023   /* Copy the predictor variables from the temporary location into the
1024      final one, dropping any categorical variables which appear there.
1025      FIXME: This is O(NxM).
1026   */
1027   {
1028   struct variable_node *vn, *next;
1029   struct hmap allvars;
1030   hmap_init (&allvars);
1031   for (v = x = 0; v < n_pred_vars; ++v)
1032     {
1033       bool drop = false;
1034       const struct variable *var = pred_vars[v];
1035       int cv = 0;
1036
1037       unsigned int hash = hash_pointer (var, 0);
1038       struct variable_node *vn = lookup_variable (&allvars, var, hash);
1039       if (vn == NULL)
1040         {
1041           vn = xmalloc (sizeof *vn);
1042           vn->var = var;
1043           hmap_insert (&allvars, &vn->node,  hash);
1044         }
1045
1046       for (cv = 0; cv < lr.n_cat_predictors ; ++cv)
1047         {
1048           int iv;
1049           const struct interaction *iact = lr.cat_predictors[cv];
1050           for (iv = 0 ; iv < iact->n_vars ; ++iv)
1051             {
1052               const struct variable *ivar = iact->vars[iv];
1053               unsigned int hash = hash_pointer (ivar, 0);
1054               struct variable_node *vn = lookup_variable (&allvars, ivar, hash);
1055               if (vn == NULL)
1056                 {
1057                   vn = xmalloc (sizeof *vn);
1058                   vn->var = ivar;
1059
1060                   hmap_insert (&allvars, &vn->node,  hash);
1061                 }
1062
1063               if (var == ivar)
1064                 {
1065                   drop = true;
1066                 }
1067             }
1068         }
1069
1070       if (drop)
1071         continue;
1072
1073       lr.predictor_vars = xrealloc (lr.predictor_vars, sizeof *lr.predictor_vars * (x + 1));
1074       lr.predictor_vars[x++] = var;
1075       lr.n_predictor_vars++;
1076     }
1077   free (pred_vars);
1078
1079   lr.n_indep_vars = hmap_count (&allvars);
1080   lr.indep_vars = xmalloc (lr.n_indep_vars * sizeof *lr.indep_vars);
1081
1082   /* Interate over each variable and push it into the array */
1083   x = 0;
1084   HMAP_FOR_EACH_SAFE (vn, next, struct variable_node, node, &allvars)
1085     {
1086       lr.indep_vars[x++] = vn->var;
1087       free (vn);
1088     }
1089   hmap_destroy (&allvars);
1090   }
1091
1092
1093   /* logistical regression for each split group */
1094   {
1095     struct casegrouper *grouper;
1096     struct casereader *group;
1097     bool ok;
1098
1099     grouper = casegrouper_create_splits (proc_open (ds), lr.dict);
1100     while (casegrouper_get_next_group (grouper, &group))
1101       ok = run_lr (&lr, group, ds);
1102     ok = casegrouper_destroy (grouper);
1103     ok = proc_commit (ds) && ok;
1104   }
1105
1106   for (i = 0 ; i < lr.n_cat_predictors; ++i)
1107     {
1108       interaction_destroy (lr.cat_predictors[i]);
1109     }
1110   free (lr.predictor_vars);
1111   free (lr.cat_predictors);
1112   free (lr.indep_vars);
1113
1114   return CMD_SUCCESS;
1115
1116  error:
1117
1118   for (i = 0 ; i < lr.n_cat_predictors; ++i)
1119     {
1120       interaction_destroy (lr.cat_predictors[i]);
1121     }
1122   free (lr.predictor_vars);
1123   free (lr.cat_predictors);
1124   free (lr.indep_vars);
1125
1126   return CMD_FAILURE;
1127 }
1128
1129
1130 \f
1131
1132 /* Show the Dependent Variable Encoding box.
1133    This indicates how the dependent variable
1134    is mapped to the internal zero/one values.
1135 */
1136 static void
1137 output_depvarmap (const struct lr_spec *cmd, const struct lr_result *res)
1138 {
1139   const int heading_columns = 0;
1140   const int heading_rows = 1;
1141   struct tab_table *t;
1142   struct string str;
1143
1144   const int nc = 2;
1145   int nr = heading_rows + 2;
1146
1147   t = tab_create (nc, nr);
1148   tab_title (t, _("Dependent Variable Encoding"));
1149
1150   tab_headers (t, heading_columns, 0, heading_rows, 0);
1151
1152   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1153
1154   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1155   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1156
1157   tab_text (t,  0, 0, TAB_CENTER | TAT_TITLE, _("Original Value"));
1158   tab_text (t,  1, 0, TAB_CENTER | TAT_TITLE, _("Internal Value"));
1159
1160
1161
1162   ds_init_empty (&str);
1163   var_append_value_name (cmd->dep_var, &res->y0, &str);
1164   tab_text (t,  0, 0 + heading_rows,  0, ds_cstr (&str));
1165
1166   ds_clear (&str);
1167   var_append_value_name (cmd->dep_var, &res->y1, &str);
1168   tab_text (t,  0, 1 + heading_rows,  0, ds_cstr (&str));
1169
1170
1171   tab_double (t, 1, 0 + heading_rows, 0, map_dependent_var (cmd, res, &res->y0), NULL, RC_INTEGER);
1172   tab_double (t, 1, 1 + heading_rows, 0, map_dependent_var (cmd, res, &res->y1), NULL, RC_INTEGER);
1173   ds_destroy (&str);
1174
1175   tab_submit (t);
1176 }
1177
1178
1179 /* Show the Variables in the Equation box */
1180 static void
1181 output_variables (const struct lr_spec *cmd,
1182                   const struct lr_result *res)
1183 {
1184   int row = 0;
1185   const int heading_columns = 1;
1186   int heading_rows = 1;
1187   struct tab_table *t;
1188
1189   int nc = 8;
1190   int nr ;
1191   int i = 0;
1192   int ivar = 0;
1193   int idx_correction = 0;
1194
1195   if (cmd->print & PRINT_CI)
1196     {
1197       nc += 2;
1198       heading_rows += 1;
1199       row++;
1200     }
1201   nr = heading_rows + cmd->n_predictor_vars;
1202   if (cmd->constant)
1203     nr++;
1204
1205   if (res->cats)
1206     nr += categoricals_df_total (res->cats) + cmd->n_cat_predictors;
1207
1208   t = tab_create (nc, nr);
1209   tab_title (t, _("Variables in the Equation"));
1210
1211   tab_headers (t, heading_columns, 0, heading_rows, 0);
1212
1213   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1214
1215   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1216   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1217
1218   tab_text (t,  0, row + 1, TAB_CENTER | TAT_TITLE, _("Step 1"));
1219
1220   tab_text (t,  2, row, TAB_CENTER | TAT_TITLE, _("B"));
1221   tab_text (t,  3, row, TAB_CENTER | TAT_TITLE, _("S.E."));
1222   tab_text (t,  4, row, TAB_CENTER | TAT_TITLE, _("Wald"));
1223   tab_text (t,  5, row, TAB_CENTER | TAT_TITLE, _("df"));
1224   tab_text (t,  6, row, TAB_CENTER | TAT_TITLE, _("Sig."));
1225   tab_text (t,  7, row, TAB_CENTER | TAT_TITLE, _("Exp(B)"));
1226
1227   if (cmd->print & PRINT_CI)
1228     {
1229       tab_joint_text_format (t, 8, 0, 9, 0,
1230                              TAB_CENTER | TAT_TITLE, _("%d%% CI for Exp(B)"), cmd->confidence);
1231
1232       tab_text (t,  8, row, TAB_CENTER | TAT_TITLE, _("Lower"));
1233       tab_text (t,  9, row, TAB_CENTER | TAT_TITLE, _("Upper"));
1234     }
1235
1236   for (row = heading_rows ; row < nr; ++row)
1237     {
1238       const int idx = row - heading_rows - idx_correction;
1239
1240       const double b = gsl_vector_get (res->beta_hat, idx);
1241       const double sigma2 = gsl_matrix_get (res->hessian, idx, idx);
1242       const double wald = pow2 (b) / sigma2;
1243       const double df = 1;
1244
1245       if (idx < cmd->n_predictor_vars)
1246         {
1247           tab_text (t, 1, row, TAB_LEFT | TAT_TITLE,
1248                     var_to_string (cmd->predictor_vars[idx]));
1249         }
1250       else if (i < cmd->n_cat_predictors)
1251         {
1252           double wald;
1253           bool summary = false;
1254           struct string str;
1255           const struct interaction *cat_predictors = cmd->cat_predictors[i];
1256           const int df = categoricals_df (res->cats, i);
1257
1258           ds_init_empty (&str);
1259           interaction_to_string (cat_predictors, &str);
1260
1261           if (ivar == 0)
1262             {
1263               /* Calculate the Wald statistic,
1264                  which is \beta' C^-1 \beta .
1265                  where \beta is the vector of the coefficient estimates comprising this
1266                  categorial variable. and C is the corresponding submatrix of the
1267                  hessian matrix.
1268               */
1269               gsl_matrix_const_view mv =
1270                 gsl_matrix_const_submatrix (res->hessian, idx, idx, df, df);
1271               gsl_matrix *subhessian = gsl_matrix_alloc (mv.matrix.size1, mv.matrix.size2);
1272               gsl_vector_const_view vv = gsl_vector_const_subvector (res->beta_hat, idx, df);
1273               gsl_vector *temp = gsl_vector_alloc (df);
1274
1275               gsl_matrix_memcpy (subhessian, &mv.matrix);
1276               gsl_linalg_cholesky_decomp (subhessian);
1277               gsl_linalg_cholesky_invert (subhessian);
1278
1279               gsl_blas_dgemv (CblasTrans, 1.0, subhessian, &vv.vector, 0, temp);
1280               gsl_blas_ddot (temp, &vv.vector, &wald);
1281
1282               tab_double (t, 4, row, 0, wald, NULL, RC_OTHER);
1283               tab_double (t, 5, row, 0, df, NULL, RC_INTEGER);
1284               tab_double (t, 6, row, 0, gsl_cdf_chisq_Q (wald, df), NULL, RC_PVALUE);
1285
1286               idx_correction ++;
1287               summary = true;
1288               gsl_matrix_free (subhessian);
1289               gsl_vector_free (temp);
1290             }
1291           else
1292             {
1293               ds_put_format (&str, "(%d)", ivar);
1294             }
1295
1296           tab_text (t, 1, row, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
1297           if (ivar++ == df)
1298             {
1299               ++i; /* next interaction */
1300               ivar = 0;
1301             }
1302
1303           ds_destroy (&str);
1304
1305           if (summary)
1306             continue;
1307         }
1308       else
1309         {
1310           tab_text (t, 1, row, TAB_LEFT | TAT_TITLE, _("Constant"));
1311         }
1312
1313       tab_double (t, 2, row, 0, b, NULL, RC_OTHER);
1314       tab_double (t, 3, row, 0, sqrt (sigma2), NULL, RC_OTHER);
1315       tab_double (t, 4, row, 0, wald, NULL, RC_OTHER);
1316       tab_double (t, 5, row, 0, df, NULL, RC_INTEGER);
1317       tab_double (t, 6, row, 0, gsl_cdf_chisq_Q (wald, df), NULL, RC_PVALUE);
1318       tab_double (t, 7, row, 0, exp (b), NULL, RC_OTHER);
1319
1320       if (cmd->print & PRINT_CI)
1321         {
1322           int last_ci = nr;
1323           double wc = gsl_cdf_ugaussian_Pinv (0.5 + cmd->confidence / 200.0);
1324           wc *= sqrt (sigma2);
1325
1326           if (cmd->constant)
1327             last_ci--;
1328
1329           if (row < last_ci)
1330             {
1331               tab_double (t, 8, row, 0, exp (b - wc), NULL, RC_OTHER);
1332               tab_double (t, 9, row, 0, exp (b + wc), NULL, RC_OTHER);
1333             }
1334         }
1335     }
1336
1337   tab_submit (t);
1338 }
1339
1340
1341 /* Show the model summary box */
1342 static void
1343 output_model_summary (const struct lr_result *res,
1344                       double initial_log_likelihood, double log_likelihood)
1345 {
1346   const int heading_columns = 0;
1347   const int heading_rows = 1;
1348   struct tab_table *t;
1349
1350   const int nc = 4;
1351   int nr = heading_rows + 1;
1352   double cox;
1353
1354   t = tab_create (nc, nr);
1355   tab_title (t, _("Model Summary"));
1356
1357   tab_headers (t, heading_columns, 0, heading_rows, 0);
1358
1359   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1360
1361   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1362   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1363
1364   tab_text (t,  0, 0, TAB_LEFT | TAT_TITLE, _("Step 1"));
1365   tab_text (t,  1, 0, TAB_CENTER | TAT_TITLE, _("-2 Log likelihood"));
1366   tab_double (t,  1, 1, 0, -2 * log_likelihood, NULL, RC_OTHER);
1367
1368
1369   tab_text (t,  2, 0, TAB_CENTER | TAT_TITLE, _("Cox & Snell R Square"));
1370   cox =  1.0 - exp((initial_log_likelihood - log_likelihood) * (2 / res->cc));
1371   tab_double (t,  2, 1, 0, cox, NULL, RC_OTHER);
1372
1373   tab_text (t,  3, 0, TAB_CENTER | TAT_TITLE, _("Nagelkerke R Square"));
1374   tab_double (t,  3, 1, 0, cox / ( 1.0 - exp(initial_log_likelihood * (2 / res->cc))), NULL, RC_OTHER);
1375
1376
1377   tab_submit (t);
1378 }
1379
1380 /* Show the case processing summary box */
1381 static void
1382 case_processing_summary (const struct lr_result *res)
1383 {
1384   const int heading_columns = 1;
1385   const int heading_rows = 1;
1386   struct tab_table *t;
1387
1388   const int nc = 3;
1389   const int nr = heading_rows + 3;
1390   casenumber total;
1391
1392   t = tab_create (nc, nr);
1393   tab_title (t, _("Case Processing Summary"));
1394
1395   tab_headers (t, heading_columns, 0, heading_rows, 0);
1396
1397   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1398
1399   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1400   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1401
1402   tab_text (t,  0, 0, TAB_LEFT | TAT_TITLE, _("Unweighted Cases"));
1403   tab_text (t,  1, 0, TAB_CENTER | TAT_TITLE, _("N"));
1404   tab_text (t,  2, 0, TAB_CENTER | TAT_TITLE, _("Percent"));
1405
1406
1407   tab_text (t,  0, 1, TAB_LEFT | TAT_TITLE, _("Included in Analysis"));
1408   tab_text (t,  0, 2, TAB_LEFT | TAT_TITLE, _("Missing Cases"));
1409   tab_text (t,  0, 3, TAB_LEFT | TAT_TITLE, _("Total"));
1410
1411   tab_double (t,  1, 1, 0, res->n_nonmissing, NULL, RC_INTEGER);
1412   tab_double (t,  1, 2, 0, res->n_missing, NULL, RC_INTEGER);
1413
1414   total = res->n_nonmissing + res->n_missing;
1415   tab_double (t,  1, 3, 0, total , NULL, RC_INTEGER);
1416
1417   tab_double (t,  2, 1, 0, 100 * res->n_nonmissing / (double) total, NULL, RC_OTHER);
1418   tab_double (t,  2, 2, 0, 100 * res->n_missing / (double) total, NULL, RC_OTHER);
1419   tab_double (t,  2, 3, 0, 100 * total / (double) total, NULL, RC_OTHER);
1420
1421   tab_submit (t);
1422 }
1423
1424 static void
1425 output_categories (const struct lr_spec *cmd, const struct lr_result *res)
1426 {
1427   const struct fmt_spec *wfmt =
1428     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
1429
1430   int cumulative_df;
1431   int i = 0;
1432   const int heading_columns = 2;
1433   const int heading_rows = 2;
1434   struct tab_table *t;
1435
1436   int nc ;
1437   int nr ;
1438
1439   int v;
1440   int r = 0;
1441
1442   int max_df = 0;
1443   int total_cats = 0;
1444   for (i = 0; i < cmd->n_cat_predictors; ++i)
1445     {
1446       size_t n = categoricals_n_count (res->cats, i);
1447       size_t df = categoricals_df (res->cats, i);
1448       if (max_df < df)
1449         max_df = df;
1450       total_cats += n;
1451     }
1452
1453   nc = heading_columns + 1 + max_df;
1454   nr = heading_rows + total_cats;
1455
1456   t = tab_create (nc, nr);
1457   tab_set_format (t, RC_WEIGHT, wfmt);
1458
1459   tab_title (t, _("Categorical Variables' Codings"));
1460
1461   tab_headers (t, heading_columns, 0, heading_rows, 0);
1462
1463   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1464
1465   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1466   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1467
1468
1469   tab_text (t, heading_columns, 1, TAB_CENTER | TAT_TITLE, _("Frequency"));
1470
1471   tab_joint_text_format (t, heading_columns + 1, 0, nc - 1, 0,
1472                          TAB_CENTER | TAT_TITLE, _("Parameter coding"));
1473
1474
1475   for (i = 0; i < max_df; ++i)
1476     {
1477       int c = heading_columns + 1 + i;
1478       tab_text_format (t,  c, 1, TAB_CENTER | TAT_TITLE, _("(%d)"), i + 1);
1479     }
1480
1481   cumulative_df = 0;
1482   for (v = 0; v < cmd->n_cat_predictors; ++v)
1483     {
1484       int cat;
1485       const struct interaction *cat_predictors = cmd->cat_predictors[v];
1486       int df =  categoricals_df (res->cats, v);
1487       struct string str;
1488       ds_init_empty (&str);
1489
1490       interaction_to_string (cat_predictors, &str);
1491
1492       tab_text (t, 0, heading_rows + r, TAB_LEFT | TAT_TITLE, ds_cstr (&str) );
1493
1494       ds_destroy (&str);
1495
1496       for (cat = 0; cat < categoricals_n_count (res->cats, v) ; ++cat)
1497         {
1498           struct string str;
1499           const struct ccase *c = categoricals_get_case_by_category_real (res->cats, v, cat);
1500           const double *freq = categoricals_get_user_data_by_category_real (res->cats, v, cat);
1501
1502           int x;
1503           ds_init_empty (&str);
1504
1505           for (x = 0; x < cat_predictors->n_vars; ++x)
1506             {
1507               const union value *val = case_data (c, cat_predictors->vars[x]);
1508               var_append_value_name (cat_predictors->vars[x], val, &str);
1509
1510               if (x < cat_predictors->n_vars - 1)
1511                 ds_put_cstr (&str, " ");
1512             }
1513
1514           tab_text   (t, 1, heading_rows + r, 0, ds_cstr (&str));
1515           ds_destroy (&str);
1516           tab_double (t, 2, heading_rows + r, 0, *freq, NULL, RC_WEIGHT);
1517
1518           for (x = 0; x < df; ++x)
1519             {
1520               tab_double (t, heading_columns + 1 + x, heading_rows + r, 0, (cat == x), NULL, RC_INTEGER);
1521             }
1522           ++r;
1523         }
1524       cumulative_df += df;
1525     }
1526
1527   tab_submit (t);
1528
1529 }
1530
1531
1532 static void
1533 output_classification_table (const struct lr_spec *cmd, const struct lr_result *res)
1534 {
1535   const struct fmt_spec *wfmt =
1536     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
1537
1538   const int heading_columns = 3;
1539   const int heading_rows = 3;
1540
1541   struct string sv0, sv1;
1542
1543   const int nc = heading_columns + 3;
1544   const int nr = heading_rows + 3;
1545
1546   struct tab_table *t = tab_create (nc, nr);
1547   tab_set_format (t, RC_WEIGHT, wfmt);
1548
1549   ds_init_empty (&sv0);
1550   ds_init_empty (&sv1);
1551
1552   tab_title (t, _("Classification Table"));
1553
1554   tab_headers (t, heading_columns, 0, heading_rows, 0);
1555
1556   tab_box (t, TAL_2, TAL_2, -1, -1, 0, 0, nc - 1, nr - 1);
1557   tab_box (t, -1, -1, -1, TAL_1, heading_columns, 0, nc - 1, nr - 1);
1558
1559   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1560   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1561
1562   tab_text (t,  0, heading_rows, TAB_CENTER | TAT_TITLE, _("Step 1"));
1563
1564
1565   tab_joint_text (t, heading_columns, 0, nc - 1, 0,
1566                   TAB_CENTER | TAT_TITLE, _("Predicted"));
1567
1568   tab_joint_text (t, heading_columns, 1, heading_columns + 1, 1,
1569                   0, var_to_string (cmd->dep_var) );
1570
1571   tab_joint_text (t, 1, 2, 2, 2,
1572                   TAB_LEFT | TAT_TITLE, _("Observed"));
1573
1574   tab_text (t, 1, 3, TAB_LEFT, var_to_string (cmd->dep_var) );
1575
1576
1577   tab_joint_text (t, nc - 1, 1, nc - 1, 2,
1578                   TAB_CENTER | TAT_TITLE, _("Percentage\nCorrect"));
1579
1580
1581   tab_joint_text (t, 1, nr - 1, 2, nr - 1,
1582                   TAB_LEFT | TAT_TITLE, _("Overall Percentage"));
1583
1584
1585   tab_hline (t, TAL_1, 1, nc - 1, nr - 1);
1586
1587   var_append_value_name (cmd->dep_var, &res->y0, &sv0);
1588   var_append_value_name (cmd->dep_var, &res->y1, &sv1);
1589
1590   tab_text (t, 2, heading_rows,     TAB_LEFT,  ds_cstr (&sv0));
1591   tab_text (t, 2, heading_rows + 1, TAB_LEFT,  ds_cstr (&sv1));
1592
1593   tab_text (t, heading_columns,     2, 0,  ds_cstr (&sv0));
1594   tab_text (t, heading_columns + 1, 2, 0,  ds_cstr (&sv1));
1595
1596   ds_destroy (&sv0);
1597   ds_destroy (&sv1);
1598
1599   tab_double (t, heading_columns, 3,     0, res->tn, NULL, RC_WEIGHT);
1600   tab_double (t, heading_columns + 1, 4, 0, res->tp, NULL, RC_WEIGHT);
1601
1602   tab_double (t, heading_columns + 1, 3, 0, res->fp, NULL, RC_WEIGHT);
1603   tab_double (t, heading_columns,     4, 0, res->fn, NULL, RC_WEIGHT);
1604
1605   tab_double (t, heading_columns + 2, 3, 0, 100 * res->tn / (res->tn + res->fp), NULL, RC_OTHER);
1606   tab_double (t, heading_columns + 2, 4, 0, 100 * res->tp / (res->tp + res->fn), NULL, RC_OTHER);
1607
1608   tab_double (t, heading_columns + 2, 5, 0,
1609               100 * (res->tp + res->tn) / (res->tp  + res->tn + res->fp + res->fn), NULL, RC_OTHER);
1610
1611
1612   tab_submit (t);
1613 }