src/math/interaction.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 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   An interaction is a gsl_vector containing a "product" of other
  19   variables. The variables can be either categorical or numeric.
  20   If the variables are all numeric, the interaction is just the
  21   scalar product. If any of the variables are categorical, their
  22   product is a vector containing 0's in all but one entry. This entry
  23   is found by combining the vectors corresponding to the variables'
  24   OBS_VALS member. If there are K categorical variables, each with
  25   N_1, N_2, ..., N_K categories, then the interaction will have
  26   N_1 * N_2 * N_3 *...* N_K - 1 entries.
  27
  28   When using these functions, make sure the orders of variables and
  29   values match when appropriate.
  30  */
  31
  32 #include <config.h>
  33 #include <assert.h>
  34 #include <gsl/gsl_math.h>
  35 #include <gsl/gsl_vector.h>
  36 #include <data/value.h>
  37 #include <data/variable.h>
  38 #include <math/interaction.h>
  39 #include <string.h>
  40 #include <xalloc.h>
  41
  42 struct interaction_variable
  43 {
  44   int n_vars;
  45   const struct variable **members;
  46   struct variable *intr;
  47   size_t n_alpha;
  48 };
  49
  50 struct interaction_value
  51 {
  52   const struct interaction_variable *intr;
  53   union value val; /* Concatenation of the string values in this
  54                       interaction's value, or the product of a bunch
  55                       of numeric values for a purely numeric
  56                       interaction.
  57                     */
  58   double f; /* Product of the numerical values in this interaction's value. */
  59 };
  60
  61 /*
  62   An interaction_variable has type alpha if any of members have type
  63   alpha. Otherwise, its type is numeric.
  64  */
  65 struct interaction_variable *
  66 interaction_variable_create (const struct variable **vars, int n_vars)
  67 {
  68   struct interaction_variable *result = NULL;
  69   size_t i;
  70
  71   if (n_vars > 0)
  72     {
  73       int width = 0;
  74
  75       result = xmalloc (sizeof (*result));
  76       result->n_alpha = 0;
  77       result->members = xnmalloc (n_vars, sizeof (*result->members));
  78       result->n_vars = n_vars;
  79       for (i = 0; i < n_vars; i++)
  80         {
  81           result->members[i] = vars[i];
  82           if (var_is_alpha (vars[i]))
  83             {
  84               result->n_alpha++;
  85               width += var_get_width (vars[i]);
  86             }
  87         }
  88       result->intr = var_create_internal (0, width);
  89     }
  90
  91   return result;
  92 }
  93 void interaction_variable_destroy (struct interaction_variable *iv)
  94 {
  95   var_destroy (iv->intr);
  96   free (iv->members);
  97   free (iv);
  98 }
  99
 100 /*
 101   Get one of the member variables.
 102  */
 103 const struct variable *
 104 interaction_get_member (const struct interaction_variable *iv, size_t i)
 105 {
 106   return iv->members[i];
 107 }
 108
 109 size_t
 110 interaction_get_n_vars (const struct interaction_variable *iv)
 111 {
 112   return (iv == NULL) ? 0 : iv->n_vars;
 113 }
 114
 115 size_t
 116 interaction_get_n_alpha (const struct interaction_variable *iv)
 117 {
 118   return iv->n_alpha;
 119 }
 120
 121 size_t
 122 interaction_get_n_numeric (const struct interaction_variable *iv)
 123 {
 124   return (interaction_get_n_vars (iv) - interaction_get_n_alpha (iv));
 125 }
 126
 127 /*
 128   Get the interaction variable itself.
 129  */
 130 const struct variable *
 131 interaction_get_variable (const struct interaction_variable *iv)
 132 {
 133   return iv->intr;
 134 }
 135 /*
 136   Given list of values, compute the value of the corresponding
 137   interaction.  This "value" is not stored as the typical vector of
 138   0's and one double, but rather the string values are concatenated to
 139   make one big string value, and the numerical values are multiplied
 140   together to give the non-zero entry of the corresponding vector.
 141  */
 142 struct interaction_value *
 143 interaction_value_create (const struct interaction_variable *var, const union value **vals)
 144 {
 145   struct interaction_value *result = NULL;
 146   const struct variable *member;
 147   size_t i;
 148   size_t n_vars;
 149
 150   if (var != NULL)
 151     {
 152       int val_width = var_get_width (interaction_get_variable (var));
 153       int offset;
 154
 155       result = xmalloc (sizeof (*result));
 156       result->intr = var;
 157       n_vars = interaction_get_n_vars (var);
 158
 159       value_init (&result->val, val_width);
 160
 161       offset = 0;
 162       result->f = 1.0;
 163       for (i = 0; i < n_vars; i++)
 164         {
 165           member = interaction_get_member (var, i);
 166
 167           if (var_is_value_missing (member, vals[i], MV_ANY))
 168             {
 169               value_set_missing (&result->val, val_width);
 170               result->f = SYSMIS;
 171               break;
 172             }
 173           else
 174             {
 175               if (var_is_alpha (var->members[i]))
 176                 {
 177                   char *val = value_str_rw (&result->val, val_width);
 178                   int w = var_get_width (var->members[i]);
 179                   memcpy (val + offset, value_str (vals[i], w), w);
 180                   offset += w;
 181                 }
 182               else if (var_is_numeric (var->members[i]))
 183                 {
 184                   result->f *= vals[i]->f;
 185                 }
 186             }
 187         }
 188       if (interaction_get_n_alpha (var) == 0)
 189         {
 190           /*
 191             If there are no categorical variables, then the
 192             interaction consists of only numeric data. In this case,
 193             code that uses this interaction_value will see the union
 194             member as the numeric value. If we were to store that
 195             numeric value in result->f as well, the calling code may
 196             inadvertently square this value by multiplying by
 197             result->val->f. Such multiplication would be correct for an
 198             interaction consisting of both categorical and numeric
 199             data, but a mistake for purely numerical interactions. To
 200             avoid the error, we set result->f to 1.0 for numeric
 201             interactions.
 202            */
 203           result->val.f = result->f;
 204           result->f = 1.0;
 205         }
 206     }
 207   return result;
 208 }
 209
 210 const union value *
 211 interaction_value_get (const struct interaction_value *val)
 212 {
 213   return &val->val;
 214 }
 215
 216 /*
 217   Returns the numeric value of the non-zero entry for the vector
 218   corresponding to this interaction.  Do not use this function to get
 219   the numeric value of a purely numeric interaction. Instead, use the
 220   union value * returned by interaction_value_get.
 221  */
 222 double
 223 interaction_value_get_nonzero_entry (const struct interaction_value *val)
 224 {
 225   if (val != NULL)
 226     return val->f;
 227   return 1.0;
 228 }
 229
 230 void
 231 interaction_value_destroy (struct interaction_value *val)
 232 {
 233   if (val != NULL)
 234     {
 235       int val_width = var_get_width (interaction_get_variable (val->intr));
 236
 237       value_destroy (&val->val, val_width);
 238       free (val);
 239     }
 240 }
 241
 242 /*
 243   Return a value from a variable that is an interaction.
 244  */
 245 struct interaction_value *
 246 interaction_case_data (const struct ccase *ccase, const struct interaction_variable *iv)
 247 {
 248   size_t i;
 249   size_t n_vars;
 250   const struct variable *member;
 251   const union value **vals = NULL;
 252
 253   n_vars = interaction_get_n_vars (iv);
 254   vals = xnmalloc (n_vars, sizeof (*vals));
 255
 256   for (i = 0; i < n_vars; i++)
 257         {
 258           member = interaction_get_member (iv, i);
 259           vals[i] = case_data (ccase, member);
 260         }
 261
 262   return interaction_value_create (iv, vals);
 263 }
 264
 265 bool
 266 is_interaction (const struct variable *var, const struct interaction_variable **iv, size_t n_intr)
 267 {
 268   size_t i;
 269   const struct variable *intr;
 270
 271   for (i = 0; i < n_intr; i++)
 272     {
 273       intr = interaction_get_variable (iv[i]);
 274       if (var_get_dict_index (intr) == var_get_dict_index (var))
 275         {
 276           return true;
 277         }
 278     }
 279   return false;
 280 }
 281