src/math/covariance-matrix.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2008 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   Create and update the values in the covariance matrix.
  19 */
  20 #include <assert.h>
  21 #include <config.h>
  22 #include <data/case.h>
  23 #include <data/category.h>
  24 #include <data/variable.h>
  25 #include <data/value.h>
  26 #include <libpspp/hash.h>
  27 #include <libpspp/hash-functions.h>
  28 #include <math/covariance-matrix.h>
  29 #include <math/moments.h>
  30 #include <string.h>
  31 #include <xalloc.h>
  32
  33 /*
  34   Structure used to accumulate the covariance matrix in a single data
  35   pass.  Before passing the data, we do not know how many categories
  36   there are in each categorical variable. Therefore we do not know the
  37   size of the covariance matrix. To get around this problem, we
  38   accumulate the elements of the covariance matrix in pointers to
  39   COVARIANC_ACCUMULATOR. These values are then used to populate
  40   the covariance matrix.
  41  */
  42 struct covariance_accumulator
  43 {
  44   const struct variable *v1;
  45   const struct variable *v2;
  46   const union value *val1;
  47   const union value *val2;
  48   double dot_product;
  49   double sum1;
  50   double sum2;
  51   double ssize;
  52 };
  53
  54
  55
  56 struct covariance_matrix
  57 {
  58   struct design_matrix *cov;
  59   struct design_matrix *ssize;
  60   struct design_matrix *means;
  61   struct hsh_table *ca;
  62   struct moments1 **m1;
  63   struct moments **m;
  64   const struct variable **v_variables;
  65   size_t n_variables;
  66   int n_pass;
  67   int missing_handling;
  68   enum mv_class missing_value;
  69   void (*accumulate) (struct covariance_matrix *, const struct ccase *,
  70                       const struct interaction_variable **, size_t);
  71   void (*update_moments) (struct covariance_matrix *, size_t, double);
  72 };
  73
  74
  75
  76 static struct hsh_table *covariance_hsh_create (size_t *);
  77 static hsh_hash_func covariance_accumulator_hash;
  78 static unsigned int hash_numeric_alpha (const struct variable *,
  79                                         const struct variable *,
  80                                         const union value *, size_t);
  81 static hsh_compare_func covariance_accumulator_compare;
  82 static hsh_free_func covariance_accumulator_free;
  83 static void update_moments1 (struct covariance_matrix *, size_t, double);
  84 static void update_moments2 (struct covariance_matrix *, size_t, double);
  85 static struct covariance_accumulator *get_new_covariance_accumulator (const
  86                                                                       struct
  87                                                                       variable
  88                                                                       *,
  89                                                                       const
  90                                                                       struct
  91                                                                       variable
  92                                                                       *,
  93                                                                       const
  94                                                                       union
  95                                                                       value *,
  96                                                                       const
  97                                                                       union
  98                                                                       value
  99                                                                       *);
 100 static void covariance_accumulate_listwise (struct covariance_matrix *,
 101                                             const struct ccase *,
 102                                             const struct interaction_variable **,
 103                                             size_t);
 104 static void covariance_accumulate_pairwise (struct covariance_matrix *,
 105                                             const struct ccase *,
 106                                             const struct interaction_variable **,
 107                                             size_t);
 108
 109 struct covariance_matrix *
 110 covariance_matrix_init (size_t n_variables,
 111                         const struct variable *v_variables[], int n_pass,
 112                         int missing_handling, enum mv_class missing_value)
 113 {
 114   size_t i;
 115   struct covariance_matrix *result = NULL;
 116
 117   result = xmalloc (sizeof (*result));
 118   result->cov = NULL;
 119   result->n_variables = n_variables;
 120   result->ca = covariance_hsh_create (&result->n_variables);
 121   result->m = NULL;
 122   result->m1 = NULL;
 123   result->missing_handling = missing_handling;
 124   result->missing_value = missing_value;
 125   result->accumulate = (result->missing_handling == LISTWISE) ?
 126     covariance_accumulate_listwise : covariance_accumulate_pairwise;
 127   if (n_pass == ONE_PASS)
 128     {
 129       result->update_moments = update_moments1;
 130       result->m1 = xnmalloc (n_variables, sizeof (*result->m1));
 131       for (i = 0; i < n_variables; i++)
 132         {
 133           result->m1[i] = moments1_create (MOMENT_MEAN);
 134         }
 135     }
 136   else
 137     {
 138       result->update_moments = update_moments2;
 139       result->m = xnmalloc (n_variables, sizeof (*result->m));
 140       for (i = 0; i < n_variables; i++)
 141         {
 142           result->m[i] = moments_create (MOMENT_MEAN);
 143         }
 144     }
 145   result->v_variables = v_variables;
 146
 147   result->n_pass = n_pass;
 148
 149   return result;
 150 }
 151
 152 /*
 153   The covariances are stored in a DESIGN_MATRIX structure.
 154  */
 155 struct design_matrix *
 156 covariance_matrix_create (size_t n_variables,
 157                           const struct variable *v_variables[])
 158 {
 159   return design_matrix_create (n_variables, v_variables,
 160                                (size_t) n_variables);
 161 }
 162
 163 static void
 164 update_moments1 (struct covariance_matrix *cov, size_t i, double x)
 165 {
 166   assert (cov->m1 != NULL);
 167   moments1_add (cov->m1[i], x, 1.0);
 168 }
 169
 170 static void
 171 update_moments2 (struct covariance_matrix *cov, size_t i, double x)
 172 {
 173   assert (cov->m != NULL);
 174   moments_pass_one (cov->m[i], x, 1.0);
 175 }
 176
 177 void
 178 covariance_matrix_destroy (struct covariance_matrix *cov)
 179 {
 180   size_t i;
 181
 182   assert (cov != NULL);
 183   design_matrix_destroy (cov->cov);
 184   design_matrix_destroy (cov->ssize);
 185   design_matrix_destroy (cov->means);
 186   hsh_destroy (cov->ca);
 187   if (cov->n_pass == ONE_PASS)
 188     {
 189       for (i = 0; i < cov->n_variables; i++)
 190         {
 191           moments1_destroy (cov->m1[i]);
 192         }
 193       free (cov->m1);
 194     }
 195   else
 196     {
 197       for (i = 0; i < cov->n_variables; i++)
 198         {
 199           moments_destroy (cov->m[i]);
 200         }
 201       free (cov->m);
 202     }
 203 }
 204
 205 /*
 206   Update the covariance matrix with the new entries, assuming that ROW
 207   corresponds to a categorical variable and V2 is numeric.
 208  */
 209 static void
 210 covariance_update_categorical_numeric (struct design_matrix *cov, double mean,
 211                                        size_t row,
 212                                        const struct variable *v2, double x,
 213                                        const union value *val2)
 214 {
 215   size_t col;
 216   double tmp;
 217
 218   assert (var_is_numeric (v2));
 219
 220   col = design_matrix_var_to_column (cov, v2);
 221   assert (val2 != NULL);
 222   tmp = gsl_matrix_get (cov->m, row, col);
 223   gsl_matrix_set (cov->m, row, col, (val2->f - mean) * x + tmp);
 224   gsl_matrix_set (cov->m, col, row, (val2->f - mean) * x + tmp);
 225 }
 226 static void
 227 column_iterate (struct design_matrix *cov, const struct variable *v,
 228                 double ssize, double x, const union value *val1, size_t row)
 229 {
 230   size_t col;
 231   size_t i;
 232   double y;
 233   double tmp;
 234   const union value *tmp_val;
 235
 236   col = design_matrix_var_to_column (cov, v);
 237   for (i = 0; i < cat_get_n_categories (v) - 1; i++)
 238     {
 239       col += i;
 240       y = -1.0 * cat_get_category_count (i, v) / ssize;
 241       tmp_val = cat_subscript_to_value (i, v);
 242       if (!compare_values_short (tmp_val, val1, v))
 243         {
 244           y += -1.0;
 245         }
 246       tmp = gsl_matrix_get (cov->m, row, col);
 247       gsl_matrix_set (cov->m, row, col, x * y + tmp);
 248       gsl_matrix_set (cov->m, col, row, x * y + tmp);
 249     }
 250 }
 251
 252 /*
 253   Call this function in the second data pass. The central moments are
 254   MEAN1 and MEAN2. Any categorical variables should already have their
 255   values summarized in in its OBS_VALS element.
 256  */
 257 void
 258 covariance_pass_two (struct design_matrix *cov, double mean1, double mean2,
 259                      double ssize, const struct variable *v1,
 260                      const struct variable *v2, const union value *val1,
 261                      const union value *val2)
 262 {
 263   size_t row;
 264   size_t col;
 265   size_t i;
 266   double x;
 267   const union value *tmp_val;
 268
 269   if (var_is_alpha (v1))
 270     {
 271       row = design_matrix_var_to_column (cov, v1);
 272       for (i = 0; i < cat_get_n_categories (v1) - 1; i++)
 273         {
 274           row += i;
 275           x = -1.0 * cat_get_category_count (i, v1) / ssize;
 276           tmp_val = cat_subscript_to_value (i, v1);
 277           if (!compare_values_short (tmp_val, val1, v1))
 278             {
 279               x += 1.0;
 280             }
 281           if (var_is_numeric (v2))
 282             {
 283               covariance_update_categorical_numeric (cov, mean2, row,
 284                                                      v2, x, val2);
 285             }
 286           else
 287             {
 288               column_iterate (cov, v1, ssize, x, val1, row);
 289               column_iterate (cov, v2, ssize, x, val2, row);
 290             }
 291         }
 292     }
 293   else if (var_is_alpha (v2))
 294     {
 295       /*
 296          Reverse the orders of V1, V2, etc. and put ourselves back
 297          in the previous IF scope.
 298        */
 299       covariance_pass_two (cov, mean2, mean1, ssize, v2, v1, val2, val1);
 300     }
 301   else
 302     {
 303       /*
 304          Both variables are numeric.
 305        */
 306       row = design_matrix_var_to_column (cov, v1);
 307       col = design_matrix_var_to_column (cov, v2);
 308       x = (val1->f - mean1) * (val2->f - mean2);
 309       x += gsl_matrix_get (cov->m, col, row);
 310       gsl_matrix_set (cov->m, row, col, x);
 311       gsl_matrix_set (cov->m, col, row, x);
 312     }
 313 }
 314
 315 static unsigned int
 316 covariance_accumulator_hash (const void *h, const void *aux)
 317 {
 318   struct covariance_accumulator *ca = (struct covariance_accumulator *) h;
 319   size_t *n_vars = (size_t *) aux;
 320   size_t idx_max;
 321   size_t idx_min;
 322   const struct variable *v_min;
 323   const struct variable *v_max;
 324   const union value *val_min;
 325   const union value *val_max;
 326
 327   /*
 328      Order everything by the variables' indices. This ensures we get the
 329      same key regardless of the order in which the variables are stored
 330      and passed around.
 331    */
 332   v_min =
 333     (var_get_dict_index (ca->v1) <
 334      var_get_dict_index (ca->v2)) ? ca->v1 : ca->v2;
 335   v_max = (ca->v1 == v_min) ? ca->v2 : ca->v1;
 336
 337   val_min = (v_min == ca->v1) ? ca->val1 : ca->val2;
 338   val_max = (ca->val1 == val_min) ? ca->val2 : ca->val1;
 339
 340   idx_min = var_get_dict_index (v_min);
 341   idx_max = var_get_dict_index (v_max);
 342
 343   if (var_is_numeric (v_max) && var_is_numeric (v_min))
 344     {
 345       return (*n_vars * idx_max + idx_min);
 346     }
 347   if (var_is_numeric (v_max) && var_is_alpha (v_min))
 348     {
 349       return hash_numeric_alpha (v_max, v_min, val_min, *n_vars);
 350     }
 351   if (var_is_alpha (v_max) && var_is_numeric (v_min))
 352     {
 353       return (hash_numeric_alpha (v_min, v_max, val_max, *n_vars));
 354     }
 355   if (var_is_alpha (v_max) && var_is_alpha (v_min))
 356     {
 357       unsigned tmp = hsh_hash_bytes (val_max, var_get_width (v_max));
 358       tmp ^= hsh_hash_bytes (val_min, var_get_width (v_min));
 359       tmp += *n_vars * (*n_vars + 1 + idx_max) + idx_min;
 360       return (size_t) tmp;
 361     }
 362   return -1u;
 363 }
 364
 365 /*
 366   Make a hash table consisting of struct covariance_accumulators.
 367   This allows the accumulation of the elements of a covariance matrix
 368   in a single data pass. Call covariance_accumulate () for each case
 369   in the data.
 370  */
 371 static struct hsh_table *
 372 covariance_hsh_create (size_t *n_vars)
 373 {
 374   return hsh_create (*n_vars * *n_vars, covariance_accumulator_compare,
 375                      covariance_accumulator_hash, covariance_accumulator_free,
 376                      n_vars);
 377 }
 378
 379 static void
 380 covariance_accumulator_free (void *c_, const void *aux UNUSED)
 381 {
 382   struct covariance_accumulator *c = c_;
 383   assert (c != NULL);
 384   free (c);
 385 }
 386
 387 /*
 388   Hash comparison. Returns 0 for a match, or a non-zero int
 389   otherwise. The sign of a non-zero return value *should* indicate the
 390   position of C relative to the covariance_accumulator described by
 391   the other arguments. But for now, it just returns 1 for any
 392   non-match.  This should be changed when someone figures out how to
 393   compute a sensible sign for the return value.
 394  */
 395 static int
 396 match_nodes (const struct covariance_accumulator *c,
 397              const struct variable *v1, const struct variable *v2,
 398              const union value *val1, const union value *val2)
 399 {
 400   if (var_get_dict_index (v1) == var_get_dict_index (c->v1))
 401     if (var_get_dict_index (v2) == var_get_dict_index (c->v2))
 402       {
 403         if (var_is_numeric (v1) && var_is_numeric (v2))
 404           {
 405             return 0;
 406           }
 407         if (var_is_numeric (v1) && var_is_alpha (v2))
 408           {
 409             if (!compare_values_short (val2, c->val2, v2))
 410               {
 411                 return 0;
 412               }
 413           }
 414         if (var_is_alpha (v1) && var_is_numeric (v2))
 415           {
 416             if (!compare_values_short (val1, c->val1, v1))
 417               {
 418                 return 0;
 419               }
 420           }
 421         if (var_is_alpha (v1) && var_is_alpha (v2))
 422           {
 423             if (!compare_values_short (val1, c->val1, v1))
 424               {
 425                 if (!compare_values_short (val2, c->val2, v2))
 426                   {
 427                     return 0;
 428                   }
 429               }
 430           }
 431       }
 432   return 1;
 433 }
 434
 435 /*
 436   This function is meant to be used as a comparison function for
 437   a struct hsh_table in src/libpspp/hash.c.
 438 */
 439 static int
 440 covariance_accumulator_compare (const void *a1_, const void *a2_,
 441                                 const void *aux UNUSED)
 442 {
 443   const struct covariance_accumulator *a1 = a1_;
 444   const struct covariance_accumulator *a2 = a2_;
 445
 446   if (a1 == NULL && a2 == NULL)
 447     return 0;
 448
 449   if (a1 == NULL || a2 == NULL)
 450     return 1;
 451
 452   return match_nodes (a1, a2->v1, a2->v2, a2->val1, a2->val2);
 453 }
 454
 455 static unsigned int
 456 hash_numeric_alpha (const struct variable *v1, const struct variable *v2,
 457                     const union value *val, size_t n_vars)
 458 {
 459   unsigned int result = -1u;
 460   if (var_is_numeric (v1) && var_is_alpha (v2))
 461     {
 462       result = n_vars * ((n_vars + 1) + var_get_dict_index (v1))
 463         + var_get_dict_index (v2) + hsh_hash_string (val->s);
 464     }
 465   else if (var_is_alpha (v1) && var_is_numeric (v2))
 466     {
 467       result = hash_numeric_alpha (v2, v1, val, n_vars);
 468     }
 469   return result;
 470 }
 471
 472
 473 static double
 474 update_product (const struct variable *v1, const struct variable *v2,
 475                 const union value *val1, const union value *val2)
 476 {
 477   assert (v1 != NULL);
 478   assert (v2 != NULL);
 479   assert (val1 != NULL);
 480   assert (val2 != NULL);
 481   if (var_is_alpha (v1) && var_is_alpha (v2))
 482     {
 483       return 1.0;
 484     }
 485   if (var_is_numeric (v1) && var_is_numeric (v2))
 486     {
 487       return (val1->f * val2->f);
 488     }
 489   if (var_is_numeric (v1) && var_is_alpha (v2))
 490     {
 491       return (val1->f);
 492     }
 493   if (var_is_numeric (v2) && var_is_alpha (v1))
 494     {
 495       update_product (v2, v1, val2, val1);
 496     }
 497   return 0.0;
 498 }
 499 static double
 500 update_sum (const struct variable *var, const union value *val, double weight)
 501 {
 502   assert (var != NULL);
 503   assert (val != NULL);
 504   if (var_is_alpha (var))
 505     {
 506       return weight;
 507     }
 508   return val->f;
 509 }
 510 static struct covariance_accumulator *
 511 get_new_covariance_accumulator (const struct variable *v1,
 512                                 const struct variable *v2,
 513                                 const union value *val1,
 514                                 const union value *val2)
 515 {
 516   if ((v1 != NULL) && (v2 != NULL) && (val1 != NULL) && (val2 != NULL))
 517     {
 518       struct covariance_accumulator *ca;
 519       ca = xmalloc (sizeof (*ca));
 520       ca->v1 = v1;
 521       ca->v2 = v2;
 522       ca->val1 = val1;
 523       ca->val2 = val2;
 524       return ca;
 525     }
 526   return NULL;
 527 }
 528
 529 static const struct variable **
 530 get_covariance_variables (const struct covariance_matrix *cov)
 531 {
 532   return cov->v_variables;
 533 }
 534
 535 static void
 536 update_hash_entry (struct hsh_table *c,
 537                    const struct variable *v1,
 538                    const struct variable *v2,
 539                    const union value *val1, const union value *val2,
 540                    const struct interaction_value *i_val1,
 541                    const struct interaction_value *i_val2)
 542 {
 543   struct covariance_accumulator *ca;
 544   struct covariance_accumulator *new_entry;
 545   double iv_f1;
 546   double iv_f2;
 547
 548   iv_f1 = interaction_value_get_nonzero_entry (i_val1);
 549   iv_f2 = interaction_value_get_nonzero_entry (i_val2);
 550   ca = get_new_covariance_accumulator (v1, v2, val1, val2);
 551   ca->dot_product = update_product (ca->v1, ca->v2, ca->val1, ca->val2);
 552   ca->dot_product *= iv_f1 * iv_f2;
 553   ca->sum1 = update_sum (ca->v1, ca->val1, iv_f1);
 554   ca->sum2 = update_sum (ca->v2, ca->val2, iv_f2);
 555   ca->ssize = 1.0;
 556   new_entry = hsh_insert (c, ca);
 557
 558   if (new_entry != NULL)
 559     {
 560       new_entry->dot_product += ca->dot_product;
 561       new_entry->ssize += 1.0;
 562       new_entry->sum1 += ca->sum1;
 563       new_entry->sum2 += ca->sum2;
 564       /*
 565         If DOT_PRODUCT is null, CA was not already in the hash
 566         hable, so we don't free it because it was just inserted.
 567         If DOT_PRODUCT was not null, CA is already in the hash table.
 568         Unnecessary now, it must be freed here.
 569       */
 570       free (ca);
 571     }
 572 }
 573
 574 /*
 575   Compute the covariance matrix in a single data-pass. Cases with
 576   missing values are dropped pairwise, in other words, only if one of
 577   the two values necessary to accumulate the inner product is missing.
 578
 579   Do not call this function directly. Call it through the struct
 580   covariance_matrix ACCUMULATE member function, for example,
 581   cov->accumulate (cov, ccase).
 582  */
 583 static void
 584 covariance_accumulate_pairwise (struct covariance_matrix *cov,
 585                                 const struct ccase *ccase,
 586                                 const struct interaction_variable **i_var,
 587                                 size_t n_intr)
 588 {
 589   size_t i;
 590   size_t j;
 591   const union value *val1;
 592   const union value *val2;
 593   const struct variable **v_variables;
 594   struct interaction_value *i_val1 = NULL;
 595   struct interaction_value *i_val2 = NULL;
 596
 597   assert (cov != NULL);
 598   assert (ccase != NULL);
 599
 600   v_variables = get_covariance_variables (cov);
 601   assert (v_variables != NULL);
 602
 603   for (i = 0; i < cov->n_variables; ++i)
 604     {
 605       if (is_interaction (v_variables[i], i_var, n_intr))
 606         {
 607           i_val1 = interaction_case_data (ccase, v_variables[i], i_var, n_intr);
 608           val1 = interaction_value_get (i_val1);
 609         }
 610       else
 611         {
 612           val1 = case_data (ccase, v_variables[i]);
 613         }
 614       if (!var_is_value_missing (v_variables[i], val1, cov->missing_value))
 615         {
 616           cat_value_update (v_variables[i], val1);
 617           if (var_is_numeric (v_variables[i]))
 618             cov->update_moments (cov, i, val1->f);
 619
 620           for (j = i; j < cov->n_variables; j++)
 621             {
 622               if (is_interaction (v_variables[j], i_var, n_intr))
 623                 {
 624                   i_val2 = interaction_case_data (ccase, v_variables[j], i_var, n_intr);
 625                   val2 = interaction_value_get (i_val2);
 626                 }
 627               else
 628                 {
 629                   val2 = case_data (ccase, v_variables[j]);
 630                 }
 631               if (!var_is_value_missing
 632                   (v_variables[j], val2, cov->missing_value))
 633                 {
 634                   update_hash_entry (cov->ca, v_variables[i], v_variables[j],
 635                                      val1, val2, i_val1, i_val2);
 636                   if (j != i)
 637                     update_hash_entry (cov->ca, v_variables[j],
 638                                        v_variables[i], val2, val1, i_val2, i_val1);
 639                 }
 640             }
 641         }
 642     }
 643 }
 644
 645 /*
 646   Compute the covariance matrix in a single data-pass. Cases with
 647   missing values are dropped listwise. In other words, if one of the
 648   values for any variable in a case is missing, the entire case is
 649   skipped.
 650
 651   The caller must use a casefilter to remove the cases with missing
 652   values before calling covariance_accumulate_listwise. This function
 653   assumes that CCASE has already passed through this filter, and
 654   contains no missing values.
 655
 656   Do not call this function directly. Call it through the struct
 657   covariance_matrix ACCUMULATE member function, for example,
 658   cov->accumulate (cov, ccase).
 659  */
 660 static void
 661 covariance_accumulate_listwise (struct covariance_matrix *cov,
 662                                 const struct ccase *ccase,
 663                                 const struct interaction_variable **i_var,
 664                                 size_t n_intr)
 665 {
 666   size_t i;
 667   size_t j;
 668   const union value *val1;
 669   const union value *val2;
 670   const struct variable **v_variables;
 671   struct interaction_value *i_val1 = NULL;
 672   struct interaction_value *i_val2 = NULL;
 673
 674   assert (cov != NULL);
 675   assert (ccase != NULL);
 676
 677   v_variables = get_covariance_variables (cov);
 678   assert (v_variables != NULL);
 679
 680   for (i = 0; i < cov->n_variables; ++i)
 681     {
 682       if (is_interaction (v_variables[i], i_var, n_intr))
 683         {
 684           i_val1 = interaction_case_data (ccase, v_variables[i], i_var, n_intr);
 685           val1 = interaction_value_get (i_val1);
 686         }
 687       else
 688         {
 689           val1 = case_data (ccase, v_variables[i]);
 690         }
 691       cat_value_update (v_variables[i], val1);
 692       if (var_is_numeric (v_variables[i]))
 693         cov->update_moments (cov, i, val1->f);
 694
 695       for (j = i; j < cov->n_variables; j++)
 696         {
 697           if (is_interaction (v_variables[j], i_var, n_intr))
 698             {
 699               i_val2 = interaction_case_data (ccase, v_variables[j], i_var, n_intr);
 700               val2 = interaction_value_get (i_val2);
 701             }
 702           else
 703             {
 704               val2 = case_data (ccase, v_variables[j]);
 705             }
 706           update_hash_entry (cov->ca, v_variables[i], v_variables[j],
 707                              val1, val2, i_val1, i_val2);
 708           if (j != i)
 709             update_hash_entry (cov->ca, v_variables[j], v_variables[i],
 710                                val2, val1, i_val2, i_val1);
 711         }
 712     }
 713 }
 714
 715 /*
 716   Call this function during the data pass. Each case will be added to
 717   a hash containing all values of the covariance matrix. After the
 718   data have been passed, call covariance_matrix_compute to put the
 719   values in the struct covariance_matrix.
 720  */
 721 void
 722 covariance_matrix_accumulate (struct covariance_matrix *cov,
 723                               const struct ccase *ccase, void **aux, size_t n_intr)
 724 {
 725   cov->accumulate (cov, ccase, (const struct interaction_variable **) aux, n_intr);
 726 }
 727 /*
 728   If VAR is categorical with d categories, its first category should
 729   correspond to the origin in d-dimensional Euclidean space.
 730  */
 731 static bool
 732 is_origin (const struct variable *var, const union value *val)
 733 {
 734   if (cat_value_find (var, val) == 0)
 735     {
 736       return true;
 737     }
 738   return false;
 739 }
 740
 741 /*
 742   Return the subscript of the column of the design matrix
 743   corresponding to VAL. If VAR is categorical with d categories, its
 744   first category should correspond to the origin in d-dimensional
 745   Euclidean space, so there is no subscript for this value.
 746  */
 747 static size_t
 748 get_exact_subscript (const struct design_matrix *dm, const struct variable *var,
 749                      const union value *val)
 750 {
 751   size_t result;
 752
 753   if (is_origin (var, val))
 754     {
 755       return -1u;
 756     }
 757
 758   result = design_matrix_var_to_column (dm, var);
 759   if (var_is_alpha (var))
 760     {
 761       result += cat_value_find (var, val) - 1;
 762     }
 763   return result;
 764 }
 765
 766 static void
 767 covariance_matrix_insert (struct design_matrix *cov,
 768                           const struct variable *v1,
 769                           const struct variable *v2, const union value *val1,
 770                           const union value *val2, double product)
 771 {
 772   size_t row;
 773   size_t col;
 774
 775   assert (cov != NULL);
 776
 777   row = get_exact_subscript (cov, v1, val1);
 778   col = get_exact_subscript (cov, v2, val2);
 779   if (row != -1u && col != -1u)
 780     {
 781       gsl_matrix_set (cov->m, row, col, product);
 782     }
 783 }
 784
 785
 786 static bool
 787 is_covariance_contributor (const struct covariance_accumulator *ca, const struct design_matrix *dm,
 788                            size_t i, size_t j)
 789 {
 790   size_t k;
 791   const struct variable *v1;
 792   const struct variable *v2;
 793
 794   assert (dm != NULL);
 795   v1 = design_matrix_col_to_var (dm, i);
 796   if (var_get_dict_index (v1) == var_get_dict_index(ca->v1))
 797     {
 798       v2 = design_matrix_col_to_var (dm, j);
 799       if (var_get_dict_index (v2) == var_get_dict_index (ca->v2))
 800         {
 801           k = get_exact_subscript (dm, v1, ca->val1);
 802           if (k == i)
 803             {
 804               k = get_exact_subscript (dm, v2, ca->val2);
 805               if (k == j)
 806                 {
 807                   return true;
 808                 }
 809             }
 810         }
 811     }
 812   return false;
 813 }
 814 static void
 815 update_ssize (struct design_matrix *dm, size_t i, size_t j, struct covariance_accumulator *ca)
 816 {
 817   struct variable *var;
 818   double tmp;
 819   var = design_matrix_col_to_var (dm, i);
 820   if (var_get_dict_index (ca->v1) == var_get_dict_index (var))
 821     {
 822       var = design_matrix_col_to_var (dm, j);
 823       if (var_get_dict_index (ca->v2) == var_get_dict_index (var))
 824         {
 825           tmp = gsl_matrix_get (dm->m, i, j);
 826           tmp += ca->ssize;
 827           gsl_matrix_set (dm->m, i, j, tmp);
 828         }
 829     }
 830 }
 831 static void
 832 covariance_accumulator_to_matrix (struct covariance_matrix *cov)
 833 {
 834   size_t i;
 835   size_t j;
 836   double tmp;
 837   struct covariance_accumulator *entry;
 838   struct hsh_iterator iter;
 839
 840   cov->cov = covariance_matrix_create (cov->n_variables, cov->v_variables);
 841   cov->ssize = covariance_matrix_create (cov->n_variables, cov->v_variables);
 842   cov->means = covariance_matrix_create (cov->n_variables, cov->v_variables);
 843   for (i = 0; i < design_matrix_get_n_cols (cov->cov); i++)
 844     {
 845       for (j = i; j < design_matrix_get_n_cols (cov->cov); j++)
 846         {
 847           entry = hsh_first (cov->ca, &iter);
 848
 849           while (entry != NULL)
 850             {
 851               update_ssize (cov->ssize, i, j, entry);
 852
 853               /*
 854                 We compute the centered, un-normalized covariance matrix.
 855               */
 856               if (is_covariance_contributor (entry, cov->cov, i, j))
 857                 {
 858                   covariance_matrix_insert (cov->cov, entry->v1, entry->v2, entry->val1,
 859                                             entry->val2, entry->dot_product);
 860                   covariance_matrix_insert (cov->cov, entry->v1, entry->v2, entry->val1,
 861                                             entry->val2, entry->sum1 * entry->sum2);
 862                 }
 863               entry = hsh_next (cov->ca, &iter);
 864             }
 865           tmp = gsl_matrix_get (cov->cov->m, i, j);
 866           tmp -= gsl_matrix_get (cov->means->m, i, j) / gsl_matrix_get (cov->ssize->m, i, j);
 867           gsl_matrix_set (cov->cov->m, i, j, tmp);
 868         }
 869     }
 870 }
 871
 872
 873 /*
 874   Call this function after passing the data.
 875  */
 876 void
 877 covariance_matrix_compute (struct covariance_matrix *cov)
 878 {
 879   if (cov->n_pass == ONE_PASS)
 880     {
 881       covariance_accumulator_to_matrix (cov);
 882     }
 883 }
 884
 885 struct design_matrix *
 886 covariance_to_design (const struct covariance_matrix *c)
 887 {
 888   if (c != NULL)
 889     {
 890       return c->cov;
 891     }
 892   return NULL;
 893 }