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               goto error;
 527             }
 528         }
 529
 530       if (v0set && value_equal (&res->y0, depval, width))
 531           sumA += weight;
 532
 533       if (v1set && value_equal (&res->y1, depval, width))
 534           sumB += weight;
 535
 536
 537       res->cc += weight;
 538
 539       categoricals_update (res->cats, c);
 540     }
 541   casereader_destroy (reader);
 542
 543   categoricals_done (res->cats);
 544
 545   sum = sumB;
 546
 547   /* Ensure that Y0 is less than Y1.  Otherwise the mapping gets
 548      inverted, which is confusing to users */
 549   if (var_is_numeric (cmd->dep_var) && value_compare_3way (&res->y0, &res->y1, width) > 0)
 550     {
 551       union value tmp;
 552       value_clone (&tmp, &res->y0, width);
 553       value_copy (&res->y0, &res->y1, width);
 554       value_copy (&res->y1, &tmp, width);
 555       value_destroy (&tmp, width);
 556       sum = sumA;
 557     }
 558
 559   n_coefficients += categoricals_df_total (res->cats);
 560   res->beta_hat = gsl_vector_calloc (n_coefficients);
 561
 562   if (cmd->constant)
 563     {
 564       double mean = sum / res->cc;
 565       gsl_vector_set (res->beta_hat, res->beta_hat->size - 1, log (mean / (1 - mean)));
 566     }
 567
 568   return true;
 569
 570  error:
 571   casereader_destroy (reader);
 572   return false;
 573 }
 574
 575
 576
 577 /* Start of the logistic regression routine proper */
 578 static bool
 579 run_lr (const struct lr_spec *cmd, struct casereader *input,
 580         const struct dataset *ds UNUSED)
 581 {
 582   int i;
 583
 584   bool converged = false;
 585
 586   /* Set the log likelihoods to a sentinel value */
 587   double log_likelihood = SYSMIS;
 588   double prev_log_likelihood = SYSMIS;
 589   double initial_log_likelihood = SYSMIS;
 590
 591   struct lr_result work;
 592   work.n_missing = 0;
 593   work.n_nonmissing = 0;
 594   work.warn_bad_weight = true;
 595   work.cats = NULL;
 596   work.beta_hat = NULL;
 597
 598   /* Get the initial estimates of \beta and their standard errors.
 599      And perform other auxilliary initialisation.  */
 600   if (! initial_pass (cmd, &work, input))
 601     return false;
 602
 603   for (i = 0; i < cmd->n_cat_predictors; ++i)
 604     {
 605       if (1 >= categoricals_n_count (work.cats, i))
 606         {
 607           struct string str;
 608           ds_init_empty (&str);
 609
 610           interaction_to_string (cmd->cat_predictors[i], &str);
 611
 612           msg (ME, _("Category %s does not have at least two distinct values. Logistic regression will not be run."),
 613                ds_cstr(&str));
 614           ds_destroy (&str);
 615           return false;
 616         }
 617     }
 618
 619   output_depvarmap (cmd, &work);
 620
 621   case_processing_summary (&work);
 622
 623
 624   input = casereader_create_filter_missing (input,
 625                                             cmd->indep_vars,
 626                                             cmd->n_indep_vars,
 627                                             cmd->exclude,
 628                                             NULL,
 629                                             NULL);
 630
 631   input = casereader_create_filter_missing (input,
 632                                             &cmd->dep_var,
 633                                             1,
 634                                             cmd->exclude,
 635                                             NULL,
 636                                             NULL);
 637
 638   work.hessian = gsl_matrix_calloc (work.beta_hat->size, work.beta_hat->size);
 639
 640   /* Start the Newton Raphson iteration process... */
 641   for( i = 0 ; i < cmd->max_iter ; ++i)
 642     {
 643       double min, max;
 644       gsl_vector *v ;
 645
 646
 647       hessian (cmd, &work, input,
 648                cmd->predictor_vars, cmd->n_predictor_vars,
 649                &converged);
 650
 651       gsl_linalg_cholesky_decomp (work.hessian);
 652       gsl_linalg_cholesky_invert (work.hessian);
 653
 654       v = xt_times_y_pi (cmd, &work, input,
 655                          cmd->predictor_vars, cmd->n_predictor_vars,
 656                          cmd->dep_var,
 657                          &log_likelihood);
 658
 659       {
 660         /* delta = M.v */
 661         gsl_vector *delta = gsl_vector_alloc (v->size);
 662         gsl_blas_dgemv (CblasNoTrans, 1.0, work.hessian, v, 0, delta);
 663         gsl_vector_free (v);
 664
 665
 666         gsl_vector_add (work.beta_hat, delta);
 667
 668         gsl_vector_minmax (delta, &min, &max);
 669
 670         if ( fabs (min) < cmd->bcon && fabs (max) < cmd->bcon)
 671           {
 672             msg (MN, _("Estimation terminated at iteration number %d because parameter estimates changed by less than %g"),
 673                  i + 1, cmd->bcon);
 674             converged = true;
 675           }
 676
 677         gsl_vector_free (delta);
 678       }
 679
 680       if (i > 0)
 681         {
 682           if (-log_likelihood > -(1.0 - cmd->lcon) * prev_log_likelihood)
 683             {
 684               msg (MN, _("Estimation terminated at iteration number %d because Log Likelihood decreased by less than %g%%"), i + 1, 100 * cmd->lcon);
 685               converged = true;
 686             }
 687         }
 688       if (i == 0)
 689         initial_log_likelihood = log_likelihood;
 690       prev_log_likelihood = log_likelihood;
 691
 692       if (converged)
 693         break;
 694     }
 695   casereader_destroy (input);
 696
 697
 698   if ( ! converged)
 699     msg (MW, _("Estimation terminated at iteration number %d because maximum iterations has been reached"), i );
 700
 701
 702   output_model_summary (&work, initial_log_likelihood, log_likelihood);
 703
 704   if (work.cats)
 705     output_categories (cmd, &work);
 706
 707   output_classification_table (cmd, &work);
 708   output_variables (cmd, &work);
 709
 710   gsl_matrix_free (work.hessian);
 711   gsl_vector_free (work.beta_hat);
 712
 713   categoricals_destroy (work.cats);
 714
 715   return true;
 716 }
 717
 718 struct variable_node
 719 {
 720   struct hmap_node node;      /* Node in hash map. */
 721   const struct variable *var; /* The variable */
 722 };
 723
 724 static struct variable_node *
 725 lookup_variable (const struct hmap *map, const struct variable *var, unsigned int hash)
 726 {
 727   struct variable_node *vn = NULL;
 728   HMAP_FOR_EACH_WITH_HASH (vn, struct variable_node, node, hash, map)
 729     {
 730       if (vn->var == var)
 731         break;
 732
 733       fprintf (stderr, "Warning: Hash table collision\n");
 734     }
 735
 736   return vn;
 737 }
 738
 739
 740 /* Parse the LOGISTIC REGRESSION command syntax */
 741 int
 742 cmd_logistic (struct lexer *lexer, struct dataset *ds)
 743 {
 744   int i;
 745   /* Temporary location for the predictor variables.
 746      These may or may not include the categorical predictors */
 747   const struct variable **pred_vars;
 748   size_t n_pred_vars;
 749   double cp = 0.5;
 750
 751   int v, x;
 752   struct lr_spec lr;
 753   lr.dict = dataset_dict (ds);
 754   lr.n_predictor_vars = 0;
 755   lr.predictor_vars = NULL;
 756   lr.exclude = MV_ANY;
 757   lr.wv = dict_get_weight (lr.dict);
 758   lr.max_iter = 20;
 759   lr.lcon = 0.0000;
 760   lr.bcon = 0.001;
 761   lr.min_epsilon = 0.00000001;
 762   lr.constant = true;
 763   lr.confidence = 95;
 764   lr.print = PRINT_DEFAULT;
 765   lr.cat_predictors = NULL;
 766   lr.n_cat_predictors = 0;
 767   lr.indep_vars = NULL;
 768
 769
 770   if (lex_match_id (lexer, "VARIABLES"))
 771     lex_match (lexer, T_EQUALS);
 772
 773   if (! (lr.dep_var = parse_variable_const (lexer, lr.dict)))
 774     goto error;
 775
 776   lex_force_match (lexer, T_WITH);
 777
 778   if (!parse_variables_const (lexer, lr.dict,
 779                               &pred_vars, &n_pred_vars,
 780                               PV_NO_DUPLICATE))
 781     goto error;
 782
 783
 784   while (lex_token (lexer) != T_ENDCMD)
 785     {
 786       lex_match (lexer, T_SLASH);
 787
 788       if (lex_match_id (lexer, "MISSING"))
 789         {
 790           lex_match (lexer, T_EQUALS);
 791           while (lex_token (lexer) != T_ENDCMD
 792                  && lex_token (lexer) != T_SLASH)
 793             {
 794               if (lex_match_id (lexer, "INCLUDE"))
 795                 {
 796                   lr.exclude = MV_SYSTEM;
 797                 }
 798               else if (lex_match_id (lexer, "EXCLUDE"))
 799                 {
 800                   lr.exclude = MV_ANY;
 801                 }
 802               else
 803                 {
 804                   lex_error (lexer, NULL);
 805                   goto error;
 806                 }
 807             }
 808         }
 809       else if (lex_match_id (lexer, "ORIGIN"))
 810         {
 811           lr.constant = false;
 812         }
 813       else if (lex_match_id (lexer, "NOORIGIN"))
 814         {
 815           lr.constant = true;
 816         }
 817       else if (lex_match_id (lexer, "NOCONST"))
 818         {
 819           lr.constant = false;
 820         }
 821       else if (lex_match_id (lexer, "EXTERNAL"))
 822         {
 823           /* This is for compatibility.  It does nothing */
 824         }
 825       else if (lex_match_id (lexer, "CATEGORICAL"))
 826         {
 827           lex_match (lexer, T_EQUALS);
 828           do
 829             {
 830               lr.cat_predictors = xrealloc (lr.cat_predictors,
 831                                   sizeof (*lr.cat_predictors) * ++lr.n_cat_predictors);
 832               lr.cat_predictors[lr.n_cat_predictors - 1] = 0;
 833             }
 834           while (parse_design_interaction (lexer, lr.dict,
 835                                            lr.cat_predictors + lr.n_cat_predictors - 1));
 836           lr.n_cat_predictors--;
 837         }
 838       else if (lex_match_id (lexer, "PRINT"))
 839         {
 840           lex_match (lexer, T_EQUALS);
 841           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
 842             {
 843               if (lex_match_id (lexer, "DEFAULT"))
 844                 {
 845                   lr.print |= PRINT_DEFAULT;
 846                 }
 847               else if (lex_match_id (lexer, "SUMMARY"))
 848                 {
 849                   lr.print |= PRINT_SUMMARY;
 850                 }
 851 #if 0
 852               else if (lex_match_id (lexer, "CORR"))
 853                 {
 854                   lr.print |= PRINT_CORR;
 855                 }
 856               else if (lex_match_id (lexer, "ITER"))
 857                 {
 858                   lr.print |= PRINT_ITER;
 859                 }
 860               else if (lex_match_id (lexer, "GOODFIT"))
 861                 {
 862                   lr.print |= PRINT_GOODFIT;
 863                 }
 864 #endif
 865               else if (lex_match_id (lexer, "CI"))
 866                 {
 867                   lr.print |= PRINT_CI;
 868                   if (lex_force_match (lexer, T_LPAREN))
 869                     {
 870                       if (! lex_force_int (lexer))
 871                         {
 872                           lex_error (lexer, NULL);
 873                           goto error;
 874                         }
 875                       lr.confidence = lex_integer (lexer);
 876                       lex_get (lexer);
 877                       if ( ! lex_force_match (lexer, T_RPAREN))
 878                         {
 879                           lex_error (lexer, NULL);
 880                           goto error;
 881                         }
 882                     }
 883                 }
 884               else if (lex_match_id (lexer, "ALL"))
 885                 {
 886                   lr.print = ~0x0000;
 887                 }
 888               else
 889                 {
 890                   lex_error (lexer, NULL);
 891                   goto error;
 892                 }
 893             }
 894         }
 895       else if (lex_match_id (lexer, "CRITERIA"))
 896         {
 897           lex_match (lexer, T_EQUALS);
 898           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
 899             {
 900               if (lex_match_id (lexer, "BCON"))
 901                 {
 902                   if (lex_force_match (lexer, T_LPAREN))
 903                     {
 904                       if (! lex_force_num (lexer))
 905                         {
 906                           lex_error (lexer, NULL);
 907                           goto error;
 908                         }
 909                       lr.bcon = lex_number (lexer);
 910                       lex_get (lexer);
 911                       if ( ! lex_force_match (lexer, T_RPAREN))
 912                         {
 913                           lex_error (lexer, NULL);
 914                           goto error;
 915                         }
 916                     }
 917                 }
 918               else if (lex_match_id (lexer, "ITERATE"))
 919                 {
 920                   if (lex_force_match (lexer, T_LPAREN))
 921                     {
 922                       if (! lex_force_int (lexer))
 923                         {
 924                           lex_error (lexer, NULL);
 925                           goto error;
 926                         }
 927                       lr.max_iter = lex_integer (lexer);
 928                       lex_get (lexer);
 929                       if ( ! lex_force_match (lexer, T_RPAREN))
 930                         {
 931                           lex_error (lexer, NULL);
 932                           goto error;
 933                         }
 934                     }
 935                 }
 936               else if (lex_match_id (lexer, "LCON"))
 937                 {
 938                   if (lex_force_match (lexer, T_LPAREN))
 939                     {
 940                       if (! lex_force_num (lexer))
 941                         {
 942                           lex_error (lexer, NULL);
 943                           goto error;
 944                         }
 945                       lr.lcon = lex_number (lexer);
 946                       lex_get (lexer);
 947                       if ( ! lex_force_match (lexer, T_RPAREN))
 948                         {
 949                           lex_error (lexer, NULL);
 950                           goto error;
 951                         }
 952                     }
 953                 }
 954               else if (lex_match_id (lexer, "EPS"))
 955                 {
 956                   if (lex_force_match (lexer, T_LPAREN))
 957                     {
 958                       if (! lex_force_num (lexer))
 959                         {
 960                           lex_error (lexer, NULL);
 961                           goto error;
 962                         }
 963                       lr.min_epsilon = lex_number (lexer);
 964                       lex_get (lexer);
 965                       if ( ! lex_force_match (lexer, T_RPAREN))
 966                         {
 967                           lex_error (lexer, NULL);
 968                           goto error;
 969                         }
 970                     }
 971                 }
 972               else if (lex_match_id (lexer, "CUT"))
 973                 {
 974                   if (lex_force_match (lexer, T_LPAREN))
 975                     {
 976                       if (! lex_force_num (lexer))
 977                         {
 978                           lex_error (lexer, NULL);
 979                           goto error;
 980                         }
 981                       cp = lex_number (lexer);
 982
 983                       if (cp < 0 || cp > 1.0)
 984                         {
 985                           msg (ME, _("Cut point value must be in the range [0,1]"));
 986                           goto error;
 987                         }
 988                       lex_get (lexer);
 989                       if ( ! lex_force_match (lexer, T_RPAREN))
 990                         {
 991                           lex_error (lexer, NULL);
 992                           goto error;
 993                         }
 994                     }
 995                 }
 996               else
 997                 {
 998                   lex_error (lexer, NULL);
 999                   goto error;
1000                 }
1001             }
1002         }
1003       else
1004         {
1005           lex_error (lexer, NULL);
1006           goto error;
1007         }
1008     }
1009
1010   lr.ilogit_cut_point = - log (1/cp - 1);
1011
1012
1013   /* Copy the predictor variables from the temporary location into the
1014      final one, dropping any categorical variables which appear there.
1015      FIXME: This is O(NxM).
1016   */
1017   {
1018   struct variable_node *vn, *next;
1019   struct hmap allvars;
1020   hmap_init (&allvars);
1021   for (v = x = 0; v < n_pred_vars; ++v)
1022     {
1023       bool drop = false;
1024       const struct variable *var = pred_vars[v];
1025       int cv = 0;
1026
1027       unsigned int hash = hash_pointer (var, 0);
1028       struct variable_node *vn = lookup_variable (&allvars, var, hash);
1029       if (vn == NULL)
1030         {
1031           vn = xmalloc (sizeof *vn);
1032           vn->var = var;
1033           hmap_insert (&allvars, &vn->node,  hash);
1034         }
1035
1036       for (cv = 0; cv < lr.n_cat_predictors ; ++cv)
1037         {
1038           int iv;
1039           const struct interaction *iact = lr.cat_predictors[cv];
1040           for (iv = 0 ; iv < iact->n_vars ; ++iv)
1041             {
1042               const struct variable *ivar = iact->vars[iv];
1043               unsigned int hash = hash_pointer (ivar, 0);
1044               struct variable_node *vn = lookup_variable (&allvars, ivar, hash);
1045               if (vn == NULL)
1046                 {
1047                   vn = xmalloc (sizeof *vn);
1048                   vn->var = ivar;
1049
1050                   hmap_insert (&allvars, &vn->node,  hash);
1051                 }
1052
1053               if (var == ivar)
1054                 {
1055                   drop = true;
1056                 }
1057             }
1058         }
1059
1060       if (drop)
1061         continue;
1062
1063       lr.predictor_vars = xrealloc (lr.predictor_vars, sizeof *lr.predictor_vars * (x + 1));
1064       lr.predictor_vars[x++] = var;
1065       lr.n_predictor_vars++;
1066     }
1067   free (pred_vars);
1068
1069   lr.n_indep_vars = hmap_count (&allvars);
1070   lr.indep_vars = xmalloc (lr.n_indep_vars * sizeof *lr.indep_vars);
1071
1072   /* Interate over each variable and push it into the array */
1073   x = 0;
1074   HMAP_FOR_EACH_SAFE (vn, next, struct variable_node, node, &allvars)
1075     {
1076       lr.indep_vars[x++] = vn->var;
1077       free (vn);
1078     }
1079   hmap_destroy (&allvars);
1080   }
1081
1082
1083   /* logistical regression for each split group */
1084   {
1085     struct casegrouper *grouper;
1086     struct casereader *group;
1087     bool ok;
1088
1089     grouper = casegrouper_create_splits (proc_open (ds), lr.dict);
1090     while (casegrouper_get_next_group (grouper, &group))
1091       ok = run_lr (&lr, group, ds);
1092     ok = casegrouper_destroy (grouper);
1093     ok = proc_commit (ds) && ok;
1094   }
1095
1096   for (i = 0 ; i < lr.n_cat_predictors; ++i)
1097     {
1098       interaction_destroy (lr.cat_predictors[i]);
1099     }
1100   free (lr.predictor_vars);
1101   free (lr.cat_predictors);
1102   free (lr.indep_vars);
1103
1104   return CMD_SUCCESS;
1105
1106  error:
1107
1108   for (i = 0 ; i < lr.n_cat_predictors; ++i)
1109     {
1110       interaction_destroy (lr.cat_predictors[i]);
1111     }
1112   free (lr.predictor_vars);
1113   free (lr.cat_predictors);
1114   free (lr.indep_vars);
1115
1116   return CMD_FAILURE;
1117 }
1118
1119
1120 \f
1121
1122 /* Show the Dependent Variable Encoding box.
1123    This indicates how the dependent variable
1124    is mapped to the internal zero/one values.
1125 */
1126 static void
1127 output_depvarmap (const struct lr_spec *cmd, const struct lr_result *res)
1128 {
1129   const int heading_columns = 0;
1130   const int heading_rows = 1;
1131   struct tab_table *t;
1132   struct string str;
1133
1134   const int nc = 2;
1135   int nr = heading_rows + 2;
1136
1137   t = tab_create (nc, nr);
1138   tab_title (t, _("Dependent Variable Encoding"));
1139
1140   tab_headers (t, heading_columns, 0, heading_rows, 0);
1141
1142   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1143
1144   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1145   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1146
1147   tab_text (t,  0, 0, TAB_CENTER | TAT_TITLE, _("Original Value"));
1148   tab_text (t,  1, 0, TAB_CENTER | TAT_TITLE, _("Internal Value"));
1149
1150
1151
1152   ds_init_empty (&str);
1153   var_append_value_name (cmd->dep_var, &res->y0, &str);
1154   tab_text (t,  0, 0 + heading_rows,  0, ds_cstr (&str));
1155
1156   ds_clear (&str);
1157   var_append_value_name (cmd->dep_var, &res->y1, &str);
1158   tab_text (t,  0, 1 + heading_rows,  0, ds_cstr (&str));
1159
1160
1161   tab_double (t, 1, 0 + heading_rows, 0, map_dependent_var (cmd, res, &res->y0), &F_8_0);
1162   tab_double (t, 1, 1 + heading_rows, 0, map_dependent_var (cmd, res, &res->y1), &F_8_0);
1163   ds_destroy (&str);
1164
1165   tab_submit (t);
1166 }
1167
1168
1169 /* Show the Variables in the Equation box */
1170 static void
1171 output_variables (const struct lr_spec *cmd,
1172                   const struct lr_result *res)
1173 {
1174   int row = 0;
1175   const int heading_columns = 1;
1176   int heading_rows = 1;
1177   struct tab_table *t;
1178
1179   int nc = 8;
1180   int nr ;
1181   int i = 0;
1182   int ivar = 0;
1183   int idx_correction = 0;
1184
1185   if (cmd->print & PRINT_CI)
1186     {
1187       nc += 2;
1188       heading_rows += 1;
1189       row++;
1190     }
1191   nr = heading_rows + cmd->n_predictor_vars;
1192   if (cmd->constant)
1193     nr++;
1194
1195   if (res->cats)
1196     nr += categoricals_df_total (res->cats) + cmd->n_cat_predictors;
1197
1198   t = tab_create (nc, nr);
1199   tab_title (t, _("Variables in the Equation"));
1200
1201   tab_headers (t, heading_columns, 0, heading_rows, 0);
1202
1203   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1204
1205   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1206   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1207
1208   tab_text (t,  0, row + 1, TAB_CENTER | TAT_TITLE, _("Step 1"));
1209
1210   tab_text (t,  2, row, TAB_CENTER | TAT_TITLE, _("B"));
1211   tab_text (t,  3, row, TAB_CENTER | TAT_TITLE, _("S.E."));
1212   tab_text (t,  4, row, TAB_CENTER | TAT_TITLE, _("Wald"));
1213   tab_text (t,  5, row, TAB_CENTER | TAT_TITLE, _("df"));
1214   tab_text (t,  6, row, TAB_CENTER | TAT_TITLE, _("Sig."));
1215   tab_text (t,  7, row, TAB_CENTER | TAT_TITLE, _("Exp(B)"));
1216
1217   if (cmd->print & PRINT_CI)
1218     {
1219       tab_joint_text_format (t, 8, 0, 9, 0,
1220                              TAB_CENTER | TAT_TITLE, _("%d%% CI for Exp(B)"), cmd->confidence);
1221
1222       tab_text (t,  8, row, TAB_CENTER | TAT_TITLE, _("Lower"));
1223       tab_text (t,  9, row, TAB_CENTER | TAT_TITLE, _("Upper"));
1224     }
1225
1226   for (row = heading_rows ; row < nr; ++row)
1227     {
1228       const int idx = row - heading_rows - idx_correction;
1229
1230       const double b = gsl_vector_get (res->beta_hat, idx);
1231       const double sigma2 = gsl_matrix_get (res->hessian, idx, idx);
1232       const double wald = pow2 (b) / sigma2;
1233       const double df = 1;
1234
1235       if (idx < cmd->n_predictor_vars)
1236         {
1237           tab_text (t, 1, row, TAB_LEFT | TAT_TITLE,
1238                     var_to_string (cmd->predictor_vars[idx]));
1239         }
1240       else if (i < cmd->n_cat_predictors)
1241         {
1242           double wald;
1243           bool summary = false;
1244           struct string str;
1245           const struct interaction *cat_predictors = cmd->cat_predictors[i];
1246           const int df = categoricals_df (res->cats, i);
1247
1248           ds_init_empty (&str);
1249           interaction_to_string (cat_predictors, &str);
1250
1251           if (ivar == 0)
1252             {
1253               /* Calculate the Wald statistic,
1254                  which is \beta' C^-1 \beta .
1255                  where \beta is the vector of the coefficient estimates comprising this
1256                  categorial variable. and C is the corresponding submatrix of the
1257                  hessian matrix.
1258               */
1259               gsl_matrix_const_view mv =
1260                 gsl_matrix_const_submatrix (res->hessian, idx, idx, df, df);
1261               gsl_matrix *subhessian = gsl_matrix_alloc (mv.matrix.size1, mv.matrix.size2);
1262               gsl_vector_const_view vv = gsl_vector_const_subvector (res->beta_hat, idx, df);
1263               gsl_vector *temp = gsl_vector_alloc (df);
1264
1265               gsl_matrix_memcpy (subhessian, &mv.matrix);
1266               gsl_linalg_cholesky_decomp (subhessian);
1267               gsl_linalg_cholesky_invert (subhessian);
1268
1269               gsl_blas_dgemv (CblasTrans, 1.0, subhessian, &vv.vector, 0, temp);
1270               gsl_blas_ddot (temp, &vv.vector, &wald);
1271
1272               tab_double (t, 4, row, 0, wald, 0);
1273               tab_double (t, 5, row, 0, df, &F_8_0);
1274               tab_double (t, 6, row, 0, gsl_cdf_chisq_Q (wald, df), 0);
1275
1276               idx_correction ++;
1277               summary = true;
1278               gsl_matrix_free (subhessian);
1279               gsl_vector_free (temp);
1280             }
1281           else
1282             {
1283               ds_put_format (&str, "(%d)", ivar);
1284             }
1285
1286           tab_text (t, 1, row, TAB_LEFT | TAT_TITLE, ds_cstr (&str));
1287           if (ivar++ == df)
1288             {
1289               ++i; /* next interaction */
1290               ivar = 0;
1291             }
1292
1293           ds_destroy (&str);
1294
1295           if (summary)
1296             continue;
1297         }
1298       else
1299         {
1300           tab_text (t, 1, row, TAB_LEFT | TAT_TITLE, _("Constant"));
1301         }
1302
1303       tab_double (t, 2, row, 0, b, 0);
1304       tab_double (t, 3, row, 0, sqrt (sigma2), 0);
1305       tab_double (t, 4, row, 0, wald, 0);
1306       tab_double (t, 5, row, 0, df, &F_8_0);
1307       tab_double (t, 6, row, 0, gsl_cdf_chisq_Q (wald, df), 0);
1308       tab_double (t, 7, row, 0, exp (b), 0);
1309
1310       if (cmd->print & PRINT_CI)
1311         {
1312           int last_ci = nr;
1313           double wc = gsl_cdf_ugaussian_Pinv (0.5 + cmd->confidence / 200.0);
1314           wc *= sqrt (sigma2);
1315
1316           if (cmd->constant)
1317             last_ci--;
1318
1319           if (row < last_ci)
1320             {
1321               tab_double (t, 8, row, 0, exp (b - wc), 0);
1322               tab_double (t, 9, row, 0, exp (b + wc), 0);
1323             }
1324         }
1325     }
1326
1327   tab_submit (t);
1328 }
1329
1330
1331 /* Show the model summary box */
1332 static void
1333 output_model_summary (const struct lr_result *res,
1334                       double initial_log_likelihood, double log_likelihood)
1335 {
1336   const int heading_columns = 0;
1337   const int heading_rows = 1;
1338   struct tab_table *t;
1339
1340   const int nc = 4;
1341   int nr = heading_rows + 1;
1342   double cox;
1343
1344   t = tab_create (nc, nr);
1345   tab_title (t, _("Model Summary"));
1346
1347   tab_headers (t, heading_columns, 0, heading_rows, 0);
1348
1349   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1350
1351   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1352   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1353
1354   tab_text (t,  0, 0, TAB_LEFT | TAT_TITLE, _("Step 1"));
1355   tab_text (t,  1, 0, TAB_CENTER | TAT_TITLE, _("-2 Log likelihood"));
1356   tab_double (t,  1, 1, 0, -2 * log_likelihood, 0);
1357
1358
1359   tab_text (t,  2, 0, TAB_CENTER | TAT_TITLE, _("Cox & Snell R Square"));
1360   cox =  1.0 - exp((initial_log_likelihood - log_likelihood) * (2 / res->cc));
1361   tab_double (t,  2, 1, 0, cox, 0);
1362
1363   tab_text (t,  3, 0, TAB_CENTER | TAT_TITLE, _("Nagelkerke R Square"));
1364   tab_double (t,  3, 1, 0, cox / ( 1.0 - exp(initial_log_likelihood * (2 / res->cc))), 0);
1365
1366
1367   tab_submit (t);
1368 }
1369
1370 /* Show the case processing summary box */
1371 static void
1372 case_processing_summary (const struct lr_result *res)
1373 {
1374   const int heading_columns = 1;
1375   const int heading_rows = 1;
1376   struct tab_table *t;
1377
1378   const int nc = 3;
1379   const int nr = heading_rows + 3;
1380   casenumber total;
1381
1382   t = tab_create (nc, nr);
1383   tab_title (t, _("Case Processing Summary"));
1384
1385   tab_headers (t, heading_columns, 0, heading_rows, 0);
1386
1387   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1388
1389   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1390   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1391
1392   tab_text (t,  0, 0, TAB_LEFT | TAT_TITLE, _("Unweighted Cases"));
1393   tab_text (t,  1, 0, TAB_CENTER | TAT_TITLE, _("N"));
1394   tab_text (t,  2, 0, TAB_CENTER | TAT_TITLE, _("Percent"));
1395
1396
1397   tab_text (t,  0, 1, TAB_LEFT | TAT_TITLE, _("Included in Analysis"));
1398   tab_text (t,  0, 2, TAB_LEFT | TAT_TITLE, _("Missing Cases"));
1399   tab_text (t,  0, 3, TAB_LEFT | TAT_TITLE, _("Total"));
1400
1401   tab_double (t,  1, 1, 0, res->n_nonmissing, &F_8_0);
1402   tab_double (t,  1, 2, 0, res->n_missing, &F_8_0);
1403
1404   total = res->n_nonmissing + res->n_missing;
1405   tab_double (t,  1, 3, 0, total , &F_8_0);
1406
1407   tab_double (t,  2, 1, 0, 100 * res->n_nonmissing / (double) total, 0);
1408   tab_double (t,  2, 2, 0, 100 * res->n_missing / (double) total, 0);
1409   tab_double (t,  2, 3, 0, 100 * total / (double) total, 0);
1410
1411   tab_submit (t);
1412 }
1413
1414 static void
1415 output_categories (const struct lr_spec *cmd, const struct lr_result *res)
1416 {
1417   const struct fmt_spec *wfmt =
1418     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
1419
1420   int cumulative_df;
1421   int i = 0;
1422   const int heading_columns = 2;
1423   const int heading_rows = 2;
1424   struct tab_table *t;
1425
1426   int nc ;
1427   int nr ;
1428
1429   int v;
1430   int r = 0;
1431
1432   int max_df = 0;
1433   int total_cats = 0;
1434   for (i = 0; i < cmd->n_cat_predictors; ++i)
1435     {
1436       size_t n = categoricals_n_count (res->cats, i);
1437       size_t df = categoricals_df (res->cats, i);
1438       if (max_df < df)
1439         max_df = df;
1440       total_cats += n;
1441     }
1442
1443   nc = heading_columns + 1 + max_df;
1444   nr = heading_rows + total_cats;
1445
1446   t = tab_create (nc, nr);
1447   tab_title (t, _("Categorical Variables' Codings"));
1448
1449   tab_headers (t, heading_columns, 0, heading_rows, 0);
1450
1451   tab_box (t, TAL_2, TAL_2, -1, TAL_1, 0, 0, nc - 1, nr - 1);
1452
1453   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1454   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1455
1456
1457   tab_text (t, heading_columns, 1, TAB_CENTER | TAT_TITLE, _("Frequency"));
1458
1459   tab_joint_text_format (t, heading_columns + 1, 0, nc - 1, 0,
1460                          TAB_CENTER | TAT_TITLE, _("Parameter coding"));
1461
1462
1463   for (i = 0; i < max_df; ++i)
1464     {
1465       int c = heading_columns + 1 + i;
1466       tab_text_format (t,  c, 1, TAB_CENTER | TAT_TITLE, _("(%d)"), i + 1);
1467     }
1468
1469   cumulative_df = 0;
1470   for (v = 0; v < cmd->n_cat_predictors; ++v)
1471     {
1472       int cat;
1473       const struct interaction *cat_predictors = cmd->cat_predictors[v];
1474       int df =  categoricals_df (res->cats, v);
1475       struct string str;
1476       ds_init_empty (&str);
1477
1478       interaction_to_string (cat_predictors, &str);
1479
1480       tab_text (t, 0, heading_rows + r, TAB_LEFT | TAT_TITLE, ds_cstr (&str) );
1481
1482       ds_destroy (&str);
1483
1484       for (cat = 0; cat < categoricals_n_count (res->cats, v) ; ++cat)
1485         {
1486           struct string str;
1487           const struct ccase *c = categoricals_get_case_by_category_real (res->cats, v, cat);
1488           const double *freq = categoricals_get_user_data_by_category_real (res->cats, v, cat);
1489
1490           int x;
1491           ds_init_empty (&str);
1492
1493           for (x = 0; x < cat_predictors->n_vars; ++x)
1494             {
1495               const union value *val = case_data (c, cat_predictors->vars[x]);
1496               var_append_value_name (cat_predictors->vars[x], val, &str);
1497
1498               if (x < cat_predictors->n_vars - 1)
1499                 ds_put_cstr (&str, " ");
1500             }
1501
1502           tab_text   (t, 1, heading_rows + r, 0, ds_cstr (&str));
1503           ds_destroy (&str);
1504           tab_double (t, 2, heading_rows + r, 0, *freq, wfmt);
1505
1506           for (x = 0; x < df; ++x)
1507             {
1508               tab_double (t, heading_columns + 1 + x, heading_rows + r, 0, (cat == x), &F_8_0);
1509             }
1510           ++r;
1511         }
1512       cumulative_df += df;
1513     }
1514
1515   tab_submit (t);
1516
1517 }
1518
1519
1520 static void
1521 output_classification_table (const struct lr_spec *cmd, const struct lr_result *res)
1522 {
1523   const struct fmt_spec *wfmt =
1524     cmd->wv ? var_get_print_format (cmd->wv) : &F_8_0;
1525
1526   const int heading_columns = 3;
1527   const int heading_rows = 3;
1528
1529   struct string sv0, sv1;
1530
1531   const int nc = heading_columns + 3;
1532   const int nr = heading_rows + 3;
1533
1534   struct tab_table *t = tab_create (nc, nr);
1535
1536   ds_init_empty (&sv0);
1537   ds_init_empty (&sv1);
1538
1539   tab_title (t, _("Classification Table"));
1540
1541   tab_headers (t, heading_columns, 0, heading_rows, 0);
1542
1543   tab_box (t, TAL_2, TAL_2, -1, -1, 0, 0, nc - 1, nr - 1);
1544   tab_box (t, -1, -1, -1, TAL_1, heading_columns, 0, nc - 1, nr - 1);
1545
1546   tab_hline (t, TAL_2, 0, nc - 1, heading_rows);
1547   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1548
1549   tab_text (t,  0, heading_rows, TAB_CENTER | TAT_TITLE, _("Step 1"));
1550
1551
1552   tab_joint_text (t, heading_columns, 0, nc - 1, 0,
1553                   TAB_CENTER | TAT_TITLE, _("Predicted"));
1554
1555   tab_joint_text (t, heading_columns, 1, heading_columns + 1, 1,
1556                   0, var_to_string (cmd->dep_var) );
1557
1558   tab_joint_text (t, 1, 2, 2, 2,
1559                   TAB_LEFT | TAT_TITLE, _("Observed"));
1560
1561   tab_text (t, 1, 3, TAB_LEFT, var_to_string (cmd->dep_var) );
1562
1563
1564   tab_joint_text (t, nc - 1, 1, nc - 1, 2,
1565                   TAB_CENTER | TAT_TITLE, _("Percentage\nCorrect"));
1566
1567
1568   tab_joint_text (t, 1, nr - 1, 2, nr - 1,
1569                   TAB_LEFT | TAT_TITLE, _("Overall Percentage"));
1570
1571
1572   tab_hline (t, TAL_1, 1, nc - 1, nr - 1);
1573
1574   var_append_value_name (cmd->dep_var, &res->y0, &sv0);
1575   var_append_value_name (cmd->dep_var, &res->y1, &sv1);
1576
1577   tab_text (t, 2, heading_rows,     TAB_LEFT,  ds_cstr (&sv0));
1578   tab_text (t, 2, heading_rows + 1, TAB_LEFT,  ds_cstr (&sv1));
1579
1580   tab_text (t, heading_columns,     2, 0,  ds_cstr (&sv0));
1581   tab_text (t, heading_columns + 1, 2, 0,  ds_cstr (&sv1));
1582
1583   ds_destroy (&sv0);
1584   ds_destroy (&sv1);
1585
1586   tab_double (t, heading_columns, 3,     0, res->tn, wfmt);
1587   tab_double (t, heading_columns + 1, 4, 0, res->tp, wfmt);
1588
1589   tab_double (t, heading_columns + 1, 3, 0, res->fp, wfmt);
1590   tab_double (t, heading_columns,     4, 0, res->fn, wfmt);
1591
1592   tab_double (t, heading_columns + 2, 3, 0, 100 * res->tn / (res->tn + res->fp), 0);
1593   tab_double (t, heading_columns + 2, 4, 0, 100 * res->tp / (res->tp + res->fn), 0);
1594
1595   tab_double (t, heading_columns + 2, 5, 0,
1596               100 * (res->tp + res->tn) / (res->tp  + res->tn + res->fp + res->fn), 0);
1597
1598
1599   tab_submit (t);
1600 }