src/language/stats/rank.q

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2005, 2006, 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 <limits.h>
  20 #include <math.h>
  21
  22 #include <data/case.h>
  23 #include <data/casegrouper.h>
  24 #include <data/casereader.h>
  25 #include <data/casewriter.h>
  26 #include <data/dictionary.h>
  27 #include <data/format.h>
  28 #include <data/missing-values.h>
  29 #include <data/procedure.h>
  30 #include <data/short-names.h>
  31 #include <data/subcase.h>
  32 #include <data/variable.h>
  33 #include <language/command.h>
  34 #include <language/stats/sort-criteria.h>
  35 #include <libpspp/compiler.h>
  36 #include <libpspp/taint.h>
  37 #include <math/sort.h>
  38 #include <output/manager.h>
  39 #include <output/table.h>
  40
  41 #include <gsl/gsl_cdf.h>
  42
  43 #include "gettext.h"
  44 #define _(msgid) gettext (msgid)
  45
  46 /* (headers) */
  47
  48 /* (specification)
  49    "RANK" (rank_):
  50    *^variables=custom;
  51    +rank=custom;
  52    +normal=custom;
  53    +percent=custom;
  54    +ntiles=custom;
  55    +rfraction=custom;
  56    +proportion=custom;
  57    +n=custom;
  58    +savage=custom;
  59    +print=print:!yes/no;
  60    +fraction=fraction:!blom/tukey/vw/rankit;
  61    +ties=ties:!mean/low/high/condense;
  62    missing=miss:!exclude/include.
  63 */
  64 /* (declarations) */
  65 /* (functions) */
  66
  67 typedef double (*rank_function_t) (double c, double cc, double cc_1,
  68                                  int i, double w);
  69
  70 static double rank_proportion (double c, double cc, double cc_1,
  71                                int i, double w);
  72
  73 static double rank_normal (double c, double cc, double cc_1,
  74                            int i, double w);
  75
  76 static double rank_percent (double c, double cc, double cc_1,
  77                             int i, double w);
  78
  79 static double rank_rfraction (double c, double cc, double cc_1,
  80                               int i, double w);
  81
  82 static double rank_rank (double c, double cc, double cc_1,
  83                          int i, double w);
  84
  85 static double rank_n (double c, double cc, double cc_1,
  86                       int i, double w);
  87
  88 static double rank_savage (double c, double cc, double cc_1,
  89                       int i, double w);
  90
  91 static double rank_ntiles (double c, double cc, double cc_1,
  92                       int i, double w);
  93
  94
  95 enum RANK_FUNC
  96   {
  97     RANK,
  98     NORMAL,
  99     PERCENT,
 100     RFRACTION,
 101     PROPORTION,
 102     N,
 103     NTILES,
 104     SAVAGE,
 105     n_RANK_FUNCS
 106   };
 107
 108 static const struct fmt_spec dest_format[n_RANK_FUNCS] = {
 109   {FMT_F, 9, 3}, /* rank */
 110   {FMT_F, 6, 4}, /* normal */
 111   {FMT_F, 6, 2}, /* percent */
 112   {FMT_F, 6, 4}, /* rfraction */
 113   {FMT_F, 6, 4}, /* proportion */
 114   {FMT_F, 6, 0}, /* n */
 115   {FMT_F, 3, 0}, /* ntiles */
 116   {FMT_F, 8, 4}  /* savage */
 117 };
 118
 119 static const char * const function_name[n_RANK_FUNCS] = {
 120   "RANK",
 121   "NORMAL",
 122   "PERCENT",
 123   "RFRACTION",
 124   "PROPORTION",
 125   "N",
 126   "NTILES",
 127   "SAVAGE"
 128 };
 129
 130 static const rank_function_t rank_func[n_RANK_FUNCS] = {
 131   rank_rank,
 132   rank_normal,
 133   rank_percent,
 134   rank_rfraction,
 135   rank_proportion,
 136   rank_n,
 137   rank_ntiles,
 138   rank_savage
 139   };
 140
 141
 142 struct rank_spec
 143 {
 144   enum RANK_FUNC rfunc;
 145   struct variable **destvars;
 146 };
 147
 148
 149 /* Categories of missing values to exclude. */
 150 static enum mv_class exclude_values;
 151
 152 static struct rank_spec *rank_specs;
 153 static size_t n_rank_specs;
 154
 155 static struct subcase sc;
 156
 157 static const struct variable **group_vars;
 158 static size_t n_group_vars;
 159
 160 static const struct variable **src_vars;
 161 static size_t n_src_vars;
 162
 163
 164 static int k_ntiles;
 165
 166 static struct cmd_rank cmd;
 167
 168 static void rank_sorted_file (struct casereader *,
 169                               struct casewriter *,
 170                               const struct dictionary *,
 171                               const struct rank_spec *rs,
 172                               int n_rank_specs,
 173                               int idx,
 174                               const struct variable *rank_var);
 175
 176 static const char *
 177 fraction_name(void)
 178 {
 179   static char name[10];
 180   switch ( cmd.fraction )
 181     {
 182     case RANK_BLOM:
 183       strcpy (name, "BLOM");
 184       break;
 185     case RANK_RANKIT:
 186       strcpy (name, "RANKIT");
 187       break;
 188     case RANK_TUKEY:
 189       strcpy (name, "TUKEY");
 190       break;
 191     case RANK_VW:
 192       strcpy (name, "VW");
 193       break;
 194     default:
 195       NOT_REACHED ();
 196     }
 197   return name;
 198 }
 199
 200 /* Create a label on DEST_VAR, describing its derivation from SRC_VAR and F */
 201 static void
 202 create_var_label (struct variable *dest_var,
 203                   const struct variable *src_var, enum RANK_FUNC f)
 204 {
 205   struct string label;
 206   ds_init_empty (&label);
 207
 208   if ( n_group_vars > 0 )
 209     {
 210       struct string group_var_str;
 211       int g;
 212
 213       ds_init_empty (&group_var_str);
 214
 215       for (g = 0 ; g < n_group_vars ; ++g )
 216         {
 217           if ( g > 0 ) ds_put_cstr (&group_var_str, " ");
 218           ds_put_cstr (&group_var_str, var_get_name (group_vars[g]));
 219         }
 220
 221       ds_put_format (&label, _("%s of %s by %s"), function_name[f],
 222                      var_get_name (src_var), ds_cstr (&group_var_str));
 223       ds_destroy (&group_var_str);
 224     }
 225   else
 226     ds_put_format (&label, _("%s of %s"),
 227                    function_name[f], var_get_name (src_var));
 228
 229   var_set_label (dest_var, ds_cstr (&label));
 230
 231   ds_destroy (&label);
 232 }
 233
 234
 235 static bool
 236 rank_cmd (struct dataset *ds, const struct subcase *sc,
 237           const struct rank_spec *rank_specs, int n_rank_specs)
 238 {
 239   struct dictionary *d = dataset_dict (ds);
 240   bool ok = true;
 241   int i;
 242
 243   for (i = 0 ; i < subcase_get_n_fields (sc) ; ++i )
 244     {
 245       /* Rank variable at index I in SC. */
 246       struct casegrouper *split_grouper;
 247       struct casereader *split_group;
 248       struct casewriter *output;
 249
 250       proc_discard_output (ds);
 251       split_grouper = casegrouper_create_splits (proc_open (ds), d);
 252       output = autopaging_writer_create (dict_get_proto (d));
 253
 254       while (casegrouper_get_next_group (split_grouper, &split_group))
 255         {
 256           struct subcase ordering;
 257           struct casereader *ordered;
 258           struct casegrouper *by_grouper;
 259           struct casereader *by_group;
 260
 261           /* Sort this split group by the BY variables as primary
 262              keys and the rank variable as secondary key. */
 263           subcase_init_vars (&ordering, group_vars, n_group_vars);
 264           subcase_add_var (&ordering, src_vars[i],
 265                            subcase_get_direction (sc, i));
 266           ordered = sort_execute (split_group, &ordering);
 267           subcase_destroy (&ordering);
 268
 269           /* Rank the rank variable within this split group. */
 270           by_grouper = casegrouper_create_vars (ordered,
 271                                                 group_vars, n_group_vars);
 272           while (casegrouper_get_next_group (by_grouper, &by_group))
 273             {
 274               /* Rank the rank variable within this BY group
 275                  within the split group. */
 276
 277               rank_sorted_file (by_group, output, d, rank_specs, n_rank_specs,
 278                                 i, src_vars[i]);
 279             }
 280           ok = casegrouper_destroy (by_grouper) && ok;
 281         }
 282       ok = casegrouper_destroy (split_grouper);
 283       ok = proc_commit (ds) && ok;
 284       ok = (proc_set_active_file_data (ds, casewriter_make_reader (output))
 285             && ok);
 286       if (!ok)
 287         break;
 288     }
 289
 290   return ok;
 291 }
 292
 293 /* Hardly a rank function !! */
 294 static double
 295 rank_n (double c UNUSED, double cc UNUSED, double cc_1 UNUSED,
 296           int i UNUSED, double w)
 297 {
 298   return w;
 299 }
 300
 301
 302 static double
 303 rank_rank (double c, double cc, double cc_1,
 304           int i, double w UNUSED)
 305 {
 306   double rank;
 307
 308   if ( c >= 1.0 )
 309     {
 310       switch (cmd.ties)
 311         {
 312         case RANK_LOW:
 313           rank = cc_1 + 1;
 314           break;
 315         case RANK_HIGH:
 316           rank = cc;
 317           break;
 318         case RANK_MEAN:
 319           rank = cc_1 + (c + 1.0)/ 2.0;
 320           break;
 321         case RANK_CONDENSE:
 322           rank = i;
 323           break;
 324         default:
 325           NOT_REACHED ();
 326         }
 327     }
 328   else
 329     {
 330       switch (cmd.ties)
 331         {
 332         case RANK_LOW:
 333           rank = cc_1;
 334           break;
 335         case RANK_HIGH:
 336           rank = cc;
 337           break;
 338         case RANK_MEAN:
 339           rank = cc_1 + c / 2.0 ;
 340           break;
 341         case RANK_CONDENSE:
 342           rank = i;
 343           break;
 344         default:
 345           NOT_REACHED ();
 346         }
 347     }
 348
 349   return rank;
 350 }
 351
 352
 353 static double
 354 rank_rfraction (double c, double cc, double cc_1,
 355                 int i, double w)
 356 {
 357   return rank_rank (c, cc, cc_1, i, w) / w ;
 358 }
 359
 360
 361 static double
 362 rank_percent (double c, double cc, double cc_1,
 363                 int i, double w)
 364 {
 365   return rank_rank (c, cc, cc_1, i, w) * 100.0 / w ;
 366 }
 367
 368
 369 static double
 370 rank_proportion (double c, double cc, double cc_1,
 371                  int i, double w)
 372 {
 373   const double r =  rank_rank (c, cc, cc_1, i, w) ;
 374
 375   double f;
 376
 377   switch ( cmd.fraction )
 378     {
 379     case RANK_BLOM:
 380       f =  (r - 3.0/8.0) / (w + 0.25);
 381       break;
 382     case RANK_RANKIT:
 383       f = (r - 0.5) / w ;
 384       break;
 385     case RANK_TUKEY:
 386       f = (r - 1.0/3.0) / (w + 1.0/3.0);
 387       break;
 388     case RANK_VW:
 389       f = r / ( w + 1.0);
 390       break;
 391     default:
 392       NOT_REACHED ();
 393     }
 394
 395
 396   return (f > 0) ? f : SYSMIS;
 397 }
 398
 399 static double
 400 rank_normal (double c, double cc, double cc_1,
 401              int i, double w)
 402 {
 403   double f = rank_proportion (c, cc, cc_1, i, w);
 404
 405   return gsl_cdf_ugaussian_Pinv (f);
 406 }
 407
 408 static double
 409 rank_ntiles (double c, double cc, double cc_1,
 410                 int i, double w)
 411 {
 412   double r = rank_rank (c, cc, cc_1, i, w);
 413
 414
 415   return ( floor (( r * k_ntiles) / ( w + 1) ) + 1);
 416 }
 417
 418 /* Expected value of the order statistics from an exponential distribution */
 419 static double
 420 ee (int j, double w_star)
 421 {
 422   int k;
 423   double sum = 0.0;
 424
 425   for (k = 1 ; k <= j; k++)
 426     sum += 1.0 / ( w_star + 1 - k );
 427
 428   return sum;
 429 }
 430
 431
 432 static double
 433 rank_savage (double c, double cc, double cc_1,
 434                 int i UNUSED, double w)
 435 {
 436   double int_part;
 437   const int i_1 = floor (cc_1);
 438   const int i_2 = floor (cc);
 439
 440   const double w_star = (modf (w, &int_part) == 0 ) ? w : floor (w) + 1;
 441
 442   const double g_1 = cc_1 - i_1;
 443   const double g_2 = cc - i_2;
 444
 445   /* The second factor is infinite, when the first is zero.
 446      Therefore, evaluate the second, only when the first is non-zero */
 447   const double expr1 =  (1 - g_1) ? (1 - g_1) * ee(i_1+1, w_star) : ( 1 - g_1);
 448   const double expr2 =  g_2 ? g_2 * ee (i_2+1, w_star) : g_2 ;
 449
 450   if ( i_1 == i_2 )
 451     return ee (i_1 + 1, w_star) - 1;
 452
 453   if ( i_1 + 1 == i_2 )
 454     return ( ( expr1 + expr2 )/c ) - 1;
 455
 456   if ( i_1 + 2 <= i_2 )
 457     {
 458       int j;
 459       double sigma = 0.0;
 460       for (j = i_1 + 2 ; j <= i_2; ++j )
 461         sigma += ee (j, w_star);
 462       return ( (expr1 + expr2 + sigma) / c) -1;
 463     }
 464
 465   NOT_REACHED();
 466 }
 467
 468 static void
 469 rank_sorted_file (struct casereader *input,
 470                   struct casewriter *output,
 471                   const struct dictionary *dict,
 472                   const struct rank_spec *rs,
 473                   int n_rank_specs,
 474                   int dest_idx,
 475                   const struct variable *rank_var)
 476 {
 477   struct casereader *pass1, *pass2, *pass2_1;
 478   struct casegrouper *tie_grouper;
 479   struct ccase *c;
 480   double w = 0.0;
 481   double cc = 0.0;
 482   int tie_group = 1;
 483
 484
 485   input = casereader_create_filter_missing (input, &rank_var, 1,
 486                                             exclude_values, NULL, output);
 487   input = casereader_create_filter_weight (input, dict, NULL, output);
 488
 489   casereader_split (input, &pass1, &pass2);
 490
 491   /* Pass 1: Get total group weight. */
 492   for (; (c = casereader_read (pass1)) != NULL; case_unref (c))
 493     w += dict_get_case_weight (dict, c, NULL);
 494   casereader_destroy (pass1);
 495
 496   /* Pass 2: Do ranking. */
 497   tie_grouper = casegrouper_create_vars (pass2, &rank_var, 1);
 498   while (casegrouper_get_next_group (tie_grouper, &pass2_1))
 499     {
 500       struct casereader *pass2_2;
 501       double cc_1 = cc;
 502       double tw = 0.0;
 503       int i;
 504
 505       pass2_2 = casereader_clone (pass2_1);
 506       taint_propagate (casereader_get_taint (pass2_2),
 507                        casewriter_get_taint (output));
 508
 509       /* Pass 2.1: Sum up weight for tied cases. */
 510       for (; (c = casereader_read (pass2_1)) != NULL; case_unref (c))
 511         tw += dict_get_case_weight (dict, c, NULL);
 512       cc += tw;
 513       casereader_destroy (pass2_1);
 514
 515       /* Pass 2.2: Rank tied cases. */
 516       while ((c = casereader_read (pass2_2)) != NULL)
 517         {
 518           c = case_unshare (c);
 519           for (i = 0; i < n_rank_specs; ++i)
 520             {
 521               const struct variable *dst_var = rs[i].destvars[dest_idx];
 522               double *dst_value = &case_data_rw (c, dst_var)->f;
 523               *dst_value = rank_func[rs[i].rfunc] (tw, cc, cc_1, tie_group, w);
 524             }
 525           casewriter_write (output, c);
 526         }
 527       casereader_destroy (pass2_2);
 528
 529       tie_group++;
 530     }
 531   casegrouper_destroy (tie_grouper);
 532 }
 533
 534 /* Transformation function to enumerate all the cases */
 535 static int
 536 create_resort_key (void *key_var_, struct ccase **cc, casenumber case_num)
 537 {
 538   struct variable *key_var = key_var_;
 539
 540   *cc = case_unshare (*cc);
 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   subcase_destroy (&sc);
 628
 629   free (src_vars);
 630   src_vars = NULL;
 631   n_src_vars = 0;
 632 }
 633
 634 int
 635 cmd_rank (struct lexer *lexer, struct dataset *ds)
 636 {
 637   bool result;
 638   struct variable *order;
 639   size_t i;
 640   n_rank_specs = 0;
 641
 642   subcase_init_empty (&sc);
 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 (subcase_get_n_fields (&sc), sizeof (struct variable *));
 663
 664       n_rank_specs = 1;
 665     }
 666
 667   assert ( subcase_get_n_fields (&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 casereader *sorted;
 781
 782     /* FIXME: loses error conditions. */
 783
 784     proc_discard_output (ds);
 785     sorted = sort_execute_1var (proc_open (ds), order);
 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   if (!parse_sort_criteria (lexer, dataset_dict (ds), &sc, &src_vars, NULL))
 811     return 0;
 812   n_src_vars = subcase_get_n_fields (&sc);
 813
 814   if ( lex_match (lexer, T_BY)  )
 815     {
 816       if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL))
 817         {
 818           return 2;
 819         }
 820
 821       if (!parse_variables_const (lexer, dataset_dict (ds),
 822                             &group_vars, &n_group_vars,
 823                             PV_NO_DUPLICATE | PV_NO_SCRATCH) )
 824         {
 825           free (group_vars);
 826           return 0;
 827         }
 828     }
 829
 830   return 1;
 831 }
 832
 833
 834 /* Parse the [/rank INTO var1 var2 ... varN ] clause */
 835 static int
 836 parse_rank_function (struct lexer *lexer, struct dictionary *dict, struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
 837 {
 838   int var_count = 0;
 839
 840   n_rank_specs++;
 841   rank_specs = xnrealloc(rank_specs, n_rank_specs, sizeof *rank_specs);
 842   rank_specs[n_rank_specs - 1].rfunc = f;
 843   rank_specs[n_rank_specs - 1].destvars = NULL;
 844
 845   rank_specs[n_rank_specs - 1].destvars =
 846             xcalloc (subcase_get_n_fields (&sc), sizeof (struct variable *));
 847
 848   if (lex_match_id (lexer, "INTO"))
 849     {
 850       struct variable *destvar;
 851
 852       while( lex_token (lexer) == T_ID )
 853         {
 854
 855           if ( dict_lookup_var (dict, lex_tokid (lexer)) != NULL )
 856             {
 857               msg(SE, _("Variable %s already exists."), lex_tokid (lexer));
 858               return 0;
 859             }
 860           if ( var_count >= subcase_get_n_fields (&sc) )
 861             {
 862               msg(SE, _("Too many variables in INTO clause."));
 863               return 0;
 864             }
 865
 866           destvar = create_rank_variable (dict, f, src_vars[var_count], lex_tokid (lexer));
 867           rank_specs[n_rank_specs - 1].destvars[var_count] = destvar ;
 868
 869           lex_get (lexer);
 870           ++var_count;
 871         }
 872     }
 873
 874   return 1;
 875 }
 876
 877
 878 static int
 879 rank_custom_rank (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 880 {
 881   struct dictionary *dict = dataset_dict (ds);
 882
 883   return parse_rank_function (lexer, dict, cmd, RANK);
 884 }
 885
 886 static int
 887 rank_custom_normal (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 888 {
 889   struct  dictionary *dict = dataset_dict (ds);
 890
 891   return parse_rank_function (lexer, dict, cmd, NORMAL);
 892 }
 893
 894 static int
 895 rank_custom_percent (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 896 {
 897   struct dictionary *dict = dataset_dict (ds);
 898
 899   return parse_rank_function (lexer, dict, cmd, PERCENT);
 900 }
 901
 902 static int
 903 rank_custom_rfraction (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 904 {
 905   struct dictionary *dict = dataset_dict (ds);
 906
 907   return parse_rank_function (lexer, dict, cmd, RFRACTION);
 908 }
 909
 910 static int
 911 rank_custom_proportion (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 912 {
 913   struct dictionary *dict = dataset_dict (ds);
 914
 915   return parse_rank_function (lexer, dict, cmd, PROPORTION);
 916 }
 917
 918 static int
 919 rank_custom_n (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 920 {
 921   struct dictionary *dict = dataset_dict (ds);
 922
 923   return parse_rank_function (lexer, dict, cmd, N);
 924 }
 925
 926 static int
 927 rank_custom_savage (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 928 {
 929   struct dictionary *dict = dataset_dict (ds);
 930
 931   return parse_rank_function (lexer, dict, cmd, SAVAGE);
 932 }
 933
 934
 935 static int
 936 rank_custom_ntiles (struct lexer *lexer, struct dataset *ds, struct cmd_rank *cmd, void *aux UNUSED )
 937 {
 938   struct dictionary *dict = dataset_dict (ds);
 939
 940   if ( lex_force_match (lexer, '(') )
 941     {
 942       if ( lex_force_int (lexer) )
 943         {
 944           k_ntiles = lex_integer (lexer);
 945           lex_get (lexer);
 946           lex_force_match (lexer, ')');
 947         }
 948       else
 949         return 0;
 950     }
 951   else
 952     return 0;
 953
 954   return parse_rank_function (lexer, dict, cmd, NTILES);
 955 }
 956
 957 /*
 958   Local Variables:
 959   mode: c
 960   End:
 961 */