/* PSPP - RANK. -*-c-*-
-Copyright (C) 2005 Free Software Foundation, Inc.
-Author: John Darrington 2005
+Copyright (C) 2005, 2006 Free Software Foundation, Inc.
+Author: John Darrington <john@darrington.wattle.id.au>,
+ Ben Pfaff <blp@gnu.org>.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
#include <data/dictionary.h>
#include <data/procedure.h>
#include <data/variable.h>
+#include <data/case.h>
+#include <data/casefile.h>
+#include <data/fastfile.h>
+#include <data/storage-stream.h>
#include <language/command.h>
#include <language/stats/sort-criteria.h>
+#include <limits.h>
#include <libpspp/compiler.h>
#include <math/sort.h>
+#include <output/table.h>
+#include <output/manager.h>
+
+#include <gsl/gsl_cdf.h>
+#include <math.h>
#include "gettext.h"
#define _(msgid) gettext (msgid)
+n=custom;
+savage=custom;
+print=print:!yes/no;
+ +fraction=fraction:!blom/tukey/vw/rankit;
+ +ties=ties:!mean/low/high/condense;
missing=miss:!exclude/include.
*/
/* (declarations) */
/* (functions) */
+typedef double (*rank_function_t) (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_proportion (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_normal (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_percent (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_rfraction (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_rank (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_n (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_savage (double c, double cc, double cc_1,
+ int i, double w);
+
+static double rank_ntiles (double c, double cc, double cc_1,
+ int i, double w);
enum RANK_FUNC
N,
NTILES,
SAVAGE,
+ n_RANK_FUNCS
+ };
+
+static const struct fmt_spec dest_format[n_RANK_FUNCS] = {
+ {FMT_F, 9, 3}, /* rank */
+ {FMT_F, 6, 4}, /* normal */
+ {FMT_F, 6, 2}, /* percent */
+ {FMT_F, 6, 4}, /* rfraction */
+ {FMT_F, 6, 4}, /* proportion */
+ {FMT_F, 6, 0}, /* n */
+ {FMT_F, 3, 0}, /* ntiles */
+ {FMT_F, 8, 4} /* savage */
+};
+
+static const char *function_name[n_RANK_FUNCS] = {
+ "RANK",
+ "NORMAL",
+ "PERCENT",
+ "RFRACTION",
+ "PROPORTION",
+ "N",
+ "NTILES",
+ "SAVAGE"
+};
+
+static rank_function_t rank_func[n_RANK_FUNCS] = {
+ rank_rank,
+ rank_normal,
+ rank_percent,
+ rank_rfraction,
+ rank_proportion,
+ rank_n,
+ rank_ntiles,
+ rank_savage
};
{
enum RANK_FUNC rfunc;
struct variable **destvars;
- struct variable *srcvar;
};
+/* Function to use for testing for missing values */
+static is_missing_func *value_is_missing;
+
static struct rank_spec *rank_specs;
static size_t n_rank_specs;
static struct variable **group_vars;
static size_t n_group_vars;
+static struct variable **src_vars;
+static size_t n_src_vars;
+
+
+static int k_ntiles;
+
static struct cmd_rank cmd;
+static struct casefile *rank_sorted_casefile (struct casefile *cf,
+ const struct sort_criteria *,
+ const struct rank_spec *rs,
+ int n_rank_specs,
+ int idx,
+ const struct missing_values *miss
+ );
+static const char *
+fraction_name(void)
+{
+ static char name[10];
+ switch ( cmd.fraction )
+ {
+ case RANK_BLOM:
+ strcpy (name, "BLOM");
+ break;
+ case RANK_RANKIT:
+ strcpy (name, "RANKIT");
+ break;
+ case RANK_TUKEY:
+ strcpy (name, "TUKEY");
+ break;
+ case RANK_VW:
+ strcpy (name, "VW");
+ break;
+ default:
+ NOT_REACHED ();
+ }
+ return name;
+}
+
+/* Create a label on DEST_VAR, describing its derivation from SRC_VAR and F */
+static void
+create_var_label (struct variable *dest_var,
+ const struct variable *src_var, enum RANK_FUNC f)
+{
+ struct string label;
+ ds_init_empty (&label);
+
+ if ( n_group_vars > 0 )
+ {
+ struct string group_var_str;
+ int g;
+
+ ds_init_empty (&group_var_str);
+
+ for (g = 0 ; g < n_group_vars ; ++g )
+ {
+ if ( g > 0 ) ds_put_cstr (&group_var_str, " ");
+ ds_put_cstr (&group_var_str, group_vars[g]->name);
+ }
+
+ ds_put_format (&label, _("%s of %s by %s"), function_name[f],
+ src_var->name, ds_cstr (&group_var_str));
+ ds_destroy (&group_var_str);
+ }
+ else
+ ds_put_format (&label,_("%s of %s"), function_name[f], src_var->name);
+
+ dest_var->label = strdup (ds_cstr (&label) );
+
+ ds_destroy (&label);
+}
+
+
+static bool
+rank_cmd (const struct sort_criteria *sc,
+ const struct rank_spec *rank_specs, int n_rank_specs)
+{
+ struct sort_criteria criteria;
+ bool result = true;
+ int i;
+ const int n_splits = dict_get_split_cnt (default_dict);
+
+ criteria.crit_cnt = n_splits + n_group_vars + 1;
+ criteria.crits = xnmalloc (criteria.crit_cnt, sizeof *criteria.crits);
+ for (i = 0; i < n_splits ; i++)
+ {
+ struct variable *v = dict_get_split_vars (default_dict)[i];
+ criteria.crits[i].fv = v->fv;
+ criteria.crits[i].width = v->width;
+ criteria.crits[i].dir = SRT_ASCEND;
+ }
+ for (i = 0; i < n_group_vars; i++)
+ {
+ criteria.crits[i + n_splits].fv = group_vars[i]->fv;
+ criteria.crits[i + n_splits].width = group_vars[i]->width;
+ criteria.crits[i + n_splits].dir = SRT_ASCEND;
+ }
+ for (i = 0 ; i < sc->crit_cnt ; ++i )
+ {
+ struct casefile *out ;
+ struct casefile *cf ;
+ struct casereader *reader ;
+ struct casefile *sorted_cf ;
+
+ /* Obtain active file in CF. */
+ if (!procedure (NULL, NULL))
+ return false;
+ cf = proc_capture_output ();
+
+ /* Sort CF into SORTED_CF. */
+ reader = casefile_get_destructive_reader (cf) ;
+ criteria.crits[criteria.crit_cnt - 1] = sc->crits[i];
+ assert ( sc->crits[i].fv == src_vars[i]->fv );
+ sorted_cf = sort_execute (reader, &criteria);
+ casefile_destroy (cf);
+
+ out = rank_sorted_casefile (sorted_cf, &criteria,
+ rank_specs, n_rank_specs,
+ i, &src_vars[i]->miss) ;
+ if ( NULL == out )
+ {
+ result = false ;
+ continue ;
+ }
+
+ proc_set_source (storage_source_create (out));
+ }
+ free (criteria.crits);
+
+ return result ;
+}
+
+/* Hardly a rank function !! */
+static double
+rank_n (double c UNUSED, double cc UNUSED, double cc_1 UNUSED,
+ int i UNUSED, double w)
+{
+ return w;
+}
+
+
+static double
+rank_rank (double c, double cc, double cc_1,
+ int i, double w UNUSED)
+{
+ double rank;
+ if ( c >= 1.0 )
+ {
+ switch (cmd.ties)
+ {
+ case RANK_LOW:
+ rank = cc_1 + 1;
+ break;
+ case RANK_HIGH:
+ rank = cc;
+ break;
+ case RANK_MEAN:
+ rank = cc_1 + (c + 1.0)/ 2.0;
+ break;
+ case RANK_CONDENSE:
+ rank = i;
+ break;
+ default:
+ NOT_REACHED ();
+ }
+ }
+ else
+ {
+ switch (cmd.ties)
+ {
+ case RANK_LOW:
+ rank = cc_1;
+ break;
+ case RANK_HIGH:
+ rank = cc;
+ break;
+ case RANK_MEAN:
+ rank = cc_1 + c / 2.0 ;
+ break;
+ case RANK_CONDENSE:
+ rank = i;
+ break;
+ default:
+ NOT_REACHED ();
+ }
+ }
+
+ return rank;
+}
+
+
+static double
+rank_rfraction (double c, double cc, double cc_1,
+ int i, double w)
+{
+ return rank_rank (c, cc, cc_1, i, w) / w ;
+}
+
+
+static double
+rank_percent (double c, double cc, double cc_1,
+ int i, double w)
+{
+ return rank_rank (c, cc, cc_1, i, w) * 100.0 / w ;
+}
+
+
+static double
+rank_proportion (double c, double cc, double cc_1,
+ int i, double w)
+{
+ const double r = rank_rank (c, cc, cc_1, i, w) ;
+
+ double f;
+
+ switch ( cmd.fraction )
+ {
+ case RANK_BLOM:
+ f = (r - 3.0/8.0) / (w + 0.25);
+ break;
+ case RANK_RANKIT:
+ f = (r - 0.5) / w ;
+ break;
+ case RANK_TUKEY:
+ f = (r - 1.0/3.0) / (w + 1.0/3.0);
+ break;
+ case RANK_VW:
+ f = r / ( w + 1.0);
+ break;
+ default:
+ NOT_REACHED ();
+ }
+
+
+ return (f > 0) ? f : SYSMIS;
+}
+
+static double
+rank_normal (double c, double cc, double cc_1,
+ int i, double w)
+{
+ double f = rank_proportion (c, cc, cc_1, i, w);
+
+ return gsl_cdf_ugaussian_Pinv (f);
+}
+
+static double
+rank_ntiles (double c, double cc, double cc_1,
+ int i, double w)
+{
+ double r = rank_rank (c, cc, cc_1, i, w);
+
+
+ return ( floor (( r * k_ntiles) / ( w + 1) ) + 1);
+}
+
+/* Expected value of the order statistics from an exponential distribution */
+static double
+ee (int j, double w_star)
+{
+ int k;
+ double sum = 0.0;
+
+ for (k = 1 ; k <= j; k++)
+ sum += 1.0 / ( w_star + 1 - k );
+
+ return sum;
+}
+
+
+static double
+rank_savage (double c, double cc, double cc_1,
+ int i UNUSED, double w)
+{
+ double int_part;
+ const int i_1 = floor (cc_1);
+ const int i_2 = floor (cc);
+
+ const double w_star = (modf (w, &int_part) == 0 ) ? w : floor (w) + 1;
+
+ const double g_1 = cc_1 - i_1;
+ const double g_2 = cc - i_2;
+
+ /* The second factor is infinite, when the first is zero.
+ Therefore, evaluate the second, only when the first is non-zero */
+ const double expr1 = (1 - g_1) ? (1 - g_1) * ee(i_1+1, w_star) : ( 1 - g_1);
+ const double expr2 = g_2 ? g_2 * ee (i_2+1, w_star) : g_2 ;
+
+ if ( i_1 == i_2 )
+ return ee (i_1 + 1, w_star) - 1;
+
+ if ( i_1 + 1 == i_2 )
+ return ( ( expr1 + expr2 )/c ) - 1;
+
+ if ( i_1 + 2 <= i_2 )
+ {
+ int j;
+ double sigma = 0.0;
+ for (j = i_1 + 2 ; j <= i_2; ++j )
+ sigma += ee (j, w_star);
+ return ( (expr1 + expr2 + sigma) / c) -1;
+ }
+
+ NOT_REACHED();
+}
+
+
+/* Rank the casefile belonging to CR, starting from the current
+ postition of CR continuing up to and including the ENDth case.
+
+ RS points to an array containing the rank specifications to
+ use. N_RANK_SPECS is the number of elements of RS.
+
+
+ DEST_VAR_INDEX is the index into the rank_spec destvar element
+ to be used for this ranking.
+
+ Prerequisites: 1. The casefile must be sorted according to CRITERION.
+ 2. W is the sum of the non-missing caseweights for this
+ range of the casefile.
+*/
+static void
+rank_cases (struct casereader *cr,
+ unsigned long end,
+ const struct sort_criterion *criterion,
+ const struct missing_values *mv,
+ double w,
+ const struct rank_spec *rs,
+ int n_rank_specs,
+ int dest_var_index,
+ struct casefile *dest)
+{
+ bool warn = true;
+ double cc = 0.0;
+ double cc_1;
+ int iter = 1;
+
+ const int fv = criterion->fv;
+ const int width = criterion->width;
+ while (casereader_cnum (cr) < end)
+ {
+ struct casereader *lookahead;
+ const union value *this_value;
+ struct ccase this_case, lookahead_case;
+ double c;
+ int i;
+ size_t n = 0;
+
+ if (!casereader_read_xfer (cr, &this_case))
+ break;
+
+ this_value = case_data (&this_case, fv);
+ c = dict_get_case_weight (default_dict, &this_case, &warn);
+
+ lookahead = casereader_clone (cr);
+ n = 0;
+ while (casereader_cnum (lookahead) < end
+ && casereader_read_xfer (lookahead, &lookahead_case))
+ {
+ const union value *lookahead_value = case_data (&lookahead_case, fv);
+ int diff = compare_values (this_value, lookahead_value, width);
+
+ if (diff != 0)
+ {
+ /* Make sure the casefile was sorted */
+ assert ( diff == ((criterion->dir == SRT_ASCEND) ? -1 :1));
+
+ case_destroy (&lookahead_case);
+ break;
+ }
+
+ c += dict_get_case_weight (default_dict, &lookahead_case, &warn);
+ case_destroy (&lookahead_case);
+ n++;
+ }
+ casereader_destroy (lookahead);
+
+ cc_1 = cc;
+ if ( !value_is_missing (mv, this_value) )
+ cc += c;
+
+ do
+ {
+ for (i = 0; i < n_rank_specs; ++i)
+ {
+ const int dest_idx = rs[i].destvars[dest_var_index]->fv;
+
+ if ( value_is_missing (mv, this_value) )
+ case_data_rw (&this_case, dest_idx)->f = SYSMIS;
+ else
+ case_data_rw (&this_case, dest_idx)->f =
+ rank_func[rs[i].rfunc](c, cc, cc_1, iter, w);
+ }
+ casefile_append_xfer (dest, &this_case);
+ }
+ while (n-- > 0 && casereader_read_xfer (cr, &this_case));
+
+ if ( !value_is_missing (mv, this_value) )
+ iter++;
+ }
+
+ /* If this isn't true, then all the results will be wrong */
+ assert ( w == cc );
+}
+
+static bool
+same_group (const struct ccase *a, const struct ccase *b,
+ const struct sort_criteria *crit)
+{
+ size_t i;
+
+ for (i = 0; i < crit->crit_cnt - 1; i++)
+ {
+ struct sort_criterion *c = &crit->crits[i];
+ if (compare_values (case_data (a, c->fv), case_data (b, c->fv),
+ c->width) != 0)
+ return false;
+ }
+
+ return true;
+}
+
+static struct casefile *
+rank_sorted_casefile (struct casefile *cf,
+ const struct sort_criteria *crit,
+ const struct rank_spec *rs,
+ int n_rank_specs,
+ int dest_idx,
+ const struct missing_values *mv)
+{
+ struct casefile *dest = fastfile_create (casefile_get_value_cnt (cf));
+ struct casereader *lookahead = casefile_get_reader (cf);
+ struct casereader *pos = casereader_clone (lookahead);
+ struct ccase group_case;
+ bool warn = true;
+
+ struct sort_criterion *ultimate_crit = &crit->crits[crit->crit_cnt - 1];
+
+ if (casereader_read (lookahead, &group_case))
+ {
+ struct ccase this_case;
+ const union value *this_value ;
+ double w = 0.0;
+ this_value = case_data( &group_case, ultimate_crit->fv);
+
+ if ( !value_is_missing(mv, this_value) )
+ w = dict_get_case_weight (default_dict, &group_case, &warn);
+
+ while (casereader_read (lookahead, &this_case))
+ {
+ const union value *this_value =
+ case_data(&this_case, ultimate_crit->fv);
+ double c = dict_get_case_weight (default_dict, &this_case, &warn);
+ if (!same_group (&group_case, &this_case, crit))
+ {
+ rank_cases (pos, casereader_cnum (lookahead) - 1,
+ ultimate_crit,
+ mv, w,
+ rs, n_rank_specs,
+ dest_idx, dest);
+
+ w = 0.0;
+ case_move (&group_case, &this_case);
+ }
+ if ( !value_is_missing (mv, this_value) )
+ w += c;
+ }
+ rank_cases (pos, ULONG_MAX, ultimate_crit, mv, w,
+ rs, n_rank_specs, dest_idx, dest);
+ }
+
+ if (casefile_error (dest))
+ {
+ casefile_destroy (dest);
+ dest = NULL;
+ }
+
+ casefile_destroy (cf);
+ return dest;
+}
+
+
+/* Transformation function to enumerate all the cases */
+static int
+create_resort_key (void *key_var_, struct ccase *cc, casenum_t case_num)
+{
+ struct variable *key_var = key_var_;
+
+ case_data_rw(cc, key_var->fv)->f = case_num;
+
+ return TRNS_CONTINUE;
+}
+
+
+/* Create and return a new variable in which to store the ranks of SRC_VAR
+ accoring to the rank function F.
+ VNAME is the name of the variable to be created.
+ If VNAME is NULL, then a name will be automatically chosen.
+ */
+static struct variable *
+create_rank_variable (enum RANK_FUNC f,
+ const struct variable *src_var,
+ const char *vname)
+{
+ int i;
+ struct variable *var = NULL;
+ char name[SHORT_NAME_LEN + 1];
+
+ if ( vname )
+ var = dict_create_var(default_dict, vname, 0);
+
+ if ( NULL == var )
+ {
+ snprintf(name, SHORT_NAME_LEN + 1, "%c%s",
+ function_name[f][0], src_var->name);
+
+ var = dict_create_var(default_dict, name, 0);
+ }
+
+ i = 1;
+ while( NULL == var )
+ {
+ char func_abb[4];
+ snprintf(func_abb, 4, "%s", function_name[f]);
+ snprintf(name, SHORT_NAME_LEN + 1, "%s%03d", func_abb,
+ i);
+
+ var = dict_create_var(default_dict, name, 0);
+ if (i++ >= 999)
+ break;
+ }
+
+ i = 1;
+ while ( NULL == var )
+ {
+ char func_abb[3];
+ snprintf(func_abb, 3, "%s", function_name[f]);
+
+ snprintf(name, SHORT_NAME_LEN + 1,
+ "RNK%s%02d", func_abb, i);
+
+ var = dict_create_var(default_dict, name, 0);
+ if ( i++ >= 99 )
+ break;
+ }
+
+ if ( NULL == var )
+ {
+ msg(ME, _("Cannot create new rank variable. All candidates in use."));
+ return NULL;
+ }
+
+ var->write = var->print = dest_format[f];
+
+ return var;
+}
int cmd_rank(void);
+static void
+rank_cleanup(void)
+{
+ int i;
+
+ free (group_vars);
+ group_vars = NULL;
+ n_group_vars = 0;
+
+ for (i = 0 ; i < n_rank_specs ; ++i )
+ {
+ free (rank_specs[i].destvars);
+ }
+
+ free (rank_specs);
+ rank_specs = NULL;
+ n_rank_specs = 0;
+
+ sort_destroy_criteria (sc);
+ sc = NULL;
+
+ free (src_vars);
+ src_vars = NULL;
+ n_src_vars = 0;
+}
+
int
cmd_rank(void)
{
+ bool result;
+ struct variable *order;
size_t i;
n_rank_specs = 0;
if ( !parse_rank(&cmd, NULL) )
+ {
+ rank_cleanup ();
return CMD_FAILURE;
+ }
-#if 1
- for (i = 0 ; i < sc->crit_cnt ; ++i )
+ /* If /MISSING=INCLUDE is set, then user missing values are ignored */
+ if (cmd.miss == RANK_INCLUDE )
+ value_is_missing = mv_is_value_system_missing;
+ else
+ value_is_missing = mv_is_value_missing;
+
+
+ /* Default to /RANK if no function subcommands are given */
+ if ( !( cmd.sbc_normal || cmd.sbc_ntiles || cmd.sbc_proportion ||
+ cmd.sbc_rfraction || cmd.sbc_savage || cmd.sbc_n ||
+ cmd.sbc_percent || cmd.sbc_rank ) )
{
- struct sort_criterion *crit = &sc->crits[i];
+ assert ( n_rank_specs == 0 );
- printf("Dir: %d; Index: %d\n", crit->dir, crit->fv);
+ rank_specs = xmalloc (sizeof (*rank_specs));
+ rank_specs[0].rfunc = RANK;
+ rank_specs[0].destvars =
+ xcalloc (sc->crit_cnt, sizeof (struct variable *));
+
+ n_rank_specs = 1;
}
- for (i = 0 ; i < n_group_vars ; ++i )
- printf("Group var: %s\n",group_vars[0]->name);
+ assert ( sc->crit_cnt == n_src_vars);
+ /* Create variables for all rank destinations which haven't
+ already been created with INTO.
+ Add labels to all the destination variables.
+ */
for (i = 0 ; i < n_rank_specs ; ++i )
{
- int j;
- printf("Ranks spec %d; Func: %d\n",i, rank_specs[i].rfunc);
+ int v;
+ for ( v = 0 ; v < n_src_vars ; v ++ )
+ {
+ if ( rank_specs[i].destvars[v] == NULL )
+ {
+ rank_specs[i].destvars[v] =
+ create_rank_variable (rank_specs[i].rfunc, src_vars[v], NULL);
+ }
- for (j=0; j < sc->crit_cnt ; ++j )
- printf("Dest var is \"%s\"\n", rank_specs[i].destvars[j]->name);
+ create_var_label ( rank_specs[i].destvars[v],
+ src_vars[v],
+ rank_specs[i].rfunc);
+ }
}
-#endif
+ if ( cmd.print == RANK_YES )
+ {
+ int v;
- free(group_vars);
+ tab_output_text (0, _("Variables Created By RANK"));
+ tab_output_text (0, "\n");
- for (i = 0 ; i < n_rank_specs ; ++i )
- {
- free(rank_specs[i].destvars);
+ for (i = 0 ; i < n_rank_specs ; ++i )
+ {
+ for ( v = 0 ; v < n_src_vars ; v ++ )
+ {
+ if ( n_group_vars > 0 )
+ {
+ struct string varlist;
+ int g;
+
+ ds_init_empty (&varlist);
+ for ( g = 0 ; g < n_group_vars ; ++g )
+ {
+ ds_put_cstr (&varlist, group_vars[g]->name);
+
+ if ( g < n_group_vars - 1)
+ ds_put_cstr (&varlist, " ");
+ }
+
+ if ( rank_specs[i].rfunc == NORMAL ||
+ rank_specs[i].rfunc == PROPORTION )
+ tab_output_text (TAT_PRINTF,
+ _("%s into %s(%s of %s using %s BY %s)"),
+ src_vars[v]->name,
+ rank_specs[i].destvars[v]->name,
+ function_name[rank_specs[i].rfunc],
+ src_vars[v]->name,
+ fraction_name(),
+ ds_cstr (&varlist)
+ );
+
+ else
+ tab_output_text (TAT_PRINTF,
+ _("%s into %s(%s of %s BY %s)"),
+ src_vars[v]->name,
+ rank_specs[i].destvars[v]->name,
+ function_name[rank_specs[i].rfunc],
+ src_vars[v]->name,
+ ds_cstr (&varlist)
+ );
+ ds_destroy (&varlist);
+ }
+ else
+ {
+ if ( rank_specs[i].rfunc == NORMAL ||
+ rank_specs[i].rfunc == PROPORTION )
+ tab_output_text (TAT_PRINTF,
+ _("%s into %s(%s of %s using %s)"),
+ src_vars[v]->name,
+ rank_specs[i].destvars[v]->name,
+ function_name[rank_specs[i].rfunc],
+ src_vars[v]->name,
+ fraction_name()
+ );
+
+ else
+ tab_output_text (TAT_PRINTF,
+ _("%s into %s(%s of %s)"),
+ src_vars[v]->name,
+ rank_specs[i].destvars[v]->name,
+ function_name[rank_specs[i].rfunc],
+ src_vars[v]->name
+ );
+ }
+ }
+ }
}
-
- free(rank_specs);
- sort_destroy_criteria(sc);
+ if ( cmd.sbc_fraction &&
+ ( ! cmd.sbc_normal && ! cmd.sbc_proportion) )
+ msg(MW, _("FRACTION has been specified, but NORMAL and PROPORTION rank functions have not been requested. The FRACTION subcommand will be ignored.") );
+
+ /* Add a variable which we can sort by to get back the original
+ order */
+ order = dict_create_var_assert (default_dict, "$ORDER_", 0);
- return CMD_SUCCESS;
+ add_transformation (create_resort_key, 0, order);
+
+ /* Do the ranking */
+ result = rank_cmd (sc, rank_specs, n_rank_specs);
+
+ /* Put the active file back in its original order */
+ {
+ struct sort_criteria criteria;
+ struct sort_criterion restore_criterion ;
+ restore_criterion.fv = order->fv;
+ restore_criterion.width = 0;
+ restore_criterion.dir = SRT_ASCEND;
+
+ criteria.crits = &restore_criterion;
+ criteria.crit_cnt = 1;
+
+ sort_active_file_in_place (&criteria);
}
+ /* ... and we don't need our sort key anymore. So delete it */
+ dict_delete_var (default_dict, order);
+
+ rank_cleanup();
+
+ return (result ? CMD_SUCCESS : CMD_CASCADING_FAILURE);
+}
/* Parser for the variables sub command
&& token != T_ALL)
return 2;
- sc = sort_parse_criteria (default_dict, 0, 0, 0, terminators);
+ sc = sort_parse_criteria (default_dict,
+ &src_vars, &n_src_vars, 0, terminators);
if ( lex_match(T_BY) )
{
}
-/* Return a name for a new variable which ranks the variable VAR_NAME,
- according to the ranking function F.
- If IDX is non zero, then IDX is used as a disambiguating number.
- FIXME: This is not very robust.
-*/
-static char *
-new_variable_name(const char *ranked_var_name, enum RANK_FUNC f, int idx)
-{
- static char new_name[SHORT_NAME_LEN + 1];
- char temp[SHORT_NAME_LEN + 1];
-
- if ( idx == 0 )
- {
- switch (f)
- {
- case RANK:
- case RFRACTION:
- strcpy(new_name,"R");
- break;
-
- case NORMAL:
- case N:
- case NTILES:
- strcpy(new_name,"N");
- break;
-
- case PERCENT:
- case PROPORTION:
- strcpy(new_name,"P");
- break;
-
- case SAVAGE:
- strcpy(new_name,"S");
- break;
-
- default:
- assert(false);
- break;
- }
-
- strncat(new_name, ranked_var_name, 7);
- }
- else
- {
- strncpy(temp, ranked_var_name, 3);
- snprintf(new_name, SHORT_NAME_LEN, "%s%03d", temp, idx);
- }
-
- return new_name;
-}
-
/* Parse the [/rank INTO var1 var2 ... varN ] clause */
static int
parse_rank_function(struct cmd_rank *cmd UNUSED, enum RANK_FUNC f)
{
- static const struct fmt_spec f8_2 = {FMT_F, 8, 2};
int var_count = 0;
n_rank_specs++;
rank_specs = xnrealloc(rank_specs, n_rank_specs, sizeof *rank_specs);
rank_specs[n_rank_specs - 1].rfunc = f;
+ rank_specs[n_rank_specs - 1].destvars = NULL;
rank_specs[n_rank_specs - 1].destvars =
xcalloc (sc->crit_cnt, sizeof (struct variable *));
while( token == T_ID )
{
- ++var_count;
+
if ( dict_lookup_var (default_dict, tokid) != NULL )
{
msg(SE, _("Variable %s already exists."), tokid);
return 0;
}
- if ( var_count > sc->crit_cnt )
+ if ( var_count >= sc->crit_cnt )
{
msg(SE, _("Too many variables in INTO clause."));
return 0;
}
- destvar = dict_create_var (default_dict, tokid, 0);
- if ( destvar )
- {
- destvar->print = destvar->write = f8_2;
- }
-
- rank_specs[n_rank_specs - 1].destvars[var_count - 1] = destvar ;
+ destvar = create_rank_variable (f, src_vars[var_count], tokid);
+ rank_specs[n_rank_specs - 1].destvars[var_count] = destvar ;
lex_get();
-
+ ++var_count;
}
}
- /* Allocate rank variable names to all those which haven't had INTO
- variables assigned */
- while (var_count < sc->crit_cnt)
- {
- static int idx=0;
- struct variable *destvar ;
- const struct variable *v = dict_get_var(default_dict,
- sc->crits[var_count].fv);
-
- char *new_name;
-
- do {
- new_name = new_variable_name(v->name, f, idx);
-
- destvar = dict_create_var (default_dict, new_name, 0);
- if (!destvar )
- ++idx;
-
- } while( !destvar ) ;
-
- destvar->print = destvar->write = f8_2;
-
- rank_specs[n_rank_specs - 1].destvars[var_count] = destvar ;
-
- ++var_count;
- }
-
return 1;
}
static int
rank_custom_percent(struct cmd_rank *cmd, void *aux UNUSED )
{
- return parse_rank_function(cmd, NORMAL);
+ return parse_rank_function (cmd, PERCENT);
}
static int
{
if ( lex_force_int() )
{
+ k_ntiles = lex_integer ();
lex_get();
lex_force_match(')');
}
return parse_rank_function(cmd, NTILES);
}
-
-
--- /dev/null
+#!/bin/sh
+
+# This program tests the RANK command.
+
+TEMPDIR=/tmp/pspp-tst-$$
+TESTFILE=$TEMPDIR/`basename $0`.sps
+
+# ensure that top_srcdir and top_builddir are absolute
+if [ -z "$top_srcdir" ] ; then top_srcdir=. ; fi
+if [ -z "$top_builddir" ] ; then top_builddir=. ; fi
+top_srcdir=`cd $top_srcdir; pwd`
+top_builddir=`cd $top_builddir; pwd`
+
+PSPP=$top_builddir/src/ui/terminal/pspp
+
+STAT_CONFIG_PATH=$top_srcdir/config
+export STAT_CONFIG_PATH
+
+LANG=C
+export LANG
+
+
+cleanup()
+{
+ if [ x"$PSPP_TEST_NO_CLEANUP" != x ] ; then
+ echo "NOT cleaning $TEMPDIR"
+ return ;
+ fi
+ rm -rf $TEMPDIR
+}
+
+
+fail()
+{
+ echo $activity
+ echo FAILED
+ cleanup;
+ exit 1;
+}
+
+
+no_result()
+{
+ echo $activity
+ echo NO RESULT;
+ cleanup;
+ exit 2;
+}
+
+pass()
+{
+ cleanup;
+ exit 0;
+}
+
+mkdir -p $TEMPDIR
+
+cd $TEMPDIR
+
+
+# Some tests for proper behaviour in the face of invalid input.
+activity="create file 1"
+cat > $TESTFILE <<EOF
+DATA LIST LIST NOTABLE /x * a (a2).
+BEGIN DATA.
+-1 s
+0 s
+1 s
+2 s
+2 s
+4 s
+5 s
+END DATA.
+
+DEBUG XFORM FAIL.
+
+RANK x.
+
+EOF
+if [ $? -ne 0 ] ; then no_result ; fi
+
+# Check that it properly handles failed transformations.
+activity="run program 1"
+$SUPERVISOR $PSPP --testing-mode -o raw-ascii $TESTFILE > $TEMPDIR/err
+if [ $? -ne 1 ] ; then fail ; fi
+
+activity="diff 1"
+perl -pi -e 's/^\s*$//g' $TEMPDIR/err
+diff -b $TEMPDIR/err - <<EOF
+$TEMPDIR/rank.sh.sps:14: error: Stopping syntax file processing here to avoid a cascade of dependent command failures.
+EOF
+if [ $? -ne 0 ] ; then fail ; fi
+
+
+#Now for some general error conditions.
+activity="create file 2"
+cat > $TESTFILE <<EOF
+DATA LIST LIST NOTABLE /x * a (a2).
+BEGIN DATA.
+-1 s
+0 s
+1 s
+2 s
+2 s
+4 s
+5 s
+END DATA.
+
+* invalid NTILES (no parameter)
+RANK x
+ /NTILES
+.
+
+* invalid NTILES (not an integer)
+RANK x
+ /NTILES(d)
+.
+
+
+* destination variable already exists
+RANK x
+ /RANK INTO x.
+
+
+* Too many variables in INTO
+RANK x
+ /RANK INTO foo bar wiz.
+
+* Alpha group
+RANK x BY a.
+
+
+EOF
+if [ $? -ne 0 ] ; then no_result ; fi
+
+
+activity="run program (syntax errors)"
+$SUPERVISOR $PSPP --testing-mode -o raw-ascii $TESTFILE > $TEMPDIR/errs
+if [ $? -ne 1 ] ; then fail ; fi
+
+activity="compare errors"
+perl -pi -e 's/^\s*$//g' $TEMPDIR/errs
+diff -b $TEMPDIR/errs - << EOF
+$TEMPDIR/rank.sh.sps:15: error: RANK: Syntax error expecting \`(' at end of command.
+$TEMPDIR/rank.sh.sps:19: error: RANK: Syntax error expecting integer at \`d'.
+$TEMPDIR/rank.sh.sps:25: error: RANK: Variable x already exists.
+$TEMPDIR/rank.sh.sps:30: error: RANK: Too many variables in INTO clause.
+$TEMPDIR/rank.sh.sps:33: warning: RANK: a is not a numeric variable. It will not be included in the variable list.
+EOF
+if [ $? -ne 0 ] ; then fail ; fi
+
+# Now some real tests.
+
+activity="create file 3"
+cat > $TESTFILE <<EOF
+DATA LIST LIST NOTABLE /x (f8).
+BEGIN DATA.
+-1
+0
+1
+2
+2
+4
+5
+END DATA.
+
+ECHO 'Simple example using defaults'.
+
+RANK x.
+
+LIST.
+
+NEW FILE.
+DATA LIST LIST NOTABLE /a * b *.
+BEGIN DATA.
+0 24
+1 32
+2 31
+2 32
+4 30
+5 29
+6 1
+7 43
+8 .
+9 45
+END DATA.
+
+RANK a b (D)
+ /PRINT=YES
+ /RANK
+ /TIES=HIGH
+ /RFRACTION
+ /N INTO count
+ .
+
+DISPLAY DICTIONARY.
+
+LIST.
+
+
+ECHO 'Test variable name fallback'.
+
+NEW FILE.
+DATA LIST LIST NOTABLE /foo * rfoo * ran003 *.
+BEGIN DATA.
+0 3 2
+1 3 2
+2 3 2
+2 3 2
+4 3 2
+5 3 2
+6 3 2
+7 3 2
+8 3 2
+9 3 2
+END DATA.
+
+RANK foo.
+
+
+DISPLAY DICTIONARY.
+
+
+NEW FILE.
+DATA LIST LIST NOTABLE /a * b *.
+BEGIN DATA.
+0 24
+1 32
+2 31
+2 32
+4 30
+5 29
+6 1
+7 43
+8 8
+9 45
+END DATA.
+
+RANK a
+ /PRINT=YES
+ /TIES=CONDENSE
+ /SAVAGE
+ /PERCENT
+ /PROPORTION
+ /NTILES(4)
+ /NORMAL
+.
+
+LIST.
+
+NEW FILE.
+DATA LIST LIST NOTABLE /a * g1 g2 *.
+BEGIN DATA.
+1 0 2
+2 0 2
+3 0 2
+4 0 2
+5 0 2
+6 0 2
+7 0 2
+8 0 2
+2 1 2
+2 1 2
+3 1 2
+4 1 2
+5 1 2
+6 1 2
+7 1 2
+7 1 2
+8 1 2
+9 1 1
+END DATA.
+
+RANK a (D) BY g2 g1
+ /PRINT=YES
+ /TIES=LOW
+ /MISSING=INCLUDE
+ /FRACTION=RANKIT
+ /RANK
+ /NORMAL
+ .
+
+LIST.
+
+
+ECHO 'fractional ranks ( including small ones for special case of SAVAGE ranks)'
+NEW FILE.
+DATA LIST LIST NOTABLE /a * w * .
+BEGIN DATA.
+1 1.5
+2 0.2
+3 0.1
+4 1
+5 1
+6 1
+7 1
+8 1
+END DATA.
+
+WEIGHT BY w.
+
+RANK a
+ /FRACTION=TUKEY
+ /PROPORTION
+ /SAVAGE
+.
+
+LIST.
+
+
+ECHO 'test all the ties cases with low caseweight values'.
+
+NEW FILE.
+DATA LIST LIST NOTABLE /x * w *.
+BEGIN DATA.
+1 0.1
+2 0.1
+3 0.1
+4 0.2
+5 0.1
+6 0.1
+7 0.1
+8 0.1
+END DATA.
+
+WEIGHT BY w.
+
+RANK x
+ /TIES=low
+ /RANK into xl.
+
+
+RANK x
+ /TIES=high
+ /RANK into xh.
+
+RANK x
+ /TIES=condense
+ /RANK into xc.
+
+
+* Test VW fraction
+
+RANK x
+ /FRACTION=VW
+ /NORMAL.
+
+LIST.
+EOF
+if [ $? -ne 0 ] ; then no_result ; fi
+
+
+activity="run program 3"
+$SUPERVISOR $PSPP --testing-mode -o raw-ascii $TESTFILE
+if [ $? -ne 0 ] ; then no_result ; fi
+
+
+activity="compare output 3"
+perl -pi -e 's/^\s*$//g' $TEMPDIR/pspp.list
+diff -b $TEMPDIR/pspp.list - <<EOF
+Simple example using defaults
+Variables Created By RANK
+x into Rx(RANK of x)
+ x Rx
+-------- ---------
+ -1 1.000
+ 0 2.000
+ 1 3.000
+ 2 4.500
+ 2 4.500
+ 4 6.000
+ 5 7.000
+Variables Created By RANK
+a into Ra(RANK of a)
+b into Rb(RANK of b)
+a into RFR001(RFRACTION of a)
+b into RFR002(RFRACTION of b)
+a into count(N of a)
+b into Nb(N of b)
+1.1 DISPLAY.
++--------+-------------------------------------------+--------+
+|Variable|Description |Position|
+#========#===========================================#========#
+|a |Format: F8.2 | 1|
++--------+-------------------------------------------+--------+
+|b |Format: F8.2 | 2|
++--------+-------------------------------------------+--------+
+|count |N of a | 3|
+| |Format: F6.0 | |
++--------+-------------------------------------------+--------+
+|Ra |RANK of a | 4|
+| |Format: F9.3 | |
++--------+-------------------------------------------+--------+
+|Rb |RANK of b | 5|
+| |Format: F9.3 | |
++--------+-------------------------------------------+--------+
+|RFR001 |RFRACTION of a | 6|
+| |Format: F6.4 | |
++--------+-------------------------------------------+--------+
+|RFR002 |RFRACTION of b | 7|
+| |Format: F6.4 | |
++--------+-------------------------------------------+--------+
+|Nb |N of b | 8|
+| |Format: F6.0 | |
++--------+-------------------------------------------+--------+
+ a b count Ra Rb RFR001 RFR002 Nb
+-------- -------- ------ --------- --------- ------ ------ ------
+ .00 24.00 10 10.000 8.000 1.0000 .8889 9
+ 1.00 32.00 10 9.000 4.000 .9000 .4444 9
+ 2.00 31.00 10 8.000 5.000 .8000 .5556 9
+ 2.00 32.00 10 8.000 4.000 .8000 .4444 9
+ 4.00 30.00 10 6.000 6.000 .6000 .6667 9
+ 5.00 29.00 10 5.000 7.000 .5000 .7778 9
+ 6.00 1.00 10 4.000 9.000 .4000 1.0000 9
+ 7.00 43.00 10 3.000 2.000 .3000 .2222 9
+ 8.00 . 10 2.000 . .2000 . .
+ 9.00 45.00 10 1.000 1.000 .1000 .1111 9
+Test variable name fallback
+Variables Created By RANK
+foo into RAN001(RANK of foo)
+2.1 DISPLAY.
++--------+-------------------------------------------+--------+
+|Variable|Description |Position|
+#========#===========================================#========#
+|foo |Format: F8.2 | 1|
++--------+-------------------------------------------+--------+
+|rfoo |Format: F8.2 | 2|
++--------+-------------------------------------------+--------+
+|ran003 |Format: F8.2 | 3|
++--------+-------------------------------------------+--------+
+|RAN001 |RANK of foo | 4|
+| |Format: F9.3 | |
++--------+-------------------------------------------+--------+
+Variables Created By RANK
+a into Sa(SAVAGE of a)
+a into Pa(PERCENT of a)
+a into PRO001(PROPORTION of a using BLOM)
+a into Na(NTILES of a)
+a into NOR001(NORMAL of a using BLOM)
+ a b Sa Pa PRO001 Na NOR001
+-------- -------- -------- ------ ------ --- ------
+ .00 24.00 -.9000 10.00 .0610 1 -1.547
+ 1.00 32.00 -.7889 20.00 .1585 1 -1.000
+ 2.00 31.00 -.5925 30.00 .2561 2 -.6554
+ 2.00 32.00 -.5925 30.00 .2561 2 -.6554
+ 4.00 30.00 -.3544 40.00 .3537 2 -.3755
+ 5.00 29.00 -.1544 50.00 .4512 2 -.1226
+ 6.00 1.00 .0956 60.00 .5488 3 .1226
+ 7.00 43.00 .4290 70.00 .6463 3 .3755
+ 8.00 8.00 .9290 80.00 .7439 3 .6554
+ 9.00 45.00 1.9290 90.00 .8415 4 1.0005
+Variables Created By RANK
+a into Ra(RANK of a BY g2 g1)
+a into Na(NORMAL of a using RANKIT BY g2 g1)
+ a g1 g2 Ra Na
+-------- -------- -------- --------- ------
+ 1.00 .00 2.00 8.000 1.5341
+ 2.00 .00 2.00 7.000 .8871
+ 3.00 .00 2.00 6.000 .4888
+ 4.00 .00 2.00 5.000 .1573
+ 5.00 .00 2.00 4.000 -.1573
+ 6.00 .00 2.00 3.000 -.4888
+ 7.00 .00 2.00 2.000 -.8871
+ 8.00 .00 2.00 1.000 -1.534
+ 2.00 1.00 2.00 8.000 .9674
+ 2.00 1.00 2.00 8.000 .9674
+ 3.00 1.00 2.00 7.000 .5895
+ 4.00 1.00 2.00 6.000 .2822
+ 5.00 1.00 2.00 5.000 .0000
+ 6.00 1.00 2.00 4.000 -.2822
+ 7.00 1.00 2.00 2.000 -.9674
+ 7.00 1.00 2.00 2.000 -.9674
+ 8.00 1.00 2.00 1.000 -1.593
+ 9.00 1.00 1.00 1.000 .0000
+fractional ranks ( including small ones for special case of SAVAGE ranks)
+Variables Created By RANK
+a into Pa(PROPORTION of a using TUKEY)
+a into Sa(SAVAGE of a)
+ a w Pa Sa
+-------- -------- ------ --------
+ 1.00 1.50 .1285 -.8016
+ 2.00 .20 .1776 -.6905
+ 3.00 .10 .1986 -.6905
+ 4.00 1.00 .3458 -.5305
+ 5.00 1.00 .4860 -.2905
+ 6.00 1.00 .6262 .0262
+ 7.00 1.00 .7664 .4929
+ 8.00 1.00 .9065 1.3929
+test all the ties cases with low caseweight values
+Variables Created By RANK
+x into xl(RANK of x)
+Variables Created By RANK
+x into xh(RANK of x)
+Variables Created By RANK
+x into xc(RANK of x)
+Variables Created By RANK
+x into Nx(NORMAL of x using VW)
+ x w xl xh xc Nx
+-------- -------- --------- --------- --------- ------
+ 1.00 .10 .000 .100 1.000 -1.938
+ 2.00 .10 .100 .200 2.000 -1.412
+ 3.00 .10 .200 .300 3.000 -1.119
+ 4.00 .20 .300 .500 4.000 -.8046
+ 5.00 .10 .500 .600 5.000 -.5549
+ 6.00 .10 .600 .700 6.000 -.4067
+ 7.00 .10 .700 .800 7.000 -.2670
+ 8.00 .10 .800 .900 8.000 -.1323
+EOF
+if [ $? -ne 0 ] ; then fail ; fi
+
+
+
+# A test to make sure that variable name creation is really robust
+activity="create file 4"
+cat > $TESTFILE <<EOF
+DATA LIST LIST notable /x * rx * ran001 TO ran999.
+BEGIN DATA.
+1
+2
+3
+4
+5
+6
+7
+END DATA.
+
+RANK x.
+
+MODIFY VARS /drop ran001 TO ran999.
+
+LIST.
+
+EOF
+if [ $? -ne 0 ] ; then no_result ; fi
+
+activity="run program 4"
+$SUPERVISOR $PSPP --testing-mode -o raw-ascii $TESTFILE > /dev/null
+if [ $? -ne 0 ] ; then fail ; fi
+
+
+activity="compare output 4"
+perl -pi -e 's/^\s*$//g' $TEMPDIR/pspp.list
+diff -b $TEMPDIR/pspp.list - << EOF
+Variables Created By RANK
+x into RNKRA01(RANK of x)
+ x rx RNKRA01
+-------- -------- ---------
+ 1.00 . 1.000
+ 2.00 . 2.000
+ 3.00 . 3.000
+ 4.00 . 4.000
+ 5.00 . 5.000
+ 6.00 . 6.000
+ 7.00 . 7.000
+EOF
+if [ $? -ne 0 ] ; then fail ; fi
+
+pass;
projects / pspp-builds.git / commitdiff