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

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2009, 2010, 2011, 2012, 2014, 2015,
   3    2016, 2017 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  17
  18 #include <config.h>
  19
  20 #include <gsl/gsl_vector.h>
  21 #include <gsl/gsl_linalg.h>
  22 #include <gsl/gsl_matrix.h>
  23 #include <gsl/gsl_eigen.h>
  24 #include <gsl/gsl_blas.h>
  25 #include <gsl/gsl_sort_vector.h>
  26 #include <gsl/gsl_cdf.h>
  27
  28 #include "data/any-reader.h"
  29 #include "data/casegrouper.h"
  30 #include "data/casereader.h"
  31 #include "data/casewriter.h"
  32 #include "data/dataset.h"
  33 #include "data/dictionary.h"
  34 #include "data/format.h"
  35 #include "data/subcase.h"
  36 #include "language/command.h"
  37 #include "language/lexer/lexer.h"
  38 #include "language/lexer/value-parser.h"
  39 #include "language/lexer/variable-parser.h"
  40 #include "language/data-io/file-handle.h"
  41 #include "language/data-io/matrix-reader.h"
  42 #include "libpspp/cast.h"
  43 #include "libpspp/message.h"
  44 #include "libpspp/misc.h"
  45 #include "math/correlation.h"
  46 #include "math/covariance.h"
  47 #include "math/moments.h"
  48 #include "output/chart-item.h"
  49 #include "output/charts/scree.h"
  50 #include "output/tab.h"
  51
  52
  53 #include "gettext.h"
  54 #define _(msgid) gettext (msgid)
  55 #define N_(msgid) msgid
  56
  57 enum method
  58   {
  59     METHOD_CORR,
  60     METHOD_COV
  61   };
  62
  63 enum missing_type
  64   {
  65     MISS_LISTWISE,
  66     MISS_PAIRWISE,
  67     MISS_MEANSUB,
  68   };
  69
  70 enum extraction_method
  71   {
  72     EXTRACTION_PC,
  73     EXTRACTION_PAF,
  74   };
  75
  76 enum plot_opts
  77   {
  78     PLOT_SCREE = 0x0001,
  79     PLOT_ROTATION = 0x0002
  80   };
  81
  82 enum print_opts
  83   {
  84     PRINT_UNIVARIATE  = 0x0001,
  85     PRINT_DETERMINANT = 0x0002,
  86     PRINT_INV         = 0x0004,
  87     PRINT_AIC         = 0x0008,
  88     PRINT_SIG         = 0x0010,
  89     PRINT_COVARIANCE  = 0x0020,
  90     PRINT_CORRELATION = 0x0040,
  91     PRINT_ROTATION    = 0x0080,
  92     PRINT_EXTRACTION  = 0x0100,
  93     PRINT_INITIAL     = 0x0200,
  94     PRINT_KMO         = 0x0400,
  95     PRINT_REPR        = 0x0800,
  96     PRINT_FSCORE      = 0x1000
  97   };
  98
  99 enum rotation_type
 100   {
 101     ROT_VARIMAX = 0,
 102     ROT_EQUAMAX,
 103     ROT_QUARTIMAX,
 104     ROT_PROMAX,
 105     ROT_NONE
 106   };
 107
 108 typedef void (*rotation_coefficients) (double *x, double *y,
 109                                     double a, double b, double c, double d,
 110                                     const gsl_matrix *loadings );
 111
 112
 113 static void
 114 varimax_coefficients (double *x, double *y,
 115                       double a, double b, double c, double d,
 116                       const gsl_matrix *loadings )
 117 {
 118   *x = d - 2 * a * b / loadings->size1;
 119   *y = c - (a * a - b * b) / loadings->size1;
 120 }
 121
 122 static void
 123 equamax_coefficients (double *x, double *y,
 124                       double a, double b, double c, double d,
 125                       const gsl_matrix *loadings )
 126 {
 127   *x = d - loadings->size2 * a * b / loadings->size1;
 128   *y = c - loadings->size2 * (a * a - b * b) / (2 * loadings->size1);
 129 }
 130
 131 static void
 132 quartimax_coefficients (double *x, double *y,
 133                       double a UNUSED, double b UNUSED, double c, double d,
 134                       const gsl_matrix *loadings UNUSED)
 135 {
 136   *x = d ;
 137   *y = c ;
 138 }
 139
 140 static const rotation_coefficients rotation_coeff[] = {
 141   varimax_coefficients,
 142   equamax_coefficients,
 143   quartimax_coefficients,
 144   varimax_coefficients  /* PROMAX is identical to VARIMAX */
 145 };
 146
 147
 148 /* return diag (C'C) ^ {-0.5} */
 149 static gsl_matrix *
 150 diag_rcp_sqrt (const gsl_matrix *C)
 151 {
 152   int j;
 153   gsl_matrix *d =  gsl_matrix_calloc (C->size1, C->size2);
 154   gsl_matrix *r =  gsl_matrix_calloc (C->size1, C->size2);
 155
 156   assert (C->size1 == C->size2);
 157
 158   gsl_linalg_matmult_mod (C,  GSL_LINALG_MOD_TRANSPOSE,
 159                           C,  GSL_LINALG_MOD_NONE,
 160                           d);
 161
 162   for (j = 0 ; j < d->size2; ++j)
 163     {
 164       double e = gsl_matrix_get (d, j, j);
 165       e = 1.0 / sqrt (e);
 166       gsl_matrix_set (r, j, j, e);
 167     }
 168
 169   gsl_matrix_free (d);
 170
 171   return r;
 172 }
 173
 174
 175
 176 /* return diag ((C'C)^-1) ^ {-0.5} */
 177 static gsl_matrix *
 178 diag_rcp_inv_sqrt (const gsl_matrix *CCinv)
 179 {
 180   int j;
 181   gsl_matrix *r =  gsl_matrix_calloc (CCinv->size1, CCinv->size2);
 182
 183   assert (CCinv->size1 == CCinv->size2);
 184
 185   for (j = 0 ; j < CCinv->size2; ++j)
 186     {
 187       double e = gsl_matrix_get (CCinv, j, j);
 188       e = 1.0 / sqrt (e);
 189       gsl_matrix_set (r, j, j, e);
 190     }
 191
 192   return r;
 193 }
 194
 195
 196
 197
 198
 199 struct cmd_factor
 200 {
 201   size_t n_vars;
 202   const struct variable **vars;
 203
 204   const struct variable *wv;
 205
 206   enum method method;
 207   enum missing_type missing_type;
 208   enum mv_class exclude;
 209   enum print_opts print;
 210   enum extraction_method extraction;
 211   enum plot_opts plot;
 212   enum rotation_type rotation;
 213   int rotation_iterations;
 214   int promax_power;
 215
 216   /* Extraction Criteria */
 217   int n_factors;
 218   double min_eigen;
 219   double econverge;
 220   int extraction_iterations;
 221
 222   double rconverge;
 223
 224   /* Format */
 225   double blank;
 226   bool sort;
 227 };
 228
 229
 230 struct idata
 231 {
 232   /* Intermediate values used in calculation */
 233   struct matrix_material mm;
 234
 235   gsl_matrix *analysis_matrix; /* A pointer to either mm.corr or mm.cov */
 236
 237   gsl_vector *eval ;  /* The eigenvalues */
 238   gsl_matrix *evec ;  /* The eigenvectors */
 239
 240   int n_extractions;
 241
 242   gsl_vector *msr ;  /* Multiple Squared Regressions */
 243
 244   double detR;  /* The determinant of the correlation matrix */
 245
 246   gsl_matrix *ai_cov; /* The anti-image covariance matrix */
 247   gsl_matrix *ai_cor; /* The anti-image correlation matrix */
 248   struct covariance *cvm;
 249 };
 250
 251 static struct idata *
 252 idata_alloc (size_t n_vars)
 253 {
 254   struct idata *id = xzalloc (sizeof (*id));
 255
 256   id->n_extractions = 0;
 257   id->msr = gsl_vector_alloc (n_vars);
 258
 259   id->eval = gsl_vector_alloc (n_vars);
 260   id->evec = gsl_matrix_alloc (n_vars, n_vars);
 261
 262   return id;
 263 }
 264
 265 static void
 266 idata_free (struct idata *id)
 267 {
 268   gsl_vector_free (id->msr);
 269   gsl_vector_free (id->eval);
 270   gsl_matrix_free (id->evec);
 271   gsl_matrix_free (id->ai_cov);
 272   gsl_matrix_free (id->ai_cor);
 273
 274   free (id);
 275 }
 276
 277 /* Return the sum of squares of all the elements in row J excluding column J */
 278 static double
 279 ssq_row_od_n (const gsl_matrix *m, int j)
 280 {
 281   int i;
 282   double ss = 0;
 283   assert (m->size1 == m->size2);
 284
 285   assert (j < m->size1);
 286
 287   for (i = 0; i < m->size1; ++i)
 288     {
 289       if (i == j ) continue;
 290       ss += pow2 (gsl_matrix_get (m, i, j));
 291     }
 292
 293   return ss;
 294 }
 295
 296 /* Return the sum of squares of all the elements excluding row N */
 297 static double
 298 ssq_od_n (const gsl_matrix *m, int n)
 299 {
 300   int i, j;
 301   double ss = 0;
 302   assert (m->size1 == m->size2);
 303
 304   assert (n < m->size1);
 305
 306   for (i = 0; i < m->size1; ++i)
 307     {
 308       for (j = 0; j < m->size2; ++j)
 309         {
 310           if (i == j) continue;
 311           ss += pow2 (gsl_matrix_get (m, i, j));
 312         }
 313     }
 314
 315   return ss;
 316 }
 317
 318
 319 static gsl_matrix *
 320 anti_image_corr (const gsl_matrix *m, const struct idata *idata)
 321 {
 322   int i, j;
 323   gsl_matrix *a;
 324   assert (m->size1 == m->size2);
 325
 326   a = gsl_matrix_alloc (m->size1, m->size2);
 327
 328   for (i = 0; i < m->size1; ++i)
 329     {
 330       for (j = 0; j < m->size2; ++j)
 331         {
 332           double *p = gsl_matrix_ptr (a, i, j);
 333           *p = gsl_matrix_get (m, i, j);
 334           *p /= sqrt (gsl_matrix_get (m, i, i) *
 335                       gsl_matrix_get (m, j, j));
 336         }
 337     }
 338
 339   for (i = 0; i < m->size1; ++i)
 340     {
 341       double r = ssq_row_od_n (idata->mm.corr, i);
 342       double u = ssq_row_od_n (a, i);
 343       gsl_matrix_set (a, i, i, r / (r + u));
 344     }
 345
 346   return a;
 347 }
 348
 349 static gsl_matrix *
 350 anti_image_cov (const gsl_matrix *m)
 351 {
 352   int i, j;
 353   gsl_matrix *a;
 354   assert (m->size1 == m->size2);
 355
 356   a = gsl_matrix_alloc (m->size1, m->size2);
 357
 358   for (i = 0; i < m->size1; ++i)
 359     {
 360       for (j = 0; j < m->size2; ++j)
 361         {
 362           double *p = gsl_matrix_ptr (a, i, j);
 363           *p = gsl_matrix_get (m, i, j);
 364           *p /= gsl_matrix_get (m, i, i);
 365           *p /= gsl_matrix_get (m, j, j);
 366         }
 367     }
 368
 369   return a;
 370 }
 371
 372 #if 0
 373 static void
 374 dump_matrix (const gsl_matrix *m)
 375 {
 376   size_t i, j;
 377
 378   for (i = 0 ; i < m->size1; ++i)
 379     {
 380       for (j = 0 ; j < m->size2; ++j)
 381         printf ("%02f ", gsl_matrix_get (m, i, j));
 382       printf ("\n");
 383     }
 384 }
 385
 386 static void
 387 dump_matrix_permute (const gsl_matrix *m, const gsl_permutation *p)
 388 {
 389   size_t i, j;
 390
 391   for (i = 0 ; i < m->size1; ++i)
 392     {
 393       for (j = 0 ; j < m->size2; ++j)
 394         printf ("%02f ", gsl_matrix_get (m, gsl_permutation_get (p, i), j));
 395       printf ("\n");
 396     }
 397 }
 398
 399
 400 static void
 401 dump_vector (const gsl_vector *v)
 402 {
 403   size_t i;
 404   for (i = 0 ; i < v->size; ++i)
 405     {
 406       printf ("%02f\n", gsl_vector_get (v, i));
 407     }
 408   printf ("\n");
 409 }
 410 #endif
 411
 412
 413 static int
 414 n_extracted_factors (const struct cmd_factor *factor, struct idata *idata)
 415 {
 416   int i;
 417
 418   /* If there is a cached value, then return that. */
 419   if ( idata->n_extractions != 0)
 420     return idata->n_extractions;
 421
 422   /* Otherwise, if the number of factors has been explicitly requested,
 423      use that. */
 424   if (factor->n_factors > 0)
 425     {
 426       idata->n_extractions = factor->n_factors;
 427       goto finish;
 428     }
 429
 430   /* Use the MIN_EIGEN setting. */
 431   for (i = 0 ; i < idata->eval->size; ++i)
 432     {
 433       double evali = fabs (gsl_vector_get (idata->eval, i));
 434
 435       idata->n_extractions = i;
 436
 437       if (evali < factor->min_eigen)
 438         goto finish;
 439     }
 440
 441  finish:
 442   return idata->n_extractions;
 443 }
 444
 445
 446 /* Returns a newly allocated matrix identical to M.
 447    It it the callers responsibility to free the returned value.
 448 */
 449 static gsl_matrix *
 450 matrix_dup (const gsl_matrix *m)
 451 {
 452   gsl_matrix *n =  gsl_matrix_alloc (m->size1, m->size2);
 453
 454   gsl_matrix_memcpy (n, m);
 455
 456   return n;
 457 }
 458
 459
 460 struct smr_workspace
 461 {
 462   /* Copy of the subject */
 463   gsl_matrix *m;
 464
 465   gsl_matrix *inverse;
 466
 467   gsl_permutation *perm;
 468
 469   gsl_matrix *result1;
 470   gsl_matrix *result2;
 471 };
 472
 473
 474 static struct smr_workspace *ws_create (const gsl_matrix *input)
 475 {
 476   struct smr_workspace *ws = xmalloc (sizeof (*ws));
 477
 478   ws->m = gsl_matrix_alloc (input->size1, input->size2);
 479   ws->inverse = gsl_matrix_calloc (input->size1 - 1, input->size2 - 1);
 480   ws->perm = gsl_permutation_alloc (input->size1 - 1);
 481   ws->result1 = gsl_matrix_calloc (input->size1 - 1, 1);
 482   ws->result2 = gsl_matrix_calloc (1, 1);
 483
 484   return ws;
 485 }
 486
 487 static void
 488 ws_destroy (struct smr_workspace *ws)
 489 {
 490   gsl_matrix_free (ws->result2);
 491   gsl_matrix_free (ws->result1);
 492   gsl_permutation_free (ws->perm);
 493   gsl_matrix_free (ws->inverse);
 494   gsl_matrix_free (ws->m);
 495
 496   free (ws);
 497 }
 498
 499
 500 /*
 501    Return the square of the regression coefficient for VAR regressed against all other variables.
 502  */
 503 static double
 504 squared_multiple_correlation (const gsl_matrix *corr, int var, struct smr_workspace *ws)
 505 {
 506   /* For an explanation of what this is doing, see
 507      http://www.visualstatistics.net/Visual%20Statistics%20Multimedia/multiple_regression_analysis.htm
 508   */
 509
 510   int signum = 0;
 511   gsl_matrix_view rxx;
 512
 513   gsl_matrix_memcpy (ws->m, corr);
 514
 515   gsl_matrix_swap_rows (ws->m, 0, var);
 516   gsl_matrix_swap_columns (ws->m, 0, var);
 517
 518   rxx = gsl_matrix_submatrix (ws->m, 1, 1, ws->m->size1 - 1, ws->m->size1 - 1);
 519
 520   gsl_linalg_LU_decomp (&rxx.matrix, ws->perm, &signum);
 521
 522   gsl_linalg_LU_invert (&rxx.matrix, ws->perm, ws->inverse);
 523
 524   {
 525     gsl_matrix_const_view rxy = gsl_matrix_const_submatrix (ws->m, 1, 0, ws->m->size1 - 1, 1);
 526     gsl_matrix_const_view ryx = gsl_matrix_const_submatrix (ws->m, 0, 1, 1, ws->m->size1 - 1);
 527
 528     gsl_blas_dgemm (CblasNoTrans,  CblasNoTrans,
 529                     1.0, ws->inverse, &rxy.matrix, 0.0, ws->result1);
 530
 531     gsl_blas_dgemm (CblasNoTrans,  CblasNoTrans,
 532                     1.0, &ryx.matrix, ws->result1, 0.0, ws->result2);
 533   }
 534
 535   return gsl_matrix_get (ws->result2, 0, 0);
 536 }
 537
 538
 539
 540 static double the_communality (const gsl_matrix *evec, const gsl_vector *eval, int n, int n_factors);
 541
 542
 543 struct factor_matrix_workspace
 544 {
 545   size_t n_factors;
 546   gsl_eigen_symmv_workspace *eigen_ws;
 547
 548   gsl_vector *eval ;
 549   gsl_matrix *evec ;
 550
 551   gsl_matrix *gamma ;
 552
 553   gsl_matrix *r;
 554 };
 555
 556 static struct factor_matrix_workspace *
 557 factor_matrix_workspace_alloc (size_t n, size_t nf)
 558 {
 559   struct factor_matrix_workspace *ws = xmalloc (sizeof (*ws));
 560
 561   ws->n_factors = nf;
 562   ws->gamma = gsl_matrix_calloc (nf, nf);
 563   ws->eigen_ws = gsl_eigen_symmv_alloc (n);
 564   ws->eval = gsl_vector_alloc (n);
 565   ws->evec = gsl_matrix_alloc (n, n);
 566   ws->r  = gsl_matrix_alloc (n, n);
 567
 568   return ws;
 569 }
 570
 571 static void
 572 factor_matrix_workspace_free (struct factor_matrix_workspace *ws)
 573 {
 574   gsl_eigen_symmv_free (ws->eigen_ws);
 575   gsl_vector_free (ws->eval);
 576   gsl_matrix_free (ws->evec);
 577   gsl_matrix_free (ws->gamma);
 578   gsl_matrix_free (ws->r);
 579   free (ws);
 580 }
 581
 582 /*
 583   Shift P left by OFFSET places, and overwrite TARGET
 584   with the shifted result.
 585   Positions in TARGET less than OFFSET are unchanged.
 586 */
 587 static void
 588 perm_shift_apply (gsl_permutation *target, const gsl_permutation *p,
 589                   size_t offset)
 590 {
 591   size_t i;
 592   assert (target->size == p->size);
 593   assert (offset <= target->size);
 594
 595   for (i = 0; i < target->size - offset; ++i)
 596     {
 597       target->data[i] = p->data [i + offset];
 598     }
 599 }
 600
 601
 602 /*
 603    Indirectly sort the rows of matrix INPUT, storing the sort order in PERM.
 604    The sort criteria are as follows:
 605
 606    Rows are sorted on the first column, until the absolute value of an
 607    element in a subsequent column  is greater than that of the first
 608    column.  Thereafter, rows will be sorted on the second column,
 609    until the absolute value of an element in a subsequent column
 610    exceeds that of the second column ...
 611 */
 612 static void
 613 sort_matrix_indirect (const gsl_matrix *input, gsl_permutation *perm)
 614 {
 615   const size_t n = perm->size;
 616   const size_t m = input->size2;
 617   int i, j;
 618   gsl_matrix *mat ;
 619   int column_n = 0;
 620   int row_n = 0;
 621   gsl_permutation *p;
 622
 623   assert (perm->size == input->size1);
 624
 625   p = gsl_permutation_alloc (n);
 626
 627   /* Copy INPUT into MAT, discarding the sign */
 628   mat = gsl_matrix_alloc (n, m);
 629   for (i = 0 ; i < mat->size1; ++i)
 630     {
 631       for (j = 0 ; j < mat->size2; ++j)
 632         {
 633           double x = gsl_matrix_get (input, i, j);
 634           gsl_matrix_set (mat, i, j, fabs (x));
 635         }
 636     }
 637
 638   while (column_n < m && row_n < n)
 639     {
 640       gsl_vector_const_view columni = gsl_matrix_const_column (mat, column_n);
 641       gsl_sort_vector_index (p, &columni.vector);
 642
 643       for (i = 0 ; i < n; ++i)
 644         {
 645           gsl_vector_view row = gsl_matrix_row (mat, p->data[n - 1 - i]);
 646           size_t maxindex = gsl_vector_max_index (&row.vector);
 647
 648           if ( maxindex > column_n )
 649             break;
 650
 651           /* All subsequent elements of this row, are of no interest.
 652              So set them all to a highly negative value */
 653           for (j = column_n + 1; j < row.vector.size ; ++j)
 654             gsl_vector_set (&row.vector, j, -DBL_MAX);
 655         }
 656
 657       perm_shift_apply (perm, p, row_n);
 658       row_n += i;
 659
 660       column_n++;
 661     }
 662
 663   gsl_permutation_free (p);
 664   gsl_matrix_free (mat);
 665
 666   assert ( 0 == gsl_permutation_valid (perm));
 667
 668   /* We want the biggest value to be first */
 669   gsl_permutation_reverse (perm);
 670 }
 671
 672
 673 static void
 674 drot_go (double phi, double *l0, double *l1)
 675 {
 676   double r0 = cos (phi) * *l0 + sin (phi) * *l1;
 677   double r1 = - sin (phi) * *l0 + cos (phi) * *l1;
 678
 679   *l0 = r0;
 680   *l1 = r1;
 681 }
 682
 683
 684 static gsl_matrix *
 685 clone_matrix (const gsl_matrix *m)
 686 {
 687   int j, k;
 688   gsl_matrix *c = gsl_matrix_calloc (m->size1, m->size2);
 689
 690   for (j = 0 ; j < c->size1; ++j)
 691     {
 692       for (k = 0 ; k < c->size2; ++k)
 693         {
 694           const double *v = gsl_matrix_const_ptr (m, j, k);
 695           gsl_matrix_set (c, j, k, *v);
 696         }
 697     }
 698
 699   return c;
 700 }
 701
 702
 703 static double
 704 initial_sv (const gsl_matrix *fm)
 705 {
 706   int j, k;
 707
 708   double sv = 0.0;
 709   for (j = 0 ; j < fm->size2; ++j)
 710     {
 711       double l4s = 0;
 712       double l2s = 0;
 713
 714       for (k = j + 1 ; k < fm->size2; ++k)
 715         {
 716           double lambda = gsl_matrix_get (fm, k, j);
 717           double lambda_sq = lambda * lambda;
 718           double lambda_4 = lambda_sq * lambda_sq;
 719
 720           l4s += lambda_4;
 721           l2s += lambda_sq;
 722         }
 723       sv += ( fm->size1 * l4s - (l2s * l2s) ) / (fm->size1 * fm->size1 );
 724     }
 725   return sv;
 726 }
 727
 728 static void
 729 rotate (const struct cmd_factor *cf, const gsl_matrix *unrot,
 730         const gsl_vector *communalities,
 731         gsl_matrix *result,
 732         gsl_vector *rotated_loadings,
 733         gsl_matrix *pattern_matrix,
 734         gsl_matrix *factor_correlation_matrix
 735         )
 736 {
 737   int j, k;
 738   int i;
 739   double prev_sv;
 740
 741   /* First get a normalised version of UNROT */
 742   gsl_matrix *normalised = gsl_matrix_calloc (unrot->size1, unrot->size2);
 743   gsl_matrix *h_sqrt = gsl_matrix_calloc (communalities->size, communalities->size);
 744   gsl_matrix *h_sqrt_inv ;
 745
 746   /* H is the diagonal matrix containing the absolute values of the communalities */
 747   for (i = 0 ; i < communalities->size ; ++i)
 748     {
 749       double *ptr = gsl_matrix_ptr (h_sqrt, i, i);
 750       *ptr = fabs (gsl_vector_get (communalities, i));
 751     }
 752
 753   /* Take the square root of the communalities */
 754   gsl_linalg_cholesky_decomp (h_sqrt);
 755
 756
 757   /* Save a copy of h_sqrt and invert it */
 758   h_sqrt_inv = clone_matrix (h_sqrt);
 759   gsl_linalg_cholesky_decomp (h_sqrt_inv);
 760   gsl_linalg_cholesky_invert (h_sqrt_inv);
 761
 762   /* normalised vertion is H^{1/2} x UNROT */
 763   gsl_blas_dgemm (CblasNoTrans,  CblasNoTrans, 1.0, h_sqrt_inv, unrot, 0.0, normalised);
 764
 765   gsl_matrix_free (h_sqrt_inv);
 766
 767
 768   /* Now perform the rotation iterations */
 769
 770   prev_sv = initial_sv (normalised);
 771   for (i = 0 ; i < cf->rotation_iterations ; ++i)
 772     {
 773       double sv = 0.0;
 774       for (j = 0 ; j < normalised->size2; ++j)
 775         {
 776           /* These variables relate to the convergence criterium */
 777           double l4s = 0;
 778           double l2s = 0;
 779
 780           for (k = j + 1 ; k < normalised->size2; ++k)
 781             {
 782               int p;
 783               double a = 0.0;
 784               double b = 0.0;
 785               double c = 0.0;
 786               double d = 0.0;
 787               double x, y;
 788               double phi;
 789
 790               for (p = 0; p < normalised->size1; ++p)
 791                 {
 792                   double jv = gsl_matrix_get (normalised, p, j);
 793                   double kv = gsl_matrix_get (normalised, p, k);
 794
 795                   double u = jv * jv - kv * kv;
 796                   double v = 2 * jv * kv;
 797                   a += u;
 798                   b += v;
 799                   c +=  u * u - v * v;
 800                   d += 2 * u * v;
 801                 }
 802
 803               rotation_coeff [cf->rotation] (&x, &y, a, b, c, d, normalised);
 804
 805               phi = atan2 (x,  y) / 4.0 ;
 806
 807               /* Don't bother rotating if the angle is small */
 808               if ( fabs (sin (phi) ) <= pow (10.0, -15.0))
 809                   continue;
 810
 811               for (p = 0; p < normalised->size1; ++p)
 812                 {
 813                   double *lambda0 = gsl_matrix_ptr (normalised, p, j);
 814                   double *lambda1 = gsl_matrix_ptr (normalised, p, k);
 815                   drot_go (phi, lambda0, lambda1);
 816                 }
 817
 818               /* Calculate the convergence criterium */
 819               {
 820                 double lambda = gsl_matrix_get (normalised, k, j);
 821                 double lambda_sq = lambda * lambda;
 822                 double lambda_4 = lambda_sq * lambda_sq;
 823
 824                 l4s += lambda_4;
 825                 l2s += lambda_sq;
 826               }
 827             }
 828           sv += ( normalised->size1 * l4s - (l2s * l2s) ) / (normalised->size1 * normalised->size1 );
 829         }
 830
 831       if ( fabs (sv - prev_sv) <= cf->rconverge)
 832         break;
 833
 834       prev_sv = sv;
 835     }
 836
 837   gsl_blas_dgemm (CblasNoTrans,  CblasNoTrans, 1.0,
 838                   h_sqrt, normalised,  0.0,   result);
 839
 840   gsl_matrix_free (h_sqrt);
 841   gsl_matrix_free (normalised);
 842
 843   if (cf->rotation == ROT_PROMAX)
 844     {
 845       /* general purpose m by m matrix, where m is the number of factors */
 846       gsl_matrix *mm1 =  gsl_matrix_calloc (unrot->size2, unrot->size2);
 847       gsl_matrix *mm2 =  gsl_matrix_calloc (unrot->size2, unrot->size2);
 848
 849       /* general purpose m by p matrix, where p is the number of variables */
 850       gsl_matrix *mp1 =  gsl_matrix_calloc (unrot->size2, unrot->size1);
 851
 852       gsl_matrix *pm1 =  gsl_matrix_calloc (unrot->size1, unrot->size2);
 853
 854       gsl_permutation *perm = gsl_permutation_alloc (unrot->size2);
 855
 856       int signum;
 857
 858       int i, j;
 859
 860       /* The following variables follow the notation by SPSS Statistical Algorithms
 861          page 342 */
 862       gsl_matrix *L =  gsl_matrix_calloc (unrot->size2, unrot->size2);
 863       gsl_matrix *P = clone_matrix (result);
 864       gsl_matrix *D ;
 865       gsl_matrix *Q ;
 866
 867
 868       /* Vector of length p containing (indexed by i)
 869          \Sum^m_j {\lambda^2_{ij}} */
 870       gsl_vector *rssq = gsl_vector_calloc (unrot->size1);
 871
 872       for (i = 0; i < P->size1; ++i)
 873         {
 874           double sum = 0;
 875           for (j = 0; j < P->size2; ++j)
 876             {
 877               sum += gsl_matrix_get (result, i, j)
 878                 * gsl_matrix_get (result, i, j);
 879
 880             }
 881
 882           gsl_vector_set (rssq, i, sqrt (sum));
 883         }
 884
 885       for (i = 0; i < P->size1; ++i)
 886         {
 887           for (j = 0; j < P->size2; ++j)
 888             {
 889               double l = gsl_matrix_get (result, i, j);
 890               double r = gsl_vector_get (rssq, i);
 891               gsl_matrix_set (P, i, j, pow (fabs (l / r), cf->promax_power + 1) * r / l);
 892             }
 893         }
 894
 895       gsl_vector_free (rssq);
 896
 897       gsl_linalg_matmult_mod (result,
 898                               GSL_LINALG_MOD_TRANSPOSE,
 899                               result,
 900                               GSL_LINALG_MOD_NONE,
 901                               mm1);
 902
 903       gsl_linalg_LU_decomp (mm1, perm, &signum);
 904       gsl_linalg_LU_invert (mm1, perm, mm2);
 905
 906       gsl_linalg_matmult_mod (mm2,   GSL_LINALG_MOD_NONE,
 907                               result,  GSL_LINALG_MOD_TRANSPOSE,
 908                               mp1);
 909
 910       gsl_linalg_matmult_mod (mp1, GSL_LINALG_MOD_NONE,
 911                               P,   GSL_LINALG_MOD_NONE,
 912                               L);
 913
 914       D = diag_rcp_sqrt (L);
 915       Q = gsl_matrix_calloc (unrot->size2, unrot->size2);
 916
 917       gsl_linalg_matmult_mod (L, GSL_LINALG_MOD_NONE,
 918                               D, GSL_LINALG_MOD_NONE,
 919                               Q);
 920
 921       gsl_matrix *QQinv = gsl_matrix_calloc (unrot->size2, unrot->size2);
 922
 923       gsl_linalg_matmult_mod (Q, GSL_LINALG_MOD_TRANSPOSE,
 924                               Q,  GSL_LINALG_MOD_NONE,
 925                               QQinv);
 926
 927       gsl_linalg_cholesky_decomp (QQinv);
 928       gsl_linalg_cholesky_invert (QQinv);
 929
 930
 931       gsl_matrix *C = diag_rcp_inv_sqrt (QQinv);
 932       gsl_matrix *Cinv =  clone_matrix (C);
 933
 934       gsl_linalg_cholesky_decomp (Cinv);
 935       gsl_linalg_cholesky_invert (Cinv);
 936
 937
 938       gsl_linalg_matmult_mod (result, GSL_LINALG_MOD_NONE,
 939                               Q,      GSL_LINALG_MOD_NONE,
 940                               pm1);
 941
 942       gsl_linalg_matmult_mod (pm1,      GSL_LINALG_MOD_NONE,
 943                               Cinv,         GSL_LINALG_MOD_NONE,
 944                               pattern_matrix);
 945
 946
 947       gsl_linalg_matmult_mod (C,      GSL_LINALG_MOD_NONE,
 948                               QQinv,  GSL_LINALG_MOD_NONE,
 949                               mm1);
 950
 951       gsl_linalg_matmult_mod (mm1,      GSL_LINALG_MOD_NONE,
 952                               C,  GSL_LINALG_MOD_TRANSPOSE,
 953                               factor_correlation_matrix);
 954
 955       gsl_linalg_matmult_mod (pattern_matrix,      GSL_LINALG_MOD_NONE,
 956                               factor_correlation_matrix,  GSL_LINALG_MOD_NONE,
 957                               pm1);
 958
 959       gsl_matrix_memcpy (result, pm1);
 960
 961
 962       gsl_matrix_free (QQinv);
 963       gsl_matrix_free (C);
 964       gsl_matrix_free (Cinv);
 965
 966       gsl_matrix_free (D);
 967       gsl_matrix_free (Q);
 968       gsl_matrix_free (L);
 969       gsl_matrix_free (P);
 970
 971       gsl_permutation_free (perm);
 972
 973       gsl_matrix_free (mm1);
 974       gsl_matrix_free (mm2);
 975       gsl_matrix_free (mp1);
 976       gsl_matrix_free (pm1);
 977     }
 978
 979
 980   /* reflect negative sums and populate the rotated loadings vector*/
 981   for (i = 0 ; i < result->size2; ++i)
 982     {
 983       double ssq = 0.0;
 984       double sum = 0.0;
 985       for (j = 0 ; j < result->size1; ++j)
 986         {
 987           double s = gsl_matrix_get (result, j, i);
 988           ssq += s * s;
 989           sum += s;
 990         }
 991
 992       gsl_vector_set (rotated_loadings, i, ssq);
 993
 994       if ( sum < 0 )
 995         for (j = 0 ; j < result->size1; ++j)
 996           {
 997             double *lambda = gsl_matrix_ptr (result, j, i);
 998             *lambda = - *lambda;
 999           }
1000     }
1001 }
1002
1003
1004 /*
1005   Get an approximation for the factor matrix into FACTORS, and the communalities into COMMUNALITIES.
1006   R is the matrix to be analysed.
1007   WS is a pointer to a structure which must have been initialised with factor_matrix_workspace_init.
1008  */
1009 static void
1010 iterate_factor_matrix (const gsl_matrix *r, gsl_vector *communalities, gsl_matrix *factors,
1011                        struct factor_matrix_workspace *ws)
1012 {
1013   size_t i;
1014   gsl_matrix_view mv ;
1015
1016   assert (r->size1 == r->size2);
1017   assert (r->size1 == communalities->size);
1018
1019   assert (factors->size1 == r->size1);
1020   assert (factors->size2 == ws->n_factors);
1021
1022   gsl_matrix_memcpy (ws->r, r);
1023
1024   /* Apply Communalities to diagonal of correlation matrix */
1025   for (i = 0 ; i < communalities->size ; ++i)
1026     {
1027       double *x = gsl_matrix_ptr (ws->r, i, i);
1028       *x = gsl_vector_get (communalities, i);
1029     }
1030
1031   gsl_eigen_symmv (ws->r, ws->eval, ws->evec, ws->eigen_ws);
1032
1033   mv = gsl_matrix_submatrix (ws->evec, 0, 0, ws->evec->size1, ws->n_factors);
1034
1035   /* Gamma is the diagonal matrix containing the absolute values of the eigenvalues */
1036   for (i = 0 ; i < ws->n_factors ; ++i)
1037     {
1038       double *ptr = gsl_matrix_ptr (ws->gamma, i, i);
1039       *ptr = fabs (gsl_vector_get (ws->eval, i));
1040     }
1041
1042   /* Take the square root of gamma */
1043   gsl_linalg_cholesky_decomp (ws->gamma);
1044
1045   gsl_blas_dgemm (CblasNoTrans,  CblasNoTrans, 1.0, &mv.matrix, ws->gamma, 0.0, factors);
1046
1047   for (i = 0 ; i < r->size1 ; ++i)
1048     {
1049       double h = the_communality (ws->evec, ws->eval, i, ws->n_factors);
1050       gsl_vector_set (communalities, i, h);
1051     }
1052 }
1053
1054
1055
1056 static bool run_factor (struct dataset *ds, const struct cmd_factor *factor);
1057
1058 static void do_factor_by_matrix (const struct cmd_factor *factor, struct idata *idata);
1059
1060
1061
1062 int
1063 cmd_factor (struct lexer *lexer, struct dataset *ds)
1064 {
1065   struct dictionary *dict = NULL;
1066   int n_iterations = 25;
1067   struct cmd_factor factor;
1068   factor.n_vars = 0;
1069   factor.vars = NULL;
1070   factor.method = METHOD_CORR;
1071   factor.missing_type = MISS_LISTWISE;
1072   factor.exclude = MV_ANY;
1073   factor.print = PRINT_INITIAL | PRINT_EXTRACTION | PRINT_ROTATION;
1074   factor.extraction = EXTRACTION_PC;
1075   factor.n_factors = 0;
1076   factor.min_eigen = SYSMIS;
1077   factor.extraction_iterations = 25;
1078   factor.rotation_iterations = 25;
1079   factor.econverge = 0.001;
1080
1081   factor.blank = 0;
1082   factor.sort = false;
1083   factor.plot = 0;
1084   factor.rotation = ROT_VARIMAX;
1085   factor.wv = NULL;
1086
1087   factor.rconverge = 0.0001;
1088
1089   lex_match (lexer, T_SLASH);
1090
1091   struct matrix_reader *mr = NULL;
1092   struct casereader *matrix_reader = NULL;
1093
1094   if (lex_match_id (lexer, "VARIABLES"))
1095     {
1096       lex_match (lexer, T_EQUALS);
1097       dict = dataset_dict (ds);
1098       factor.wv = dict_get_weight (dict);
1099
1100       if (!parse_variables_const (lexer, dict, &factor.vars, &factor.n_vars,
1101                                   PV_NO_DUPLICATE | PV_NUMERIC))
1102         goto error;
1103     }
1104   else if (lex_match_id (lexer, "MATRIX"))
1105     {
1106       lex_match (lexer, T_EQUALS);
1107       if (! lex_force_match_id (lexer, "IN"))
1108         goto error;
1109       if (!lex_force_match (lexer, T_LPAREN))
1110         {
1111           goto error;
1112         }
1113       if (lex_match_id (lexer, "CORR"))
1114         {
1115         }
1116       else if (lex_match_id (lexer, "COV"))
1117         {
1118         }
1119       else
1120         {
1121           lex_error (lexer, _("Matrix input for %s must be either COV or CORR"), "FACTOR");
1122           goto error;
1123         }
1124       if (! lex_force_match (lexer, T_EQUALS))
1125         goto error;
1126       if (lex_match (lexer, T_ASTERISK))
1127         {
1128           dict = dataset_dict (ds);
1129           matrix_reader = casereader_clone (dataset_source (ds));
1130         }
1131       else
1132         {
1133           struct file_handle *fh = fh_parse (lexer, FH_REF_FILE, NULL);
1134           if (fh == NULL)
1135             goto error;
1136
1137           matrix_reader
1138             = any_reader_open_and_decode (fh, NULL, &dict, NULL);
1139
1140           if (! (matrix_reader && dict))
1141             {
1142               goto error;
1143             }
1144         }
1145
1146       if (! lex_force_match (lexer, T_RPAREN))
1147         goto error;
1148
1149       mr = create_matrix_reader_from_case_reader (dict, matrix_reader,
1150                                                   &factor.vars, &factor.n_vars);
1151     }
1152   else
1153     {
1154       goto error;
1155     }
1156
1157   while (lex_token (lexer) != T_ENDCMD)
1158     {
1159       lex_match (lexer, T_SLASH);
1160
1161       if (lex_match_id (lexer, "ANALYSIS"))
1162         {
1163           struct const_var_set *vs;
1164           const struct variable **vars;
1165           size_t n_vars;
1166           bool ok;
1167
1168           lex_match (lexer, T_EQUALS);
1169
1170           vs = const_var_set_create_from_array (factor.vars, factor.n_vars);
1171           ok = parse_const_var_set_vars (lexer, vs, &vars, &n_vars,
1172                                          PV_NO_DUPLICATE | PV_NUMERIC);
1173           const_var_set_destroy (vs);
1174
1175           if (!ok)
1176             goto error;
1177
1178           free (factor.vars);
1179           factor.vars = vars;
1180           factor.n_vars = n_vars;
1181         }
1182       else if (lex_match_id (lexer, "PLOT"))
1183         {
1184           lex_match (lexer, T_EQUALS);
1185           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1186             {
1187               if (lex_match_id (lexer, "EIGEN"))
1188                 {
1189                   factor.plot |= PLOT_SCREE;
1190                 }
1191 #if FACTOR_FULLY_IMPLEMENTED
1192               else if (lex_match_id (lexer, "ROTATION"))
1193                 {
1194                 }
1195 #endif
1196               else
1197                 {
1198                   lex_error (lexer, NULL);
1199                   goto error;
1200                 }
1201             }
1202         }
1203       else if (lex_match_id (lexer, "METHOD"))
1204         {
1205           lex_match (lexer, T_EQUALS);
1206           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1207             {
1208               if (lex_match_id (lexer, "COVARIANCE"))
1209                 {
1210                   factor.method = METHOD_COV;
1211                 }
1212               else if (lex_match_id (lexer, "CORRELATION"))
1213                 {
1214                   factor.method = METHOD_CORR;
1215                 }
1216               else
1217                 {
1218                   lex_error (lexer, NULL);
1219                   goto error;
1220                 }
1221             }
1222         }
1223       else if (lex_match_id (lexer, "ROTATION"))
1224         {
1225           lex_match (lexer, T_EQUALS);
1226           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1227             {
1228               /* VARIMAX and DEFAULT are defaults */
1229               if (lex_match_id (lexer, "VARIMAX") || lex_match_id (lexer, "DEFAULT"))
1230                 {
1231                   factor.rotation = ROT_VARIMAX;
1232                 }
1233               else if (lex_match_id (lexer, "EQUAMAX"))
1234                 {
1235                   factor.rotation = ROT_EQUAMAX;
1236                 }
1237               else if (lex_match_id (lexer, "QUARTIMAX"))
1238                 {
1239                   factor.rotation = ROT_QUARTIMAX;
1240                 }
1241               else if (lex_match_id (lexer, "PROMAX"))
1242                 {
1243                   factor.promax_power = 5;
1244                   if (lex_match (lexer, T_LPAREN)
1245                       && lex_force_int (lexer))
1246                     {
1247                       factor.promax_power = lex_integer (lexer);
1248                       lex_get (lexer);
1249                       if (! lex_force_match (lexer, T_RPAREN))
1250                         goto error;
1251                     }
1252                   factor.rotation = ROT_PROMAX;
1253                 }
1254               else if (lex_match_id (lexer, "NOROTATE"))
1255                 {
1256                   factor.rotation = ROT_NONE;
1257                 }
1258               else
1259                 {
1260                   lex_error (lexer, NULL);
1261                   goto error;
1262                 }
1263             }
1264           factor.rotation_iterations = n_iterations;
1265         }
1266       else if (lex_match_id (lexer, "CRITERIA"))
1267         {
1268           lex_match (lexer, T_EQUALS);
1269           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1270             {
1271               if (lex_match_id (lexer, "FACTORS"))
1272                 {
1273                   if ( lex_force_match (lexer, T_LPAREN)
1274                        && lex_force_int (lexer))
1275                     {
1276                       factor.n_factors = lex_integer (lexer);
1277                       lex_get (lexer);
1278                       if (! lex_force_match (lexer, T_RPAREN))
1279                         goto error;
1280                     }
1281                 }
1282               else if (lex_match_id (lexer, "MINEIGEN"))
1283                 {
1284                   if ( lex_force_match (lexer, T_LPAREN)
1285                        && lex_force_num (lexer))
1286                     {
1287                       factor.min_eigen = lex_number (lexer);
1288                       lex_get (lexer);
1289                       if (! lex_force_match (lexer, T_RPAREN))
1290                         goto error;
1291                     }
1292                 }
1293               else if (lex_match_id (lexer, "ECONVERGE"))
1294                 {
1295                   if ( lex_force_match (lexer, T_LPAREN)
1296                        && lex_force_num (lexer))
1297                     {
1298                       factor.econverge = lex_number (lexer);
1299                       lex_get (lexer);
1300                       if (! lex_force_match (lexer, T_RPAREN))
1301                         goto error;
1302                     }
1303                 }
1304               else if (lex_match_id (lexer, "RCONVERGE"))
1305                 {
1306                   if (lex_force_match (lexer, T_LPAREN)
1307                       && lex_force_num (lexer))
1308                     {
1309                       factor.rconverge = lex_number (lexer);
1310                       lex_get (lexer);
1311                       if (! lex_force_match (lexer, T_RPAREN))
1312                         goto error;
1313                     }
1314                 }
1315               else if (lex_match_id (lexer, "ITERATE"))
1316                 {
1317                   if ( lex_force_match (lexer, T_LPAREN)
1318                        && lex_force_int (lexer))
1319                     {
1320                       n_iterations = lex_integer (lexer);
1321                       lex_get (lexer);
1322                       if (! lex_force_match (lexer, T_RPAREN))
1323                         goto error;
1324                     }
1325                 }
1326               else if (lex_match_id (lexer, "DEFAULT"))
1327                 {
1328                   factor.n_factors = 0;
1329                   factor.min_eigen = 1;
1330                   n_iterations = 25;
1331                 }
1332               else
1333                 {
1334                   lex_error (lexer, NULL);
1335                   goto error;
1336                 }
1337             }
1338         }
1339       else if (lex_match_id (lexer, "EXTRACTION"))
1340         {
1341           lex_match (lexer, T_EQUALS);
1342           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1343             {
1344               if (lex_match_id (lexer, "PAF"))
1345                 {
1346                   factor.extraction = EXTRACTION_PAF;
1347                 }
1348               else if (lex_match_id (lexer, "PC"))
1349                 {
1350                   factor.extraction = EXTRACTION_PC;
1351                 }
1352               else if (lex_match_id (lexer, "PA1"))
1353                 {
1354                   factor.extraction = EXTRACTION_PC;
1355                 }
1356               else if (lex_match_id (lexer, "DEFAULT"))
1357                 {
1358                   factor.extraction = EXTRACTION_PC;
1359                 }
1360               else
1361                 {
1362                   lex_error (lexer, NULL);
1363                   goto error;
1364                 }
1365             }
1366           factor.extraction_iterations = n_iterations;
1367         }
1368       else if (lex_match_id (lexer, "FORMAT"))
1369         {
1370           lex_match (lexer, T_EQUALS);
1371           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1372             {
1373               if (lex_match_id (lexer, "SORT"))
1374                 {
1375                   factor.sort = true;
1376                 }
1377               else if (lex_match_id (lexer, "BLANK"))
1378                 {
1379                   if ( lex_force_match (lexer, T_LPAREN)
1380                        && lex_force_num (lexer))
1381                     {
1382                       factor.blank = lex_number (lexer);
1383                       lex_get (lexer);
1384                       if (! lex_force_match (lexer, T_RPAREN))
1385                         goto error;
1386                     }
1387                 }
1388               else if (lex_match_id (lexer, "DEFAULT"))
1389                 {
1390                   factor.blank = 0;
1391                   factor.sort = false;
1392                 }
1393               else
1394                 {
1395                   lex_error (lexer, NULL);
1396                   goto error;
1397                 }
1398             }
1399         }
1400       else if (lex_match_id (lexer, "PRINT"))
1401         {
1402           factor.print = 0;
1403           lex_match (lexer, T_EQUALS);
1404           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1405             {
1406               if (lex_match_id (lexer, "UNIVARIATE"))
1407                 {
1408                   factor.print |= PRINT_UNIVARIATE;
1409                 }
1410               else if (lex_match_id (lexer, "DET"))
1411                 {
1412                   factor.print |= PRINT_DETERMINANT;
1413                 }
1414 #if FACTOR_FULLY_IMPLEMENTED
1415               else if (lex_match_id (lexer, "INV"))
1416                 {
1417                 }
1418 #endif
1419               else if (lex_match_id (lexer, "AIC"))
1420                 {
1421                   factor.print |= PRINT_AIC;
1422                 }
1423               else if (lex_match_id (lexer, "SIG"))
1424                 {
1425                   factor.print |= PRINT_SIG;
1426                 }
1427               else if (lex_match_id (lexer, "CORRELATION"))
1428                 {
1429                   factor.print |= PRINT_CORRELATION;
1430                 }
1431               else if (lex_match_id (lexer, "COVARIANCE"))
1432                 {
1433                   factor.print |= PRINT_COVARIANCE;
1434                 }
1435               else if (lex_match_id (lexer, "ROTATION"))
1436                 {
1437                   factor.print |= PRINT_ROTATION;
1438                 }
1439               else if (lex_match_id (lexer, "EXTRACTION"))
1440                 {
1441                   factor.print |= PRINT_EXTRACTION;
1442                 }
1443               else if (lex_match_id (lexer, "INITIAL"))
1444                 {
1445                   factor.print |= PRINT_INITIAL;
1446                 }
1447               else if (lex_match_id (lexer, "KMO"))
1448                 {
1449                   factor.print |= PRINT_KMO;
1450                 }
1451 #if FACTOR_FULLY_IMPLEMENTED
1452               else if (lex_match_id (lexer, "REPR"))
1453                 {
1454                 }
1455               else if (lex_match_id (lexer, "FSCORE"))
1456                 {
1457                 }
1458 #endif
1459               else if (lex_match (lexer, T_ALL))
1460                 {
1461                   factor.print = 0xFFFF;
1462                 }
1463               else if (lex_match_id (lexer, "DEFAULT"))
1464                 {
1465                   factor.print |= PRINT_INITIAL ;
1466                   factor.print |= PRINT_EXTRACTION ;
1467                   factor.print |= PRINT_ROTATION ;
1468                 }
1469               else
1470                 {
1471                   lex_error (lexer, NULL);
1472                   goto error;
1473                 }
1474             }
1475         }
1476       else if (lex_match_id (lexer, "MISSING"))
1477         {
1478           lex_match (lexer, T_EQUALS);
1479           while (lex_token (lexer) != T_ENDCMD && lex_token (lexer) != T_SLASH)
1480             {
1481               if (lex_match_id (lexer, "INCLUDE"))
1482                 {
1483                   factor.exclude = MV_SYSTEM;
1484                 }
1485               else if (lex_match_id (lexer, "EXCLUDE"))
1486                 {
1487                   factor.exclude = MV_ANY;
1488                 }
1489               else if (lex_match_id (lexer, "LISTWISE"))
1490                 {
1491                   factor.missing_type = MISS_LISTWISE;
1492                 }
1493               else if (lex_match_id (lexer, "PAIRWISE"))
1494                 {
1495                   factor.missing_type = MISS_PAIRWISE;
1496                 }
1497               else if (lex_match_id (lexer, "MEANSUB"))
1498                 {
1499                   factor.missing_type = MISS_MEANSUB;
1500                 }
1501               else
1502                 {
1503                   lex_error (lexer, NULL);
1504                   goto error;
1505                 }
1506             }
1507         }
1508       else
1509         {
1510           lex_error (lexer, NULL);
1511           goto error;
1512         }
1513     }
1514
1515   if ( factor.rotation == ROT_NONE )
1516     factor.print &= ~PRINT_ROTATION;
1517
1518   if (factor.n_vars < 2)
1519     msg (MW, _("Factor analysis on a single variable is not useful."));
1520
1521   if (factor.n_vars < 1)
1522     {
1523       msg (ME, _("Factor analysis without variables is not possible."));
1524       goto error;
1525     }
1526
1527   if (matrix_reader)
1528     {
1529       struct idata *id = idata_alloc (factor.n_vars);
1530
1531       while (next_matrix_from_reader (&id->mm, mr,
1532                                       factor.vars, factor.n_vars))
1533         {
1534           do_factor_by_matrix (&factor, id);
1535
1536           gsl_matrix_free (id->mm.corr);
1537           id->mm.corr = NULL;
1538           gsl_matrix_free (id->mm.cov);
1539           id->mm.cov = NULL;
1540         }
1541
1542       idata_free (id);
1543     }
1544   else
1545     if ( ! run_factor (ds, &factor))
1546       goto error;
1547
1548
1549   destroy_matrix_reader (mr);
1550   free (factor.vars);
1551   return CMD_SUCCESS;
1552
1553  error:
1554   destroy_matrix_reader (mr);
1555   free (factor.vars);
1556   return CMD_FAILURE;
1557 }
1558
1559 static void do_factor (const struct cmd_factor *factor, struct casereader *group);
1560
1561
1562 static bool
1563 run_factor (struct dataset *ds, const struct cmd_factor *factor)
1564 {
1565   struct dictionary *dict = dataset_dict (ds);
1566   bool ok;
1567   struct casereader *group;
1568
1569   struct casegrouper *grouper = casegrouper_create_splits (proc_open (ds), dict);
1570
1571   while (casegrouper_get_next_group (grouper, &group))
1572     {
1573       if ( factor->missing_type == MISS_LISTWISE )
1574         group  = casereader_create_filter_missing (group, factor->vars, factor->n_vars,
1575                                                    factor->exclude,
1576                                                    NULL,  NULL);
1577       do_factor (factor, group);
1578     }
1579
1580   ok = casegrouper_destroy (grouper);
1581   ok = proc_commit (ds) && ok;
1582
1583   return ok;
1584 }
1585
1586
1587 /* Return the communality of variable N, calculated to N_FACTORS */
1588 static double
1589 the_communality (const gsl_matrix *evec, const gsl_vector *eval, int n, int n_factors)
1590 {
1591   size_t i;
1592
1593   double comm = 0;
1594
1595   assert (n >= 0);
1596   assert (n < eval->size);
1597   assert (n < evec->size1);
1598   assert (n_factors <= eval->size);
1599
1600   for (i = 0 ; i < n_factors; ++i)
1601     {
1602       double evali = fabs (gsl_vector_get (eval, i));
1603
1604       double eveci = gsl_matrix_get (evec, n, i);
1605
1606       comm += pow2 (eveci) * evali;
1607     }
1608
1609   return comm;
1610 }
1611
1612 /* Return the communality of variable N, calculated to N_FACTORS */
1613 static double
1614 communality (const struct idata *idata, int n, int n_factors)
1615 {
1616   return the_communality (idata->evec, idata->eval, n, n_factors);
1617 }
1618
1619
1620 static void
1621 show_scree (const struct cmd_factor *f, const struct idata *idata)
1622 {
1623   struct scree *s;
1624   const char *label ;
1625
1626   if ( !(f->plot & PLOT_SCREE) )
1627     return;
1628
1629
1630   label = f->extraction == EXTRACTION_PC ? _("Component Number") : _("Factor Number");
1631
1632   s = scree_create (idata->eval, label);
1633
1634   scree_submit (s);
1635 }
1636
1637 static void
1638 show_communalities (const struct cmd_factor * factor,
1639                     const gsl_vector *initial, const gsl_vector *extracted)
1640 {
1641   int i;
1642   int c = 0;
1643   const int heading_columns = 1;
1644   int nc = heading_columns;
1645   const int heading_rows = 1;
1646   const int nr = heading_rows + factor->n_vars;
1647   struct tab_table *t;
1648
1649   if (factor->print & PRINT_EXTRACTION)
1650     nc++;
1651
1652   if (factor->print & PRINT_INITIAL)
1653     nc++;
1654
1655   /* No point having a table with only headings */
1656   if (nc <= 1)
1657     return;
1658
1659   t = tab_create (nc, nr);
1660
1661   tab_title (t, _("Communalities"));
1662
1663   tab_headers (t, heading_columns, 0, heading_rows, 0);
1664
1665   c = 1;
1666   if (factor->print & PRINT_INITIAL)
1667     tab_text (t, c++, 0, TAB_CENTER | TAT_TITLE, _("Initial"));
1668
1669   if (factor->print & PRINT_EXTRACTION)
1670     tab_text (t, c++, 0, TAB_CENTER | TAT_TITLE, _("Extraction"));
1671
1672   /* Outline the box */
1673   tab_box (t,
1674            TAL_2, TAL_2,
1675            -1, -1,
1676            0, 0,
1677            nc - 1, nr - 1);
1678
1679   /* Vertical lines */
1680   tab_box (t,
1681            -1, -1,
1682            -1, TAL_1,
1683            heading_columns, 0,
1684            nc - 1, nr - 1);
1685
1686   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
1687   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1688
1689   for (i = 0 ; i < factor->n_vars; ++i)
1690     {
1691       c = 0;
1692       tab_text (t, c++, i + heading_rows, TAT_TITLE, var_to_string (factor->vars[i]));
1693
1694       if (factor->print & PRINT_INITIAL)
1695         tab_double (t, c++, i + heading_rows, 0, gsl_vector_get (initial, i), NULL, RC_OTHER);
1696
1697       if (factor->print & PRINT_EXTRACTION)
1698         tab_double (t, c++, i + heading_rows, 0, gsl_vector_get (extracted, i), NULL, RC_OTHER);
1699     }
1700
1701   tab_submit (t);
1702 }
1703
1704
1705 static void
1706 show_factor_matrix (const struct cmd_factor *factor, const struct idata *idata, const char *title, const gsl_matrix *fm)
1707 {
1708   int i;
1709
1710   const int n_factors = idata->n_extractions;
1711
1712   const int heading_columns = 1;
1713   const int heading_rows = 2;
1714   const int nr = heading_rows + factor->n_vars;
1715   const int nc = heading_columns + n_factors;
1716   gsl_permutation *perm;
1717
1718   struct tab_table *t = tab_create (nc, nr);
1719
1720   /*
1721   if ( factor->extraction == EXTRACTION_PC )
1722     tab_title (t, _("Component Matrix"));
1723   else
1724     tab_title (t, _("Factor Matrix"));
1725   */
1726
1727   tab_title (t, "%s", title);
1728
1729   tab_headers (t, heading_columns, 0, heading_rows, 0);
1730
1731   if ( factor->extraction == EXTRACTION_PC )
1732     tab_joint_text (t,
1733                     1, 0,
1734                     nc - 1, 0,
1735                     TAB_CENTER | TAT_TITLE, _("Component"));
1736   else
1737     tab_joint_text (t,
1738                     1, 0,
1739                     nc - 1, 0,
1740                     TAB_CENTER | TAT_TITLE, _("Factor"));
1741
1742
1743   tab_hline (t, TAL_1, heading_columns, nc - 1, 1);
1744
1745
1746   /* Outline the box */
1747   tab_box (t,
1748            TAL_2, TAL_2,
1749            -1, -1,
1750            0, 0,
1751            nc - 1, nr - 1);
1752
1753   /* Vertical lines */
1754   tab_box (t,
1755            -1, -1,
1756            -1, TAL_1,
1757            heading_columns, 1,
1758            nc - 1, nr - 1);
1759
1760   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
1761   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1762
1763
1764   /* Initialise to the identity permutation */
1765   perm = gsl_permutation_calloc (factor->n_vars);
1766
1767   if ( factor->sort)
1768     sort_matrix_indirect (fm, perm);
1769
1770   for (i = 0 ; i < n_factors; ++i)
1771     {
1772       tab_text_format (t, heading_columns + i, 1, TAB_CENTER | TAT_TITLE, _("%d"), i + 1);
1773     }
1774
1775   for (i = 0 ; i < factor->n_vars; ++i)
1776     {
1777       int j;
1778       const int matrix_row = perm->data[i];
1779       tab_text (t, 0, i + heading_rows, TAT_TITLE, var_to_string (factor->vars[matrix_row]));
1780
1781       for (j = 0 ; j < n_factors; ++j)
1782         {
1783           double x = gsl_matrix_get (fm, matrix_row, j);
1784
1785           if ( fabs (x) < factor->blank)
1786             continue;
1787
1788           tab_double (t, heading_columns + j, heading_rows + i, 0, x, NULL, RC_OTHER);
1789         }
1790     }
1791
1792   gsl_permutation_free (perm);
1793
1794   tab_submit (t);
1795 }
1796
1797
1798 static void
1799 show_explained_variance (const struct cmd_factor * factor,
1800                          const struct idata *idata,
1801                          const gsl_vector *initial_eigenvalues,
1802                          const gsl_vector *extracted_eigenvalues,
1803                          const gsl_vector *rotated_loadings)
1804 {
1805   size_t i;
1806   int c = 0;
1807   const int heading_columns = 1;
1808   const int heading_rows = 2;
1809   const int nr = heading_rows + factor->n_vars;
1810
1811   struct tab_table *t ;
1812
1813   double i_total = 0.0;
1814   double i_cum = 0.0;
1815
1816   double e_total = 0.0;
1817   double e_cum = 0.0;
1818
1819   double r_cum = 0.0;
1820
1821   int nc = heading_columns;
1822
1823   if (factor->print & PRINT_EXTRACTION)
1824     nc += 3;
1825
1826   if (factor->print & PRINT_INITIAL)
1827     nc += 3;
1828
1829   if (factor->print & PRINT_ROTATION)
1830     {
1831       nc += factor->rotation == ROT_PROMAX ? 1 : 3;
1832     }
1833
1834   /* No point having a table with only headings */
1835   if ( nc <= heading_columns)
1836     return;
1837
1838   t = tab_create (nc, nr);
1839
1840   tab_title (t, _("Total Variance Explained"));
1841
1842   tab_headers (t, heading_columns, 0, heading_rows, 0);
1843
1844   /* Outline the box */
1845   tab_box (t,
1846            TAL_2, TAL_2,
1847            -1, -1,
1848            0, 0,
1849            nc - 1, nr - 1);
1850
1851   /* Vertical lines */
1852   tab_box (t,
1853            -1, -1,
1854            -1, TAL_1,
1855            heading_columns, 0,
1856            nc - 1, nr - 1);
1857
1858   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
1859   tab_hline (t, TAL_1, 1, nc - 1, 1);
1860
1861   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
1862
1863
1864   if ( factor->extraction == EXTRACTION_PC)
1865     tab_text (t, 0, 1, TAB_LEFT | TAT_TITLE, _("Component"));
1866   else
1867     tab_text (t, 0, 1, TAB_LEFT | TAT_TITLE, _("Factor"));
1868
1869   c = 1;
1870   if (factor->print & PRINT_INITIAL)
1871     {
1872       tab_joint_text (t, c, 0, c + 2, 0, TAB_CENTER | TAT_TITLE, _("Initial Eigenvalues"));
1873       c += 3;
1874     }
1875
1876   if (factor->print & PRINT_EXTRACTION)
1877     {
1878       tab_joint_text (t, c, 0, c + 2, 0, TAB_CENTER | TAT_TITLE, _("Extraction Sums of Squared Loadings"));
1879       c += 3;
1880     }
1881
1882   if (factor->print & PRINT_ROTATION)
1883     {
1884       const int width = factor->rotation == ROT_PROMAX ? 0 : 2;
1885       tab_joint_text (t, c, 0, c + width, 0, TAB_CENTER | TAT_TITLE, _("Rotation Sums of Squared Loadings"));
1886       c += width + 1;
1887     }
1888
1889   for (i = 0; i < (nc - heading_columns + 2) / 3 ; ++i)
1890     {
1891       tab_text (t, i * 3 + 1, 1, TAB_CENTER | TAT_TITLE, _("Total"));
1892
1893       tab_vline (t, TAL_2, heading_columns + i * 3, 0, nr - 1);
1894
1895       if (i == 2 && factor->rotation == ROT_PROMAX)
1896         continue;
1897
1898       /* xgettext:no-c-format */
1899       tab_text (t, i * 3 + 2, 1, TAB_CENTER | TAT_TITLE, _("% of Variance"));
1900       tab_text (t, i * 3 + 3, 1, TAB_CENTER | TAT_TITLE, _("Cumulative %"));
1901     }
1902
1903   for (i = 0 ; i < initial_eigenvalues->size; ++i)
1904     i_total += gsl_vector_get (initial_eigenvalues, i);
1905
1906   if ( factor->extraction == EXTRACTION_PAF)
1907     {
1908       e_total = factor->n_vars;
1909     }
1910   else
1911     {
1912       e_total = i_total;
1913     }
1914
1915   for (i = 0 ; i < factor->n_vars; ++i)
1916     {
1917       const double i_lambda = gsl_vector_get (initial_eigenvalues, i);
1918       double i_percent = 100.0 * i_lambda / i_total ;
1919
1920       const double e_lambda = gsl_vector_get (extracted_eigenvalues, i);
1921       double e_percent = 100.0 * e_lambda / e_total ;
1922
1923       c = 0;
1924
1925       tab_text_format (t, c++, i + heading_rows, TAB_LEFT | TAT_TITLE, _("%zu"), i + 1);
1926
1927       i_cum += i_percent;
1928       e_cum += e_percent;
1929
1930       /* Initial Eigenvalues */
1931       if (factor->print & PRINT_INITIAL)
1932       {
1933         tab_double (t, c++, i + heading_rows, 0, i_lambda, NULL, RC_OTHER);
1934         tab_double (t, c++, i + heading_rows, 0, i_percent, NULL, RC_OTHER);
1935         tab_double (t, c++, i + heading_rows, 0, i_cum, NULL, RC_OTHER);
1936       }
1937
1938
1939       if (factor->print & PRINT_EXTRACTION)
1940         {
1941           if (i < idata->n_extractions)
1942             {
1943               /* Sums of squared loadings */
1944               tab_double (t, c++, i + heading_rows, 0, e_lambda, NULL, RC_OTHER);
1945               tab_double (t, c++, i + heading_rows, 0, e_percent, NULL, RC_OTHER);
1946               tab_double (t, c++, i + heading_rows, 0, e_cum, NULL, RC_OTHER);
1947             }
1948         }
1949
1950       if (rotated_loadings != NULL)
1951         {
1952           const double r_lambda = gsl_vector_get (rotated_loadings, i);
1953           double r_percent = 100.0 * r_lambda / e_total ;
1954
1955           if (factor->print & PRINT_ROTATION)
1956             {
1957               if (i < idata->n_extractions)
1958                 {
1959                   r_cum += r_percent;
1960                   tab_double (t, c++, i + heading_rows, 0, r_lambda, NULL, RC_OTHER);
1961                   if (factor->rotation != ROT_PROMAX)
1962                     {
1963                       tab_double (t, c++, i + heading_rows, 0, r_percent, NULL, RC_OTHER);
1964                       tab_double (t, c++, i + heading_rows, 0, r_cum, NULL, RC_OTHER);
1965                     }
1966                 }
1967             }
1968         }
1969     }
1970
1971   tab_submit (t);
1972 }
1973
1974
1975 static void
1976 show_factor_correlation (const struct cmd_factor * factor, const gsl_matrix *fcm)
1977 {
1978   size_t i, j;
1979   const int heading_columns = 1;
1980   const int heading_rows = 1;
1981   const int nr = heading_rows + fcm->size2;
1982   const int nc = heading_columns + fcm->size1;
1983   struct tab_table *t = tab_create (nc, nr);
1984
1985   tab_title (t, _("Factor Correlation Matrix"));
1986
1987   tab_headers (t, heading_columns, 0, heading_rows, 0);
1988
1989   /* Outline the box */
1990   tab_box (t,
1991            TAL_2, TAL_2,
1992            -1, -1,
1993            0, 0,
1994            nc - 1, nr - 1);
1995
1996   /* Vertical lines */
1997   tab_box (t,
1998            -1, -1,
1999            -1, TAL_1,
2000            heading_columns, 0,
2001            nc - 1, nr - 1);
2002
2003   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
2004   tab_hline (t, TAL_1, 1, nc - 1, 1);
2005
2006   tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
2007
2008
2009   if ( factor->extraction == EXTRACTION_PC)
2010     tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Component"));
2011   else
2012     tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("Factor"));
2013
2014   for (i = 0 ; i < fcm->size1; ++i)
2015     {
2016       tab_text_format (t, heading_columns + i, 0, TAB_CENTER | TAT_TITLE, _("%zu"), i + 1);
2017     }
2018
2019   for (i = 0 ; i < fcm->size2; ++i)
2020     {
2021       tab_text_format (t, 0, heading_rows + i, TAB_CENTER | TAT_TITLE, _("%zu"), i + 1);
2022     }
2023
2024
2025   for (i = 0 ; i < fcm->size1; ++i)
2026     {
2027       for (j = 0 ; j < fcm->size2; ++j)
2028         tab_double (t, heading_columns + j,  heading_rows + i, 0,
2029                     gsl_matrix_get (fcm, i, j), NULL, RC_OTHER);
2030     }
2031
2032   tab_submit (t);
2033 }
2034
2035 static void
2036 show_aic (const struct cmd_factor *factor, const struct idata *idata)
2037 {
2038   struct tab_table *t ;
2039   size_t i;
2040
2041   const int heading_rows = 1;
2042   const int heading_columns = 2;
2043
2044   const int nc = heading_columns + factor->n_vars;
2045   const int nr = heading_rows + 2 * factor->n_vars;
2046
2047   if ((factor->print & PRINT_AIC) == 0)
2048     return;
2049
2050   t = tab_create (nc, nr);
2051
2052   tab_title (t, _("Anti-Image Matrices"));
2053
2054   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
2055
2056   tab_headers (t, heading_columns, 0, heading_rows, 0);
2057
2058   tab_vline (t, TAL_2, 2, 0, nr - 1);
2059
2060   /* Outline the box */
2061   tab_box (t,
2062            TAL_2, TAL_2,
2063            -1, -1,
2064            0, 0,
2065            nc - 1, nr - 1);
2066
2067   /* Vertical lines */
2068   tab_box (t,
2069            -1, -1,
2070            -1, TAL_1,
2071            heading_columns, 0,
2072            nc - 1, nr - 1);
2073
2074
2075   for (i = 0; i < factor->n_vars; ++i)
2076     tab_text (t, heading_columns + i, 0, TAT_TITLE, var_to_string (factor->vars[i]));
2077
2078   tab_text (t, 0, heading_rows, TAT_TITLE, _("Anti-image Covariance"));
2079   tab_hline (t, TAL_1, 0, nc - 1, heading_rows + factor->n_vars);
2080   tab_text (t, 0, heading_rows + factor->n_vars, TAT_TITLE, _("Anti-image Correlation"));
2081
2082   for (i = 0; i < factor->n_vars; ++i)
2083     {
2084       tab_text (t, 1, i + heading_rows, TAT_TITLE,
2085                 var_to_string (factor->vars[i]));
2086
2087       tab_text (t, 1, factor->n_vars + i + heading_rows, TAT_TITLE,
2088                 var_to_string (factor->vars[i]));
2089     }
2090
2091   for (i = 0; i < factor->n_vars; ++i)
2092     {
2093       int j;
2094       for (j = 0; j < factor->n_vars; ++j)
2095         {
2096           tab_double (t, heading_columns + i, heading_rows + j, 0,
2097                       gsl_matrix_get (idata->ai_cov, i, j), NULL, RC_OTHER);
2098         }
2099
2100
2101       for (j = 0; j < factor->n_vars; ++j)
2102         {
2103           tab_double (t, heading_columns + i, factor->n_vars + heading_rows + j, 0,
2104                       gsl_matrix_get (idata->ai_cor, i, j), NULL, RC_OTHER);
2105         }
2106     }
2107
2108   tab_submit (t);
2109 }
2110
2111 static void
2112 show_correlation_matrix (const struct cmd_factor *factor, const struct idata *idata)
2113 {
2114   struct tab_table *t ;
2115   size_t i, j;
2116   int y_pos_corr = -1;
2117   int y_pos_sig = -1;
2118   int suffix_rows = 0;
2119
2120   const int heading_rows = 1;
2121   const int heading_columns = 2;
2122
2123   int nc = heading_columns ;
2124   int nr = heading_rows ;
2125   int n_data_sets = 0;
2126
2127   if (factor->print & PRINT_CORRELATION)
2128     {
2129       y_pos_corr = n_data_sets;
2130       n_data_sets++;
2131       nc = heading_columns + factor->n_vars;
2132     }
2133
2134   if (factor->print & PRINT_SIG)
2135     {
2136       y_pos_sig = n_data_sets;
2137       n_data_sets++;
2138       nc = heading_columns + factor->n_vars;
2139     }
2140
2141   nr += n_data_sets * factor->n_vars;
2142
2143   if (factor->print & PRINT_DETERMINANT)
2144     suffix_rows = 1;
2145
2146   /* If the table would contain only headings, don't bother rendering it */
2147   if (nr <= heading_rows && suffix_rows == 0)
2148     return;
2149
2150   t = tab_create (nc, nr + suffix_rows);
2151
2152   tab_title (t, _("Correlation Matrix"));
2153
2154   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
2155
2156   if (nr > heading_rows)
2157     {
2158       tab_headers (t, heading_columns, 0, heading_rows, 0);
2159
2160       tab_vline (t, TAL_2, 2, 0, nr - 1);
2161
2162       /* Outline the box */
2163       tab_box (t,
2164                TAL_2, TAL_2,
2165                -1, -1,
2166                0, 0,
2167                nc - 1, nr - 1);
2168
2169       /* Vertical lines */
2170       tab_box (t,
2171                -1, -1,
2172                -1, TAL_1,
2173                heading_columns, 0,
2174                nc - 1, nr - 1);
2175
2176
2177       for (i = 0; i < factor->n_vars; ++i)
2178         tab_text (t, heading_columns + i, 0, TAT_TITLE, var_to_string (factor->vars[i]));
2179
2180
2181       for (i = 0 ; i < n_data_sets; ++i)
2182         {
2183           int y = heading_rows + i * factor->n_vars;
2184           size_t v;
2185           for (v = 0; v < factor->n_vars; ++v)
2186             tab_text (t, 1, y + v, TAT_TITLE, var_to_string (factor->vars[v]));
2187
2188           tab_hline (t, TAL_1, 0, nc - 1, y);
2189         }
2190
2191       if (factor->print & PRINT_CORRELATION)
2192         {
2193           const double y = heading_rows + y_pos_corr;
2194           tab_text (t, 0, y, TAT_TITLE, _("Correlations"));
2195
2196           for (i = 0; i < factor->n_vars; ++i)
2197             {
2198               for (j = 0; j < factor->n_vars; ++j)
2199                 tab_double (t, heading_columns + j,  y + i, 0, gsl_matrix_get (idata->mm.corr, i, j), NULL, RC_OTHER);
2200             }
2201         }
2202
2203       if (factor->print & PRINT_SIG)
2204         {
2205           const double y = heading_rows + y_pos_sig * factor->n_vars;
2206           tab_text (t, 0, y, TAT_TITLE, _("Sig. (1-tailed)"));
2207
2208           for (i = 0; i < factor->n_vars; ++i)
2209             {
2210               for (j = 0; j < factor->n_vars; ++j)
2211                 {
2212                   double rho = gsl_matrix_get (idata->mm.corr, i, j);
2213                   double w = gsl_matrix_get (idata->mm.n, i, j);
2214
2215                   if (i == j)
2216                     continue;
2217
2218                   tab_double (t, heading_columns + j,  y + i, 0, significance_of_correlation (rho, w), NULL, RC_PVALUE);
2219                 }
2220             }
2221         }
2222     }
2223
2224   if (factor->print & PRINT_DETERMINANT)
2225     {
2226       tab_text (t, 0, nr, TAB_LEFT | TAT_TITLE, _("Determinant"));
2227
2228       tab_double (t, 1, nr, 0, idata->detR, NULL, RC_OTHER);
2229     }
2230
2231   tab_submit (t);
2232 }
2233
2234 static void
2235 show_covariance_matrix (const struct cmd_factor *factor, const struct idata *idata)
2236 {
2237   struct tab_table *t ;
2238   size_t i, j;
2239   int y_pos_corr = -1;
2240   int suffix_rows = 0;
2241
2242   const int heading_rows = 1;
2243   const int heading_columns = 1;
2244
2245   int nc = heading_columns ;
2246   int nr = heading_rows ;
2247   int n_data_sets = 0;
2248
2249   if (factor->print & PRINT_COVARIANCE)
2250     {
2251       y_pos_corr = n_data_sets;
2252       n_data_sets++;
2253       nc = heading_columns + factor->n_vars;
2254     }
2255
2256   nr += n_data_sets * factor->n_vars;
2257
2258   /* If the table would contain only headings, don't bother rendering it */
2259   if (nr <= heading_rows && suffix_rows == 0)
2260     return;
2261
2262   t = tab_create (nc, nr + suffix_rows);
2263
2264   tab_title (t, _("Covariance Matrix"));
2265
2266   tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
2267
2268   if (nr > heading_rows)
2269     {
2270       tab_headers (t, heading_columns, 0, heading_rows, 0);
2271
2272       tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
2273
2274       /* Outline the box */
2275       tab_box (t,
2276                TAL_2, TAL_2,
2277                -1, -1,
2278                0, 0,
2279                nc - 1, nr - 1);
2280
2281       /* Vertical lines */
2282       tab_box (t,
2283                -1, -1,
2284                -1, TAL_1,
2285                heading_columns, 0,
2286                nc - 1, nr - 1);
2287
2288
2289       for (i = 0; i < factor->n_vars; ++i)
2290         tab_text (t, heading_columns + i, 0, TAT_TITLE, var_to_string (factor->vars[i]));
2291
2292
2293       for (i = 0 ; i < n_data_sets; ++i)
2294         {
2295           int y = heading_rows + i * factor->n_vars;
2296           size_t v;
2297           for (v = 0; v < factor->n_vars; ++v)
2298             tab_text (t, heading_columns -1, y + v, TAT_TITLE, var_to_string (factor->vars[v]));
2299
2300           tab_hline (t, TAL_1, 0, nc - 1, y);
2301         }
2302
2303       if (factor->print & PRINT_COVARIANCE)
2304         {
2305           const double y = heading_rows + y_pos_corr;
2306
2307           for (i = 0; i < factor->n_vars; ++i)
2308             {
2309               for (j = 0; j < factor->n_vars; ++j)
2310                 tab_double (t, heading_columns + j,  y + i, 0, gsl_matrix_get (idata->mm.cov, i, j), NULL, RC_OTHER);
2311             }
2312         }
2313     }
2314
2315   tab_submit (t);
2316 }
2317
2318
2319 static void
2320 do_factor (const struct cmd_factor *factor, struct casereader *r)
2321 {
2322   struct ccase *c;
2323   struct idata *idata = idata_alloc (factor->n_vars);
2324
2325   idata->cvm = covariance_1pass_create (factor->n_vars, factor->vars,
2326                                         factor->wv, factor->exclude, true);
2327
2328   for ( ; (c = casereader_read (r) ); case_unref (c))
2329     {
2330       covariance_accumulate (idata->cvm, c);
2331     }
2332
2333   idata->mm.cov = covariance_calculate (idata->cvm);
2334
2335   if (idata->mm.cov == NULL)
2336     {
2337       msg (MW, _("The dataset contains no complete observations. No analysis will be performed."));
2338       covariance_destroy (idata->cvm);
2339       goto finish;
2340     }
2341
2342   idata->mm.var_matrix = covariance_moments (idata->cvm, MOMENT_VARIANCE);
2343   idata->mm.mean_matrix = covariance_moments (idata->cvm, MOMENT_MEAN);
2344   idata->mm.n = covariance_moments (idata->cvm, MOMENT_NONE);
2345
2346   do_factor_by_matrix (factor, idata);
2347
2348  finish:
2349   gsl_matrix_free (idata->mm.corr);
2350   gsl_matrix_free (idata->mm.cov);
2351
2352   idata_free (idata);
2353   casereader_destroy (r);
2354 }
2355
2356 static void
2357 do_factor_by_matrix (const struct cmd_factor *factor, struct idata *idata)
2358 {
2359   if (!idata->mm.cov && !idata->mm.corr)
2360     {
2361       msg (ME, _("The dataset has no complete covariance or correlation matrix."));
2362       return;
2363     }
2364
2365   if (idata->mm.cov && !idata->mm.corr)
2366     idata->mm.corr = correlation_from_covariance (idata->mm.cov, idata->mm.var_matrix);
2367   if (idata->mm.corr && !idata->mm.cov)
2368     idata->mm.cov = covariance_from_correlation (idata->mm.corr, idata->mm.var_matrix);
2369   if (factor->method == METHOD_CORR)
2370     idata->analysis_matrix = idata->mm.corr;
2371   else
2372     idata->analysis_matrix = idata->mm.cov;
2373
2374   gsl_matrix *r_inv;
2375   r_inv  = clone_matrix (idata->mm.corr);
2376   gsl_linalg_cholesky_decomp (r_inv);
2377   gsl_linalg_cholesky_invert (r_inv);
2378
2379   idata->ai_cov = anti_image_cov (r_inv);
2380   idata->ai_cor = anti_image_corr (r_inv, idata);
2381
2382   int i;
2383   double sum_ssq_r = 0;
2384   double sum_ssq_a = 0;
2385   for (i = 0; i < r_inv->size1; ++i)
2386     {
2387       sum_ssq_r += ssq_od_n (idata->mm.corr, i);
2388       sum_ssq_a += ssq_od_n (idata->ai_cor, i);
2389     }
2390
2391   gsl_matrix_free (r_inv);
2392
2393   if (factor->print & PRINT_DETERMINANT
2394       || factor->print & PRINT_KMO)
2395     {
2396       int sign = 0;
2397
2398       const int size = idata->mm.corr->size1;
2399       gsl_permutation *p = gsl_permutation_calloc (size);
2400       gsl_matrix *tmp = gsl_matrix_calloc (size, size);
2401       gsl_matrix_memcpy (tmp, idata->mm.corr);
2402
2403       gsl_linalg_LU_decomp (tmp, p, &sign);
2404       idata->detR = gsl_linalg_LU_det (tmp, sign);
2405       gsl_permutation_free (p);
2406       gsl_matrix_free (tmp);
2407     }
2408
2409   if ( factor->print & PRINT_UNIVARIATE)
2410     {
2411       const struct fmt_spec *wfmt = factor->wv ? var_get_print_format (factor->wv) : & F_8_0;
2412       const int nc = 4;
2413       int i;
2414
2415       const int heading_columns = 1;
2416       const int heading_rows = 1;
2417
2418       const int nr = heading_rows + factor->n_vars;
2419
2420       struct tab_table *t = tab_create (nc, nr);
2421       tab_set_format (t, RC_WEIGHT, wfmt);
2422       tab_title (t, _("Descriptive Statistics"));
2423
2424       tab_headers (t, heading_columns, 0, heading_rows, 0);
2425
2426       /* Outline the box */
2427       tab_box (t,
2428                TAL_2, TAL_2,
2429                -1, -1,
2430                0, 0,
2431                nc - 1, nr - 1);
2432
2433       /* Vertical lines */
2434       tab_box (t,
2435                -1, -1,
2436                -1, TAL_1,
2437                heading_columns, 0,
2438                nc - 1, nr - 1);
2439
2440       tab_hline (t, TAL_1, 0, nc - 1, heading_rows);
2441       tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
2442
2443       tab_text (t, 1, 0, TAB_CENTER | TAT_TITLE, _("Mean"));
2444       tab_text (t, 2, 0, TAB_CENTER | TAT_TITLE, _("Std. Deviation"));
2445       tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Analysis N"));
2446
2447       for (i = 0 ; i < factor->n_vars; ++i)
2448         {
2449           const struct variable *v = factor->vars[i];
2450           tab_text (t, 0, i + heading_rows, TAB_LEFT | TAT_TITLE, var_to_string (v));
2451
2452           tab_double (t, 1, i + heading_rows, 0, gsl_matrix_get (idata->mm.mean_matrix, i, i), NULL, RC_OTHER);
2453           tab_double (t, 2, i + heading_rows, 0, sqrt (gsl_matrix_get (idata->mm.var_matrix, i, i)), NULL, RC_OTHER);
2454           tab_double (t, 3, i + heading_rows, 0, gsl_matrix_get (idata->mm.n, i, i), NULL, RC_WEIGHT);
2455         }
2456
2457       tab_submit (t);
2458     }
2459
2460   if (factor->print & PRINT_KMO)
2461     {
2462       int i;
2463       double df = factor->n_vars * (factor->n_vars - 1) / 2;
2464
2465       double w = 0;
2466
2467
2468       double xsq;
2469
2470       const int heading_columns = 2;
2471       const int heading_rows = 0;
2472
2473       const int nr = heading_rows + 4;
2474       const int nc = heading_columns + 1;
2475
2476
2477
2478       struct tab_table *t = tab_create (nc, nr);
2479       tab_title (t, _("KMO and Bartlett's Test"));
2480
2481
2482       tab_headers (t, heading_columns, 0, heading_rows, 0);
2483
2484       /* Outline the box */
2485       tab_box (t,
2486                TAL_2, TAL_2,
2487                -1, -1,
2488                0, 0,
2489                nc - 1, nr - 1);
2490
2491       tab_vline (t, TAL_2, heading_columns, 0, nr - 1);
2492
2493       tab_text (t, 0, 0, TAT_TITLE | TAB_LEFT, _("Kaiser-Meyer-Olkin Measure of Sampling Adequacy"));
2494
2495       tab_double (t, 2, 0, 0, sum_ssq_r /  (sum_ssq_r + sum_ssq_a), NULL, RC_OTHER);
2496
2497       tab_text (t, 0, 1, TAT_TITLE | TAB_LEFT, _("Bartlett's Test of Sphericity"));
2498
2499       tab_text (t, 1, 1, TAT_TITLE, _("Approx. Chi-Square"));
2500       tab_text (t, 1, 2, TAT_TITLE, _("df"));
2501       tab_text (t, 1, 3, TAT_TITLE, _("Sig."));
2502
2503
2504       /* The literature doesn't say what to do for the value of W when
2505          missing values are involved.  The best thing I can think of
2506          is to take the mean average. */
2507       w = 0;
2508       for (i = 0; i < idata->mm.n->size1; ++i)
2509         w += gsl_matrix_get (idata->mm.n, i, i);
2510       w /= idata->mm.n->size1;
2511
2512       xsq = w - 1 - (2 * factor->n_vars + 5) / 6.0;
2513       xsq *= -log (idata->detR);
2514
2515       tab_double (t, 2, 1, 0, xsq, NULL, RC_OTHER);
2516       tab_double (t, 2, 2, 0, df, NULL, RC_INTEGER);
2517       tab_double (t, 2, 3, 0, gsl_cdf_chisq_Q (xsq, df), NULL, RC_PVALUE);
2518
2519
2520       tab_submit (t);
2521     }
2522
2523   show_correlation_matrix (factor, idata);
2524   show_covariance_matrix (factor, idata);
2525   if (idata->cvm)
2526     covariance_destroy (idata->cvm);
2527
2528   {
2529     gsl_matrix *am = matrix_dup (idata->analysis_matrix);
2530     gsl_eigen_symmv_workspace *workspace = gsl_eigen_symmv_alloc (factor->n_vars);
2531
2532     gsl_eigen_symmv (am, idata->eval, idata->evec, workspace);
2533
2534     gsl_eigen_symmv_free (workspace);
2535     gsl_matrix_free (am);
2536   }
2537
2538   gsl_eigen_symmv_sort (idata->eval, idata->evec, GSL_EIGEN_SORT_ABS_DESC);
2539
2540   idata->n_extractions = n_extracted_factors (factor, idata);
2541
2542   if (idata->n_extractions == 0)
2543     {
2544       msg (MW, _("The %s criteria result in zero factors extracted. Therefore no analysis will be performed."), "FACTOR");
2545       return;
2546     }
2547
2548   if (idata->n_extractions > factor->n_vars)
2549     {
2550       msg (MW,
2551            _("The %s criteria result in more factors than variables, which is not meaningful. No analysis will be performed."),
2552            "FACTOR");
2553       return;
2554     }
2555
2556   {
2557     gsl_matrix *rotated_factors = NULL;
2558     gsl_matrix *pattern_matrix = NULL;
2559     gsl_matrix *fcm = NULL;
2560     gsl_vector *rotated_loadings = NULL;
2561
2562     const gsl_vector *extracted_eigenvalues = NULL;
2563     gsl_vector *initial_communalities = gsl_vector_alloc (factor->n_vars);
2564     gsl_vector *extracted_communalities = gsl_vector_alloc (factor->n_vars);
2565     size_t i;
2566     struct factor_matrix_workspace *fmw = factor_matrix_workspace_alloc (idata->msr->size, idata->n_extractions);
2567     gsl_matrix *factor_matrix = gsl_matrix_calloc (factor->n_vars, fmw->n_factors);
2568
2569     if ( factor->extraction == EXTRACTION_PAF)
2570       {
2571         gsl_vector *diff = gsl_vector_alloc (idata->msr->size);
2572         struct smr_workspace *ws = ws_create (idata->analysis_matrix);
2573
2574         for (i = 0 ; i < factor->n_vars ; ++i)
2575           {
2576             double r2 = squared_multiple_correlation (idata->analysis_matrix, i, ws);
2577
2578             gsl_vector_set (idata->msr, i, r2);
2579           }
2580         ws_destroy (ws);
2581
2582         gsl_vector_memcpy (initial_communalities, idata->msr);
2583
2584         for (i = 0; i < factor->extraction_iterations; ++i)
2585           {
2586             double min, max;
2587             gsl_vector_memcpy (diff, idata->msr);
2588
2589             iterate_factor_matrix (idata->analysis_matrix, idata->msr, factor_matrix, fmw);
2590
2591             gsl_vector_sub (diff, idata->msr);
2592
2593             gsl_vector_minmax (diff, &min, &max);
2594
2595             if ( fabs (min) < factor->econverge && fabs (max) < factor->econverge)
2596               break;
2597           }
2598         gsl_vector_free (diff);
2599
2600
2601
2602         gsl_vector_memcpy (extracted_communalities, idata->msr);
2603         extracted_eigenvalues = fmw->eval;
2604       }
2605     else if (factor->extraction == EXTRACTION_PC)
2606       {
2607         for (i = 0; i < factor->n_vars; ++i)
2608           gsl_vector_set (initial_communalities, i, communality (idata, i, factor->n_vars));
2609
2610         gsl_vector_memcpy (extracted_communalities, initial_communalities);
2611
2612         iterate_factor_matrix (idata->analysis_matrix, extracted_communalities, factor_matrix, fmw);
2613
2614
2615         extracted_eigenvalues = idata->eval;
2616       }
2617
2618
2619     show_aic (factor, idata);
2620     show_communalities (factor, initial_communalities, extracted_communalities);
2621
2622     if ( factor->rotation != ROT_NONE)
2623       {
2624         rotated_factors = gsl_matrix_calloc (factor_matrix->size1, factor_matrix->size2);
2625         rotated_loadings = gsl_vector_calloc (factor_matrix->size2);
2626         if (factor->rotation == ROT_PROMAX)
2627           {
2628             pattern_matrix = gsl_matrix_calloc (factor_matrix->size1, factor_matrix->size2);
2629             fcm = gsl_matrix_calloc (factor_matrix->size2, factor_matrix->size2);
2630           }
2631
2632
2633         rotate (factor, factor_matrix, extracted_communalities, rotated_factors, rotated_loadings, pattern_matrix, fcm);
2634       }
2635
2636     show_explained_variance (factor, idata, idata->eval, extracted_eigenvalues, rotated_loadings);
2637
2638     factor_matrix_workspace_free (fmw);
2639
2640     show_scree (factor, idata);
2641
2642     show_factor_matrix (factor, idata,
2643                         factor->extraction == EXTRACTION_PC ? _("Component Matrix") : _("Factor Matrix"),
2644                         factor_matrix);
2645
2646     if ( factor->rotation == ROT_PROMAX)
2647       {
2648         show_factor_matrix (factor, idata, _("Pattern Matrix"),  pattern_matrix);
2649         gsl_matrix_free (pattern_matrix);
2650       }
2651
2652     if ( factor->rotation != ROT_NONE)
2653       {
2654         show_factor_matrix (factor, idata,
2655                             (factor->rotation == ROT_PROMAX) ? _("Structure Matrix") :
2656                             (factor->extraction == EXTRACTION_PC ? _("Rotated Component Matrix") :
2657                              _("Rotated Factor Matrix")),
2658                             rotated_factors);
2659
2660         gsl_matrix_free (rotated_factors);
2661       }
2662
2663     if ( factor->rotation == ROT_PROMAX)
2664       {
2665         show_factor_correlation (factor, fcm);
2666         gsl_matrix_free (fcm);
2667       }
2668
2669     gsl_matrix_free (factor_matrix);
2670     gsl_vector_free (rotated_loadings);
2671     gsl_vector_free (initial_communalities);
2672     gsl_vector_free (extracted_communalities);
2673   }
2674 }
2675
2676