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 *cache;
  91
  92   cache = (pspp_linreg_cache *) malloc (sizeof (pspp_linreg_cache));
  93   cache->param_estimates = gsl_vector_alloc (p + 1);
  94   cache->indep_means = gsl_vector_alloc (p);
  95   cache->indep_std = gsl_vector_alloc (p);
  96   cache->ssx = gsl_vector_alloc (p);    /* Sums of squares for the independent
  97                                            variables.
  98                                          */
  99   cache->ss_indeps = gsl_vector_alloc (p);      /* Sums of squares for the model
 100                                                    parameters.
 101                                                  */
 102   cache->cov = gsl_matrix_alloc (p + 1, p + 1); /* Covariance matrix. */
 103   cache->n_obs = n;
 104   cache->n_indeps = p;
 105   /*
 106      Default settings.
 107    */
 108   cache->method = PSPP_LINREG_SWEEP;
 109
 110   return cache;
 111 }
 112
 113 void
 114 pspp_linreg_cache_free (pspp_linreg_cache * cache)
 115 {
 116   gsl_vector_free (cache->param_estimates);
 117   gsl_vector_free (cache->indep_means);
 118   gsl_vector_free (cache->indep_std);
 119   gsl_vector_free (cache->ss_indeps);
 120   gsl_matrix_free (cache->cov);
 121   free (cache);
 122 }
 123
 124 /*
 125   Fit the linear model via least squares. All pointers passed to pspp_linreg
 126   are assumed to be allocated to the correct size and initialized to the
 127   values as indicated by opts.
 128  */
 129 int
 130 pspp_linreg (const gsl_vector * Y, const gsl_matrix * X,
 131              const pspp_linreg_opts * opts, pspp_linreg_cache * cache)
 132 {
 133   int rc;
 134   gsl_matrix *design;
 135   gsl_matrix_view xtx;
 136   gsl_matrix_view xm;
 137   gsl_matrix_view xmxtx;
 138   gsl_vector_view xty;
 139   gsl_vector_view xi;
 140   gsl_vector_view xj;
 141
 142   size_t i;
 143   size_t j;
 144   double tmp;
 145   double m;
 146   double s;
 147   double ss;
 148   double mse;
 149
 150   if (cache == NULL)
 151     {
 152       return GSL_EFAULT;
 153     }
 154   if (opts->get_depvar_mean_std)
 155     {
 156       linreg_mean_std (gsl_vector_const_subvector (Y, 0, Y->size),
 157                        &m, &s, &ss);
 158       cache->depvar_mean = m;
 159       cache->depvar_std = s;
 160       cache->sst = ss;
 161     }
 162   for (i = 0; i < cache->n_indeps; i++)
 163     {
 164       if (opts->get_indep_mean_std[i])
 165         {
 166           linreg_mean_std (gsl_matrix_const_column (X, i), &m, &s, &ss);
 167           gsl_vector_set (cache->indep_means, i, m);
 168           gsl_vector_set (cache->indep_std, i, s);
 169           gsl_vector_set (cache->ssx, i, ss);
 170         }
 171     }
 172   cache->dft = cache->n_obs - 1;
 173   cache->dfm = cache->n_indeps;
 174   cache->dfe = cache->dft - cache->dfm;
 175   if (cache->method == PSPP_LINREG_SWEEP)
 176     {
 177       gsl_matrix *sw;
 178       /*
 179          Subtract the means to improve the condition of the design
 180          matrix. This requires copying X and Y. We do not divide by the
 181          standard deviations of the independent variables here since doing
 182          so would cause a miscalculation of the residual sums of
 183          squares. Dividing by the standard deviation is done GSL's linear
 184          regression functions, so if the design matrix has a very poor
 185          condition, use QR decomposition.
 186          *
 187          The design matrix here does not include a column for the intercept
 188          (i.e., a column of 1's). If using PSPP_LINREG_QR, we need that column,
 189          so design is allocated here when sweeping, or below if using QR.
 190        */
 191       design = gsl_matrix_alloc (X->size1, X->size2);
 192       for (i = 0; i < X->size2; i++)
 193         {
 194           m = gsl_vector_get (cache->indep_means, i);
 195           for (j = 0; j < X->size1; j++)
 196             {
 197               tmp = (gsl_matrix_get (X, j, i) - m);
 198               gsl_matrix_set (design, j, i, tmp);
 199             }
 200         }
 201       sw = gsl_matrix_calloc (cache->n_indeps + 1, cache->n_indeps + 1);
 202       xtx = gsl_matrix_submatrix (sw, 0, 0, cache->n_indeps, cache->n_indeps);
 203
 204       for (i = 0; i < xtx.matrix.size1; i++)
 205         {
 206           tmp = gsl_vector_get (cache->ssx, i);
 207           gsl_matrix_set (&(xtx.matrix), i, i, tmp);
 208           xi = gsl_matrix_column (design, i);
 209           for (j = (i + 1); j < xtx.matrix.size2; j++)
 210             {
 211               xj = gsl_matrix_column (design, j);
 212               gsl_blas_ddot (&(xi.vector), &(xj.vector), &tmp);
 213               gsl_matrix_set (&(xtx.matrix), i, j, tmp);
 214             }
 215         }
 216
 217       gsl_matrix_set (sw, cache->n_indeps, cache->n_indeps, cache->sst);
 218       xty = gsl_matrix_column (sw, cache->n_indeps);
 219       /*
 220          This loop starts at 1, with i=0 outside the loop, so we can get
 221          the model sum of squares due to the first independent variable.
 222        */
 223       xi = gsl_matrix_column (design, 0);
 224       gsl_blas_ddot (&(xi.vector), Y, &tmp);
 225       gsl_vector_set (&(xty.vector), 0, tmp);
 226       tmp *= tmp / gsl_vector_get (cache->ssx, 0);
 227       gsl_vector_set (cache->ss_indeps, 0, tmp);
 228       for (i = 1; i < cache->n_indeps; i++)
 229         {
 230           xi = gsl_matrix_column (design, i);
 231           gsl_blas_ddot (&(xi.vector), Y, &tmp);
 232           gsl_vector_set (&(xty.vector), i, tmp);
 233         }
 234
 235       /*
 236          Sweep on the matrix sw, which contains XtX, XtY and YtY.
 237        */
 238       pspp_reg_sweep (sw);
 239       cache->sse = gsl_matrix_get (sw, cache->n_indeps, cache->n_indeps);
 240       cache->mse = cache->sse / cache->dfe;
 241       /*
 242          Get the intercept.
 243        */
 244       m = cache->depvar_mean;
 245       for (i = 0; i < cache->n_indeps; i++)
 246         {
 247           tmp = gsl_matrix_get (sw, i, cache->n_indeps);
 248           gsl_vector_set (cache->param_estimates, i + 1, tmp);
 249           m -= tmp * gsl_vector_get (cache->indep_means, i);
 250         }
 251       /*
 252          Get the covariance matrix of the parameter estimates.
 253          Only the upper triangle is necessary.
 254        */
 255
 256       /*
 257          The loops below do not compute the entries related
 258          to the estimated intercept.
 259        */
 260       for (i = 0; i < cache->n_indeps; i++)
 261         for (j = i; j < cache->n_indeps; j++)
 262           {
 263             tmp = -1.0 * cache->mse * gsl_matrix_get (sw, i, j);
 264             gsl_matrix_set (cache->cov, i + 1, j + 1, tmp);
 265           }
 266       /*
 267          Get the covariances related to the intercept.
 268        */
 269       xtx = gsl_matrix_submatrix (sw, 0, 0, cache->n_indeps, cache->n_indeps);
 270       xmxtx = gsl_matrix_submatrix (cache->cov, 0, 1, 1, cache->n_indeps);
 271       xm = gsl_matrix_view_vector (cache->indep_means, 1, cache->n_indeps);
 272       rc = gsl_blas_dsymm (CblasRight, CblasUpper, cache->mse,
 273                            &xtx.matrix, &xm.matrix, 0.0, &xmxtx.matrix);
 274       if (rc == GSL_SUCCESS)
 275         {
 276           tmp = cache->mse / cache->n_obs;
 277           for (i = 1; i < 1 + cache->n_indeps; i++)
 278             {
 279               tmp -= gsl_matrix_get (cache->cov, 0, i)
 280                 * gsl_vector_get (cache->indep_means, i - 1);
 281             }
 282           gsl_matrix_set (cache->cov, 0, 0, tmp);
 283
 284           gsl_vector_set (cache->param_estimates, 0, m);
 285         }
 286       else
 287         {
 288           fprintf (stderr, "%s:%d:gsl_blas_dsymm: %s\n",
 289                    __FILE__, __LINE__, gsl_strerror (rc));
 290           exit (rc);
 291         }
 292       gsl_matrix_free (sw);
 293     }
 294   else
 295     {
 296       /*
 297          Use QR decomposition via GSL. This section has not been tested.
 298        */
 299       design = gsl_matrix_alloc (X->size1, 1 + X->size2);
 300
 301       for (j = 0; j < X->size1; j++)
 302         {
 303           gsl_matrix_set (design, j, 0, 1.0);
 304           for (i = 0; i < X->size2; i++)
 305             {
 306               tmp = gsl_matrix_get (X, j, i);
 307               gsl_matrix_set (design, j, i + 1, tmp);
 308             }
 309         }
 310       gsl_multifit_linear_workspace *wk =
 311         gsl_multifit_linear_alloc (design->size1, design->size2);
 312       rc = gsl_multifit_linear (design, Y, cache->param_estimates,
 313                                 cache->cov, &(cache->sse), wk);
 314       if (rc == GSL_SUCCESS)
 315         {
 316           gsl_multifit_linear_free (wk);
 317         }
 318       else
 319         {
 320           fprintf (stderr, "%s:%d: gsl_multifit_linear returned %d\n",
 321                    __FILE__, __LINE__, rc);
 322         }
 323     }
 324
 325
 326   cache->ssm = cache->sst - cache->sse;
 327   /*
 328      Get the remaining sums of squares for the independent
 329      variables.
 330    */
 331   m = 0;
 332   for (i = 1; i < cache->n_indeps; i++)
 333     {
 334       j = i - 1;
 335       m += gsl_vector_get (cache->ss_indeps, j);
 336       tmp = cache->ssm - m;
 337       gsl_vector_set (cache->ss_indeps, i, tmp);
 338     }
 339
 340   gsl_matrix_free (design);
 341   return GSL_SUCCESS;
 342 }