pintos-os.org Git - pspp/blob - src/language/stats/autorecode.c

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