made matrix argument const in coefficient initialization
[pspp-builds.git] / src / math / coefficient.h
index 5c9b61d174653ccb7fd2beca620cf90c0759d198..75044f0cadcc261831520845c17ffd170cd1446d 100644 (file)
 #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;
 
 /*
@@ -54,7 +64,7 @@ struct pspp_coeff
                                   interaction terms will have more than one
                                   variable. */
 };
-
+typedef struct pspp_coeff coefficient;
 
 void pspp_coeff_free (struct pspp_coeff *);
 
@@ -62,7 +72,7 @@ void pspp_coeff_free (struct pspp_coeff *);
   Initialize the variable and value pointers inside the
   coefficient structures for the linear model.
  */
-void pspp_coeff_init (pspp_linreg_cache *, struct design_matrix *);
+void pspp_coeff_init (struct pspp_coeff **, const struct design_matrix *);
 
 
 void