src/language/stats/glm.q

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007, 2009 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include <gsl/gsl_cdf.h>
  20 #include <gsl/gsl_matrix.h>
  21 #include <gsl/gsl_vector.h>
  22 #include <math.h>
  23 #include <stdlib.h>
  24
  25 #include <data/case.h>
  26 #include <data/category.h>
  27 #include <data/casegrouper.h>
  28 #include <data/casereader.h>
  29 #include <data/dictionary.h>
  30 #include <data/missing-values.h>
  31 #include <data/procedure.h>
  32 #include <data/transformations.h>
  33 #include <data/value-labels.h>
  34 #include <data/variable.h>
  35 #include <language/command.h>
  36 #include <language/dictionary/split-file.h>
  37 #include <language/data-io/file-handle.h>
  38 #include <language/lexer/lexer.h>
  39 #include <libpspp/compiler.h>
  40 #include <libpspp/hash.h>
  41 #include <libpspp/message.h>
  42 #include <math/covariance-matrix.h>
  43 #include <math/coefficient.h>
  44 #include <math/linreg.h>
  45 #include <math/moments.h>
  46 #include <output/table.h>
  47
  48 #include "xalloc.h"
  49 #include "gettext.h"
  50
  51 /* (headers) */
  52
  53 /* (specification)
  54    "GLM" (glm_):
  55    *dependent=custom;
  56    by=varlist;
  57    with=varlist.
  58 */
  59 /* (declarations) */
  60 /* (functions) */
  61 static struct cmd_glm cmd;
  62
  63 /*
  64   Moments for each of the variables used.
  65  */
  66 struct moments_var
  67 {
  68   struct moments1 *m;
  69   double *weight;
  70   double *mean;
  71   double *variance;
  72   const struct variable *v;
  73 };
  74
  75
  76 /*
  77   Dependent variable used.
  78  */
  79 static const struct variable **v_dependent;
  80
  81 /*
  82   Number of dependent variables.
  83  */
  84 static size_t n_dependent;
  85
  86 #if 0
  87 /*
  88   Return value for the procedure.
  89  */
  90 static int pspp_glm_rc = CMD_SUCCESS;
  91 #else
  92 int cmd_glm (struct lexer *lexer, struct dataset *ds);
  93 #endif
  94
  95 static bool run_glm (struct casereader *,
  96                      struct cmd_glm *,
  97                      const struct dataset *);
  98
  99 int
 100 cmd_glm (struct lexer *lexer, struct dataset *ds)
 101 {
 102   struct casegrouper *grouper;
 103   struct casereader *group;
 104
 105   bool ok;
 106
 107   if (!parse_glm (lexer, ds, &cmd, NULL))
 108     return CMD_FAILURE;
 109
 110   /* Data pass. */
 111   grouper = casegrouper_create_splits (proc_open (ds), dataset_dict (ds));
 112   while (casegrouper_get_next_group (grouper, &group))
 113     {
 114       run_glm (group, &cmd, ds);
 115     }
 116   ok = casegrouper_destroy (grouper);
 117   ok = proc_commit (ds) && ok;
 118
 119   free (v_dependent);
 120   return ok ? CMD_SUCCESS : CMD_FAILURE;
 121 }
 122
 123 /* Parser for the dependent sub command */
 124 static int
 125 glm_custom_dependent (struct lexer *lexer, struct dataset *ds,
 126                       struct cmd_glm *cmd UNUSED, void *aux UNUSED)
 127 {
 128   const struct dictionary *dict = dataset_dict (ds);
 129
 130   if ((lex_token (lexer) != T_ID
 131        || dict_lookup_var (dict, lex_tokid (lexer)) == NULL)
 132       && lex_token (lexer) != T_ALL)
 133     return 2;
 134
 135   if (!parse_variables_const
 136       (lexer, dict, &v_dependent, &n_dependent, PV_NONE))
 137     {
 138       free (v_dependent);
 139       return 0;
 140     }
 141   assert (n_dependent);
 142   if (n_dependent > 1)
 143     msg (SE, _("Multivariate GLM not yet supported"));
 144   n_dependent = 1;              /* Drop this line after adding support for multivariate GLM. */
 145
 146   return 1;
 147 }
 148
 149 /*
 150   COV is the covariance matrix for variables included in the
 151   model. That means the dependent variable is in there, too.
 152  */
 153 static void
 154 coeff_init (pspp_linreg_cache * c, const struct design_matrix *cov)
 155 {
 156   c->coeff = xnmalloc (cov->m->size2, sizeof (*c->coeff));
 157   c->n_coeffs = cov->m->size2 - 1;
 158   pspp_coeff_init (c->coeff, cov);
 159 }
 160
 161
 162 static pspp_linreg_cache *
 163 fit_model (const struct covariance_matrix *cov,
 164            const struct variable *dep_var,
 165            const struct variable ** indep_vars,
 166            size_t n_data, size_t n_indep)
 167 {
 168   pspp_linreg_cache *result = NULL;
 169   result = pspp_linreg_cache_alloc (dep_var, indep_vars, n_data, n_indep);
 170   coeff_init (result, covariance_to_design (cov));
 171   pspp_linreg_with_cov (cov, result);
 172
 173   return result;
 174 }
 175
 176 static bool
 177 run_glm (struct casereader *input,
 178          struct cmd_glm *cmd,
 179          const struct dataset *ds)
 180 {
 181   casenumber row;
 182   const struct variable **indep_vars;
 183   const struct variable **all_vars;
 184   int n_indep = 0;
 185   pspp_linreg_cache *model = NULL;
 186   pspp_linreg_opts lopts;
 187   struct ccase *c;
 188   size_t i;
 189   size_t n_all_vars;
 190   size_t n_data;                /* Number of valid cases. */
 191   struct casereader *reader;
 192   struct covariance_matrix *cov;
 193
 194   c = casereader_peek (input, 0);
 195   if (c == NULL)
 196     {
 197       casereader_destroy (input);
 198       return true;
 199     }
 200   output_split_file_values (ds, c);
 201   case_unref (c);
 202
 203   if (!v_dependent)
 204     {
 205       dict_get_vars (dataset_dict (ds), &v_dependent, &n_dependent,
 206                      1u << DC_SYSTEM);
 207     }
 208
 209   lopts.get_depvar_mean_std = 1;
 210
 211   lopts.get_indep_mean_std = xnmalloc (n_dependent, sizeof (int));
 212   indep_vars = xnmalloc (cmd->n_by, sizeof *indep_vars);
 213   n_all_vars = cmd->n_by + n_dependent;
 214   all_vars = xnmalloc (n_all_vars, sizeof *all_vars);
 215
 216   for (i = 0; i < n_dependent; i++)
 217     {
 218       all_vars[i] = v_dependent[i];
 219     }
 220   for (i = 0; i < cmd->n_by; i++)
 221     {
 222       indep_vars[i] = cmd->v_by[i];
 223       all_vars[i + n_dependent] = cmd->v_by[i];
 224     }
 225   n_indep = cmd->n_by;
 226
 227   reader = casereader_clone (input);
 228   reader = casereader_create_filter_missing (reader, indep_vars, n_indep,
 229                                              MV_ANY, NULL, NULL);
 230   reader = casereader_create_filter_missing (reader, v_dependent, 1,
 231                                              MV_ANY, NULL, NULL);
 232
 233   if (n_indep > 0)
 234     {
 235       for (i = 0; i < n_all_vars; i++)
 236         if (var_is_alpha (all_vars[i]))
 237           cat_stored_values_create (all_vars[i]);
 238
 239       cov = covariance_matrix_init (n_all_vars, all_vars, ONE_PASS, PAIRWISE, MV_ANY);
 240       reader = casereader_create_counter (reader, &row, -1);
 241       for (; (c = casereader_read (reader)) != NULL; case_unref (c))
 242         {
 243           /*
 244              Accumulate the covariance matrix.
 245           */
 246           covariance_matrix_accumulate (cov, c, NULL, 0);
 247           n_data++;
 248         }
 249       covariance_matrix_compute (cov);
 250
 251       for (i = 0; i < n_dependent; i++)
 252         {
 253           model = fit_model (cov, v_dependent[i], indep_vars, n_data, n_indep);
 254           pspp_linreg_cache_free (model);
 255         }
 256
 257       casereader_destroy (reader);
 258       covariance_matrix_destroy (cov);
 259     }
 260   else
 261     {
 262       msg (SE, gettext ("No valid data found. This command was skipped."));
 263     }
 264   free (indep_vars);
 265   free (lopts.get_indep_mean_std);
 266   casereader_destroy (input);
 267
 268   return true;
 269 }
 270
 271 /*
 272   Local Variables:
 273   mode: c
 274   End:
 275 */