Constness
[pspp] / src / math / covariance.c
index d63159b96d5c3244b85ccd51436170b7e20ec5e9..f0161a54c529c59b187d840611e3cde134d45852 100644 (file)
@@ -68,7 +68,7 @@ struct covariance
 {
   /* The variables for which the covariance matrix is to be calculated. */
   size_t n_vars;
-  const struct variable **vars;
+  const struct variable *const *vars;
 
   /* Categorical variables. */
   struct categoricals *categoricals;
@@ -131,11 +131,11 @@ covariance_moments (const struct covariance *cov, int m)
 /* Create a covariance struct.
  */
 struct covariance *
-covariance_1pass_create (size_t n_vars, const struct variable **vars,
+covariance_1pass_create (size_t n_vars, const struct variable *const *vars,
                         const struct variable *weight, enum mv_class exclude)
 {
   size_t i;
-  struct covariance *cov = xmalloc (sizeof *cov);
+  struct covariance *cov = xzalloc (sizeof *cov);
 
   cov->passes = 1;
   cov->state = 0;
@@ -156,7 +156,9 @@ covariance_1pass_create (size_t n_vars, const struct variable **vars,
 
   cov->n_cm = (n_vars * (n_vars - 1)  ) / 2;
 
-  cov->cm = xcalloc (sizeof *cov->cm, cov->n_cm);
+  if (cov->n_cm > 0)
+    cov->cm = xcalloc (sizeof *cov->cm, cov->n_cm);
+  cov->categoricals = NULL;
 
   return cov;
 }
@@ -168,8 +170,8 @@ covariance_1pass_create (size_t n_vars, const struct variable **vars,
   until then.
  */
 struct covariance *
-covariance_2pass_create (size_t n_vars, const struct variable **vars,
-                        size_t n_catvars, const struct variable **catvars, 
+covariance_2pass_create (size_t n_vars, const struct variable *const *vars,
+                        size_t n_catvars, const struct variable *const *catvars, 
                         const struct variable *wv, enum mv_class exclude)
 {
   size_t i;
@@ -192,10 +194,10 @@ covariance_2pass_create (size_t n_vars, const struct variable **vars,
 
   cov->exclude = exclude;
 
-  cov->n_cm = - 1;
+  cov->n_cm = -1;
   cov->cm = NULL;
 
-  cov->categoricals = categoricals_create (catvars, n_catvars, wv);
+  cov->categoricals = categoricals_create (catvars, n_catvars, wv, exclude);
 
   return cov;
 }
@@ -232,7 +234,41 @@ cm_idx (const struct covariance *cov, int i, int j)
   return i - 1 + as;
 }
 
-static void
+
+/*
+  Returns true iff the variable corresponding to the Ith element of the covariance matrix 
+   has a missing value for case C
+*/
+static bool
+is_missing (const struct covariance *cov, int i, const struct ccase *c)
+{
+  const struct variable *var = i < cov->n_vars ?
+    cov->vars[i] : 
+    categoricals_get_variable_by_subscript (cov->categoricals, i - cov->n_vars);
+
+  const union value *val = case_data (c, var);
+
+  return var_is_value_missing (var, val, cov->exclude);
+}
+
+
+static double
+get_val (const struct covariance *cov, int i, const struct ccase *c)
+{
+  if ( i < cov->n_vars)
+    {
+      const struct variable *var = cov->vars[i];
+
+      const union value *val = case_data (c, var);
+
+      return val->f;
+    }
+
+  return categoricals_get_binary_by_subscript (cov->categoricals, i - cov->n_vars, c);
+}
+
+#if 0
+void
 dump_matrix (const gsl_matrix *m)
 {
   size_t i, j;
@@ -244,6 +280,7 @@ dump_matrix (const gsl_matrix *m)
       printf ("\n");
     }
 }
+#endif
 
 /* Call this function for every case in the data set */
 void
@@ -263,17 +300,16 @@ covariance_accumulate_pass1 (struct covariance *cov, const struct ccase *c)
 
   for (i = 0 ; i < cov->dim; ++i)
     {
-      const union value *val1 = case_data (c, cov->vars[i]);
+      double v1 = get_val (cov, i, c);
 
-      if ( var_is_value_missing (cov->vars[i], val1, cov->exclude))
+      if ( is_missing (cov, i, c))
        continue;
 
       for (j = 0 ; j < cov->dim; ++j)
        {
          double pwr = 1.0;
-         const union value *val2 = case_data (c, cov->vars[j]);
 
-         if ( var_is_value_missing (cov->vars[j], val2, cov->exclude))
+         if ( is_missing (cov, j, c))
            continue;
 
          for (m = 0 ; m <= MOMENT_MEAN; ++m)
@@ -281,7 +317,7 @@ covariance_accumulate_pass1 (struct covariance *cov, const struct ccase *c)
              double *x = gsl_matrix_ptr (cov->moments[m], i, j);
 
              *x += pwr * weight;
-             pwr *= val1->f;
+             pwr *= v1;
            }
        }
     }
@@ -302,10 +338,13 @@ covariance_accumulate_pass2 (struct covariance *cov, const struct ccase *c)
 
   if (! cov->pass_two_first_case_seen)
     {
+      size_t m;
       assert (cov->state == 1);
       cov->state = 2;
 
-      cov->dim = cov->n_vars + categoricals_total (cov->categoricals);
+      cov->dim = cov->n_vars +
+       categoricals_total (cov->categoricals) - categoricals_get_n_variables (cov->categoricals);
+
       cov->n_cm = (cov->dim * (cov->dim - 1)  ) / 2;
       cov->cm = xcalloc (sizeof *cov->cm, cov->n_cm);
 
@@ -316,10 +355,41 @@ covariance_accumulate_pass2 (struct covariance *cov, const struct ccase *c)
          cov->moments[i] = resize_matrix (cov->moments[i], cov->dim);
        }
 
+      categoricals_done (cov->categoricals);
+
+      /* Populate the moments matrices with the categorical value elements */
+      for (i = cov->n_vars; i < cov->dim; ++i)
+       {
+         for (j = 0 ; j < cov->dim ; ++j) /* FIXME: This is WRONG !!! */
+           {
+             double w = categoricals_get_weight_by_subscript (cov->categoricals, i - cov->n_vars);
+
+             gsl_matrix_set (cov->moments[MOMENT_NONE], i, j, w);
+
+             w = categoricals_get_sum_by_subscript (cov->categoricals, i - cov->n_vars);
+
+             gsl_matrix_set (cov->moments[MOMENT_MEAN], i, j, w);
+           }
+       }
+
+      /* FIXME: This is WRONG!!  It must be fixed to properly handle missing values.  For
+       now it assumes there are none */
+      for (m = 0 ; m < n_MOMENTS; ++m)
+       {
+         for (i = 0 ; i < cov->dim ; ++i)
+           {
+             double x = gsl_matrix_get (cov->moments[m], i, cov->n_vars -1);
+             for (j = cov->n_vars; j < cov->dim; ++j)
+               {
+                 gsl_matrix_set (cov->moments[m], i, j, x);
+               }
+           }
+       }
+
       /* Divide the means by the number of samples */
-      for (i = 0; i < cov->n_vars; ++i)
+      for (i = 0; i < cov->dim; ++i)
        {
-         for (j = 0; j < cov->n_vars; ++j)
+         for (j = 0; j < cov->dim; ++j)
            {
              double *x = gsl_matrix_ptr (cov->moments[MOMENT_MEAN], i, j);
              *x /= gsl_matrix_get (cov->moments[MOMENT_NONE], i, j);
@@ -329,20 +399,20 @@ covariance_accumulate_pass2 (struct covariance *cov, const struct ccase *c)
 
   for (i = 0 ; i < cov->dim; ++i)
     {
-      const union value *val1 = case_data (c, cov->vars[i]);
+      double v1 = get_val (cov, i, c);
 
-      if ( var_is_value_missing (cov->vars[i], val1, cov->exclude))
+      if ( is_missing (cov, i, c))
        continue;
 
       for (j = 0 ; j < cov->dim; ++j)
        {
          int idx;
          double ss ;
-         const union value *val2 = case_data (c, cov->vars[j]);
+         double v2 = get_val (cov, j, c);
 
-         const double s = pow2 (val1->f - gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j)) * weight;
+         const double s = pow2 (v1 - gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j)) * weight;
 
-         if ( var_is_value_missing (cov->vars[j], val2, cov->exclude))
+         if ( is_missing (cov, j, c))
            continue;
 
          {
@@ -351,9 +421,9 @@ covariance_accumulate_pass2 (struct covariance *cov, const struct ccase *c)
          }
 
          ss = 
-           (val1->f - gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j))
+           (v1 - gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j))
            * 
-           (val2->f - gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j))
+           (v2 - gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j))
            * weight
            ;
 
@@ -362,7 +432,6 @@ covariance_accumulate_pass2 (struct covariance *cov, const struct ccase *c)
            {
              cov->cm [idx] += ss;
            }
-
        }
     }
 
