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/variable.h>
  23 #include <data/value.h>
  24 #include "covariance-matrix.h"
  25 #include "moments.h"
  26
  27 /*
  28   The covariances are stored in a DESIGN_MATRIX structure.
  29  */
  30 struct design_matrix *
  31 covariance_matrix_create (int n_variables, const struct variable *v_variables[])
  32 {
  33   return design_matrix_create (n_variables, v_variables, (size_t) n_variables);
  34 }
  35
  36 void covariance_matrix_destroy (struct design_matrix *x)
  37 {
  38   design_matrix_destroy (x);
  39 }
  40
  41 /*
  42   Update the covariance matrix with the new entries, assuming that ROW
  43   corresponds to a categorical variable and V2 is numeric.
  44  */
  45 static void
  46 covariance_update_categorical_numeric (struct design_matrix *cov, double mean,
  47                           double weight, size_t row,
  48                           const struct variable *v2, double x, const union value *val2)
  49 {
  50   size_t col;
  51
  52   assert (var_is_numeric (v2));
  53
  54   col = design_matrix_var_to_column (cov, v2);
  55   assert (val2 != NULL);
  56   gsl_matrix_set (cov->m, row, col, (val2->f - mean) * x * weight);
  57 }
  58 static void
  59 column_iterate (struct design_matrix *cov, const struct variable *v, double weight,
  60                 double ssize, double x, const union value *val1, size_t row)
  61 {
  62   size_t col;
  63   size_t i;
  64   double y;
  65   union value *tmp_val;
  66
  67   col = design_matrix_var_to_column (cov, v);
  68   for (i = 0; i < cat_get_n_categories (v) - 1; i++)
  69     {
  70       col += i;
  71       y = -1.0 * cat_get_category_count (i, v) / ssize;
  72       tmp_val = cat_subscript_to_value (i, v);
  73       if (compare_values (tmp_val, val1, var_get_width (v)))
  74         {
  75           y += -1.0;
  76         }
  77       gsl_matrix_set (cov->m, row, col, x * y * weight);
  78       gsl_matrix_set (cov->m, col, row, x * y * weight);
  79     }
  80 }
  81 /*
  82   Call this function in the second data pass. The central moments are
  83   MEAN1 and MEAN2. Any categorical variables should already have their
  84   values summarized in in its OBS_VALS element.
  85  */
  86 void covariance_pass_two (struct design_matrix *cov, double mean1, double mean2,
  87                           double weight, double ssize, const struct variable *v1,
  88                           const struct variable *v2, const union value *val1, const union value *val2)
  89 {
  90   size_t row;
  91   size_t col;
  92   size_t i;
  93   double x;
  94   union value *tmp_val;
  95
  96   if (var_is_alpha (v1))
  97     {
  98       row = design_matrix_var_to_column (cov, v1);
  99       for (i = 0; i < cat_get_n_categories (v1) - 1; i++)
 100         {
 101           row += i;
 102           x = -1.0 * cat_get_category_count (i, v1) / ssize;
 103           tmp_val = cat_subscript_to_value (i, v1);
 104           if (compare_values (tmp_val, val1, var_get_width (v1)))
 105             {
 106               x += 1.0;
 107             }
 108           if (var_is_numeric (v2))
 109             {
 110               covariance_update_categorical_numeric (cov, mean2, weight, row,
 111                                                      v2, x, val2);
 112             }
 113           else
 114             {
 115               column_iterate (cov, v1, weight, ssize, x, val1, row);
 116               column_iterate (cov, v2, weight, ssize, x, val2, row);
 117             }
 118         }
 119     }
 120   else if (var_is_alpha (v2))
 121     {
 122       /*
 123         Reverse the orders of V1, V2, etc. and put ourselves back
 124         in the previous IF scope.
 125        */
 126       covariance_pass_two (cov, mean2, mean1, weight, ssize, v2, v1, val2, val1);
 127     }
 128   else
 129     {
 130       /*
 131         Both variables are numeric.
 132       */
 133       row = design_matrix_var_to_column (cov, v1);
 134       col = design_matrix_var_to_column (cov, v2);
 135       x = (val1->f - mean1) * (val2->f - mean2) * weight;
 136       gsl_matrix_set (cov->m, row, col, x);
 137       gsl_matrix_set (cov->m, col, row, x);
 138     }
 139 }
 140