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 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
 514 static void
 515 rank_sorted_file (struct casereader *input,
 516                   struct casewriter *output,
 517                   const struct dictionary *dict,
 518                   int dest_idx,
 519                   const struct rank *cmd
 520                   )
 521 {
 522   struct casereader *pass1, *pass2, *pass2_1;
 523   struct casegrouper *tie_grouper;
 524   struct ccase *c;
 525   double w = 0.0;
 526   double cc = 0.0;
 527   int tie_group = 1;
 528
 529   input = casereader_create_filter_missing (input, &cmd->vars[dest_idx], 1,
 530                                             cmd->exclude, NULL, output);
 531   input = casereader_create_filter_weight (input, dict, NULL, output);
 532
 533   casereader_split (input, &pass1, &pass2);
 534
 535   /* Pass 1: Get total group weight. */
 536   for (; (c = casereader_read (pass1)) != NULL; case_unref (c))
 537     w += dict_get_case_weight (dict, c, NULL);
 538   casereader_destroy (pass1);
 539
 540   /* Pass 2: Do ranking. */
 541   tie_grouper = casegrouper_create_vars (pass2, &cmd->vars[dest_idx], 1);
 542   while (casegrouper_get_next_group (tie_grouper, &pass2_1))
 543     {
 544       struct casereader *pass2_2;
 545       double cc_1 = cc;
 546       double tw = 0.0;
 547       int i;
 548
 549       pass2_2 = casereader_clone (pass2_1);
 550       taint_propagate (casereader_get_taint (pass2_2),
 551                        casewriter_get_taint (output));
 552
 553       /* Pass 2.1: Sum up weight for tied cases. */
 554       for (; (c = casereader_read (pass2_1)) != NULL; case_unref (c))
 555         tw += dict_get_case_weight (dict, c, NULL);
 556       cc += tw;
 557       casereader_destroy (pass2_1);
 558
 559       /* Pass 2.2: Rank tied cases. */
 560       while ((c = casereader_read (pass2_2)) != NULL)
 561         {
 562           c = case_unshare (c);
 563           for (i = 0; i < cmd->n_rs; ++i)
 564             {
 565               const struct variable *dst_var = cmd->rs[i].destvars[dest_idx];
 566               double *dst_value = &case_data_rw (c, dst_var)->f;
 567               *dst_value = rank_func[cmd->rs[i].rfunc] (cmd, tw, cc, cc_1, tie_group, w);
 568             }
 569           casewriter_write (output, c);
 570         }
 571       casereader_destroy (pass2_2);
 572
 573       tie_group++;
 574     }
 575   casegrouper_destroy (tie_grouper);
 576 }
 577
 578
 579 /* Transformation function to enumerate all the cases */
 580 static int
 581 create_resort_key (void *key_var_, struct ccase **cc, casenumber case_num)
 582 {
 583   struct variable *key_var = key_var_;
 584
 585   *cc = case_unshare (*cc);
 586   case_data_rw (*cc, key_var)->f = case_num;
 587
 588   return TRNS_CONTINUE;
 589 }
 590
 591 static bool
 592 rank_cmd (struct dataset *ds,  const struct rank *cmd);
 593
 594
 595 static const char *
 596 fraction_name (const struct rank *cmd)
 597 {
 598   switch (cmd->fraction )
 599     {
 600     case FRAC_BLOM:   return "BLOM";
 601     case FRAC_RANKIT: return "RANKIT";
 602     case FRAC_TUKEY:  return "TUKEY";
 603     case FRAC_VW:     return "VW";
 604     default:          NOT_REACHED ();
 605     }
 606 }
 607
 608 /* Create a label on DEST_VAR, describing its derivation from SRC_VAR and F */
 609 static void
 610 create_var_label (struct rank *cmd, struct variable *dest_var,
 611                   const struct variable *src_var, enum rank_func f)
 612 {
 613   struct string label;
 614   ds_init_empty (&label);
 615
 616   if ( cmd->n_group_vars > 0 )
 617     {
 618       struct string group_var_str;
 619       int g;
 620
 621       ds_init_empty (&group_var_str);
 622
 623       for (g = 0 ; g < cmd->n_group_vars ; ++g )
 624         {
 625           if ( g > 0 ) ds_put_cstr (&group_var_str, " ");
 626           ds_put_cstr (&group_var_str, var_get_name (cmd->group_vars[g]));
 627         }
 628
 629       ds_put_format (&label, _("%s of %s by %s"), function_name[f],
 630                      var_get_name (src_var), ds_cstr (&group_var_str));
 631       ds_destroy (&group_var_str);
 632     }
 633   else
 634     ds_put_format (&label, _("%s of %s"),
 635                    function_name[f], var_get_name (src_var));
 636
 637   var_set_label (dest_var, ds_cstr (&label), false);
 638
 639   ds_destroy (&label);
 640 }
 641
 642 int
 643 cmd_rank (struct lexer *lexer, struct dataset *ds)
 644 {
 645   struct rank rank;
 646   struct variable *order;
 647   bool result = true;
 648   int i;
 649
 650   subcase_init_empty (&rank.sc);
 651
 652   rank.rs = NULL;
 653   rank.n_rs = 0;
 654   rank.exclude = MV_ANY;
 655   rank.n_group_vars = 0;
 656   rank.group_vars = NULL;
 657   rank.dict = dataset_dict (ds);
 658   rank.ties = TIES_MEAN;
 659   rank.fraction = FRAC_BLOM;
 660   rank.print = true;
 661   rank.pool = pool_create ();
 662
 663   if (lex_match_id (lexer, "VARIABLES"))
 664     lex_force_match (lexer, T_EQUALS);
 665
 666   if (!parse_sort_criteria (lexer, rank.dict,
 667                             &rank.sc,
 668                             &rank.vars, NULL))
 669     goto error;
 670
 671   rank.n_vars = rank.sc.n_fields;
 672
 673   if (lex_match (lexer, T_BY) )
 674     {
 675       if ( ! parse_variables_const (lexer, rank.dict,
 676                                     &rank.group_vars, &rank.n_group_vars,
 677                                     PV_NO_DUPLICATE | PV_NO_SCRATCH))
 678         goto error;
 679     }
 680
 681
 682   while (lex_token (lexer) != T_ENDCMD )
 683     {
 684       lex_force_match (lexer, T_SLASH);
 685       if (lex_match_id (lexer, "TIES"))
 686         {
 687           lex_force_match (lexer, T_EQUALS);
 688           if (lex_match_id (lexer, "MEAN"))
 689             {
 690               rank.ties = TIES_MEAN;
 691             }
 692           else if (lex_match_id (lexer, "LOW"))
 693             {
 694               rank.ties = TIES_LOW;
 695             }
 696           else if (lex_match_id (lexer, "HIGH"))
 697             {
 698               rank.ties = TIES_HIGH;
 699             }
 700           else if (lex_match_id (lexer, "CONDENSE"))
 701             {
 702               rank.ties = TIES_CONDENSE;
 703             }
 704           else
 705             {
 706               lex_error (lexer, NULL);
 707               goto error;
 708             }
 709         }
 710       else if (lex_match_id (lexer, "FRACTION"))
 711         {
 712           lex_force_match (lexer, T_EQUALS);
 713           if (lex_match_id (lexer, "BLOM"))
 714             {
 715               rank.fraction = FRAC_BLOM;
 716             }
 717           else if (lex_match_id (lexer, "TUKEY"))
 718             {
 719               rank.fraction = FRAC_TUKEY;
 720             }
 721           else if (lex_match_id (lexer, "VW"))
 722             {
 723               rank.fraction = FRAC_VW;
 724             }
 725           else if (lex_match_id (lexer, "RANKIT"))
 726             {
 727               rank.fraction = FRAC_RANKIT;
 728             }
 729           else
 730             {
 731               lex_error (lexer, NULL);
 732               goto error;
 733             }
 734         }
 735       else if (lex_match_id (lexer, "PRINT"))
 736         {
 737           lex_force_match (lexer, T_EQUALS);
 738           if (lex_match_id (lexer, "YES"))
 739             {
 740               rank.print = true;
 741             }
 742           else if (lex_match_id (lexer, "NO"))
 743             {
 744               rank.print = false;
 745             }
 746           else
 747             {
 748               lex_error (lexer, NULL);
 749               goto error;
 750             }
 751         }
 752       else if (lex_match_id (lexer, "MISSING"))
 753         {
 754           lex_force_match (lexer, T_EQUALS);
 755           if (lex_match_id (lexer, "INCLUDE"))
 756             {
 757               rank.exclude = MV_SYSTEM;
 758             }
 759           else if (lex_match_id (lexer, "EXCLUDE"))
 760             {
 761               rank.exclude = MV_ANY;
 762             }
 763           else
 764             {
 765               lex_error (lexer, NULL);
 766               goto error;
 767             }
 768         }
 769       else if (! parse_into (lexer, &rank))
 770         goto error;
 771     }
 772
 773
 774   /* If no rank specs are given, then apply a default */
 775   if ( rank.n_rs == 0)
 776     {
 777       rank.rs = pool_calloc (rank.pool, 1, sizeof (*rank.rs));
 778       rank.n_rs = 1;
 779       rank.rs[0].rfunc = RANK;
 780       rank.rs[0].destvars = pool_calloc (rank.pool, rank.n_vars, sizeof (*rank.rs[0].destvars));
 781     }
 782
 783   /* Create variables for all rank destinations which haven't
 784      already been created with INTO.
 785      Add labels to all the destination variables.
 786   */
 787   for (i = 0 ; i <  rank.n_rs ; ++i )
 788     {
 789       int v;
 790       struct rank_spec *rs = &rank.rs[i];
 791
 792       for ( v = 0 ; v < rank.n_vars ;  v ++ )
 793         {
 794           if ( rs->destvars[v] == NULL )
 795             {
 796               rs->destvars[v] =
 797                 create_rank_variable (rank.dict, rs->rfunc, rank.vars[v], NULL);
 798             }
 799
 800           create_var_label (&rank, rs->destvars[v],
 801                             rank.vars[v],
 802                             rs->rfunc);
 803         }
 804     }
 805
 806   if ( rank.print )
 807     {
 808       int v;
 809
 810       tab_output_text (0, _("Variables Created By RANK"));
 811       tab_output_text (0, "");
 812
 813       for (i = 0 ; i <  rank.n_rs ; ++i )
 814         {
 815           for ( v = 0 ; v < rank.n_vars ;  v ++ )
 816             {
 817               if ( rank.n_group_vars > 0 )
 818                 {
 819                   struct string varlist;
 820                   int g;
 821
 822                   ds_init_empty (&varlist);
 823                   for ( g = 0 ; g < rank.n_group_vars ; ++g )
 824                     {
 825                       ds_put_cstr (&varlist, var_get_name (rank.group_vars[g]));
 826
 827                       if ( g < rank.n_group_vars - 1)
 828                         ds_put_cstr (&varlist, " ");
 829                     }
 830
 831                   if ( rank.rs[i].rfunc == NORMAL ||
 832                        rank.rs[i].rfunc == PROPORTION )
 833                     tab_output_text_format (0,
 834                                             _("%s into %s(%s of %s using %s BY %s)"),
 835                                             var_get_name (rank.vars[v]),
 836                                             var_get_name (rank.rs[i].destvars[v]),
 837                                             function_name[rank.rs[i].rfunc],
 838                                             var_get_name (rank.vars[v]),
 839                                             fraction_name (&rank),
 840                                             ds_cstr (&varlist));
 841
 842                   else
 843                     tab_output_text_format (0,
 844                                             _("%s into %s(%s of %s BY %s)"),
 845                                             var_get_name (rank.vars[v]),
 846                                             var_get_name (rank.rs[i].destvars[v]),
 847                                             function_name[rank.rs[i].rfunc],
 848                                             var_get_name (rank.vars[v]),
 849                                             ds_cstr (&varlist));
 850                   ds_destroy (&varlist);
 851                 }
 852               else
 853                 {
 854                   if ( rank.rs[i].rfunc == NORMAL ||
 855                        rank.rs[i].rfunc == PROPORTION )
 856                     tab_output_text_format (0,
 857                                             _("%s into %s(%s of %s using %s)"),
 858                                             var_get_name (rank.vars[v]),
 859                                             var_get_name (rank.rs[i].destvars[v]),
 860                                             function_name[rank.rs[i].rfunc],
 861                                             var_get_name (rank.vars[v]),
 862                                             fraction_name (&rank));
 863
 864                   else
 865                     tab_output_text_format (0,
 866                                             _("%s into %s(%s of %s)"),
 867                                             var_get_name (rank.vars[v]),
 868                                             var_get_name (rank.rs[i].destvars[v]),
 869                                             function_name[rank.rs[i].rfunc],
 870                                             var_get_name (rank.vars[v]));
 871                 }
 872             }
 873         }
 874     }
 875
 876   /* Add a variable which we can sort by to get back the original
 877      order */
 878   order = dict_create_var_assert (dataset_dict (ds), "$ORDER_", 0);
 879
 880   add_transformation (ds, create_resort_key, 0, order);
 881
 882   /* Do the ranking */
 883   result = rank_cmd (ds, &rank);
 884
 885   /* Put the active dataset back in its original order.  Delete
 886      our sort key, which we don't need anymore.  */
 887   {
 888     struct casereader *sorted;
 889
 890
 891     /* FIXME: loses error conditions. */
 892
 893     proc_discard_output (ds);
 894     sorted = sort_execute_1var (proc_open (ds), order);
 895     result = proc_commit (ds) && result;
 896
 897     dict_delete_var (dataset_dict (ds), order);
 898     result = dataset_set_source (ds, sorted) && result;
 899     if ( result != true)
 900       goto error;
 901   }
 902
 903   destroy_rank (&rank);
 904   return CMD_SUCCESS;
 905
 906  error:
 907
 908   destroy_rank (&rank);
 909   return CMD_FAILURE;
 910 }
 911
 912
 913
 914 static bool
 915 rank_cmd (struct dataset *ds, const struct rank *cmd)
 916 {
 917   struct dictionary *d = dataset_dict (ds);
 918   bool ok = true;
 919   int i;
 920
 921   for (i = 0 ; i < subcase_get_n_fields (&cmd->sc) ; ++i )
 922     {
 923       /* Rank variable at index I in SC. */
 924       struct casegrouper *split_grouper;
 925       struct casereader *split_group;
 926       struct casewriter *output;
 927
 928       proc_discard_output (ds);
 929       split_grouper = casegrouper_create_splits (proc_open (ds), d);
 930       output = autopaging_writer_create (dict_get_proto (d));
 931
 932       while (casegrouper_get_next_group (split_grouper, &split_group))
 933         {
 934           struct subcase ordering;
 935           struct casereader *ordered;
 936           struct casegrouper *by_grouper;
 937           struct casereader *by_group;
 938
 939           /* Sort this split group by the BY variables as primary
 940              keys and the rank variable as secondary key. */
 941           subcase_init_vars (&ordering, cmd->group_vars, cmd->n_group_vars);
 942           subcase_add_var (&ordering, cmd->vars[i],
 943                            subcase_get_direction (&cmd->sc, i));
 944           ordered = sort_execute (split_group, &ordering);
 945           subcase_destroy (&ordering);
 946
 947           /* Rank the rank variable within this split group. */
 948           by_grouper = casegrouper_create_vars (ordered,
 949                                                 cmd->group_vars, cmd->n_group_vars);
 950           while (casegrouper_get_next_group (by_grouper, &by_group))
 951             {
 952               /* Rank the rank variable within this BY group
 953                  within the split group. */
 954
 955               rank_sorted_file (by_group, output, d,  i, cmd);
 956
 957             }
 958           ok = casegrouper_destroy (by_grouper) && ok;
 959         }
 960       ok = casegrouper_destroy (split_grouper);
 961       ok = proc_commit (ds) && ok;
 962       ok = (dataset_set_source (ds, casewriter_make_reader (output))
 963             && ok);
 964       if (!ok)
 965         break;
 966     }
 967
 968   return ok;
 969 }