src/math/covariance-matrix.c

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