Removed use of coefficient 0 as intercept; removed subcommand EXPORT.
[pspp-builds.git] / src / math / coefficient.c
index f5d0eb56a52697b52f9e735fc1287ddc5fc994da..156c782d5a03e4a750437fa43e9588f35f472f19 100644 (file)
@@ -1,26 +1,23 @@
-/*
-  lib/linreg/coefficient.c
-  
-  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.
+
+   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/>. */
 
 /*
   Accessor functions for matching coefficients and variables.
  */
+#include <config.h>
 #include <math/coefficient.h>
 #include <math/linreg/linreg.h>
 #include "src/math/design-matrix.h"
@@ -42,7 +39,7 @@ struct varinfo
 };
 
 void
-pspp_linreg_coeff_free (struct pspp_linreg_coeff *c)
+pspp_coeff_free (struct pspp_coeff *c)
 {
   free (c->v_info);
   free (c);
@@ -53,50 +50,43 @@ pspp_linreg_coeff_free (struct pspp_linreg_coeff *c)
   coefficient structures for the linear model.
  */
 void
-pspp_linreg_coeff_init (pspp_linreg_cache * c, struct design_matrix *X)
+pspp_coeff_init (struct pspp_coeff ** c, const struct design_matrix *X)
 {
   size_t i;
-  size_t j;
   int n_vals = 1;
-  struct pspp_linreg_coeff *coeff;
 
-  c->coeff = xnmalloc (X->m->size2 + 1, sizeof (*c->coeff));
-  c->coeff[0] = xmalloc (sizeof (*c->coeff[0]));
-  c->coeff[0]->v_info = NULL;  /* Intercept has no associated variable. */
+  assert (c != NULL);
   for (i = 0; i < X->m->size2; i++)
     {
-      j = i + 1;               /* The first coefficient is the intercept. */
-      c->coeff[j] = xmalloc (sizeof (*c->coeff[j]));
-      coeff = c->coeff[j];
-      coeff->n_vars = n_vals;  /* Currently, no procedures allow
+      c[i] = xmalloc (sizeof (*c[i]));
+      c[i]->n_vars = n_vals;   /* Currently, no procedures allow
                                   interactions.  This line will have to
                                   change when procedures that allow
-                                  interaction terms are written. 
+                                  interaction terms are written.
                                 */
-      coeff->v_info = xnmalloc (coeff->n_vars, sizeof (*coeff->v_info));
-      assert (coeff->v_info != NULL);
-      coeff->v_info->v =
-       (const struct variable *) design_matrix_col_to_var (X, i);
+      c[i]->v_info = xnmalloc (c[i]->n_vars, sizeof (*c[i]->v_info));
+      assert (c[i]->v_info != NULL);
+      c[i]->v_info->v = design_matrix_col_to_var (X, i);
 
-      if (coeff->v_info->v->type == ALPHA)
+      if (var_is_alpha (c[i]->v_info->v))
        {
          size_t k;
-         k = design_matrix_var_to_column (X, coeff->v_info->v);
+         k = design_matrix_var_to_column (X, c[i]->v_info->v);
          assert (k <= i);
          k = i - k;
-         coeff->v_info->val =
-           cat_subscript_to_value (k, (struct variable *) coeff->v_info->v);
+         c[i]->v_info->val =
+           cat_subscript_to_value (k, c[i]->v_info->v);
        }
     }
 }
 void
-pspp_linreg_coeff_set_estimate (struct pspp_linreg_coeff *c, double estimate)
+pspp_coeff_set_estimate (struct pspp_coeff *c, double estimate)
 {
   c->estimate = estimate;
 }
 
 void
-pspp_linreg_coeff_set_std_err (struct pspp_linreg_coeff *c, double std_err)
+pspp_coeff_set_std_err (struct pspp_coeff *c, double std_err)
 {
   c->std_err = std_err;
 }
@@ -105,7 +95,7 @@ pspp_linreg_coeff_set_std_err (struct pspp_linreg_coeff *c, double std_err)
   Return the estimated value of the coefficient.
  */
 double
-pspp_linreg_coeff_get_est (const struct pspp_linreg_coeff *c)
+pspp_coeff_get_est (const struct pspp_coeff *c)
 {
   if (c == NULL)
     {
@@ -118,7 +108,7 @@ pspp_linreg_coeff_get_est (const struct pspp_linreg_coeff *c)
   Return the standard error of the estimated coefficient.
 */
 double
-pspp_linreg_coeff_get_std_err (const struct pspp_linreg_coeff *c)
+pspp_coeff_get_std_err (const struct pspp_coeff *c)
 {
   if (c == NULL)
     {
@@ -131,7 +121,7 @@ pspp_linreg_coeff_get_std_err (const struct pspp_linreg_coeff *c)
   How many variables are associated with this coefficient?
  */
 int
-pspp_linreg_coeff_get_n_vars (struct pspp_linreg_coeff *c)
+pspp_coeff_get_n_vars (struct pspp_coeff *c)
 {
   if (c == NULL)
     {
@@ -145,7 +135,7 @@ pspp_linreg_coeff_get_n_vars (struct pspp_linreg_coeff *c)
   0 unless the coefficient refers to an interaction term.
  */
 const struct variable *
-pspp_linreg_coeff_get_var (struct pspp_linreg_coeff *c, int i)
+pspp_coeff_get_var (struct pspp_coeff *c, int i)
 {
   if (c == NULL)
     {
@@ -159,7 +149,7 @@ pspp_linreg_coeff_get_var (struct pspp_linreg_coeff *c, int i)
   Which value is associated with this coefficient/variable combination?
  */
 const union value *
-pspp_linreg_coeff_get_value (struct pspp_linreg_coeff *c,
+pspp_coeff_get_value (struct pspp_coeff *c,
                             const struct variable *v)
 {
   int i = 0;
@@ -169,14 +159,14 @@ pspp_linreg_coeff_get_value (struct pspp_linreg_coeff *c,
     {
       return NULL;
     }
-  if (v->type == NUMERIC)
+  if (var_is_numeric (v))
     {
       return NULL;
     }
   while (i < c->n_vars)
     {
-      candidate = pspp_linreg_coeff_get_var (c, i);
-      if (v->index == candidate->index)
+      candidate = pspp_coeff_get_var (c, i);
+      if (v == candidate)
        {
          return (c->v_info + i)->val;
        }
@@ -189,12 +179,12 @@ pspp_linreg_coeff_get_value (struct pspp_linreg_coeff *c,
   Which coefficient is associated with V? The VAL argument is relevant
   only to categorical variables.
  */
-const struct pspp_linreg_coeff *
+const struct pspp_coeff *
 pspp_linreg_get_coeff (const pspp_linreg_cache * c,
                       const struct variable *v, const union value *val)
 {
-  int i = 1;
-  struct pspp_linreg_coeff *result = NULL;
+  int i;
+  struct pspp_coeff *result = NULL;
   const struct variable *tmp = NULL;
 
   if (c == NULL)
@@ -205,20 +195,23 @@ pspp_linreg_get_coeff (const pspp_linreg_cache * c,
     {
       return NULL;
     }
-
-  result = c->coeff[i];
-  tmp = pspp_linreg_coeff_get_var (result, 0);
-  while (tmp->index != v->index && i < c->n_coeffs)
+  i = 0;
+  result = c->coeff[0];
+  tmp = pspp_coeff_get_var (result, 0);
+  while (tmp != v && i < c->n_coeffs)
     {
       result = c->coeff[i];
-      tmp = pspp_linreg_coeff_get_var (result, 0);
+      tmp = pspp_coeff_get_var (result, 0);
       i++;
     }
-  if (i > c->n_coeffs)
+  if (tmp != v)
     {
+      /*
+       Not found.
+       */
       return NULL;
     }
-  if (v->type == NUMERIC)
+  if (var_is_numeric (v))
     {
       return result;
     }
@@ -228,15 +221,15 @@ pspp_linreg_get_coeff (const pspp_linreg_cache * c,
          If v is categorical, we need to ensure the coefficient
          matches the VAL.
        */
-      while (tmp->index != v->index && i < c->n_coeffs
-            && compare_values (pspp_linreg_coeff_get_value (result, tmp),
-                               val, v->width))
+      while (tmp != v && i < c->n_coeffs
+            && compare_values (pspp_coeff_get_value (result, tmp),
+                               val, var_get_width (v)))
        {                       /* FIX THIS */
          i++;
          result = c->coeff[i];
-         tmp = pspp_linreg_coeff_get_var (result, 0);
+         tmp = pspp_coeff_get_var (result, 0);
        }
-      if (i == c->n_coeffs)
+      if (i == c->n_coeffs && tmp != v)
        {
          return NULL;
        }