moved src/math/linreg.[ch] to src/math
[pspp-builds.git] / src / math / linreg / linreg.h
index f0141f809f47f8c72638861197f583da7292a1a9..a7d408af56bde0c605c648963882545d9bec2967 100644 (file)
@@ -1,22 +1,18 @@
-/*
-  lib/linreg/linreg.h
-  
-  Copyright (C) 2005 Free Software Foundation, Inc. Written by Jason H. Stover.
-  
-  This program is free software; you can redistribute it and/or modify it under
-  the terms of the GNU General Public License as published by the Free
-  Software Foundation; either version 2 of the License, or (at your option)
-  any later version.
-  
-  This program is distributed in the hope that it will be useful, but WITHOUT
-  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
-  more details.
-  
-  You should have received a copy of the GNU General Public License along with
-  this program; if not, write to the Free Software Foundation, Inc., 51
-  Franklin Street, Fifth Floor, Boston, MA 02111-1307, USA.
-*/
+/* PSPP - a program for statistical analysis.
+   Copyright (C) 2005 Free Software Foundation, Inc. Written by Jason H. Stover.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #ifndef LINREG_H
 #define LINREG_H
 #include <gsl/gsl_matrix.h>
 
 struct variable;
-struct pspp_linreg_coeff;
+struct pspp_coeff;
 union value;
 
 enum
 {
+  PSPP_LINREG_CONDITIONAL_INVERSE,
+  PSPP_LINREG_QR,
   PSPP_LINREG_SWEEP,
-  PSPP_LINREG_SVD
 };
 
 
@@ -98,16 +95,18 @@ struct pspp_linreg_cache_struct
 {
   int n_obs;                   /* Number of observations. */
   int n_indeps;                        /* Number of independent variables. */
-  int n_coeffs;
+  int n_coeffs;                 /* The intercept is not considered a
+                                  coefficient here. */
 
   /*
-    The variable struct is ignored during estimation. It is here so
-    the calling procedure can find the variable used in the model.
+     The variable struct is ignored during estimation. It is here so
+     the calling procedure can find the variable used in the model.
    */
   const struct variable *depvar;
 
   gsl_vector *residuals;
-  struct pspp_linreg_coeff *coeff;
+  struct pspp_coeff **coeff;
+  double intercept;
   int method;                  /* Method to use to estimate parameters. */
   /*
      Means and standard deviations of the variables.
@@ -138,8 +137,8 @@ struct pspp_linreg_cache_struct
   gsl_vector *ssx;             /* Centered sums of squares for independent
                                   variables, i.e. \sum (x[i] - mean(x))^2. */
   double ssy;                  /* Centered sums of squares for dependent
-                                  variable. 
-                               */
+                                  variable.
+                                */
   /*
      Covariance matrix of the parameter estimates.
    */
@@ -161,12 +160,11 @@ struct pspp_linreg_cache_struct
                     const void *, int);
   double (*residual) (const struct variable **,
                      const union value **,
-                     const union value *,
-                     const void *, int);
+                     const union value *, const void *, int);
   /*
-    Returns pointers to the variables used in the model.
+     Returns pointers to the variables used in the model.
    */
-  int (*get_vars) (const void *, struct variable **);
+  int (*get_vars) (const void *, const struct variable **);
   struct variable *resid;
   struct variable *pred;
 
@@ -203,5 +201,5 @@ pspp_linreg_residual (const struct variable **, const union value **,
 /*
   All variables used in the model.
  */
-int pspp_linreg_get_vars (const void *, struct variable **);
+int pspp_linreg_get_vars (const void *, const struct variable **);
 #endif