src/language/stats/autorecode.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009, 2010 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 <stdlib.h>
  20
  21 #include "data/case.h"
  22 #include "data/casereader.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/array.h"
  31 #include "libpspp/i18n.h"
  32 #include "libpspp/compiler.h"
  33 #include "libpspp/hash-functions.h"
  34 #include "libpspp/hmap.h"
  35 #include "libpspp/message.h"
  36 #include "libpspp/pool.h"
  37 #include "libpspp/str.h"
  38
  39 #include "gl/xalloc.h"
  40 #include "gl/vasnprintf.h"
  41
  42 #include "gettext.h"
  43 #define _(msgid) gettext (msgid)
  44
  45 /* FIXME: Implement PRINT subcommand. */
  46
  47 /* Explains how to recode one value. */
  48 struct arc_item
  49   {
  50     struct hmap_node hmap_node; /* Element in "struct arc_spec" hash table. */
  51     union value from;           /* Original value. */
  52     int width;                  /* Width of the original value */
  53
  54     double to;                  /* Recoded value. */
  55   };
  56
  57 /* Explains how to recode an AUTORECODE variable. */
  58 struct arc_spec
  59   {
  60     const struct variable *src; /* Source variable. */
  61     struct variable *dst;       /* Target variable. */
  62     struct hmap *items;         /* Hash table of "struct arc_item"s. */
  63   };
  64
  65 /* Descending or ascending sort order. */
  66 enum arc_direction
  67   {
  68     ASCENDING,
  69     DESCENDING
  70   };
  71
  72 /* AUTORECODE data. */
  73 struct autorecode_pgm
  74 {
  75   struct arc_spec *specs;
  76   size_t n_specs;
  77
  78   /* Hash table of "struct arc_item"s. */
  79   struct hmap *global_items;
  80 };
  81
  82 static trns_proc_func autorecode_trns_proc;
  83 static trns_free_func autorecode_trns_free;
  84
  85 static int compare_arc_items (const void *, const void *, const void *aux);
  86 static void arc_free (struct autorecode_pgm *);
  87 static struct arc_item *find_arc_item (const struct arc_spec *, const union value *,
  88                                        size_t hash);
  89
  90 /* Performs the AUTORECODE procedure. */
  91 int
  92 cmd_autorecode (struct lexer *lexer, struct dataset *ds)
  93 {
  94   struct autorecode_pgm *arc = NULL;
  95   struct dictionary *dict = dataset_dict (ds);
  96
  97   const struct variable **src_vars = NULL;
  98   char **dst_names = NULL;
  99   size_t n_srcs = 0;
 100   size_t n_dsts = 0;
 101
 102   enum arc_direction direction = ASCENDING;
 103   bool print = true;
 104
 105   struct casereader *input;
 106   struct ccase *c;
 107
 108   size_t i;
 109   bool ok;
 110
 111   /* Create procedure. */
 112   arc = xzalloc (sizeof *arc);
 113
 114   /* Parse variable lists. */
 115   lex_match_id (lexer, "VARIABLES");
 116   lex_match (lexer, T_EQUALS);
 117   if (!parse_variables_const (lexer, dict, &src_vars, &n_srcs,
 118                               PV_NO_DUPLICATE))
 119     goto error;
 120   if (!lex_force_match_id (lexer, "INTO"))
 121     goto error;
 122   lex_match (lexer, T_EQUALS);
 123   if (!parse_DATA_LIST_vars (lexer, &dst_names, &n_dsts, PV_NO_DUPLICATE))
 124     goto error;
 125   if (n_dsts != n_srcs)
 126     {
 127       msg (SE, _("Source variable count (%zu) does not match "
 128                  "target variable count (%zu)."),
 129            n_srcs, n_dsts);
 130
 131       goto error;
 132     }
 133   for (i = 0; i < n_dsts; i++)
 134     {
 135       const char *name = dst_names[i];
 136
 137       if (dict_lookup_var (dict, name) != NULL)
 138         {
 139           msg (SE, _("Target variable %s duplicates existing variable %s."),
 140                name, name);
 141           goto error;
 142         }
 143     }
 144
 145   /* Parse options. */
 146   while (lex_match (lexer, T_SLASH))
 147     {
 148       if (lex_match_id (lexer, "DESCENDING"))
 149         direction = DESCENDING;
 150       else if (lex_match_id (lexer, "PRINT"))
 151         print = true;
 152       else if (lex_match_id (lexer, "GROUP"))
 153         {
 154           arc->global_items = xmalloc (sizeof (*arc->global_items));
 155           hmap_init (arc->global_items);
 156         }
 157     }
 158
 159   if (lex_token (lexer) != T_ENDCMD)
 160     {
 161       lex_error (lexer, _("expecting end of command"));
 162       goto error;
 163     }
 164
 165   arc->specs = xmalloc (n_dsts * sizeof *arc->specs);
 166   arc->n_specs = n_dsts;
 167
 168   for (i = 0; i < n_dsts; i++)
 169     {
 170       struct arc_spec *spec = &arc->specs[i];
 171
 172       spec->src = src_vars[i];
 173       if (arc->global_items)
 174         {
 175           spec->items = arc->global_items;
 176         }
 177       else
 178         {
 179           spec->items = xmalloc (sizeof (*spec->items));
 180           hmap_init (spec->items);
 181         }
 182     }
 183
 184
 185   /* Execute procedure. */
 186   input = proc_open (ds);
 187   for (; (c = casereader_read (input)) != NULL; case_unref (c))
 188     for (i = 0; i < arc->n_specs; i++)
 189       {
 190         struct arc_spec *spec = &arc->specs[i];
 191         int width = var_get_width (spec->src);
 192         const union value *value = case_data (c, spec->src);
 193         size_t hash = value_hash (value, width, 0);
 194         struct arc_item *item;
 195
 196         item = find_arc_item (spec, value, hash);
 197         if (item == NULL)
 198           {
 199             item = xmalloc (sizeof *item);
 200             item->width = width;
 201             value_clone (&item->from, value, width);
 202             hmap_insert (spec->items, &item->hmap_node, hash);
 203           }
 204       }
 205   ok = casereader_destroy (input);
 206   ok = proc_commit (ds) && ok;
 207
 208   /* Create transformation. */
 209   for (i = 0; i < arc->n_specs; i++)
 210     {
 211       struct arc_spec *spec = &arc->specs[i];
 212       struct arc_item **items;
 213       struct arc_item *item;
 214       size_t n_items;
 215       size_t j;
 216
 217       /* Create destination variable. */
 218       spec->dst = dict_create_var_assert (dict, dst_names[i], 0);
 219
 220       /* Create array of pointers to items. */
 221       n_items = hmap_count (spec->items);
 222       items = xmalloc (n_items * sizeof *items);
 223       j = 0;
 224       HMAP_FOR_EACH (item, struct arc_item, hmap_node, spec->items)
 225         items[j++] = item;
 226
 227       assert (j == n_items);
 228
 229       /* Sort array by value. */
 230       sort (items, n_items, sizeof *items, compare_arc_items, NULL);
 231
 232       /* Assign recoded values in sorted order. */
 233       for (j = 0; j < n_items; j++)
 234         {
 235           const union value *from = &items[j]->from;
 236           size_t len;
 237           char *recoded_value  = NULL;
 238           char *c;
 239           const int src_width = items[j]->width;
 240           union value to_val;
 241           value_init (&to_val, 0);
 242
 243           items[j]->to = direction == ASCENDING ? j + 1 : n_items - j;
 244
 245           to_val.f = items[j]->to;
 246
 247           /* Add value labels to the destination variable which indicate
 248              the source value from whence the new value comes. */
 249           if (src_width > 0)
 250             {
 251               const char *str = CHAR_CAST_BUG (const char*, value_str (from, src_width));
 252
 253               recoded_value = recode_string (UTF8, dict_get_encoding (dict), str, src_width);
 254             }
 255           else
 256             recoded_value = asnprintf (NULL, &len, "%g", from->f);
 257
 258           /* Remove trailing whitespace */
 259           for (c = recoded_value; *c != '\0'; c++)
 260             if ( *c == ' ')
 261               {
 262                 *c = '\0';
 263                 break;
 264               }
 265
 266           var_add_value_label (spec->dst, &to_val, recoded_value);
 267           value_destroy (&to_val, 0);
 268           free (recoded_value);
 269         }
 270
 271       /* Free array. */
 272       free (items);
 273     }
 274   add_transformation (ds, autorecode_trns_proc, autorecode_trns_free, arc);
 275
 276   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
 277
 278 error:
 279   for (i = 0; i < n_dsts; i++)
 280     free (dst_names[i]);
 281   free (dst_names);
 282   free (src_vars);
 283   arc_free (arc);
 284   return CMD_CASCADING_FAILURE;
 285 }
 286
 287 static void
 288 arc_free (struct autorecode_pgm *arc)
 289 {
 290   if (arc != NULL)
 291     {
 292       size_t i;
 293
 294       for (i = 0; i < arc->n_specs; i++)
 295         {
 296           struct arc_spec *spec = &arc->specs[i];
 297           struct arc_item *item, *next;
 298
 299           HMAP_FOR_EACH_SAFE (item, next, struct arc_item, hmap_node,
 300                               spec->items)
 301             {
 302               value_destroy (&item->from, item->width);
 303               hmap_delete (spec->items, &item->hmap_node);
 304               free (item);
 305             }
 306         }
 307
 308       if (arc->global_items)
 309         {
 310           free (arc->global_items);
 311         }
 312       else
 313         {
 314           for (i = 0; i < arc->n_specs; i++)
 315             {
 316               struct arc_spec *spec = &arc->specs[i];
 317               if (spec->items)
 318                 {
 319                   hmap_destroy (spec->items);
 320                   free (spec->items);
 321                 }
 322             }
 323         }
 324
 325       free (arc->specs);
 326       free (arc);
 327     }
 328 }
 329
 330 static struct arc_item *
 331 find_arc_item (const struct arc_spec *spec, const union value *value,
 332                size_t hash)
 333 {
 334   struct arc_item *item;
 335
 336   HMAP_FOR_EACH_WITH_HASH (item, struct arc_item, hmap_node, hash, spec->items)
 337     if (value_equal (value, &item->from, var_get_width (spec->src)))
 338       return item;
 339   return NULL;
 340 }
 341
 342 static int
 343 compare_arc_items (const void *a_, const void *b_, const void *aux UNUSED)
 344 {
 345   const struct arc_item *const *a = a_;
 346   const struct arc_item *const *b = b_;
 347   int width_a = (*a)->width;
 348   int width_b = (*b)->width;
 349
 350   if ( width_a == width_b)
 351     return value_compare_3way (&(*a)->from, &(*b)->from, width_a);
 352
 353   if ( width_a == 0 && width_b != 0)
 354     return -1;
 355
 356   if ( width_b == 0 && width_a != 0)
 357     return +1;
 358
 359   return buf_compare_rpad (CHAR_CAST_BUG (const char *, value_str (&(*a)->from, width_a)), width_a,
 360                            CHAR_CAST_BUG (const char *, value_str (&(*b)->from, width_b)), width_b);
 361 }
 362
 363 static int
 364 autorecode_trns_proc (void *arc_, struct ccase **c,
 365                       casenumber case_idx UNUSED)
 366 {
 367   struct autorecode_pgm *arc = arc_;
 368   size_t i;
 369
 370   *c = case_unshare (*c);
 371   for (i = 0; i < arc->n_specs; i++)
 372     {
 373       const struct arc_spec *spec = &arc->specs[i];
 374       int width = var_get_width (spec->src);
 375       const union value *value = case_data (*c, spec->src);
 376       struct arc_item *item;
 377
 378       item = find_arc_item (spec, value, value_hash (value, width, 0));
 379       case_data_rw (*c, spec->dst)->f = item ? item->to : SYSMIS;
 380     }
 381
 382   return TRNS_CONTINUE;
 383 }
 384
 385 static bool
 386 autorecode_trns_free (void *arc_)
 387 {
 388   struct autorecode_pgm *arc = arc_;
 389
 390   arc_free (arc);
 391   return true;
 392 }