src/language/stats/rank.q

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2005, 2006, 2007 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 <limits.h>
  20 #include <math.h>
  21
  22 #include <data/dictionary.h>
  23 #include <data/format.h>
  24 #include <data/missing-values.h>
  25 #include <data/procedure.h>
  26 #include <data/variable.h>
  27 #include <data/case-ordering.h>
  28 #include <data/case.h>
  29 #include <data/casegrouper.h>
  30 #include <data/casereader.h>
  31 #include <data/casewriter.h>
  32 #include <language/command.h>
  33 #include <language/stats/sort-criteria.h>
  34 #include <libpspp/compiler.h>
  35 #include <libpspp/taint.h>
  36 #include <math/sort.h>
  37 #include <output/table.h>
  38 #include <output/manager.h>
  39
  40 #include <gsl/gsl_cdf.h>
  41
  42 #include "gettext.h"
  43 #define _(msgid) gettext (msgid)
  44
  45 /* (headers) */
  46
  47 /* (specification)
  48    "RANK" (rank_):
  49    *^variables=custom;
  50    +rank=custom;
  51    +normal=custom;
  52    +percent=custom;
  53    +ntiles=custom;
  54    +rfraction=custom;
  55    +proportion=custom;
  56    +n=custom;
  57    +savage=custom;
  58    +print=print:!yes/no;
  59    +fraction=fraction:!blom/tukey/vw/rankit;
  60    +ties=ties:!mean/low/high/condense;
  61    missing=miss:!exclude/include.
  62 */
  63 /* (declarations) */
  64 /* (functions) */
  65
  66 typedef double (*rank_function_t) (double c, double cc, double cc_1,
  67                                  int i, double w);
  68
  69 static double rank_proportion (double c, double cc, double cc_1,
  70                                int i, double w);
  71
  72 static double rank_normal (double c, double cc, double cc_1,
  73                            int i, double w);
  74
  75 static double rank_percent (double c, double cc, double cc_1,
  76                             int i, double w);
  77
  78 static double rank_rfraction (double c, double cc, double cc_1,
  79                               int i, double w);
  80
  81 static double rank_rank (double c, double cc, double cc_1,
  82                          int i, double w);
  83
  84 static double rank_n (double c, double cc, double cc_1,
  85                       int i, double w);
  86
  87 static double rank_savage (double c, double cc, double cc_1,
  88                       int i, double w);
  89
  90 static double rank_ntiles (double c, double cc, double cc_1,
  91                       int i, double w);
  92
  93
  94 enum RANK_FUNC
  95   {
  96     RANK,
  97     NORMAL,
  98     PERCENT,
  99     RFRACTION,
 100     PROPORTION,
 101     N,
 102     NTILES,
 103     SAVAGE,
 104     n_RANK_FUNCS
 105   };
 106
 107 static const struct fmt_spec dest_format[n_RANK_FUNCS] = {
 108   {FMT_F, 9, 3}, /* rank */
 109   {FMT_F, 6, 4}, /* normal */
 110   {FMT_F, 6, 2}, /* percent */
 111   {FMT_F, 6, 4}, /* rfraction */
 112   {FMT_F, 6, 4}, /* proportion */
 113   {FMT_F, 6, 0}, /* n */
 114   {FMT_F, 3, 0}, /* ntiles */
 115   {FMT_F, 8, 4}  /* savage */
 116 };
 117
 118 static const char * const function_name[n_RANK_FUNCS] = {
 119   "RANK",
 120   "NORMAL",
 121   "PERCENT",
 122   "RFRACTION",
 123   "PROPORTION",
 124   "N",
 125   "NTILES",
 126   "SAVAGE"
 127 };
 128
 129 static const rank_function_t rank_func[n_RANK_FUNCS] = {
 130   rank_rank,
 131   rank_normal,
 132   rank_percent,
 133   rank_rfraction,
 134   rank_proportion,
 135   rank_n,
 136   rank_ntiles,
 137   rank_savage
 138   };
 139
 140
 141 struct rank_spec
 142 {
 143   enum RANK_FUNC rfunc;
 144   struct variable **destvars;
 145 };
 146
 147
 148 /* Categories of missing values to exclude. */
 149 static enum mv_class exclude_values;
 150
 151 static struct rank_spec *rank_specs;
 152 static size_t n_rank_specs;
 153
 154 static struct case_ordering *sc;
 155
 156 static const struct variable **group_vars;
 157 static size_t n_group_vars;
 158
 159 static const struct variable **src_vars;
 160 static size_t n_src_vars;
 161
 162
 163 static int k_ntiles;
 164
 165 static struct cmd_rank cmd;
 166
 167 static void rank_sorted_file (struct casereader *,
 168                               struct casewriter *,
 169                               const struct dictionary *,
 170                               const struct rank_spec *rs,
 171                               int n_rank_specs,
 172                               int idx,
 173                               const struct variable *rank_var);
 174
 175 static const char *
 176 fraction_name(void)
 177 {
 178   static char name[10];
 179   switch ( cmd.fraction )
 180     {
 181     case RANK_BLOM:
 182       strcpy (name, "BLOM");
 183       break;
 184     case RANK_RANKIT:
 185       strcpy (name, "RANKIT");
 186       break;
 187     case RANK_TUKEY:
 188       strcpy (name, "TUKEY");
 189       break;
 190     case RANK_VW:
 191       strcpy (name, "VW");
 192       break;
 193     default:
 194       NOT_REACHED ();
 195     }
 196   return name;
 197 }
 198
 199 /* Create a label on DEST_VAR, describing its derivation from SRC_VAR and F */
 200 static void
 201 create_var_label (struct variable *dest_var,
 202                   const struct variable *src_var, enum RANK_FUNC f)
 203 {
 204   struct string label;
 205   ds_init_empty (&label);
 206
 207   if ( n_group_vars > 0 )
 208     {
 209       struct string group_var_str;
 210       int g;
 211
 212       ds_init_empty (&group_var_str);
 213
 214       for (g = 0 ; g < n_group_vars ; ++g )
 215         {
 216           if ( g > 0 ) ds_put_cstr (&group_var_str, " ");
 217           ds_put_cstr (&group_var_str, var_get_name (group_vars[g]));
 218         }
 219
 220       ds_put_format (&label, _("%s of %s by %s"), function_name[f],
 221                      var_get_name (src_var), ds_cstr (&group_var_str));
 222       ds_destroy (&group_var_str);
 223     }
 224   else
 225     ds_put_format (&label, _("%s of %s"),
 226                    function_name[f], var_get_name (src_var));
 227
 228   var_set_label (dest_var, ds_cstr (&label));
 229
 230   ds_destroy (&label);
 231 }
 232
 233
 234 static bool
 235 rank_cmd (struct dataset *ds, const struct case_ordering *sc,
 236           const struct rank_spec *rank_specs, int n_rank_specs)
 237 {
 238   struct dictionary *d = dataset_dict (ds);
 239   bool ok = true;
 240   int i;
 241
 242   for (i = 0 ; i < case_ordering_get_var_cnt (sc) ; ++i )
 243     {
 244       /* Rank variable at index I in SC. */
 245       struct casegrouper *split_grouper;
 246       struct casereader *split_group;
 247       struct casewriter *output;
 248
 249       proc_discard_output (ds);
 250       split_grouper = casegrouper_create_splits (proc_open (ds), d);
 251       output = autopaging_writer_create (dict_get_next_value_idx (d));
 252
 253       while (casegrouper_get_next_group (split_grouper, &split_group))
 254         {
 255           struct case_ordering *ordering;
 256           struct casereader *ordered;
 257           struct casegrouper *by_grouper;
 258           struct casereader *by_group;
 259           int j;
 260
 261           /* Sort this split group by the BY variables as primary
 262              keys and the rank variable as secondary key. */
 263           ordering = case_ordering_create (d);
 264           for (j = 0; j < n_group_vars; j++)
 265             case_ordering_add_var (ordering, group_vars[j], SRT_ASCEND);
 266           case_ordering_add_var (ordering,
 267                                  case_ordering_get_var (sc, i),
 268                                  case_ordering_get_direction (sc, i));
 269           ordered = sort_execute (split_group, ordering);
 270
 271           /* Rank the rank variable within this split group. */
 272           by_grouper = casegrouper_create_vars (ordered,
 273                                                 group_vars, n_group_vars);
 274           while (casegrouper_get_next_group (by_grouper, &by_group))
 275             {
 276               /* Rank the rank variable within this BY group
 277                  within the split group. */
 278
 279               rank_sorted_file (by_group, output, d, rank_specs, n_rank_specs,
 280                                 i, src_vars[i]);
 281             }
 282           ok = casegrouper_destroy (by_grouper) && ok;
 283         }
 284       ok = casegrouper_destroy (split_grouper);
 285       ok = proc_commit (ds) && ok;
 286       ok = (proc_set_active_file_data (ds, casewriter_make_reader (output))
 287             && ok);
 288       if (!ok)
 289         break;
 290     }
 291
 292   return ok;
 293 }
 294
 295 /* Hardly a rank function !! */
 296 static double
 297 rank_n (double c UNUSED, double cc UNUSED, double cc_1 UNUSED,
 298           int i UNUSED, double w)
 299 {
 300   return w;
 301 }
 302
 303
 304 static double
 305 rank_rank (double c, double cc, double cc_1,
 306           int i, double w UNUSED)
 307 {
 308   double rank;
 309
 310   if ( c >= 1.0 )
 311     {
 312       switch (cmd.ties)
 313         {
 314         case RANK_LOW:
 315           rank = cc_1 + 1;
 316           break;
 317         case RANK_HIGH:
 318           rank = cc;
 319           break;
 320         case RANK_MEAN:
 321           rank = cc_1 + (c + 1.0)/ 2.0;
 322           break;
 323         case RANK_CONDENSE:
 324           rank = i;
 325           break;
 326         default:
 327           NOT_REACHED ();
 328         }
 329     }
 330   else
 331     {
 332       switch (cmd.ties)
 333         {
 334         case RANK_LOW:
 335           rank = cc_1;
 336           break;
 337         case RANK_HIGH:
 338           rank = cc;
 339           break;
 340         case RANK_MEAN:
 341           rank = cc_1 + c / 2.0 ;
 342           break;
 343         case RANK_CONDENSE:
 344           rank = i;
 345           break;
 346         default:
 347           NOT_REACHED ();
 348         }
 349     }
 350
 351   return rank;
 352 }
 353
 354
 355 static double
 356 rank_rfraction (double c, double cc, double cc_1,
 357                 int i, double w)
 358 {
 359   return rank_rank (c, cc, cc_1, i, w) / w ;
 360 }
 361
 362
 363 static double
 364 rank_percent (double c, double cc, double cc_1,
 365                 int i, double w)
 366 {
 367   return rank_rank (c, cc, cc_1, i, w) * 100.0 / w ;
 368 }
 369
 370
 371 static double
 372 rank_proportion (double c, double cc, double cc_1,
 373                  int i, double w)
 374 {
 375   const double r =  rank_rank (c, cc, cc_1, i, w) ;
 376
 377   double f;
 378
 379   switch ( cmd.fraction )
 380     {
 381     case RANK_BLOM:
 382       f =  (r - 3.0/8.0) / (w + 0.25);
 383       break;
 384     case RANK_RANKIT:
 385       f = (r - 0.5) / w ;
 386       break;
 387     case RANK_TUKEY:
 388       f = (r - 1.0/3.0) / (w + 1.0/3.0);
 389       break;
 390     case RANK_VW:
 391       f = r / ( w + 1.0);
 392       break;
 393     default:
 394       NOT_REACHED ();
 395     }
 396
 397
 398   return (f > 0) ? f : SYSMIS;
 399 }
 400
 401 static double
 402 rank_normal (double c, double cc, double cc_1,
 403              int i, double w)
 404 {
 405   double f = rank_proportion (c, cc, cc_1, i, w);
 406
 407   return gsl_cdf_ugaussian_Pinv (f);
 408 }
 409
 410 static double
 411 rank_ntiles (double c, double cc, double cc_1,
 412                 int i, double w)
 413 {
 414   double r = rank_rank (c, cc, cc_1, i, w);
 415
 416
 417   return ( floor (( r * k_ntiles) / ( w + 1) ) + 1);
 418 }
 419
 420 /* Expected value of the order statistics from an exponential distribution */
 421 static double
 422 ee (int j, double w_star)
 423 {
 424   int k;
 425   double sum = 0.0;
 426
 427   for (k = 1 ; k <= j; k++)
 428     sum += 1.0 / ( w_star + 1 - k );
 429
 430   return sum;
 431 }
 432
 433
 434 static double
 435 rank_savage (double c, double cc, double cc_1,
 436                 int i UNUSED, double w)
 437 {
 438   double int_part;
 439   const int i_1 = floor (cc_1);
 440   const int i_2 = floor (cc);
 441
 442   const double w_star = (modf (w, &int_part) == 0 ) ? w : floor (w) + 1;
 443
 444   const double g_1 = cc_1 - i_1;
 445   const double g_2 = cc - i_2;
 446
 447   /* The second factor is infinite, when the first is zero.
 448      Therefore, evaluate the second, only when the first is non-zero */
 449   const double expr1 =  (1 - g_1) ? (1 - g_1) * ee(i_1+1, w_star) : ( 1 - g_1);
 450   const double expr2 =  g_2 ? g_2 * ee (i_2+1, w_star) : g_2 ;
 451
 452   if ( i_1 == i_2 )
 453     return ee (i_1 + 1, w_star) - 1;
 454
 455   if ( i_1 + 1 == i_2 )
 456     return ( ( expr1 + expr2 )/c ) - 1;
 457
 458   if ( i_1 + 2 <= i_2 )
 459     {
 460       int j;
 461       double sigma = 0.0;
 462       for (j = i_1 + 2 ; j <= i_2; ++j )
 463         sigma += ee (j, w_star);
 464       return ( (expr1 + expr2 + sigma) / c) -1;
 465     }
 466
 467   NOT_REACHED();
 468 }
 469
 470 static void
 471 rank_sorted_file (struct casereader *input,
 472                   struct casewriter *output,
 473                   const struct dictionary *dict,
 474                   const struct rank_spec *rs,
 475                   int n_rank_specs,
 476                   int dest_idx,
 477                   const struct variable *rank_var)
 478 {
 479   struct casereader *pass1, *pass2, *pass2_1;
 480   struct casegrouper *tie_grouper;
 481   struct ccase c;
 482   double w = 0.0;
 483   double cc = 0.0;
 484   int tie_group = 1;
 485
 486
 487   input = casereader_create_filter_missing (input, &rank_var, 1,
 488                                             exclude_values, output);
 489   input = casereader_create_filter_weight (input, dict, NULL, output);
 490
 491   casereader_split (input, &pass1, &pass2);
 492
 493   /* Pass 1: Get total group weight. */
 494   for (; casereader_read (pass1, &c); case_destroy (&c))
 495     w += dict_get_case_weight (dict, &c, NULL);
 496   casereader_destroy (pass1);
 497
 498   /* Pass 2: Do ranking. */
 499   tie_grouper = casegrouper_create_vars (pass2, &rank_var, 1);
 500   while (casegrouper_get_next_group (tie_grouper, &pass2_1))
 501     {
 502       struct casereader *pass2_2;
 503       double cc_1 = cc;
 504       double tw = 0.0;
 505       int i;
 506
 507       pass2_2 = casereader_clone (pass2_1);
 508       taint_propagate (casereader_get_taint (pass2_2),
 509                        casewriter_get_taint (output));
 510
 511       /* Pass 2.1: Sum up weight for tied cases. */
 512       for (; casereader_read (pass2_1, &c); case_destroy (&c))
 513         tw += dict_get_case_weight (dict, &c, NULL);
 514       cc += tw;
 515       casereader_destroy (pass2_1);
 516
 517       /* Pass 2.2: Rank tied cases. */
 518       while (casereader_read (pass2_2, &c))
 519         {
 520           for (i = 0; i < n_rank_specs; ++i)
 521             {
 522               const struct variable *dst_var = rs[i].destvars[dest_idx];
 523               double *dst_value = &case_data_rw (&c, dst_var)->f;
 524               *dst_value = rank_func[rs[i].rfunc] (tw, cc, cc_1, tie_group, w);
 525             }
 526           casewriter_write (output, &c);
 527         }
 528       casereader_destroy (pass2_2);
 529
 530       tie_group++;
 531     }
 532   casegrouper_destroy (tie_grouper);
 533 }
 534
 535 /* Transformation function to enumerate all the cases */
 536 static int
 537 create_resort_key (void *key_var_, struct ccase *cc, casenumber case_num)
 538 {
 539   struct variable *key_var = key_var_;
 540
 541   case_data_rw(cc, key_var)->f = case_num;
 542
 543   return TRNS_CONTINUE;
 544 }
 545
 546
 547 /* Create and return a new variable in which to store the ranks of SRC_VAR
 548    accoring to the rank function F.
 549    VNAME is the name of the variable to be created.
 550    If VNAME is NULL, then a name will be automatically chosen.
 551  */
 552 static struct variable *
 553 create_rank_variable (struct dictionary *dict, enum RANK_FUNC f,
 554                       const struct variable *src_var,
 555                       const char *vname)
 556 {
 557   int i;
 558   struct variable *var = NULL;
 559   char name[SHORT_NAME_LEN + 1];
 560
 561   if ( vname )
 562     var = dict_create_var(dict, vname, 0);
 563
 564   if ( NULL == var )
 565     {
 566       snprintf (name, SHORT_NAME_LEN + 1, "%c%s",
 567                 function_name[f][0], var_get_name (src_var));
 568
 569       var = dict_create_var(dict, name, 0);
 570     }
 571
 572   i = 1;
 573   while( NULL == var )
 574     {
 575       char func_abb[4];
 576       snprintf(func_abb, 4, "%s", function_name[f]);
 577       snprintf(name, SHORT_NAME_LEN + 1, "%s%03d", func_abb,
 578                i);
 579
 580       var = dict_create_var(dict, name, 0);
 581       if (i++ >= 999)
 582         break;
 583     }
 584
 585   i = 1;
 586   while ( NULL == var )
 587     {
 588       char func_abb[3];
 589       snprintf(func_abb, 3, "%s", function_name[f]);
 590
 591       snprintf(name, SHORT_NAME_LEN + 1,
 592                "RNK%s%02d", func_abb, i);
 593
 594       var = dict_create_var(dict, name, 0);
 595       if ( i++ >= 99 )
 596         break;
 597     }
 598
 599   if ( NULL == var )
 600     {
 601       msg(ME, _("Cannot create new rank variable.  All candidates in use."));
 602       return NULL;
 603     }
 604
 605   var_set_both_formats (var, &dest_format[f]);
 606
 607   return var;
 608 }
 609
 610
 611 static void
 612 rank_cleanup(void)
 613 {
 614   int i;
 615
 616   free (group_vars);
 617   group_vars = NULL;
 618   n_group_vars = 0;
 619
 620   for (i = 0 ; i <  n_rank_specs ; ++i )
 621       free (rank_specs[i].destvars);
 622
 623   free (rank_specs);
 624   rank_specs = NULL;
 625   n_rank_specs = 0;
 626
 627   case_ordering_destroy (sc);
 628   sc = NULL;
 629
 630   free (src_vars);
 631   src_vars = NULL;
 632   n_src_vars = 0;
 633 }
 634
 635 int
 636 cmd_rank (struct lexer *lexer, struct dataset *ds)
 637 {
 638   bool result;
 639   struct variable *order;
 640   size_t i;
 641   n_rank_specs = 0;
 642
 643   if ( !parse_rank (lexer, ds, &cmd, NULL) )
 644     {
 645       rank_cleanup ();
 646     return CMD_FAILURE;
 647     }
 648
 649   /* If /MISSING=INCLUDE is set, then user missing values are ignored */
 650   exclude_values = cmd.miss == RANK_INCLUDE ? MV_SYSTEM : MV_ANY;
 651
 652   /* Default to /RANK if no function subcommands are given */
 653   if ( !( cmd.sbc_normal  || cmd.sbc_ntiles || cmd.sbc_proportion ||
 654           cmd.sbc_rfraction || cmd.sbc_savage || cmd.sbc_n ||
 655           cmd.sbc_percent || cmd.sbc_rank ) )
 656     {
 657       assert ( n_rank_specs == 0 );
 658
 659       rank_specs = xmalloc (sizeof (*rank_specs));
 660       rank_specs[0].rfunc = RANK;
 661       rank_specs[0].destvars =
 662         xcalloc (case_ordering_get_var_cnt (sc), sizeof (struct variable *));
 663
 664       n_rank_specs = 1;
 665     }
 666
 667   assert ( case_ordering_get_var_cnt (sc) == n_src_vars);
 668
 669   /* Create variables for all rank destinations which haven't
 670      already been created with INTO.
 671      Add labels to all the destination variables.
 672   */
 673   for (i = 0 ; i <  n_rank_specs ; ++i )
 674     {
 675       int v;
 676       for ( v = 0 ; v < n_src_vars ;  v ++ )
 677         {
 678           if ( rank_specs[i].destvars[v] == NULL )
 679             {
 680               rank_specs[i].destvars[v] =
 681                 create_rank_variable (dataset_dict(ds), rank_specs[i].rfunc, src_vars[v], NULL);
 682             }
 683
 684           create_var_label ( rank_specs[i].destvars[v],
 685                              src_vars[v],
 686                              rank_specs[i].rfunc);
 687         }
 688     }
 689
 690   if ( cmd.print == RANK_YES )
 691     {
 692       int v;
 693
 694       tab_output_text (0, _("Variables Created By RANK"));
 695       tab_output_text (0, "\n");
 696
 697       for (i = 0 ; i <  n_rank_specs ; ++i )
 698         {
 699           for ( v = 0 ; v < n_src_vars ;  v ++ )
 700             {
 701               if ( n_group_vars > 0 )
 702                 {
 703                   struct string varlist;
 704                   int g;
 705
 706                   ds_init_empty (&varlist);
 707                   for ( g = 0 ; g < n_group_vars ; ++g )
 708                     {
 709                       ds_put_cstr (&varlist, var_get_name (group_vars[g]));
 710
 711                       if ( g < n_group_vars - 1)
 712                         ds_put_cstr (&varlist, " ");
 713                     }
 714
 715                   if ( rank_specs[i].rfunc == NORMAL ||
 716                        rank_specs[i].rfunc == PROPORTION )
 717                     tab_output_text (TAT_PRINTF,
 718                                      _("%s into %s(%s of %s using %s BY %s)"),
 719                                      var_get_name (src_vars[v]),
 720                                      var_get_name (rank_specs[i].destvars[v]),
 721                                      function_name[rank_specs[i].rfunc],
 722                                      var_get_name (src_vars[v]),
 723                                      fraction_name(),
 724                                      ds_cstr (&varlist)
 725                                      );
 726
 727                   else
 728                     tab_output_text (TAT_PRINTF,
 729                                      _("%s into %s(%s of %s BY %s)"),
 730                                      var_get_name (src_vars[v]),
 731                                      var_get_name (rank_specs[i].destvars[v]),
 732                                      function_name[rank_specs[i].rfunc],
 733                                      var_get_name (src_vars[v]),
 734                                      ds_cstr (&varlist)
 735                                      );
 736                   ds_destroy (&varlist);
 737                 }
 738               else
 739                 {
 740                   if ( rank_specs[i].rfunc == NORMAL ||
 741                        rank_specs[i].rfunc == PROPORTION )
 742                     tab_output_text (TAT_PRINTF,
 743                                      _("%s into %s(%s of %s using %s)"),
 744                                      var_get_name (src_vars[v]),
 745                                      var_get_name (rank_specs[i].destvars[v]),
 746                                      function_name[rank_specs[i].rfunc],
 747                                      var_get_name (src_vars[v]),
 748                                      fraction_name()
 749                                      );
 750
 751                   else
 752                     tab_output_text (TAT_PRINTF,
 753                                      _("%s into %s(%s of %s)"),
 754                                      var_get_name (src_vars[v]),
 755                                      var_get_name (rank_specs[i].destvars[v]),
 756                                      function_name[rank_specs[i].rfunc],
 757                                      var_get_name (src_vars[v])
 758                                      );
 759                 }
 760             }
 761         }
 762     }
 763
 764   if ( cmd.sbc_fraction &&
 765        ( ! cmd.sbc_normal && ! cmd.sbc_proportion) )
 766     msg(MW, _("FRACTION has been specified, but NORMAL and PROPORTION rank functions have not been requested.  The FRACTION subcommand will be ignored.") );
 767
 768   /* Add a variable which we can sort by to get back the original
 769      order */
 770   order = dict_create_var_assert (dataset_dict (ds), "$ORDER_", 0);
 771
 772   add_transformation (ds, create_resort_key, 0, order);
 773
 774   /* Do the ranking */
 775   result = rank_cmd (ds, sc, rank_specs, n_rank_specs);
 776
 777   /* Put the active file back in its original order.  Delete
 778      our sort key, which we don't need anymore.  */
 779   {
 780     struct case_ordering *ordering = case_ordering_create (dataset_dict (ds));
 781     struct casereader *sorted;
 782     case_ordering_add_var (ordering, order, SRT_ASCEND);
 783     /* FIXME: loses error conditions. */
 784     proc_discard_output (ds);
 785     sorted = sort_execute (proc_open (ds), ordering);
 786     result = proc_commit (ds) && result;
 787
 788     dict_delete_var (dataset_dict (ds), order);
 789     result = proc_set_active_file_data (ds, sorted) && result;
 790   }
 791
 792   rank_cleanup();
 793
 794
 795   return (result ? CMD_SUCCESS : CMD_CASCADING_FAILURE);
 796 }
 797
 798
 799 /* Parser for the variables sub command
 800    Returns 1 on success */
 801 static int
 802 rank_custom_variables (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd UNUSED, void *aux UNUSED)
 803 {
 804   lex_match (lexer, '=');
 805
 806   if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL)
 807       && lex_token (lexer) != T_ALL)
 808       return 2;
 809
 810   sc = parse_case_ordering (lexer, dataset_dict (ds), NULL);
 811   if (sc == NULL)
 812     return 0;
 813   case_ordering_get_vars (sc, &src_vars, &n_src_vars);
 814
 815   if ( lex_match (lexer, T_BY)  )
 816     {
 817       if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL))
 818         {
 819           return 2;
 820         }
 821
 822       if (!parse_variables_const (lexer, dataset_dict (ds),
 823                             &group_vars, &n_group_vars,
 824                             PV_NO_DUPLICATE | PV_NO_SCRATCH) )
 825         {
 826           free (group_vars);
 827           return 0;
 828         }
 829     }
 830
 831   return 1;
 832 }
 833
 834
 835 /* Parse the [/rank INTO var1 var2 ... varN ] clause */
 836 static int
 837 parse_rank_function (struct lexer *lexer, struct dictionary *dict, struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
 838 {
 839   int var_count = 0;
 840
 841   n_rank_specs++;
 842   rank_specs = xnrealloc(rank_specs, n_rank_specs, sizeof *rank_specs);
 843   rank_specs[n_rank_specs - 1].rfunc = f;
 844   rank_specs[n_rank_specs - 1].destvars = NULL;
 845
 846   rank_specs[n_rank_specs - 1].destvars =
 847             xcalloc (case_ordering_get_var_cnt (sc),
 848                      sizeof (struct variable *));
 849
 850   if (lex_match_id (lexer, "INTO"))
 851     {
 852       struct variable *destvar;
 853
 854       while( lex_token (lexer) == T_ID )
 855         {
 856
 857           if ( dict_lookup_var (dict, lex_tokid (lexer)) != NULL )
 858             {
 859               msg(SE, _("Variable %s already exists."), lex_tokid (lexer));
 860               return 0;
 861             }
 862           if ( var_count >= case_ordering_get_var_cnt (sc) )
 863             {
 864               msg(SE, _("Too many variables in INTO clause."));
 865               return 0;
 866             }
 867
 868           destvar = create_rank_variable (dict, f, src_vars[var_count], lex_tokid (lexer));
 869           rank_specs[n_rank_specs - 1].destvars[var_count] = destvar ;
 870
 871           lex_get (lexer);
 872           ++var_count;
 873         }
 874     }
 875
 876   return 1;
 877 }
 878
 879
 880 static int
 881 rank_custom_rank (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 882 {
 883   struct dictionary *dict = dataset_dict (ds);
 884
 885   return parse_rank_function (lexer, dict, cmd, RANK);
 886 }
 887
 888 static int
 889 rank_custom_normal (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 890 {
 891   struct  dictionary *dict = dataset_dict (ds);
 892
 893   return parse_rank_function (lexer, dict, cmd, NORMAL);
 894 }
 895
 896 static int
 897 rank_custom_percent (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 898 {
 899   struct dictionary *dict = dataset_dict (ds);
 900
 901   return parse_rank_function (lexer, dict, cmd, PERCENT);
 902 }
 903
 904 static int
 905 rank_custom_rfraction (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 906 {
 907   struct dictionary *dict = dataset_dict (ds);
 908
 909   return parse_rank_function (lexer, dict, cmd, RFRACTION);
 910 }
 911
 912 static int
 913 rank_custom_proportion (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 914 {
 915   struct dictionary *dict = dataset_dict (ds);
 916
 917   return parse_rank_function (lexer, dict, cmd, PROPORTION);
 918 }
 919
 920 static int
 921 rank_custom_n (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 922 {
 923   struct dictionary *dict = dataset_dict (ds);
 924
 925   return parse_rank_function (lexer, dict, cmd, N);
 926 }
 927
 928 static int
 929 rank_custom_savage (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 930 {
 931   struct dictionary *dict = dataset_dict (ds);
 932
 933   return parse_rank_function (lexer, dict, cmd, SAVAGE);
 934 }
 935
 936
 937 static int
 938 rank_custom_ntiles (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 939 {
 940   struct dictionary *dict = dataset_dict (ds);
 941
 942   if ( lex_force_match (lexer, '(') )
 943     {
 944       if ( lex_force_int (lexer) )
 945         {
 946           k_ntiles = lex_integer (lexer);
 947           lex_get (lexer);
 948           lex_force_match (lexer, ')');
 949         }
 950       else
 951         return 0;
 952     }
 953   else
 954     return 0;
 955
 956   return parse_rank_function (lexer, dict, cmd, NTILES);
 957 }
 958
 959 /*
 960   Local Variables:
 961   mode: c
 962   End:
 963 */