src/math/linreg/coefficient.c

   1 /*
   2   lib/linreg/coefficient.c
   3
   4   Copyright (C) 2005 Free Software Foundation, Inc. Written by Jason H Stover.
   5
   6   This program is free software; you can redistribute it and/or modify it under
   7   the terms of the GNU General Public License as published by the Free
   8   Software Foundation; either version 2 of the License, or (at your option)
   9   any later version.
  10
  11   This program is distributed in the hope that it will be useful, but WITHOUT
  12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14   more details.
  15
  16   You should have received a copy of the GNU General Public License along with
  17   this program; if not, write to the Free Software Foundation, Inc., 51
  18   Franklin Street, Fifth Floor, Boston, MA 02111-1307, USA.
  19 */
  20
  21 /*
  22   Accessor functions for matching coefficients and variables.
  23  */
  24 #include <math/linreg/coefficient.h>
  25 #include <math/linreg/linreg.h>
  26 #include "src/math/design-matrix.h"
  27
  28 #include <gl/xalloc.h>
  29
  30
  31 struct varinfo
  32 {
  33   const struct variable *v;     /* Variable associated with this
  34                                    coefficient. Note this variable
  35                                    may not be unique. In other words,
  36                                    a coefficient structure may have
  37                                    other v_info's, each with its own
  38                                    variable. */
  39   const union value *val;       /* Value of the variable v which this varinfo
  40                                    refers to. This member is relevant only to
  41                                    categorical variables. */
  42 };
  43
  44 void
  45 pspp_linreg_coeff_free (struct pspp_linreg_coeff *c)
  46 {
  47   free (c);
  48 }
  49
  50 /*
  51   Initialize the variable and value pointers inside the
  52   coefficient structures for the linear model.
  53  */
  54 void
  55 pspp_linreg_coeff_init (pspp_linreg_cache * c, struct design_matrix *X)
  56 {
  57   size_t i;
  58   size_t j;
  59   int n_vals = 1;
  60   struct pspp_linreg_coeff *coeff;
  61
  62   c->coeff = xnmalloc (X->m->size2 + 1, sizeof (*c->coeff));
  63   c->coeff->v_info = NULL; /* Intercept has no associated variable. */
  64   for (i = 0; i < X->m->size2; i++)
  65     {
  66       j = i + 1;                /* The first coefficient is the intercept. */
  67       coeff = c->coeff + j;
  68       coeff->n_vars = n_vals;   /* Currently, no procedures allow
  69                                    interactions.  This line will have to
  70                                    change when procedures that allow
  71                                    interaction terms are written.
  72                                 */
  73       coeff->v_info = xnmalloc (coeff->n_vars, sizeof (*coeff->v_info));
  74       assert (coeff->v_info != NULL);
  75       coeff->v_info->v =
  76         (const struct variable *) design_matrix_col_to_var (X, i);
  77
  78       if (coeff->v_info->v->type == ALPHA)
  79         {
  80           size_t k;
  81           k = design_matrix_var_to_column (X, coeff->v_info->v);
  82           assert (k <= i);
  83           k = i - k;
  84           coeff->v_info->val =
  85             cat_subscript_to_value (k, (struct variable *) coeff->v_info->v);
  86         }
  87     }
  88 }
  89 void
  90 pspp_linreg_coeff_set_estimate (struct pspp_linreg_coeff *c, double estimate)
  91 {
  92   c->estimate = estimate;
  93 }
  94
  95 void
  96 pspp_linreg_coeff_set_std_err (struct pspp_linreg_coeff *c, double std_err)
  97 {
  98   c->std_err = std_err;
  99 }
 100
 101 /*
 102   Return the estimated value of the coefficient.
 103  */
 104 double
 105 pspp_linreg_coeff_get_est (const struct pspp_linreg_coeff *c)
 106 {
 107   if (c == NULL)
 108     {
 109       return 0.0;
 110     }
 111   return c->estimate;
 112 }
 113
 114 /*
 115   Return the standard error of the estimated coefficient.
 116 */
 117 double
 118 pspp_linreg_coeff_get_std_err (const struct pspp_linreg_coeff *c)
 119 {
 120   if (c == NULL)
 121     {
 122       return 0.0;
 123     }
 124   return c->std_err;
 125 }
 126
 127 /*
 128   How many variables are associated with this coefficient?
 129  */
 130 int
 131 pspp_linreg_coeff_get_n_vars (struct pspp_linreg_coeff *c)
 132 {
 133   if (c == NULL)
 134     {
 135       return 0;
 136     }
 137   return c->n_vars;
 138 }
 139
 140 /*
 141   Which variable does this coefficient match? I should be
 142   0 unless the coefficient refers to an interaction term.
 143  */
 144 const struct variable *
 145 pspp_linreg_coeff_get_var (struct pspp_linreg_coeff *c, int i)
 146 {
 147   if (c == NULL)
 148     {
 149       return NULL;
 150     }
 151   assert (i < c->n_vars);
 152   return (c->v_info + i)->v;
 153 }
 154
 155 /*
 156   Which value is associated with this coefficient/variable combination?
 157  */
 158 const union value *
 159 pspp_linreg_coeff_get_value (struct pspp_linreg_coeff *c,
 160                              const struct variable *v)
 161 {
 162   int i = 0;
 163   const struct variable *candidate;
 164
 165   if (c == NULL || v == NULL)
 166     {
 167       return NULL;
 168     }
 169   if (v->type == NUMERIC)
 170     {
 171       return NULL;
 172     }
 173   while (i < c->n_vars)
 174     {
 175       candidate = pspp_linreg_coeff_get_var (c, i);
 176       if (v->index == candidate->index)
 177         {
 178           return (c->v_info + i)->val;
 179         }
 180       i++;
 181     }
 182   return NULL;
 183 }
 184
 185 /*
 186   Which coefficient is associated with V? The VAL argument is relevant
 187   only to categorical variables.
 188  */
 189 const struct pspp_linreg_coeff *
 190 pspp_linreg_get_coeff (const pspp_linreg_cache * c,
 191                        const struct variable *v, const union value *val)
 192 {
 193   int i = 1;
 194   struct pspp_linreg_coeff *result = NULL;
 195   const struct variable *tmp = NULL;
 196
 197   if (c == NULL)
 198     {
 199       return NULL;
 200     }
 201   if (c->coeff == NULL || c->n_indeps == 0 || v == NULL)
 202     {
 203       return NULL;
 204     }
 205
 206   result = c->coeff + i;
 207   tmp = pspp_linreg_coeff_get_var (result, 0);
 208   while (tmp->index != v->index && i < c->n_coeffs)
 209     {
 210       result = c->coeff + i;
 211       tmp = pspp_linreg_coeff_get_var (result, 0);
 212       i++;
 213     }
 214   if (i > c->n_coeffs)
 215     {
 216       return NULL;
 217     }
 218   if (v->type == NUMERIC)
 219     {
 220       return result;
 221     }
 222   else if (val != NULL)
 223     {
 224       /*
 225          If v is categorical, we need to ensure the coefficient
 226          matches the VAL.
 227        */
 228       while (tmp->index != v->index && i < c->n_coeffs
 229              && compare_values (pspp_linreg_coeff_get_value (result, tmp),
 230                                 val, v->width))
 231         {                       /* FIX THIS */
 232           i++;
 233           result = c->coeff + i;
 234           tmp = pspp_linreg_coeff_get_var (result, 0);
 235         }
 236       if (i == c->n_coeffs)
 237         {
 238           return NULL;
 239         }
 240       return result;
 241     }
 242   return NULL;
 243 }