gui: Fix behavior of print preview in psppire-output-window.
[pspp] / src / math / linreg.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2005, 2011 Free Software Foundation, Inc. Written by Jason H. Stover.
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 #ifndef LINREG_H
18 #define LINREG_H
19
20 #include <gsl/gsl_math.h>
21 #include <gsl/gsl_matrix.h>
22 #include <gsl/gsl_vector.h>
23 #include <stdbool.h>
24
25 enum
26 {
27   LINREG_CONDITIONAL_INVERSE,
28   LINREG_QR,
29   LINREG_SWEEP,
30 };
31
32
33
34 /*
35   Options describing what special values should be computed.
36  */
37 struct pspp_linreg_opts_struct
38 {
39   int get_depvar_mean_std;
40   int *get_indep_mean_std;      /* Array of booleans
41                                    dictating which
42                                    independent variables need
43                                    their means and standard
44                                    deviations computed within
45                                    pspp_linreg. This array
46                                    MUST be of length
47                                    n_indeps. If element i is
48                                    1, pspp_linreg will
49                                    compute the mean and
50                                    variance of indpendent
51                                    variable i. If element i
52                                    is 0, it will not compute
53                                    the mean and standard
54                                    deviation, and assume the
55                                    values are stored.
56                                    cache->indep_mean[i] is
57                                    the mean and
58                                    cache->indep_std[i] is the
59                                    sample standard deviation. */
60 };
61 typedef struct pspp_linreg_opts_struct pspp_linreg_opts;
62
63
64 /*
65   Find the least-squares estimate of b for the linear model:
66
67   Y = Xb + Z
68
69   where Y is an n-by-1 column vector, X is an n-by-p matrix of
70   independent variables, b is a p-by-1 vector of regression coefficients,
71   and Z is an n-by-1 normally-distributed random vector with independent
72   identically distributed components with mean 0.
73
74   This estimate is found via the sweep operator or singular-value
75   decomposition with gsl.
76
77
78   References:
79
80   1. Matrix Computations, third edition. GH Golub and CF Van Loan.
81   The Johns Hopkins University Press. 1996. ISBN 0-8018-5414-8.
82
83   2. Numerical Analysis for Statisticians. K Lange. Springer. 1999.
84   ISBN 0-387-94979-8.
85
86   3. Numerical Linear Algebra for Applications in Statistics. JE Gentle.
87   Springer. 1998. ISBN 0-387-98542-5.
88 */
89
90
91 struct linreg_struct
92 {
93   double n_obs;                 /* Number of observations. */
94   int n_indeps;                 /* Number of independent variables. */
95   int n_coeffs;                 /* The intercept is not considered a
96                                    coefficient here. */
97
98   /*
99     Pointers to the variables.
100    */
101   const struct variable *depvar;
102   const struct variable **indep_vars;
103
104   double *coeff;
105   double intercept;
106   int method;                   /* Method to use to estimate parameters. */
107   /*
108      Means and standard deviations of the variables.
109      If these pointers are null when pspp_linreg() is
110      called, pspp_linreg() will compute their values.
111
112      Entry i of indep_means is the mean of independent
113      variable i, whose observations are stored in the ith
114      column of the design matrix.
115    */
116   double depvar_mean;
117   double depvar_std;
118   gsl_vector *indep_means;
119   gsl_vector *indep_std;
120
121   /*
122      Sums of squares.
123    */
124   double ssm;                   /* Sums of squares for the overall model. */
125   gsl_vector *ss_indeps;        /* Sums of squares from each
126                                    independent variable. */
127   double sst;                   /* Sum of squares total. */
128   double sse;                   /* Sum of squares error. */
129   double mse;                   /* Mean squared error. This is just sse /
130                                    dfe, but since it is the best unbiased
131                                    estimate of the population variance, it
132                                    has its own entry here. */
133   /*
134      Covariance matrix of the parameter estimates.
135    */
136   gsl_matrix *cov;
137   /*
138      Degrees of freedom.
139    */
140   double dft;
141   double dfe;
142   double dfm;
143
144   struct variable *pred;
145   struct variable *resid;
146   int dependent_column; /* Column containing the dependent variable. Defaults to last column. */
147 };
148
149 typedef struct linreg_struct linreg;
150
151
152
153 linreg *linreg_alloc (const struct variable *, const struct variable **, 
154                       double, size_t);
155
156 bool linreg_free (void *);
157
158 /*
159   Fit the linear model via least squares. All pointers passed to pspp_linreg
160   are assumed to be allocated to the correct size and initialized to the
161   values as indicated by opts.
162  */
163 void
164 linreg_fit (const gsl_matrix *, linreg *);
165
166 double
167 linreg_predict (const linreg *, const double *, size_t);
168 double
169 linreg_residual (const linreg *, double, const double *, size_t);
170 const struct variable ** linreg_get_vars (const linreg *);
171
172 /*
173   Return or set the standard deviation of the independent variable.
174  */
175 double linreg_get_indep_variable_sd (linreg *, size_t);
176 void linreg_set_indep_variable_sd (linreg *, size_t, double);
177 /*
178   Mean of the independent variable.
179  */
180 double linreg_get_indep_variable_mean (linreg *, size_t);
181 void linreg_set_indep_variable_mean (linreg *, size_t, double);
182
183 double linreg_mse (const linreg *);
184
185 double linreg_intercept (const linreg *);
186
187 gsl_matrix * linreg_cov (const linreg *);
188 double linreg_coeff (const linreg *, size_t);
189 const struct variable * linreg_indep_var (const linreg *, size_t);
190 size_t linreg_n_coeffs (const linreg *);
191 double linreg_n_obs (const linreg *);
192 double linreg_sse (const linreg *);
193 double linreg_ssreg (const linreg *);
194 double linreg_dfmodel (const linreg *);
195 double linreg_sst (const linreg *);
196 void linreg_set_depvar_mean (linreg *, double);
197 double linreg_get_depvar_mean (linreg *);
198 #endif