X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;ds=inline;f=src%2Fmath%2Fcoefficient.h;h=8a82f46be98ebec69eaa17ab115c8add71dc4052;hb=b9767bacac9d988bf60a9b3b20338ed36e003c6b;hp=0dc1a0353943b67e81e1a7bf5d73f4b4a4692874;hpb=c21a0f82e238fe80b61d8ab00e21ec32c753ca2f;p=pspp
diff --git a/src/math/coefficient.h b/src/math/coefficient.h
index 0dc1a03539..8a82f46be9 100644
--- a/src/math/coefficient.h
+++ b/src/math/coefficient.h
@@ -1,22 +1,18 @@
-/*
- 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 . */
#ifndef COEFFICIENT_H
@@ -27,6 +23,16 @@
#include
#include
+/*
+ This file contains definitions of data structures for storing
+ coefficients of a statistical model. The coefficients are the point
+ in the model where the theoretical aspects of the model meet the
+ data. As such, the coefficients are the interface where users need
+ to match variable names and values with any information about the
+ model itself. This file and coefficient.c provide this interface
+ between data and model structures.
+ */
+
struct design_matrix;
/*
@@ -35,7 +41,7 @@ struct design_matrix;
storage. Therefore non-essential members of the struct will be
allocated only when requested.
*/
-struct pspp_linreg_coeff
+struct pspp_coeff
{
double estimate; /* Estimated coefficient. */
double std_err; /* Standard error of the estimate. */
@@ -54,22 +60,22 @@ struct pspp_linreg_coeff
interaction terms will have more than one
variable. */
};
+typedef struct pspp_coeff coefficient;
-
-void pspp_linreg_coeff_free (struct pspp_linreg_coeff *);
+void pspp_coeff_free (struct pspp_coeff *);
/*
Initialize the variable and value pointers inside the
coefficient structures for the linear model.
*/
-void pspp_linreg_coeff_init (pspp_linreg_cache *, struct design_matrix *);
+void pspp_coeff_init (struct pspp_coeff **, const struct design_matrix *);
void
-pspp_linreg_coeff_set_estimate (struct pspp_linreg_coeff *, double estimate);
+pspp_coeff_set_estimate (struct pspp_coeff *, double estimate);
void
-pspp_linreg_coeff_set_std_err (struct pspp_linreg_coeff *, double std_err);
+pspp_coeff_set_std_err (struct pspp_coeff *, double std_err);
/*
Accessor functions for matching coefficients and variables.
@@ -78,31 +84,31 @@ pspp_linreg_coeff_set_std_err (struct pspp_linreg_coeff *, double std_err);
/*
Return the estimated value of the coefficient.
*/
-double pspp_linreg_coeff_get_est (const struct pspp_linreg_coeff *);
+double pspp_coeff_get_est (const struct pspp_coeff *);
/*
Return the standard error of the estimated coefficient.
*/
-double pspp_linreg_coeff_get_std_err (const struct pspp_linreg_coeff *);
+double pspp_coeff_get_std_err (const struct pspp_coeff *);
/*
How many variables are associated with this coefficient?
*/
-int pspp_linreg_coeff_get_n_vars (struct pspp_linreg_coeff *);
+int pspp_coeff_get_n_vars (struct pspp_coeff *);
/*
Which variable does this coefficient match? The int argument is usually
0, unless the coefficient refers to an interaction.
*/
-const struct variable *pspp_linreg_coeff_get_var (struct pspp_linreg_coeff *,
+const struct variable *pspp_coeff_get_var (struct pspp_coeff *,
int);
/*
Which value is associated with this coefficient/variable comination?
*/
-const union value *pspp_linreg_coeff_get_value (struct pspp_linreg_coeff *,
+const union value *pspp_coeff_get_value (struct pspp_coeff *,
const struct variable *);
-const struct pspp_linreg_coeff *pspp_linreg_get_coeff (const pspp_linreg_cache
+const struct pspp_coeff *pspp_linreg_get_coeff (const pspp_linreg_cache
*,
const struct variable
*,