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

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