src/math/linreg/linreg.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2005 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 #include <config.h>
  18 #include <gsl/gsl_fit.h>
  19 #include <gsl/gsl_multifit.h>
  20
  21 #include <gsl/gsl_blas.h>
  22 #include <gsl/gsl_cblas.h>
  23
  24
  25
  26 /*
  27   Find the least-squares estimate of b for the linear model:
  28
  29   Y = Xb + Z
  30
  31   where Y is an n-by-1 column vector, X is an n-by-p matrix of
  32   independent variables, b is a p-by-1 vector of regression coefficients,
  33   and Z is an n-by-1 normally-distributed random vector with independent
  34   identically distributed components with mean 0.
  35
  36   This estimate is found via the sweep operator or singular-value
  37   decomposition with gsl.
  38
  39
  40   References:
  41
  42   1. Matrix Computations, third edition. GH Golub and CF Van Loan.
  43   The Johns Hopkins University Press. 1996. ISBN 0-8018-5414-8.
  44
  45   2. Numerical Analysis for Statisticians. K Lange. Springer. 1999.
  46   ISBN 0-387-94979-8.
  47
  48   3. Numerical Linear Algebra for Applications in Statistics. JE Gentle.
  49   Springer. 1998. ISBN 0-387-98542-5.
  50 */
  51
  52 #include <math/linreg/linreg.h>
  53 #include <math/coefficient.h>
  54 #include <gsl/gsl_errno.h>
  55 #include <linreg/sweep.h>
  56 /*
  57   Get the mean and standard deviation of a vector
  58   of doubles via a form of the Kalman filter as
  59   described on page 32 of [3].
  60  */
  61 static int
  62 linreg_mean_std (gsl_vector_const_view v, double *mp, double *sp, double *ssp)
  63 {
  64   size_t i;
  65   double j = 0.0;
  66   double d;
  67   double tmp;
  68   double mean;
  69   double variance;
  70
  71   mean = gsl_vector_get (&v.vector, 0);
  72   variance = 0;
  73   for (i = 1; i < v.vector.size; i++)
  74     {
  75       j = (double) i + 1.0;
  76       tmp = gsl_vector_get (&v.vector, i);
  77       d = (tmp - mean) / j;
  78       mean += d;
  79       variance += j * (j - 1.0) * d * d;
  80     }
  81   *mp = mean;
  82   *sp = sqrt (variance / (j - 1.0));
  83   *ssp = variance;
  84
  85   return GSL_SUCCESS;
  86 }
  87
  88 /*
  89   Set V to contain an array of pointers to the variables
  90   used in the model. V must be at least C->N_COEFFS in length.
  91   The return value is the number of distinct variables found.
  92  */
  93 int
  94 pspp_linreg_get_vars (const void *c_, const struct variable **v)
  95 {
  96   const pspp_linreg_cache *c = c_;
  97   const struct variable *tmp;
  98   int i;
  99   int j;
 100   int result = 0;
 101
 102   /*
 103      Make sure the caller doesn't try to sneak a variable
 104      into V that is not in the model.
 105    */
 106   for (i = 0; i < c->n_coeffs; i++)
 107     {
 108       v[i] = NULL;
 109     }
 110   /*
 111      Start at c->coeff[1] to avoid the intercept.
 112    */
 113   for (j = 1; j < c->n_coeffs; j++)
 114     {
 115       tmp = pspp_coeff_get_var (c->coeff[j], 0);
 116       assert (tmp != NULL);
 117       /* Repeated variables are likely to bunch together, at the end
 118          of the array. */
 119       i = result - 1;
 120       while (i >= 0 && v[i] != tmp)
 121         {
 122           i--;
 123         }
 124       if (i < 0 && result < c->n_coeffs)
 125         {
 126           v[result] = tmp;
 127           result++;
 128         }
 129     }
 130   return result;
 131 }
 132
 133 /*
 134   Allocate a pspp_linreg_cache and return a pointer
 135   to it. n is the number of cases, p is the number of
 136   independent variables.
 137  */
 138 pspp_linreg_cache *
 139 pspp_linreg_cache_alloc (size_t n, size_t p)
 140 {
 141   pspp_linreg_cache *c;
 142
 143   c = (pspp_linreg_cache *) malloc (sizeof (pspp_linreg_cache));
 144   c->depvar = NULL;
 145   c->indep_means = gsl_vector_alloc (p);
 146   c->indep_std = gsl_vector_alloc (p);
 147   c->ssx = gsl_vector_alloc (p);        /* Sums of squares for the
 148                                            independent variables.
 149                                          */
 150   c->ss_indeps = gsl_vector_alloc (p);  /* Sums of squares for the
 151                                            model parameters.
 152                                          */
 153   c->cov = gsl_matrix_alloc (p + 1, p + 1);     /* Covariance matrix. */
 154   c->n_obs = n;
 155   c->n_indeps = p;
 156   /*
 157      Default settings.
 158    */
 159   c->method = PSPP_LINREG_SWEEP;
 160   c->predict = pspp_linreg_predict;
 161   c->residual = pspp_linreg_residual;   /* The procedure to compute my
 162                                            residuals. */
 163   c->get_vars = pspp_linreg_get_vars;   /* The procedure that returns
 164                                            pointers to model
 165                                            variables. */
 166   c->resid = NULL;              /* The variable storing my residuals. */
 167   c->pred = NULL;               /* The variable storing my predicted values. */
 168
 169   return c;
 170 }
 171
 172 bool
 173 pspp_linreg_cache_free (void *m)
 174 {
 175   int i;
 176
 177   pspp_linreg_cache *c = m;
 178   if (c != NULL)
 179     {
 180       gsl_vector_free (c->indep_means);
 181       gsl_vector_free (c->indep_std);
 182       gsl_vector_free (c->ss_indeps);
 183       gsl_matrix_free (c->cov);
 184       gsl_vector_free (c->ssx);
 185       for (i = 0; i < c->n_coeffs; i++)
 186         {
 187           pspp_coeff_free (c->coeff[i]);
 188         }
 189       free (c->coeff);
 190       free (c);
 191     }
 192   return true;
 193 }
 194
 195 /*
 196   Fit the linear model via least squares. All pointers passed to pspp_linreg
 197   are assumed to be allocated to the correct size and initialized to the
 198   values as indicated by opts.
 199  */
 200 int
 201 pspp_linreg (const gsl_vector * Y, const gsl_matrix * X,
 202              const pspp_linreg_opts * opts, pspp_linreg_cache * cache)
 203 {
 204   int rc;
 205   gsl_matrix *design = NULL;
 206   gsl_matrix_view xtx;
 207   gsl_matrix_view xm;
 208   gsl_matrix_view xmxtx;
 209   gsl_vector_view xty;
 210   gsl_vector_view xi;
 211   gsl_vector_view xj;
 212   gsl_vector *param_estimates;
 213
 214   size_t i;
 215   size_t j;
 216   double tmp;
 217   double m;
 218   double s;
 219   double ss;
 220
 221   if (cache == NULL)
 222     {
 223       return GSL_EFAULT;
 224     }
 225   if (opts->get_depvar_mean_std)
 226     {
 227       linreg_mean_std (gsl_vector_const_subvector (Y, 0, Y->size),
 228                        &m, &s, &ss);
 229       cache->depvar_mean = m;
 230       cache->depvar_std = s;
 231       cache->sst = ss;
 232     }
 233   for (i = 0; i < cache->n_indeps; i++)
 234     {
 235       if (opts->get_indep_mean_std[i])
 236         {
 237           linreg_mean_std (gsl_matrix_const_column (X, i), &m, &s, &ss);
 238           gsl_vector_set (cache->indep_means, i, m);
 239           gsl_vector_set (cache->indep_std, i, s);
 240           gsl_vector_set (cache->ssx, i, ss);
 241         }
 242     }
 243   cache->dft = cache->n_obs - 1;
 244   cache->dfm = cache->n_indeps;
 245   cache->dfe = cache->dft - cache->dfm;
 246   cache->n_coeffs = X->size2 + 1;       /* Adjust this later to allow for
 247                                            regression through the origin.
 248                                          */
 249   if (cache->method == PSPP_LINREG_SWEEP)
 250     {
 251       gsl_matrix *sw;
 252       /*
 253          Subtract the means to improve the condition of the design
 254          matrix. This requires copying X and Y. We do not divide by the
 255          standard deviations of the independent variables here since doing
 256          so would cause a miscalculation of the residual sums of
 257          squares. Dividing by the standard deviation is done GSL's linear
 258          regression functions, so if the design matrix has a poor
 259          condition, use QR decomposition.
 260
 261          The design matrix here does not include a column for the intercept
 262          (i.e., a column of 1's). If using PSPP_LINREG_QR, we need that column,
 263          so design is allocated here when sweeping, or below if using QR.
 264        */
 265       design = gsl_matrix_alloc (X->size1, X->size2);
 266       for (i = 0; i < X->size2; i++)
 267         {
 268           m = gsl_vector_get (cache->indep_means, i);
 269           for (j = 0; j < X->size1; j++)
 270             {
 271               tmp = (gsl_matrix_get (X, j, i) - m);
 272               gsl_matrix_set (design, j, i, tmp);
 273             }
 274         }
 275       sw = gsl_matrix_calloc (cache->n_indeps + 1, cache->n_indeps + 1);
 276       xtx = gsl_matrix_submatrix (sw, 0, 0, cache->n_indeps, cache->n_indeps);
 277
 278       for (i = 0; i < xtx.matrix.size1; i++)
 279         {
 280           tmp = gsl_vector_get (cache->ssx, i);
 281           gsl_matrix_set (&(xtx.matrix), i, i, tmp);
 282           xi = gsl_matrix_column (design, i);
 283           for (j = (i + 1); j < xtx.matrix.size2; j++)
 284             {
 285               xj = gsl_matrix_column (design, j);
 286               gsl_blas_ddot (&(xi.vector), &(xj.vector), &tmp);
 287               gsl_matrix_set (&(xtx.matrix), i, j, tmp);
 288             }
 289         }
 290
 291       gsl_matrix_set (sw, cache->n_indeps, cache->n_indeps, cache->sst);
 292       xty = gsl_matrix_column (sw, cache->n_indeps);
 293       /*
 294          This loop starts at 1, with i=0 outside the loop, so we can get
 295          the model sum of squares due to the first independent variable.
 296        */
 297       xi = gsl_matrix_column (design, 0);
 298       gsl_blas_ddot (&(xi.vector), Y, &tmp);
 299       gsl_vector_set (&(xty.vector), 0, tmp);
 300       tmp *= tmp / gsl_vector_get (cache->ssx, 0);
 301       gsl_vector_set (cache->ss_indeps, 0, tmp);
 302       for (i = 1; i < cache->n_indeps; i++)
 303         {
 304           xi = gsl_matrix_column (design, i);
 305           gsl_blas_ddot (&(xi.vector), Y, &tmp);
 306           gsl_vector_set (&(xty.vector), i, tmp);
 307         }
 308
 309       /*
 310          Sweep on the matrix sw, which contains XtX, XtY and YtY.
 311        */
 312       reg_sweep (sw);
 313       cache->sse = gsl_matrix_get (sw, cache->n_indeps, cache->n_indeps);
 314       cache->mse = cache->sse / cache->dfe;
 315       /*
 316          Get the intercept.
 317        */
 318       m = cache->depvar_mean;
 319       for (i = 0; i < cache->n_indeps; i++)
 320         {
 321           tmp = gsl_matrix_get (sw, i, cache->n_indeps);
 322           cache->coeff[i + 1]->estimate = tmp;
 323           m -= tmp * gsl_vector_get (cache->indep_means, i);
 324         }
 325       /*
 326          Get the covariance matrix of the parameter estimates.
 327          Only the upper triangle is necessary.
 328        */
 329
 330       /*
 331          The loops below do not compute the entries related
 332          to the estimated intercept.
 333        */
 334       for (i = 0; i < cache->n_indeps; i++)
 335         for (j = i; j < cache->n_indeps; j++)
 336           {
 337             tmp = -1.0 * cache->mse * gsl_matrix_get (sw, i, j);
 338             gsl_matrix_set (cache->cov, i + 1, j + 1, tmp);
 339           }
 340       /*
 341          Get the covariances related to the intercept.
 342        */
 343       xtx = gsl_matrix_submatrix (sw, 0, 0, cache->n_indeps, cache->n_indeps);
 344       xmxtx = gsl_matrix_submatrix (cache->cov, 0, 1, 1, cache->n_indeps);
 345       xm = gsl_matrix_view_vector (cache->indep_means, 1, cache->n_indeps);
 346       rc = gsl_blas_dsymm (CblasRight, CblasUpper, cache->mse,
 347                            &xtx.matrix, &xm.matrix, 0.0, &xmxtx.matrix);
 348       if (rc == GSL_SUCCESS)
 349         {
 350           tmp = cache->mse / cache->n_obs;
 351           for (i = 1; i < 1 + cache->n_indeps; i++)
 352             {
 353               tmp -= gsl_matrix_get (cache->cov, 0, i)
 354                 * gsl_vector_get (cache->indep_means, i - 1);
 355             }
 356           gsl_matrix_set (cache->cov, 0, 0, tmp);
 357
 358           cache->coeff[0]->estimate = m;
 359         }
 360       else
 361         {
 362           fprintf (stderr, "%s:%d:gsl_blas_dsymm: %s\n",
 363                    __FILE__, __LINE__, gsl_strerror (rc));
 364           exit (rc);
 365         }
 366       gsl_matrix_free (sw);
 367     }
 368   else if (cache->method == PSPP_LINREG_CONDITIONAL_INVERSE)
 369     {
 370       /*
 371         Use the SVD of X^T X to find a conditional inverse of X^TX. If
 372         the SVD is X^T X = U D V^T, then set the conditional inverse
 373         to (X^T X)^c = V D^- U^T. D^- is defined as follows: If entry
 374         (i, i) has value sigma_i, then entry (i, i) of D^- is 1 /
 375         sigma_i if sigma_i > 0, and 0 otherwise. Then solve the normal
 376         equations by setting the estimated parameter vector to
 377         (X^TX)^c X^T Y.
 378        */
 379     }
 380   else
 381     {
 382       gsl_multifit_linear_workspace *wk;
 383       /*
 384          Use QR decomposition via GSL.
 385        */
 386
 387       param_estimates = gsl_vector_alloc (1 + X->size2);
 388       design = gsl_matrix_alloc (X->size1, 1 + X->size2);
 389
 390       for (j = 0; j < X->size1; j++)
 391         {
 392           gsl_matrix_set (design, j, 0, 1.0);
 393           for (i = 0; i < X->size2; i++)
 394             {
 395               tmp = gsl_matrix_get (X, j, i);
 396               gsl_matrix_set (design, j, i + 1, tmp);
 397             }
 398         }
 399
 400       wk = gsl_multifit_linear_alloc (design->size1, design->size2);
 401       rc = gsl_multifit_linear (design, Y, param_estimates,
 402                                 cache->cov, &(cache->sse), wk);
 403       for (i = 0; i < cache->n_coeffs; i++)
 404         {
 405           cache->coeff[i]->estimate = gsl_vector_get (param_estimates, i);
 406         }
 407       if (rc == GSL_SUCCESS)
 408         {
 409           gsl_multifit_linear_free (wk);
 410           gsl_vector_free (param_estimates);
 411         }
 412       else
 413         {
 414           fprintf (stderr, "%s:%d: gsl_multifit_linear returned %d\n",
 415                    __FILE__, __LINE__, rc);
 416         }
 417     }
 418
 419
 420   cache->ssm = cache->sst - cache->sse;
 421   /*
 422      Get the remaining sums of squares for the independent
 423      variables.
 424    */
 425   m = 0;
 426   for (i = 1; i < cache->n_indeps; i++)
 427     {
 428       j = i - 1;
 429       m += gsl_vector_get (cache->ss_indeps, j);
 430       tmp = cache->ssm - m;
 431       gsl_vector_set (cache->ss_indeps, i, tmp);
 432     }
 433
 434   gsl_matrix_free (design);
 435   return GSL_SUCCESS;
 436 }