@@ -391,7 +460,7 @@ covariance_accumulate (struct covariance *cov, const struct ccase *c)
     {
       const union value *val1 = case_data (c, cov->vars[i]);
 
-      if ( var_is_value_missing (cov->vars[i], val1, cov->exclude))
+      if ( is_missing (cov, i, c))
        continue;
 
       for (j = 0 ; j < cov->dim; ++j)
@@ -400,7 +469,7 @@ covariance_accumulate (struct covariance *cov, const struct ccase *c)
          int idx;
          const union value *val2 = case_data (c, cov->vars[j]);
 
-         if ( var_is_value_missing (cov->vars[j], val2, cov->exclude))
+         if ( is_missing (cov, j, c))
            continue;
 
          idx = cm_idx (cov, i, j);
@@ -524,7 +593,6 @@ covariance_calculate_single_pass (struct covariance *cov)
 }
 
 
-
 /* 
    Return a pointer to gsl_matrix containing the pairwise covariances.
    The matrix remains owned by the COV object, and must not be freed.
@@ -533,7 +601,8 @@ covariance_calculate_single_pass (struct covariance *cov)
 const gsl_matrix *
 covariance_calculate (struct covariance *cov)
 {
-  assert ( cov->state > 0 );
+  if ( cov->state <= 0 )
+    return NULL;
 
   switch (cov->passes)
     {
@@ -548,7 +617,95 @@ covariance_calculate (struct covariance *cov)
     }
 }
 
+/*
+  Covariance computed without dividing by the sample size.
+ */
+static const gsl_matrix *
+covariance_calculate_double_pass_unnormalized (struct covariance *cov)
+{
+  size_t i, j;
+  for (i = 0 ; i < cov->dim; ++i)
+    {
+      for (j = 0 ; j < cov->dim; ++j)
+       {
+         int idx;
+         double *x = gsl_matrix_ptr (cov->moments[MOMENT_VARIANCE], i, j);
 
+         idx = cm_idx (cov, i, j);
+         if ( idx >= 0)
+           {
+             x = &cov->cm [idx];
+           }
+       }
+    }
+
+  return  cm_to_gsl (cov);
+}
+
+static const gsl_matrix *
+covariance_calculate_single_pass_unnormalized (struct covariance *cov)
+{
+  size_t i, j;
+
+  for (i = 0 ; i < cov->dim; ++i)
+    {
+      for (j = 0 ; j < cov->dim; ++j)
+       {
+         double *x = gsl_matrix_ptr (cov->moments[MOMENT_VARIANCE], i, j);
+         *x -= pow2 (gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j))
+           / gsl_matrix_get (cov->moments[MOMENT_NONE], i, j);
+       }
+    }
+  for ( j = 0 ; j < cov->dim - 1; ++j)
+    {
+      for (i = j + 1 ; i < cov->dim; ++i)
+       {
+         double *x = &cov->cm [cm_idx (cov, i, j)];
+         
+         *x -=
+           gsl_matrix_get (cov->moments[MOMENT_MEAN], i, j) 
+           *
+           gsl_matrix_get (cov->moments[MOMENT_MEAN], j, i) 
+         / gsl_matrix_get (cov->moments[MOMENT_NONE], i, j);
+       }
+    }
+
+  return cm_to_gsl (cov);
+}
+
+
+/* 
+   Return a pointer to gsl_matrix containing the pairwise covariances.
+   The matrix remains owned by the COV object, and must not be freed.
+   Call this function only after all data have been accumulated.
+*/
+const gsl_matrix *
+covariance_calculate_unnormalized (struct covariance *cov)
+{
+  if ( cov->state <= 0 )
+    return NULL;
+
+  switch (cov->passes)
+    {
+    case 1:
+      return covariance_calculate_single_pass_unnormalized (cov);  
+      break;
+    case 2:
+      return covariance_calculate_double_pass_unnormalized (cov);  
+      break;
+    default:
+      NOT_REACHED ();
+    }
+}
+
+/* Function to access the categoricals used by COV
+   The return value is owned by the COV
+*/
+const struct categoricals *
+covariance_get_categoricals (const struct covariance *cov)
+{
+  return cov->categoricals;
+}
 
 
 /* Destroy the COV object */
@@ -556,7 +713,7 @@ void
 covariance_destroy (struct covariance *cov)
 {
   size_t i;
-  free (cov->vars);
+
   categoricals_destroy (cov->categoricals);
 
   for (i = 0; i < n_MOMENTS; ++i)