lib/linreg/sweep.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2005, 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   Find the least-squares estimate of b for the linear model:
  19
  20   Y = Xb + Z
  21
  22   where Y is an n-by-1 column vector, X is an n-by-p matrix of
  23   independent variables, b is a p-by-1 vector of regression coefficients,
  24   and Z is an n-by-1 normally-distributed random vector with independent
  25   identically distributed components with mean 0.
  26
  27   This estimate is found via the sweep operator, which is a modification
  28   of Gauss-Jordan pivoting.
  29
  30
  31   References:
  32
  33   Matrix Computations, third edition. GH Golub and CF Van Loan.
  34   The Johns Hopkins University Press. 1996. ISBN 0-8018-5414-8.
  35
  36   Numerical Analysis for Statisticians. K Lange. Springer. 1999.
  37   ISBN 0-387-94979-8.
  38
  39   Numerical Linear Algebra for Applications in Statistics. JE Gentle.
  40   Springer. 1998. ISBN 0-387-98542-5.
  41  */
  42
  43 #include <config.h>
  44
  45 #include "sweep.h"
  46
  47 #include <assert.h>
  48 /*
  49   The matrix A will be overwritten. In ordinary uses of the sweep
  50   operator, A will be the matrix
  51
  52    __       __
  53   |X'X    X'Y|
  54   |          |
  55   |Y'X    Y'Y|
  56    --        --
  57
  58    X refers to the design matrix and Y to the vector of dependent
  59    observations. reg_sweep sweeps on the diagonal elements of
  60    X'X.
  61
  62    The matrix A is assumed to be symmetric, so the sweep operation is
  63    performed only for the upper triangle of A.
  64
  65    LAST_COL is considered to be the final column in the augmented matrix,
  66    that is, the column to the right of the '=' sign of the system.
  67  */
  68
  69 int
  70 reg_sweep (gsl_matrix * A, int last_col)
  71 {
  72   double sweep_element;
  73   double tmp;
  74   int i;
  75   int j;
  76   int k;
  77   gsl_matrix *B;
  78
  79   if (A != NULL)
  80     {
  81       if (A->size1 == A->size2)
  82         {
  83           assert (last_col < A->size1);
  84           gsl_matrix_swap_rows (A, A->size1 - 1, last_col);
  85           gsl_matrix_swap_columns (A, A->size1 - 1 , last_col);
  86
  87           B = gsl_matrix_alloc (A->size1, A->size2);
  88           for (k = 0; k < (A->size1 - 1); k++)
  89             {
  90               sweep_element = gsl_matrix_get (A, k, k);
  91               if (fabs (sweep_element) > GSL_DBL_MIN)
  92                 {
  93                   tmp = -1.0 / sweep_element;
  94                   gsl_matrix_set (B, k, k, tmp);
  95                   /*
  96                      Rows before current row k.
  97                    */
  98                   for (i = 0; i < k; i++)
  99                     {
 100                       for (j = i; j < A->size2; j++)
 101                         {
 102                           /*
 103                              Use only the upper triangle of A.
 104                            */
 105                           if (j < k)
 106                             {
 107                               tmp = gsl_matrix_get (A, i, j) -
 108                                 gsl_matrix_get (A, i, k)
 109                                 * gsl_matrix_get (A, j, k) / sweep_element;
 110                               gsl_matrix_set (B, i, j, tmp);
 111                             }
 112                           else if (j > k)
 113                             {
 114                               tmp = gsl_matrix_get (A, i, j) -
 115                                 gsl_matrix_get (A, i, k)
 116                                 * gsl_matrix_get (A, k, j) / sweep_element;
 117                               gsl_matrix_set (B, i, j, tmp);
 118                             }
 119                           else
 120                             {
 121                               tmp = gsl_matrix_get (A, i, k) / sweep_element;
 122                               gsl_matrix_set (B, i, j, tmp);
 123                             }
 124                         }
 125                     }
 126                   /*
 127                      Current row k.
 128                    */
 129                   for (j = k + 1; j < A->size1; j++)
 130                     {
 131                       tmp = gsl_matrix_get (A, k, j) / sweep_element;
 132                       gsl_matrix_set (B, k, j, tmp);
 133                     }
 134                   /*
 135                      Rows after the current row k.
 136                    */
 137                   for (i = k + 1; i < A->size1; i++)
 138                     {
 139                       for (j = i; j < A->size2; j++)
 140                         {
 141                           tmp = gsl_matrix_get (A, i, j) -
 142                             gsl_matrix_get (A, k, i)
 143                             * gsl_matrix_get (A, k, j) / sweep_element;
 144                           gsl_matrix_set (B, i, j, tmp);
 145                         }
 146                     }
 147                 }
 148               for (i = 0; i < A->size1; i++)
 149                 for (j = i; j < A->size2; j++)
 150                   {
 151                     gsl_matrix_set (A, i, j, gsl_matrix_get (B, i, j));
 152                   }
 153             }
 154           gsl_matrix_free (B);
 155
 156           gsl_matrix_swap_columns (A, A->size1 - 1 , last_col);
 157           gsl_matrix_swap_rows (A, A->size1 - 1, last_col);
 158
 159           return GSL_SUCCESS;
 160         }
 161       return GSL_ENOTSQR;
 162     }
 163   return GSL_EFAULT;
 164 }