src/language/stats/autorecode.c

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    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, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17    02110-1301, USA. */
  18
  19 #include <config.h>
  20 #include <stdlib.h>
  21
  22 #include <data/case.h>
  23 #include <data/dictionary.h>
  24 #include <data/procedure.h>
  25 #include <data/transformations.h>
  26 #include <data/variable.h>
  27 #include <language/command.h>
  28 #include <language/lexer/lexer.h>
  29 #include <language/lexer/variable-parser.h>
  30 #include <libpspp/alloc.h>
  31 #include <libpspp/compiler.h>
  32 #include <libpspp/hash.h>
  33 #include <libpspp/message.h>
  34 #include <libpspp/message.h>
  35 #include <libpspp/pool.h>
  36 #include <libpspp/str.h>
  37
  38 #include "gettext.h"
  39 #define _(msgid) gettext (msgid)
  40
  41 /* FIXME: Implement PRINT subcommand. */
  42
  43 /* An AUTORECODE variable's original value. */
  44 union arc_value
  45   {
  46     double f;                   /* Numeric. */
  47     char *c;                    /* Short or long string. */
  48   };
  49
  50 /* Explains how to recode one value.  `from' must be first element.  */
  51 struct arc_item
  52   {
  53     union arc_value from;       /* Original value. */
  54     double to;                  /* Recoded value. */
  55   };
  56
  57 /* Explains how to recode an AUTORECODE variable. */
  58 struct arc_spec
  59   {
  60     struct variable *src;       /* Source variable. */
  61     struct variable *dest;      /* Target variable. */
  62     struct hsh_table *items;    /* Hash table of `freq's. */
  63   };
  64
  65 /* AUTORECODE transformation. */
  66 struct autorecode_trns
  67   {
  68     struct pool *pool;          /* Contains AUTORECODE specs. */
  69     struct arc_spec *specs;     /* AUTORECODE specifications. */
  70     size_t spec_cnt;            /* Number of specifications. */
  71   };
  72
  73 /* Descending or ascending sort order. */
  74 enum direction
  75   {
  76     ASCENDING,
  77     DESCENDING
  78   };
  79
  80 /* AUTORECODE data. */
  81 struct autorecode_pgm
  82   {
  83     struct variable **src_vars;    /* Source variables. */
  84     char **dst_names;              /* Target variable names. */
  85     struct variable **dst_vars;    /* Target variables. */
  86     struct hsh_table **src_values; /* `union arc_value's of source vars. */
  87     size_t var_cnt;                /* Number of variables. */
  88     struct pool *src_values_pool;  /* Pool used by src_values. */
  89     enum direction direction;      /* Sort order. */
  90     int print;                     /* Print mapping table if nonzero. */
  91   };
  92
  93 static trns_proc_func autorecode_trns_proc;
  94 static trns_free_func autorecode_trns_free;
  95 static bool autorecode_proc_func (const struct ccase *, void *, const struct dataset *);
  96 static hsh_compare_func compare_alpha_value, compare_numeric_value;
  97 static hsh_hash_func hash_alpha_value, hash_numeric_value;
  98
  99 static void recode (struct dataset *, const struct autorecode_pgm *);
 100 static void arc_free (struct autorecode_pgm *);
 101
 102 /* Performs the AUTORECODE procedure. */
 103 int
 104 cmd_autorecode (struct lexer *lexer, struct dataset *ds)
 105 {
 106   struct autorecode_pgm arc;
 107   size_t dst_cnt;
 108   size_t i;
 109   bool ok;
 110
 111   arc.src_vars = NULL;
 112   arc.dst_names = NULL;
 113   arc.dst_vars = NULL;
 114   arc.src_values = NULL;
 115   arc.var_cnt = 0;
 116   arc.src_values_pool = NULL;
 117   arc.direction = ASCENDING;
 118   arc.print = 0;
 119   dst_cnt = 0;
 120
 121   lex_match_id (lexer, "VARIABLES");
 122   lex_match (lexer, '=');
 123   if (!parse_variables (lexer, dataset_dict (ds), &arc.src_vars, &arc.var_cnt,
 124                         PV_NO_DUPLICATE))
 125     goto lossage;
 126   if (!lex_force_match_id (lexer, "INTO"))
 127     goto lossage;
 128   lex_match (lexer, '=');
 129   if (!parse_DATA_LIST_vars (lexer, &arc.dst_names, &dst_cnt, PV_NONE))
 130     goto lossage;
 131   if (dst_cnt != arc.var_cnt)
 132     {
 133       size_t i;
 134
 135       msg (SE, _("Source variable count (%u) does not match "
 136                  "target variable count (%u)."),
 137            (unsigned) arc.var_cnt, (unsigned) dst_cnt);
 138
 139       for (i = 0; i < dst_cnt; i++)
 140         free (arc.dst_names[i]);
 141       free (arc.dst_names);
 142       arc.dst_names = NULL;
 143
 144       goto lossage;
 145     }
 146   while (lex_match (lexer, '/'))
 147     if (lex_match_id (lexer, "DESCENDING"))
 148       arc.direction = DESCENDING;
 149     else if (lex_match_id (lexer, "PRINT"))
 150       arc.print = 1;
 151   if (lex_token (lexer) != '.')
 152     {
 153       lex_error (lexer, _("expecting end of command"));
 154       goto lossage;
 155     }
 156
 157   for (i = 0; i < arc.var_cnt; i++)
 158     {
 159       int j;
 160
 161       if (dict_lookup_var (dataset_dict (ds), arc.dst_names[i]) != NULL)
 162         {
 163           msg (SE, _("Target variable %s duplicates existing variable %s."),
 164                arc.dst_names[i], arc.dst_names[i]);
 165           goto lossage;
 166         }
 167       for (j = 0; j < i; j++)
 168         if (!strcasecmp (arc.dst_names[i], arc.dst_names[j]))
 169           {
 170             msg (SE, _("Duplicate variable name %s among target variables."),
 171                  arc.dst_names[i]);
 172             goto lossage;
 173           }
 174     }
 175
 176   arc.src_values_pool = pool_create ();
 177   arc.dst_vars = xnmalloc (arc.var_cnt, sizeof *arc.dst_vars);
 178   arc.src_values = xnmalloc (arc.var_cnt, sizeof *arc.src_values);
 179   for (i = 0; i < dst_cnt; i++)
 180     if (var_is_alpha (arc.src_vars[i]))
 181       arc.src_values[i] = hsh_create (10, compare_alpha_value,
 182                                       hash_alpha_value, NULL, arc.src_vars[i]);
 183     else
 184       arc.src_values[i] = hsh_create (10, compare_numeric_value,
 185                                       hash_numeric_value, NULL, NULL);
 186
 187   ok = procedure (ds, autorecode_proc_func, &arc);
 188
 189   for (i = 0; i < arc.var_cnt; i++)
 190     arc.dst_vars[i] = dict_create_var_assert (dataset_dict (ds),
 191                                               arc.dst_names[i], 0);
 192
 193   recode (ds, &arc);
 194   arc_free (&arc);
 195   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
 196
 197 lossage:
 198   arc_free (&arc);
 199   return CMD_CASCADING_FAILURE;
 200 }
 201
 202 static void
 203 arc_free (struct autorecode_pgm *arc)
 204 {
 205   free (arc->src_vars);
 206   if (arc->dst_names != NULL)
 207     {
 208       size_t i;
 209
 210       for (i = 0; i < arc->var_cnt; i++)
 211         free (arc->dst_names[i]);
 212       free (arc->dst_names);
 213     }
 214   free (arc->dst_vars);
 215   if (arc->src_values != NULL)
 216     {
 217       size_t i;
 218
 219       for (i = 0; i < arc->var_cnt; i++)
 220         hsh_destroy (arc->src_values[i]);
 221       free (arc->src_values);
 222     }
 223   pool_destroy (arc->src_values_pool);
 224 }
 225
 226 \f
 227 /* AUTORECODE transformation. */
 228
 229 static void
 230 recode (struct dataset *ds, const struct autorecode_pgm *arc)
 231 {
 232   struct autorecode_trns *trns;
 233   size_t i;
 234
 235   trns = pool_create_container (struct autorecode_trns, pool);
 236   trns->specs = pool_nalloc (trns->pool, arc->var_cnt, sizeof *trns->specs);
 237   trns->spec_cnt = arc->var_cnt;
 238   for (i = 0; i < arc->var_cnt; i++)
 239     {
 240       struct arc_spec *spec = &trns->specs[i];
 241       void *const *p = hsh_sort (arc->src_values[i]);
 242       int count = hsh_count (arc->src_values[i]);
 243       int j;
 244
 245       spec->src = arc->src_vars[i];
 246       spec->dest = arc->dst_vars[i];
 247
 248       if (var_is_alpha (arc->src_vars[i]))
 249         spec->items = hsh_create (2 * count, compare_alpha_value,
 250                                   hash_alpha_value, NULL, arc->src_vars[i]);
 251       else
 252         spec->items = hsh_create (2 * count, compare_numeric_value,
 253                                   hash_numeric_value, NULL, NULL);
 254
 255       for (j = 0; *p; p++, j++)
 256         {
 257           struct arc_item *item = pool_alloc (trns->pool, sizeof *item);
 258           union arc_value *vp = *p;
 259
 260           if (var_is_numeric (arc->src_vars[i]))
 261             item->from.f = vp->f;
 262           else
 263             item->from.c = pool_clone (trns->pool, vp->c,
 264                                        var_get_width (arc->src_vars[i]));
 265           item->to = arc->direction == ASCENDING ? j + 1 : count - j;
 266           hsh_force_insert (spec->items, item);
 267         }
 268     }
 269   add_transformation (ds,
 270                       autorecode_trns_proc, autorecode_trns_free, trns);
 271 }
 272
 273 /* Executes an AUTORECODE transformation. */
 274 static int
 275 autorecode_trns_proc (void *trns_, struct ccase *c, casenumber case_idx UNUSED)
 276 {
 277   struct autorecode_trns *trns = trns_;
 278   size_t i;
 279
 280   for (i = 0; i < trns->spec_cnt; i++)
 281     {
 282       struct arc_spec *spec = &trns->specs[i];
 283       struct arc_item *item;
 284       union arc_value v;
 285
 286       if (var_is_numeric (spec->src))
 287         v.f = case_num (c, spec->src);
 288       else
 289         v.c = (char *) case_str (c, spec->src);
 290       item = hsh_force_find (spec->items, &v);
 291
 292       case_data_rw (c, spec->dest)->f = item->to;
 293     }
 294   return TRNS_CONTINUE;
 295 }
 296
 297 /* Frees an AUTORECODE transformation. */
 298 static bool
 299 autorecode_trns_free (void *trns_)
 300 {
 301   struct autorecode_trns *trns = trns_;
 302   size_t i;
 303
 304   for (i = 0; i < trns->spec_cnt; i++)
 305     hsh_destroy (trns->specs[i].items);
 306   pool_destroy (trns->pool);
 307   return true;
 308 }
 309 \f
 310 /* AUTORECODE procedure. */
 311
 312 static int
 313 compare_alpha_value (const void *a_, const void *b_, const void *v_)
 314 {
 315   const union arc_value *a = a_;
 316   const union arc_value *b = b_;
 317   const struct variable *v = v_;
 318
 319   return memcmp (a->c, b->c, var_get_width (v));
 320 }
 321
 322 static unsigned
 323 hash_alpha_value (const void *a_, const void *v_)
 324 {
 325   const union arc_value *a = a_;
 326   const struct variable *v = v_;
 327
 328   return hsh_hash_bytes (a->c, var_get_width (v));
 329 }
 330
 331 static int
 332 compare_numeric_value (const void *a_, const void *b_, const void *aux UNUSED)
 333 {
 334   const union arc_value *a = a_;
 335   const union arc_value *b = b_;
 336
 337   return a->f < b->f ? -1 : a->f > b->f;
 338 }
 339
 340 static unsigned
 341 hash_numeric_value (const void *a_, const void *aux UNUSED)
 342 {
 343   const union arc_value *a = a_;
 344
 345   return hsh_hash_double (a->f);
 346 }
 347
 348 static bool
 349 autorecode_proc_func (const struct ccase *c, void *arc_, const struct dataset *ds UNUSED)
 350 {
 351   struct autorecode_pgm *arc = arc_;
 352   size_t i;
 353
 354   for (i = 0; i < arc->var_cnt; i++)
 355     {
 356       union arc_value v, *vp, **vpp;
 357
 358       if (var_is_numeric (arc->src_vars[i]))
 359         v.f = case_num (c, arc->src_vars[i]);
 360       else
 361         v.c = (char *) case_str (c, arc->src_vars[i]);
 362
 363       vpp = (union arc_value **) hsh_probe (arc->src_values[i], &v);
 364       if (*vpp == NULL)
 365         {
 366           vp = pool_alloc (arc->src_values_pool, sizeof *vp);
 367           if (var_is_numeric (arc->src_vars[i]))
 368             vp->f = v.f;
 369           else
 370             vp->c = pool_clone (arc->src_values_pool,
 371                                 v.c, var_get_width (arc->src_vars[i]));
 372           *vpp = vp;
 373         }
 374     }
 375   return true;
 376 }