lib/linreg/linreg.c

   1 /* lib/linreg/linreg.c
   2
   3  Copyright (C) 2005 Free Software Foundation, Inc.
   4  Written by Jason H. Stover.
   5
   6  This program is free software; you can redistribute it and/or modify
   7  it under the terms of the GNU General Public License as published by
   8  the Free Software Foundation; either version 2 of the License, or (at
   9  your option) any later version.
  10
  11  This program is distributed in the hope that it will be useful, but
  12  WITHOUT ANY WARRANTY; without even the implied warranty of
  13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  General Public License for more details.
  15
  16  You should have received a copy of the GNU General Public License
  17  along with this program; if not, write to the Free Software
  18  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19  02111-1307, USA.
  20 */
  21
  22 /*
  23   Find the least-squares estimate of b for the linear model:
  24
  25   Y = Xb + Z
  26
  27   where Y is an n-by-1 column vector, X is an n-by-p matrix of
  28   independent variables, b is a p-by-1 vector of regression coefficients,
  29   and Z is an n-by-1 normally-distributed random vector with independent
  30   identically distributed components with mean 0.
  31
  32   This estimate is found via the sweep operator or singular-value
  33   decomposition with gsl.
  34
  35
  36   References:
  37
  38   1. Matrix Computations, third edition. GH Golub and CF Van Loan.
  39   The Johns Hopkins University Press. 1996. ISBN 0-8018-5414-8.
  40
  41   2. Numerical Analysis for Statisticians. K Lange. Springer. 1999.
  42   ISBN 0-387-94979-8.
  43
  44   3. Numerical Linear Algebra for Applications in Statistics. JE Gentle.
  45   Springer. 1998. ISBN 0-387-98542-5.
  46 */
  47
  48 #include "pspp_linreg.h"
  49 #include <gsl/gsl_errno.h>
  50 /*
  51   Get the mean and standard deviation of a vector
  52   of doubles via a form of the Kalman filter as
  53   described on page 32 of [3].
  54  */
  55 static int
  56 linreg_mean_std (gsl_vector_const_view v, double *mp, double *sp, double *ssp)
  57 {
  58   size_t i;
  59   double j = 0.0;
  60   double d;
  61   double tmp;
  62   double mean;
  63   double variance;
  64
  65   mean = gsl_vector_get (&v.vector, 0);
  66   variance = 0;
  67   for (i = 1; i < v.vector.size; i++)
  68     {
  69       j = (double) i + 1.0;
  70       tmp = gsl_vector_get (&v.vector, i);
  71       d = (tmp - mean) / j;
  72       mean += d;
  73       variance += j * (j - 1.0) * d * d;
  74     }
  75   *mp = mean;
  76   *sp = sqrt (variance / (j - 1.0));
  77   *ssp = variance;
  78
  79   return GSL_SUCCESS;
  80 }
  81
  82 /*
  83   Allocate a pspp_linreg_cache and return a pointer
  84   to it. n is the number of cases, p is the number of
  85   independent variables.
  86  */
  87 pspp_linreg_cache *
  88 pspp_linreg_cache_alloc (size_t n, size_t p)
  89 {
  90   pspp_linreg_cache *c;
  91
  92   c = (pspp_linreg_cache *) malloc (sizeof (pspp_linreg_cache));
  93   c->indep_means = gsl_vector_alloc (p);
  94   c->indep_std = gsl_vector_alloc (p);
  95   c->ssx = gsl_vector_alloc (p);        /* Sums of squares for the independent
  96                                            variables.
  97                                          */
  98   c->ss_indeps = gsl_vector_alloc (p);  /* Sums of squares for the model
  99                                            parameters.
 100                                          */
 101   c->cov = gsl_matrix_alloc (p + 1, p + 1);     /* Covariance matrix. */
 102   c->n_obs = n;
 103   c->n_indeps = p;
 104   /*
 105      Default settings.
 106    */
 107   c->method = PSPP_LINREG_SWEEP;
 108
 109   return c;
 110 }
 111
 112 void
 113 pspp_linreg_cache_free (pspp_linreg_cache * c)
 114 {
 115   gsl_vector_free (c->indep_means);
 116   gsl_vector_free (c->indep_std);
 117   gsl_vector_free (c->ss_indeps);
 118   gsl_matrix_free (c->cov);
 119   pspp_linreg_coeff_free (c->coeff);
 120   free (c);
 121 }
 122
 123 /*
 124   Fit the linear model via least squares. All pointers passed to pspp_linreg
 125   are assumed to be allocated to the correct size and initialized to the
 126   values as indicated by opts.
 127  */
 128 int
 129 pspp_linreg (const gsl_vector * Y, const gsl_matrix * X,
 130              const pspp_linreg_opts * opts, pspp_linreg_cache * cache)
 131 {
 132   int rc;
 133   gsl_matrix *design;
 134   gsl_matrix_view xtx;
 135   gsl_matrix_view xm;
 136   gsl_matrix_view xmxtx;
 137   gsl_vector_view xty;
 138   gsl_vector_view xi;
 139   gsl_vector_view xj;
 140   gsl_vector *param_estimates;
 141
 142   size_t i;
 143   size_t j;
 144   double tmp;
 145   double m;
 146   double s;
 147   double ss;
 148
 149   if (cache == NULL)
 150     {
 151       return GSL_EFAULT;
 152     }
 153   if (opts->get_depvar_mean_std)
 154     {
 155       linreg_mean_std (gsl_vector_const_subvector (Y, 0, Y->size),
 156                        &m, &s, &ss);
 157       cache->depvar_mean = m;
 158       cache->depvar_std = s;
 159       cache->sst = ss;
 160     }
 161   for (i = 0; i < cache->n_indeps; i++)
 162     {
 163       if (opts->get_indep_mean_std[i])
 164         {
 165           linreg_mean_std (gsl_matrix_const_column (X, i), &m, &s, &ss);
 166           gsl_vector_set (cache->indep_means, i, m);
 167           gsl_vector_set (cache->indep_std, i, s);
 168           gsl_vector_set (cache->ssx, i, ss);
 169         }
 170     }
 171   cache->dft = cache->n_obs - 1;
 172   cache->dfm = cache->n_indeps;
 173   cache->dfe = cache->dft - cache->dfm;
 174   cache->n_coeffs = X->size2 + 1; /* Adjust this later to allow for regression
 175                                      through the origin.
 176                                   */
 177   if (cache->method == PSPP_LINREG_SWEEP)
 178     {
 179       gsl_matrix *sw;
 180       /*
 181          Subtract the means to improve the condition of the design
 182          matrix. This requires copying X and Y. We do not divide by the
 183          standard deviations of the independent variables here since doing
 184          so would cause a miscalculation of the residual sums of
 185          squares. Dividing by the standard deviation is done GSL's linear
 186          regression functions, so if the design matrix has a poor
 187          condition, use QR decomposition.
 188
 189          The design matrix here does not include a column for the intercept
 190          (i.e., a column of 1's). If using PSPP_LINREG_QR, we need that column,
 191          so design is allocated here when sweeping, or below if using QR.
 192        */
 193       design = gsl_matrix_alloc (X->size1, X->size2);
 194       for (i = 0; i < X->size2; i++)
 195         {
 196           m = gsl_vector_get (cache->indep_means, i);
 197           for (j = 0; j < X->size1; j++)
 198             {
 199               tmp = (gsl_matrix_get (X, j, i) - m);
 200               gsl_matrix_set (design, j, i, tmp);
 201             }
 202         }
 203       sw = gsl_matrix_calloc (cache->n_indeps + 1, cache->n_indeps + 1);
 204       xtx = gsl_matrix_submatrix (sw, 0, 0, cache->n_indeps, cache->n_indeps);
 205
 206       for (i = 0; i < xtx.matrix.size1; i++)
 207         {
 208           tmp = gsl_vector_get (cache->ssx, i);
 209           gsl_matrix_set (&(xtx.matrix), i, i, tmp);
 210           xi = gsl_matrix_column (design, i);
 211           for (j = (i + 1); j < xtx.matrix.size2; j++)
 212             {
 213               xj = gsl_matrix_column (design, j);
 214               gsl_blas_ddot (&(xi.vector), &(xj.vector), &tmp);
 215               gsl_matrix_set (&(xtx.matrix), i, j, tmp);
 216             }
 217         }
 218
 219       gsl_matrix_set (sw, cache->n_indeps, cache->n_indeps, cache->sst);
 220       xty = gsl_matrix_column (sw, cache->n_indeps);
 221       /*
 222          This loop starts at 1, with i=0 outside the loop, so we can get
 223          the model sum of squares due to the first independent variable.
 224        */
 225       xi = gsl_matrix_column (design, 0);
 226       gsl_blas_ddot (&(xi.vector), Y, &tmp);
 227       gsl_vector_set (&(xty.vector), 0, tmp);
 228       tmp *= tmp / gsl_vector_get (cache->ssx, 0);
 229       gsl_vector_set (cache->ss_indeps, 0, tmp);
 230       for (i = 1; i < cache->n_indeps; i++)
 231         {
 232           xi = gsl_matrix_column (design, i);
 233           gsl_blas_ddot (&(xi.vector), Y, &tmp);
 234           gsl_vector_set (&(xty.vector), i, tmp);
 235         }
 236
 237       /*
 238          Sweep on the matrix sw, which contains XtX, XtY and YtY.
 239        */
 240       pspp_reg_sweep (sw);
 241       cache->sse = gsl_matrix_get (sw, cache->n_indeps, cache->n_indeps);
 242       cache->mse = cache->sse / cache->dfe;
 243       /*
 244          Get the intercept.
 245        */
 246       m = cache->depvar_mean;
 247       for (i = 0; i < cache->n_indeps; i++)
 248         {
 249           tmp = gsl_matrix_get (sw, i, cache->n_indeps);
 250           cache->coeff[i + 1].estimate = tmp;
 251           m -= tmp * gsl_vector_get (cache->indep_means, i);
 252         }
 253       /*
 254          Get the covariance matrix of the parameter estimates.
 255          Only the upper triangle is necessary.
 256        */
 257
 258       /*
 259          The loops below do not compute the entries related
 260          to the estimated intercept.
 261        */
 262       for (i = 0; i < cache->n_indeps; i++)
 263         for (j = i; j < cache->n_indeps; j++)
 264           {
 265             tmp = -1.0 * cache->mse * gsl_matrix_get (sw, i, j);
 266             gsl_matrix_set (cache->cov, i + 1, j + 1, tmp);
 267           }
 268       /*
 269          Get the covariances related to the intercept.
 270        */
 271       xtx = gsl_matrix_submatrix (sw, 0, 0, cache->n_indeps, cache->n_indeps);
 272       xmxtx = gsl_matrix_submatrix (cache->cov, 0, 1, 1, cache->n_indeps);
 273       xm = gsl_matrix_view_vector (cache->indep_means, 1, cache->n_indeps);
 274       rc = gsl_blas_dsymm (CblasRight, CblasUpper, cache->mse,
 275                            &xtx.matrix, &xm.matrix, 0.0, &xmxtx.matrix);
 276       if (rc == GSL_SUCCESS)
 277         {
 278           tmp = cache->mse / cache->n_obs;
 279           for (i = 1; i < 1 + cache->n_indeps; i++)
 280             {
 281               tmp -= gsl_matrix_get (cache->cov, 0, i)
 282                 * gsl_vector_get (cache->indep_means, i - 1);
 283             }
 284           gsl_matrix_set (cache->cov, 0, 0, tmp);
 285
 286           cache->coeff[0].estimate = m;
 287         }
 288       else
 289         {
 290           fprintf (stderr, "%s:%d:gsl_blas_dsymm: %s\n",
 291                    __FILE__, __LINE__, gsl_strerror (rc));
 292           exit (rc);
 293         }
 294       gsl_matrix_free (sw);
 295     }
 296   else
 297     {
 298       /*
 299          Use QR decomposition via GSL.
 300        */
 301
 302       param_estimates = gsl_vector_alloc (1 + X->size2);
 303       design = gsl_matrix_alloc (X->size1, 1 + X->size2);
 304
 305       for (j = 0; j < X->size1; j++)
 306         {
 307           gsl_matrix_set (design, j, 0, 1.0);
 308           for (i = 0; i < X->size2; i++)
 309             {
 310               tmp = gsl_matrix_get (X, j, i);
 311               gsl_matrix_set (design, j, i + 1, tmp);
 312             }
 313         }
 314       gsl_multifit_linear_workspace *wk =
 315         gsl_multifit_linear_alloc (design->size1, design->size2);
 316       rc = gsl_multifit_linear (design, Y, param_estimates,
 317                                 cache->cov, &(cache->sse), wk);
 318       for (i = 0; i < cache->n_coeffs; i++)
 319         {
 320           cache->coeff[i].estimate = gsl_vector_get (param_estimates, i);
 321         }
 322       if (rc == GSL_SUCCESS)
 323         {
 324           gsl_multifit_linear_free (wk);
 325           gsl_vector_free (param_estimates);
 326         }
 327       else
 328         {
 329           fprintf (stderr, "%s:%d: gsl_multifit_linear returned %d\n",
 330                    __FILE__, __LINE__, rc);
 331         }
 332     }
 333
 334
 335   cache->ssm = cache->sst - cache->sse;
 336   /*
 337      Get the remaining sums of squares for the independent
 338      variables.
 339    */
 340   m = 0;
 341   for (i = 1; i < cache->n_indeps; i++)
 342     {
 343       j = i - 1;
 344       m += gsl_vector_get (cache->ss_indeps, j);
 345       tmp = cache->ssm - m;
 346       gsl_vector_set (cache->ss_indeps, i, tmp);
 347     }
 348
 349   gsl_matrix_free (design);
 350   return GSL_SUCCESS;
 351 }