/*
- lib/linreg/coefficient.c
+ src/math/coefficient.c
Copyright (C) 2005 Free Software Foundation, Inc. Written by Jason H Stover.
#include <src/data/variable.h>
#include <src/data/value.h>
+/*
+ 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;
/*
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. */
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 (pspp_linreg_cache *, 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.
/*
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
*,