src/frequencies.q

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 /*
  21   TODO:
  22
  23   * Remember that histograms, bar charts need mean, stddev.
  24 */
  25
  26 #include <config.h>
  27 #include <assert.h>
  28 #include <math.h>
  29 #include <stdlib.h>
  30 #include "alloc.h"
  31 #include "bitvector.h"
  32 #include "hash.h"
  33 #include "pool.h"
  34 #include "command.h"
  35 #include "lexer.h"
  36 #include "error.h"
  37 #include "algorithm.h"
  38 #include "magic.h"
  39 #include "misc.h"
  40 #include "stats.h"
  41 #include "output.h"
  42 #include "som.h"
  43 #include "str.h"
  44 #include "tab.h"
  45 #include "value-labels.h"
  46 #include "var.h"
  47 #include "vfm.h"
  48
  49 #include "debug-print.h"
  50
  51 /* (specification)
  52    FREQUENCIES (frq_):
  53      *variables=custom;
  54      format=cond:condense/onepage(*n:onepage_limit,"%s>=0")/!standard,
  55             table:limit(n:limit,"%s>0")/notable/!table,
  56             labels:!labels/nolabels,
  57             sort:!avalue/dvalue/afreq/dfreq,
  58             spaces:!single/double,
  59             paging:newpage/!oldpage;
  60      missing=miss:include/!exclude;
  61      barchart(ba_)=:minimum(d:min),
  62             :maximum(d:max),
  63             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0");
  64      histogram(hi_)=:minimum(d:min),
  65             :maximum(d:max),
  66             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
  67             norm:!nonormal/normal,
  68             incr:increment(d:inc,"%s>0");
  69      hbar(hb_)=:minimum(d:min),
  70             :maximum(d:max),
  71             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
  72             norm:!nonormal/normal,
  73             incr:increment(d:inc,"%s>0");
  74      grouped=custom;
  75      ntiles=custom;
  76      percentiles=custom;
  77      statistics[st_]=1|mean,2|semean,3|median,4|mode,5|stddev,6|variance,
  78             7|kurtosis,8|skewness,9|range,10|minimum,11|maximum,12|sum,
  79             13|default,14|seskewness,15|sekurtosis,all,none.
  80 */
  81 /* (declarations) */
  82 /* (functions) */
  83
  84 /* Description of a statistic. */
  85 struct frq_info
  86   {
  87     int st_indx;                /* Index into a_statistics[]. */
  88     const char *s10;            /* Identifying string. */
  89   };
  90
  91 /* Table of statistics, indexed by dsc_*. */
  92 static struct frq_info st_name[frq_n_stats + 1] =
  93 {
  94   {FRQ_ST_MEAN, N_("Mean")},
  95   {FRQ_ST_SEMEAN, N_("S.E. Mean")},
  96   {FRQ_ST_MEDIAN, N_("Median")},
  97   {FRQ_ST_MODE, N_("Mode")},
  98   {FRQ_ST_STDDEV, N_("Std Dev")},
  99   {FRQ_ST_VARIANCE, N_("Variance")},
 100   {FRQ_ST_KURTOSIS, N_("Kurtosis")},
 101   {FRQ_ST_SEKURTOSIS, N_("S.E. Kurt")},
 102   {FRQ_ST_SKEWNESS, N_("Skewness")},
 103   {FRQ_ST_SESKEWNESS, N_("S.E. Skew")},
 104   {FRQ_ST_RANGE, N_("Range")},
 105   {FRQ_ST_MINIMUM, N_("Minimum")},
 106   {FRQ_ST_MAXIMUM, N_("Maximum")},
 107   {FRQ_ST_SUM, N_("Sum")},
 108   {-1, 0},
 109 };
 110
 111 /* Percentiles to calculate. */
 112 static double *percentiles;
 113 static double *percentile_values;
 114 static int n_percentiles;
 115
 116 /* Groups of statistics. */
 117 #define BI          BIT_INDEX
 118 #define frq_default                                                     \
 119         (BI (frq_mean) | BI (frq_stddev) | BI (frq_min) | BI (frq_max))
 120 #define frq_all                                                 \
 121         (BI (frq_sum) | BI(frq_min) | BI(frq_max)               \
 122          | BI(frq_mean) | BI(frq_semean) | BI(frq_stddev)       \
 123          | BI(frq_variance) | BI(frq_kurt) | BI(frq_sekurt)     \
 124          | BI(frq_skew) | BI(frq_seskew) | BI(frq_range)        \
 125          | BI(frq_range) | BI(frq_mode) | BI(frq_median))
 126
 127 /* Statistics; number of statistics. */
 128 static unsigned long stats;
 129 static int n_stats;
 130
 131 /* Types of graphs. */
 132 enum
 133   {
 134     GFT_NONE,                   /* Don't draw graphs. */
 135     GFT_BAR,                    /* Draw bar charts. */
 136     GFT_HIST,                   /* Draw histograms. */
 137     GFT_HBAR                    /* Draw bar charts or histograms at our discretion. */
 138   };
 139
 140 /* Parsed command. */
 141 static struct cmd_frequencies cmd;
 142
 143 /* Summary of the barchart, histogram, and hbar subcommands. */
 144 static int chart;               /* NONE/BAR/HIST/HBAR. */
 145 static double min, max;         /* Minimum, maximum on y axis. */
 146 static int format;              /* FREQ/PERCENT: Scaling of y axis. */
 147 static double scale, incr;      /* FIXME */
 148 static int normal;              /* FIXME */
 149
 150 /* Variables for which to calculate statistics. */
 151 static int n_variables;
 152 static struct variable **v_variables;
 153
 154 /* Arenas used to store semi-permanent storage. */
 155 static struct pool *int_pool;   /* Integer mode. */
 156 static struct pool *gen_pool;   /* General mode. */
 157
 158 /* Easier access to a_statistics. */
 159 #define stat cmd.a_statistics
 160
 161 static void determine_charts (void);
 162
 163 static void precalc (void *);
 164 static int calc (struct ccase *, void *);
 165 static void postcalc (void *);
 166
 167 static void postprocess_freq_tab (struct variable *);
 168 static void dump_full (struct variable *);
 169 static void dump_condensed (struct variable *);
 170 static void dump_statistics (struct variable *, int show_varname);
 171 static void cleanup_freq_tab (struct variable *);
 172
 173 static hsh_hash_func hash_value_numeric, hash_value_alpha;
 174 static hsh_compare_func compare_value_numeric_a, compare_value_alpha_a;
 175 static hsh_compare_func compare_value_numeric_d, compare_value_alpha_d;
 176 static hsh_compare_func compare_freq_numeric_a, compare_freq_alpha_a;
 177 static hsh_compare_func compare_freq_numeric_d, compare_freq_alpha_d;
 178 \f
 179 /* Parser and outline. */
 180
 181 static int internal_cmd_frequencies (void);
 182
 183 int
 184 cmd_frequencies (void)
 185 {
 186   int result;
 187
 188   int_pool = pool_create ();
 189   result = internal_cmd_frequencies ();
 190   pool_destroy (int_pool);
 191   int_pool=0;
 192   pool_destroy (gen_pool);
 193   gen_pool=0;
 194   free (v_variables);
 195   v_variables=0;
 196   return result;
 197 }
 198
 199 static int
 200 internal_cmd_frequencies (void)
 201 {
 202   int i;
 203
 204   n_percentiles = 0;
 205   percentile_values = NULL;
 206   percentiles = NULL;
 207
 208   n_variables = 0;
 209   v_variables = NULL;
 210
 211   for (i = 0; i < dict_get_var_cnt (default_dict); i++)
 212     dict_get_var(default_dict, i)->p.frq.used = 0;
 213
 214   lex_match_id ("FREQUENCIES");
 215   if (!parse_frequencies (&cmd))
 216     return CMD_FAILURE;
 217
 218   if (cmd.onepage_limit == NOT_LONG)
 219     cmd.onepage_limit = 50;
 220
 221   /* Figure out statistics to calculate. */
 222   stats = 0;
 223   if (stat[FRQ_ST_DEFAULT] || !cmd.sbc_statistics)
 224     stats |= frq_default;
 225   if (stat[FRQ_ST_ALL])
 226     stats |= frq_all;
 227   if (cmd.sort != FRQ_AVALUE && cmd.sort != FRQ_DVALUE)
 228     stats &= ~frq_median;
 229   for (i = 0; i < frq_n_stats; i++)
 230     if (stat[st_name[i].st_indx])
 231       stats |= BIT_INDEX (i);
 232   if (stats & frq_kurt)
 233     stats |= frq_sekurt;
 234   if (stats & frq_skew)
 235     stats |= frq_seskew;
 236
 237   /* Calculate n_stats. */
 238   n_stats = 0;
 239   for (i = 0; i < frq_n_stats; i++)
 240     if ((stats & BIT_INDEX (i)))
 241       n_stats++;
 242
 243   /* Charting. */
 244   determine_charts ();
 245   if (chart != GFT_NONE || cmd.sbc_ntiles)
 246     cmd.sort = FRQ_AVALUE;
 247
 248   /* Do it! */
 249   procedure (precalc, calc, postcalc, NULL);
 250
 251   return CMD_SUCCESS;
 252 }
 253
 254 /* Figure out which charts the user requested.  */
 255 static void
 256 determine_charts (void)
 257 {
 258   int count = (!!cmd.sbc_histogram) + (!!cmd.sbc_barchart) + (!!cmd.sbc_hbar);
 259
 260   if (!count)
 261     {
 262       chart = GFT_NONE;
 263       return;
 264     }
 265   else if (count > 1)
 266     {
 267       chart = GFT_HBAR;
 268       msg (SW, _("At most one of BARCHART, HISTOGRAM, or HBAR should be "
 269            "given.  HBAR will be assumed.  Argument values will be "
 270            "given precedence increasing along the order given."));
 271     }
 272   else if (cmd.sbc_histogram)
 273     chart = GFT_HIST;
 274   else if (cmd.sbc_barchart)
 275     chart = GFT_BAR;
 276   else
 277     chart = GFT_HBAR;
 278
 279   min = max = SYSMIS;
 280   format = FRQ_FREQ;
 281   scale = SYSMIS;
 282   incr = SYSMIS;
 283   normal = 0;
 284
 285   if (cmd.sbc_barchart)
 286     {
 287       if (cmd.ba_min != SYSMIS)
 288         min = cmd.ba_min;
 289       if (cmd.ba_max != SYSMIS)
 290         max = cmd.ba_max;
 291       if (cmd.ba_scale == FRQ_FREQ)
 292         {
 293           format = FRQ_FREQ;
 294           scale = cmd.ba_freq;
 295         }
 296       else if (cmd.ba_scale == FRQ_PERCENT)
 297         {
 298           format = FRQ_PERCENT;
 299           scale = cmd.ba_pcnt;
 300         }
 301     }
 302
 303   if (cmd.sbc_histogram)
 304     {
 305       if (cmd.hi_min != SYSMIS)
 306         min = cmd.hi_min;
 307       if (cmd.hi_max != SYSMIS)
 308         max = cmd.hi_max;
 309       if (cmd.hi_scale == FRQ_FREQ)
 310         {
 311           format = FRQ_FREQ;
 312           scale = cmd.hi_freq;
 313         }
 314       else if (cmd.hi_scale == FRQ_PERCENT)
 315         {
 316           format = FRQ_PERCENT;
 317           scale = cmd.ba_pcnt;
 318         }
 319       if (cmd.hi_norm)
 320         normal = 1;
 321       if (cmd.hi_incr == FRQ_INCREMENT)
 322         incr = cmd.hi_inc;
 323     }
 324
 325   if (cmd.sbc_hbar)
 326     {
 327       if (cmd.hb_min != SYSMIS)
 328         min = cmd.hb_min;
 329       if (cmd.hb_max != SYSMIS)
 330         max = cmd.hb_max;
 331       if (cmd.hb_scale == FRQ_FREQ)
 332         {
 333           format = FRQ_FREQ;
 334           scale = cmd.hb_freq;
 335         }
 336       else if (cmd.hb_scale == FRQ_PERCENT)
 337         {
 338           format = FRQ_PERCENT;
 339           scale = cmd.ba_pcnt;
 340         }
 341       if (cmd.hb_norm)
 342         normal = 1;
 343       if (cmd.hb_incr == FRQ_INCREMENT)
 344         incr = cmd.hb_inc;
 345     }
 346
 347   if (min != SYSMIS && max != SYSMIS && min >= max)
 348     {
 349       msg (SE, _("MAX must be greater than or equal to MIN, if both are "
 350            "specified.  However, MIN was specified as %g and MAX as %g.  "
 351            "MIN and MAX will be ignored."), min, max);
 352       min = max = SYSMIS;
 353     }
 354 }
 355
 356 /* Add data from case C to the frequency table. */
 357 static int
 358 calc (struct ccase *c, void *aux UNUSED)
 359 {
 360   double weight;
 361   int i;
 362
 363   weight = dict_get_case_weight (default_dict, c);
 364
 365   for (i = 0; i < n_variables; i++)
 366     {
 367       struct variable *v = v_variables[i];
 368       union value *val = &c->data[v->fv];
 369       struct freq_tab *ft = &v->p.frq.tab;
 370
 371       switch (v->p.frq.tab.mode)
 372         {
 373           case FRQM_GENERAL:
 374             {
 375               /* General mode. */
 376               struct freq **fpp = (struct freq **) hsh_probe (ft->data, val);
 377
 378               if (*fpp != NULL)
 379                 (*fpp)->c += weight;
 380               else
 381                 {
 382                   struct freq *fp = *fpp = pool_alloc (gen_pool, sizeof *fp);
 383                   fp->v = *val;
 384                   fp->c = weight;
 385                 }
 386             }
 387           break;
 388         case FRQM_INTEGER:
 389           /* Integer mode. */
 390           if (val->f == SYSMIS)
 391             v->p.frq.tab.sysmis += weight;
 392           else if (val->f > INT_MIN+1 && val->f < INT_MAX-1)
 393             {
 394               int i = val->f;
 395               if (i >= v->p.frq.tab.min && i <= v->p.frq.tab.max)
 396                 v->p.frq.tab.vector[i - v->p.frq.tab.min] += weight;
 397             }
 398           else
 399             v->p.frq.tab.out_of_range += weight;
 400           break;
 401         default:
 402           assert (0);
 403         }
 404     }
 405   return 1;
 406 }
 407
 408 /* Prepares each variable that is the target of FREQUENCIES by setting
 409    up its hash table. */
 410 static void
 411 precalc (void *aux UNUSED)
 412 {
 413   int i;
 414
 415   pool_destroy (gen_pool);
 416   gen_pool = pool_create ();
 417
 418   for (i = 0; i < n_variables; i++)
 419     {
 420       struct variable *v = v_variables[i];
 421
 422       if (v->p.frq.tab.mode == FRQM_GENERAL)
 423         {
 424           hsh_hash_func *hash;
 425           hsh_compare_func *compare;
 426
 427           if (v->type == NUMERIC)
 428             {
 429               hash = hash_value_numeric;
 430               compare = compare_value_numeric_a;
 431             }
 432           else
 433             {
 434               hash = hash_value_alpha;
 435               compare = compare_value_alpha_a;
 436             }
 437           v->p.frq.tab.data = hsh_create (16, compare, hash, NULL, v);
 438         }
 439       else
 440         {
 441           int j;
 442
 443           for (j = (v->p.frq.tab.max - v->p.frq.tab.min); j >= 0; j--)
 444             v->p.frq.tab.vector[j] = 0.0;
 445           v->p.frq.tab.out_of_range = 0.0;
 446           v->p.frq.tab.sysmis = 0.0;
 447         }
 448     }
 449 }
 450
 451 /* Finishes up with the variables after frequencies have been
 452    calculated.  Displays statistics, percentiles, ... */
 453 static void
 454 postcalc (void *aux UNUSED)
 455 {
 456   int i;
 457
 458   for (i = 0; i < n_variables; i++)
 459     {
 460       struct variable *v = v_variables[i];
 461       int n_categories;
 462       int dumped_freq_tab = 1;
 463
 464       postprocess_freq_tab (v);
 465
 466       /* Frequencies tables. */
 467       n_categories = v->p.frq.tab.n_valid + v->p.frq.tab.n_missing;
 468       if (cmd.table == FRQ_TABLE
 469           || (cmd.table == FRQ_LIMIT && n_categories <= cmd.limit))
 470         switch (cmd.cond)
 471           {
 472           case FRQ_CONDENSE:
 473             dump_condensed (v);
 474             break;
 475           case FRQ_STANDARD:
 476             dump_full (v);
 477             break;
 478           case FRQ_ONEPAGE:
 479             if (n_categories > cmd.onepage_limit)
 480               dump_condensed (v);
 481             else
 482               dump_full (v);
 483             break;
 484           default:
 485             assert (0);
 486           }
 487       else
 488         dumped_freq_tab = 0;
 489
 490       /* Statistics. */
 491       if (n_stats)
 492         dump_statistics (v, !dumped_freq_tab);
 493
 494       cleanup_freq_tab (v);
 495     }
 496 }
 497
 498 /* Returns the comparison function that should be used for
 499    sorting a frequency table by FRQ_SORT using VAR_TYPE
 500    variables. */
 501 static hsh_compare_func *
 502 get_freq_comparator (int frq_sort, int var_type)
 503 {
 504   /* Note that q2c generates tags beginning with 1000. */
 505   switch (frq_sort | (var_type << 16))
 506     {
 507     case FRQ_AVALUE | (NUMERIC << 16):  return compare_value_numeric_a;
 508     case FRQ_AVALUE | (ALPHA << 16):    return compare_value_alpha_a;
 509     case FRQ_DVALUE | (NUMERIC << 16):  return compare_value_numeric_d;
 510     case FRQ_DVALUE | (ALPHA << 16):    return compare_value_alpha_d;
 511     case FRQ_AFREQ | (NUMERIC << 16):   return compare_freq_numeric_a;
 512     case FRQ_AFREQ | (ALPHA << 16):     return compare_freq_alpha_a;
 513     case FRQ_DFREQ | (NUMERIC << 16):   return compare_freq_numeric_d;
 514     case FRQ_DFREQ | (ALPHA << 16):     return compare_freq_alpha_d;
 515     default: assert (0);
 516     }
 517
 518   return 0;
 519 }
 520
 521 static int
 522 not_missing (const void *f_, void *v_)
 523 {
 524   const struct freq *f = f_;
 525   struct variable *v = v_;
 526
 527   return !is_missing (&f->v, v);
 528 }
 529
 530 static void
 531 postprocess_freq_tab (struct variable * v)
 532 {
 533   hsh_compare_func *compare;
 534   struct freq_tab *ft;
 535   size_t count;
 536   void **data;
 537   struct freq *freqs, *f;
 538   size_t i;
 539
 540   assert (v->p.frq.tab.mode == FRQM_GENERAL);
 541   compare = get_freq_comparator (cmd.sort, v->type);
 542   ft = &v->p.frq.tab;
 543
 544   /* Extract data from hash table. */
 545   count = hsh_count (ft->data);
 546   data = hsh_data (ft->data);
 547
 548   /* Copy dereferenced data into freqs. */
 549   freqs = xmalloc (count* sizeof *freqs);
 550   for (i = 0; i < count; i++)
 551     {
 552       struct freq *f = data[i];
 553       freqs[i] = *f;
 554     }
 555
 556   /* Put data into ft. */
 557   ft->valid = freqs;
 558   ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, v);
 559   ft->missing = freqs + ft->n_valid;
 560   ft->n_missing = count - ft->n_valid;
 561
 562   /* Sort data. */
 563   sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare, v);
 564   sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare, v);
 565
 566   /* Summary statistics. */
 567   ft->total_cases = ft->valid_cases = 0.0;
 568   for (f = ft->valid; f < ft->valid + ft->n_valid; f++)
 569     {
 570       ft->total_cases += f->c;
 571
 572       if ((v->type != NUMERIC || f->v.f != SYSMIS)
 573           && (cmd.miss != FRQ_EXCLUDE || !is_user_missing (&f->v, v)))
 574         ft->valid_cases += f->c;
 575     }
 576 }
 577
 578 static void
 579 cleanup_freq_tab (struct variable *v)
 580 {
 581   assert (v->p.frq.tab.mode == FRQM_GENERAL);
 582   free (v->p.frq.tab.valid);
 583   hsh_destroy (v->p.frq.tab.data);
 584 }
 585
 586 /* Parses the VARIABLES subcommand, adding to
 587    {n_variables,v_variables}. */
 588 static int
 589 frq_custom_variables (struct cmd_frequencies *cmd UNUSED)
 590 {
 591   int mode;
 592   int min, max;
 593
 594   int old_n_variables = n_variables;
 595   int i;
 596
 597   lex_match ('=');
 598   if (token != T_ALL && (token != T_ID
 599                          || dict_lookup_var (default_dict, tokid) == NULL))
 600     return 2;
 601
 602   if (!parse_variables (default_dict, &v_variables, &n_variables,
 603                         PV_APPEND | PV_NO_SCRATCH))
 604     return 0;
 605
 606   for (i = old_n_variables; i < n_variables; i++)
 607     v_variables[i]->p.frq.tab.mode = FRQM_GENERAL;
 608
 609   if (!lex_match ('('))
 610     mode = FRQM_GENERAL;
 611   else
 612     {
 613       mode = FRQM_INTEGER;
 614       if (!lex_force_int ())
 615         return 0;
 616       min = lex_integer ();
 617       lex_get ();
 618       if (!lex_force_match (','))
 619         return 0;
 620       if (!lex_force_int ())
 621         return 0;
 622       max = lex_integer ();
 623       lex_get ();
 624       if (!lex_force_match (')'))
 625         return 0;
 626       if (max < min)
 627         {
 628           msg (SE, _("Upper limit of integer mode value range must be "
 629                      "greater than lower limit."));
 630           return 0;
 631         }
 632     }
 633
 634   for (i = old_n_variables; i < n_variables; i++)
 635     {
 636       struct variable *v = v_variables[i];
 637
 638       if (v->p.frq.used != 0)
 639         {
 640           msg (SE, _("Variable %s specified multiple times on VARIABLES "
 641                      "subcommand."), v->name);
 642           return 0;
 643         }
 644
 645       v->p.frq.used = 1;                /* Used simply as a marker. */
 646
 647       v->p.frq.tab.valid = v->p.frq.tab.missing = NULL;
 648
 649       if (mode == FRQM_INTEGER)
 650         {
 651           if (v->type != NUMERIC)
 652             {
 653               msg (SE, _("Integer mode specified, but %s is not a numeric "
 654                          "variable."), v->name);
 655               return 0;
 656             }
 657
 658           v->p.frq.tab.min = min;
 659           v->p.frq.tab.max = max;
 660           v->p.frq.tab.vector = pool_alloc (int_pool,
 661                                             sizeof (struct freq) * (max - min + 1));
 662         }
 663       else
 664         v->p.frq.tab.vector = NULL;
 665
 666       v->p.frq.n_groups = 0;
 667       v->p.frq.groups = NULL;
 668     }
 669   return 1;
 670 }
 671
 672 /* Parses the GROUPED subcommand, setting the frq.{n_grouped,grouped}
 673    fields of specified variables. */
 674 static int
 675 frq_custom_grouped (struct cmd_frequencies *cmd UNUSED)
 676 {
 677   lex_match ('=');
 678   if ((token == T_ID && dict_lookup_var (default_dict, tokid) != NULL)
 679       || token == T_ID)
 680     for (;;)
 681       {
 682         int i;
 683
 684         /* Max, current size of list; list itself. */
 685         int nl, ml;
 686         double *dl;
 687
 688         /* Variable list. */
 689         int n;
 690         struct variable **v;
 691
 692         if (!parse_variables (default_dict, &v, &n,
 693                               PV_NO_DUPLICATE | PV_NUMERIC))
 694           return 0;
 695         if (lex_match ('('))
 696           {
 697             nl = ml = 0;
 698             dl = NULL;
 699             while (token == T_NUM)
 700               {
 701                 if (nl >= ml)
 702                   {
 703                     ml += 16;
 704                     dl = pool_realloc (int_pool, dl, ml * sizeof (double));
 705                   }
 706                 dl[nl++] = tokval;
 707                 lex_get ();
 708                 lex_match (',');
 709               }
 710             /* Note that nl might still be 0 and dl might still be
 711                NULL.  That's okay. */
 712             if (!lex_match (')'))
 713               {
 714                 free (v);
 715                 msg (SE, _("`)' expected after GROUPED interval list."));
 716                 return 0;
 717               }
 718           }
 719         else
 720           nl = 0;
 721
 722         for (i = 0; i < n; i++)
 723           {
 724             if (v[i]->p.frq.used == 0)
 725               msg (SE, _("Variables %s specified on GROUPED but not on "
 726                    "VARIABLES."), v[i]->name);
 727             if (v[i]->p.frq.groups != NULL)
 728               msg (SE, _("Variables %s specified multiple times on GROUPED "
 729                    "subcommand."), v[i]->name);
 730             else
 731               {
 732                 v[i]->p.frq.n_groups = nl;
 733                 v[i]->p.frq.groups = dl;
 734               }
 735           }
 736         free (v);
 737         if (!lex_match ('/'))
 738           break;
 739         if ((token != T_ID || dict_lookup_var (default_dict, tokid) != NULL)
 740             && token != T_ALL)
 741           {
 742             lex_put_back ('/');
 743             break;
 744           }
 745       }
 746
 747   return 1;
 748 }
 749
 750 /* Adds X to the list of percentiles, keeping the list in proper
 751    order. */
 752 static void
 753 add_percentile (double x)
 754 {
 755   int i;
 756
 757   for (i = 0; i < n_percentiles; i++)
 758     if (x <= percentiles[i])
 759       break;
 760   if (i >= n_percentiles || tokval != percentiles[i])
 761     {
 762       percentiles
 763         = pool_realloc (int_pool, percentiles,
 764                         (n_percentiles + 1) * sizeof *percentiles);
 765       percentile_values
 766         = pool_realloc (int_pool, percentile_values,
 767                         (n_percentiles + 1) * sizeof *percentile_values);
 768       if (i < n_percentiles)
 769         {
 770           memmove (&percentiles[i + 1], &percentiles[i],
 771                    (n_percentiles - i) * sizeof *percentiles);
 772           memmove (&percentile_values[i + 1], &percentile_values[i],
 773                    (n_percentiles - i) * sizeof *percentile_values);
 774         }
 775       percentiles[i] = x;
 776       n_percentiles++;
 777     }
 778 }
 779
 780 /* Parses the PERCENTILES subcommand, adding user-specified
 781    percentiles to the list. */
 782 static int
 783 frq_custom_percentiles (struct cmd_frequencies *cmd UNUSED)
 784 {
 785   lex_match ('=');
 786   if (token != T_NUM)
 787     {
 788       msg (SE, _("Percentile list expected after PERCENTILES."));
 789       return 0;
 790     }
 791
 792   do
 793     {
 794       if (tokval <= 0 || tokval >= 100)
 795         {
 796           msg (SE, _("Percentiles must be greater than "
 797                      "0 and less than 100."));
 798           return 0;
 799         }
 800
 801       add_percentile (tokval / 100.0);
 802       lex_get ();
 803       lex_match (',');
 804     }
 805   while (token == T_NUM);
 806   return 1;
 807 }
 808
 809 /* Parses the NTILES subcommand, adding the percentiles that
 810    correspond to the specified evenly-distributed ntiles. */
 811 static int
 812 frq_custom_ntiles (struct cmd_frequencies *cmd UNUSED)
 813 {
 814   int i;
 815
 816   lex_match ('=');
 817   if (!lex_force_int ())
 818     return 0;
 819   for (i = 1; i < lex_integer (); i++)
 820     add_percentile (1.0 / lex_integer () * i);
 821   lex_get ();
 822   return 1;
 823 }
 824 \f
 825 /* Comparison functions. */
 826
 827 /* Hash of numeric values. */
 828 static unsigned
 829 hash_value_numeric (const void *value_, void *foo UNUSED)
 830 {
 831   const struct freq *value = value_;
 832   return hsh_hash_double (value->v.f);
 833 }
 834
 835 /* Hash of string values. */
 836 static unsigned
 837 hash_value_alpha (const void *value_, void *v_)
 838 {
 839   const struct freq *value = value_;
 840   struct variable *v = v_;
 841
 842   return hsh_hash_bytes (value->v.s, v->width);
 843 }
 844
 845 /* Ascending numeric compare of values. */
 846 static int
 847 compare_value_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
 848 {
 849   const struct freq *a = a_;
 850   const struct freq *b = b_;
 851
 852   if (a->v.f > b->v.f)
 853     return 1;
 854   else if (a->v.f < b->v.f)
 855     return -1;
 856   else
 857     return 0;
 858 }
 859
 860 /* Ascending string compare of values. */
 861 static int
 862 compare_value_alpha_a (const void *a_, const void *b_, void *v_)
 863 {
 864   const struct freq *a = a_;
 865   const struct freq *b = b_;
 866   const struct variable *v = v_;
 867
 868   return memcmp (a->v.s, b->v.s, v->width);
 869 }
 870
 871 /* Descending numeric compare of values. */
 872 static int
 873 compare_value_numeric_d (const void *a, const void *b, void *foo UNUSED)
 874 {
 875   return -compare_value_numeric_a (a, b, foo);
 876 }
 877
 878 /* Descending string compare of values. */
 879 static int
 880 compare_value_alpha_d (const void *a, const void *b, void *v)
 881 {
 882   return -compare_value_alpha_a (a, b, v);
 883 }
 884
 885 /* Ascending numeric compare of frequency;
 886    secondary key on ascending numeric value. */
 887 static int
 888 compare_freq_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
 889 {
 890   const struct freq *a = a_;
 891   const struct freq *b = b_;
 892
 893   if (a->c > b->c)
 894     return 1;
 895   else if (a->c < b->c)
 896     return -1;
 897
 898   if (a->v.f > b->v.f)
 899     return 1;
 900   else if (a->v.f < b->v.f)
 901     return -1;
 902   else
 903     return 0;
 904 }
 905
 906 /* Ascending numeric compare of frequency;
 907    secondary key on ascending string value. */
 908 static int
 909 compare_freq_alpha_a (const void *a_, const void *b_, void *v_)
 910 {
 911   const struct freq *a = a_;
 912   const struct freq *b = b_;
 913   const struct variable *v = v_;
 914
 915   if (a->c > b->c)
 916     return 1;
 917   else if (a->c < b->c)
 918     return -1;
 919   else
 920     return memcmp (a->v.s, b->v.s, v->width);
 921 }
 922
 923 /* Descending numeric compare of frequency;
 924    secondary key on ascending numeric value. */
 925 static int
 926 compare_freq_numeric_d (const void *a_, const void *b_, void *foo UNUSED)
 927 {
 928   const struct freq *a = a_;
 929   const struct freq *b = b_;
 930
 931   if (a->c > b->c)
 932     return -1;
 933   else if (a->c < b->c)
 934     return 1;
 935
 936   if (a->v.f > b->v.f)
 937     return 1;
 938   else if (a->v.f < b->v.f)
 939     return -1;
 940   else
 941     return 0;
 942 }
 943
 944 /* Descending numeric compare of frequency;
 945    secondary key on ascending string value. */
 946 static int
 947 compare_freq_alpha_d (const void *a_, const void *b_, void *v_)
 948 {
 949   const struct freq *a = a_;
 950   const struct freq *b = b_;
 951   const struct variable *v = v_;
 952
 953   if (a->c > b->c)
 954     return -1;
 955   else if (a->c < b->c)
 956     return 1;
 957   else
 958     return memcmp (a->v.s, b->v.s, v->width);
 959 }
 960 \f
 961 /* Frequency table display. */
 962
 963 /* Sets the widths of all the columns and heights of all the rows in
 964    table T for driver D. */
 965 static void
 966 full_dim (struct tab_table *t, struct outp_driver *d)
 967 {
 968   int lab = cmd.labels == FRQ_LABELS;
 969   int i;
 970
 971   if (lab)
 972     t->w[0] = min (tab_natural_width (t, d, 0), d->prop_em_width * 15);
 973   for (i = lab; i < lab + 5; i++)
 974     t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
 975   for (i = 0; i < t->nr; i++)
 976     t->h[i] = d->font_height;
 977 }
 978
 979 /* Displays a full frequency table for variable V. */
 980 static void
 981 dump_full (struct variable * v)
 982 {
 983   int n_categories;
 984   struct freq *f;
 985   struct tab_table *t;
 986   int r;
 987   double cum_total = 0.0;
 988   double cum_freq = 0.0;
 989
 990   struct init
 991     {
 992       int c, r;
 993       const char *s;
 994     };
 995
 996   struct init *p;
 997
 998   static struct init vec[] =
 999   {
1000     {4, 0, N_("Valid")},
1001     {5, 0, N_("Cum")},
1002     {1, 1, N_("Value")},
1003     {2, 1, N_("Frequency")},
1004     {3, 1, N_("Percent")},
1005     {4, 1, N_("Percent")},
1006     {5, 1, N_("Percent")},
1007     {0, 0, NULL},
1008     {1, 0, NULL},
1009     {2, 0, NULL},
1010     {3, 0, NULL},
1011     {-1, -1, NULL},
1012   };
1013
1014   int lab = cmd.labels == FRQ_LABELS;
1015
1016   n_categories = v->p.frq.tab.n_valid + v->p.frq.tab.n_missing;
1017   t = tab_create (5 + lab, n_categories + 3, 0);
1018   tab_headers (t, 0, 0, 2, 0);
1019   tab_dim (t, full_dim);
1020
1021   if (lab)
1022     tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value Label"));
1023   for (p = vec; p->s; p++)
1024     tab_text (t, p->c - (p->r ? !lab : 0), p->r,
1025                   TAB_CENTER | TAT_TITLE, gettext (p->s));
1026
1027   r = 2;
1028   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1029     {
1030       double percent, valid_percent;
1031
1032       cum_freq += f->c;
1033
1034       percent = f->c / v->p.frq.tab.total_cases * 100.0;
1035       valid_percent = f->c / v->p.frq.tab.valid_cases * 100.0;
1036       cum_total += valid_percent;
1037
1038       if (lab)
1039         {
1040           const char *label = val_labs_find (v->val_labs, f->v);
1041           if (label != NULL)
1042             tab_text (t, 0, r, TAB_LEFT, label);
1043         }
1044
1045       tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1046       tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1047       tab_float (t, 2 + lab, r, TAB_NONE, percent, 5, 1);
1048       tab_float (t, 3 + lab, r, TAB_NONE, valid_percent, 5, 1);
1049       tab_float (t, 4 + lab, r, TAB_NONE, cum_total, 5, 1);
1050       r++;
1051     }
1052   for (; f < &v->p.frq.tab.valid[n_categories]; f++)
1053     {
1054       cum_freq += f->c;
1055
1056       if (lab)
1057         {
1058           const char *label = val_labs_find (v->val_labs, f->v);
1059           if (label != NULL)
1060             tab_text (t, 0, r, TAB_LEFT, label);
1061         }
1062
1063       tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1064       tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1065       tab_float (t, 2 + lab, r, TAB_NONE,
1066                      f->c / v->p.frq.tab.total_cases * 100.0, 5, 1);
1067       tab_text (t, 3 + lab, r, TAB_NONE, _("Missing"));
1068       r++;
1069     }
1070
1071   tab_box (t, TAL_1, TAL_1,
1072            cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1073            0, 0, 4 + lab, r);
1074   tab_hline (t, TAL_2, 0, 4 + lab, 2);
1075   tab_hline (t, TAL_2, 0, 4 + lab, r);
1076   tab_joint_text (t, 0, r, 0 + lab, r, TAB_RIGHT | TAT_TITLE, _("Total"));
1077   tab_vline (t, TAL_0, 1, r, r);
1078   tab_float (t, 1 + lab, r, TAB_NONE, cum_freq, 8, 0);
1079   tab_float (t, 2 + lab, r, TAB_NONE, 100.0, 5, 1);
1080   tab_float (t, 3 + lab, r, TAB_NONE, 100.0, 5, 1);
1081
1082   tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1083   tab_submit (t);
1084 }
1085
1086 /* Sets the widths of all the columns and heights of all the rows in
1087    table T for driver D. */
1088 static void
1089 condensed_dim (struct tab_table *t, struct outp_driver *d)
1090 {
1091   int cum_w = max (outp_string_width (d, _("Cum")),
1092                    max (outp_string_width (d, _("Cum")),
1093                         outp_string_width (d, "000")));
1094
1095   int i;
1096
1097   for (i = 0; i < 2; i++)
1098     t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
1099   for (i = 2; i < 4; i++)
1100     t->w[i] = cum_w;
1101   for (i = 0; i < t->nr; i++)
1102     t->h[i] = d->font_height;
1103 }
1104
1105 /* Display condensed frequency table for variable V. */
1106 static void
1107 dump_condensed (struct variable * v)
1108 {
1109   int n_categories;
1110   struct freq *f;
1111   struct tab_table *t;
1112   int r;
1113   double cum_total = 0.0;
1114
1115   n_categories = v->p.frq.tab.n_valid + v->p.frq.tab.n_missing;
1116   t = tab_create (4, n_categories + 2, 0);
1117
1118   tab_headers (t, 0, 0, 2, 0);
1119   tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value"));
1120   tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Freq"));
1121   tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1122   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Cum"));
1123   tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1124   tab_dim (t, condensed_dim);
1125
1126   r = 2;
1127   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1128     {
1129       double percent;
1130
1131       percent = f->c / v->p.frq.tab.total_cases * 100.0;
1132       cum_total += f->c / v->p.frq.tab.valid_cases * 100.0;
1133
1134       tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1135       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1136       tab_float (t, 2, r, TAB_NONE, percent, 3, 0);
1137       tab_float (t, 3, r, TAB_NONE, cum_total, 3, 0);
1138       r++;
1139     }
1140   for (; f < &v->p.frq.tab.valid[n_categories]; f++)
1141     {
1142       tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1143       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1144       tab_float (t, 2, r, TAB_NONE,
1145                  f->c / v->p.frq.tab.total_cases * 100.0, 3, 0);
1146       r++;
1147     }
1148
1149   tab_box (t, TAL_1, TAL_1,
1150            cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1151            0, 0, 3, r - 1);
1152   tab_hline (t, TAL_2, 0, 3, 2);
1153   tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1154   tab_columns (t, SOM_COL_DOWN, 1);
1155   tab_submit (t);
1156 }
1157 \f
1158 /* Statistical display. */
1159
1160 /* Calculates all the pertinent statistics for variable V, putting
1161    them in array D[].  FIXME: This could be made much more optimal. */
1162 static void
1163 calc_stats (struct variable * v, double d[frq_n_stats])
1164 {
1165   double W = v->p.frq.tab.valid_cases;
1166   double X_bar, X_mode, M2, M3, M4;
1167   struct freq *f;
1168   int most_often;
1169
1170   double cum_total;
1171   int i = 0;
1172   double previous_value;
1173
1174   /* Calculate the mean. */
1175   X_bar = 0.0;
1176   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1177     X_bar += f->v.f * f->c;
1178   X_bar /= W;
1179
1180   /* Calculate percentiles. */
1181   cum_total = 0;
1182   previous_value = SYSMIS;
1183   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1184     {
1185       cum_total += f->c ;
1186       for (; i < n_percentiles; i++)
1187         {
1188           if (cum_total / v->p.frq.tab.valid_cases < percentiles[i])
1189             break;
1190
1191           percentile_values[i] = previous_value;
1192         }
1193       previous_value = f->v.f;
1194     }
1195
1196   /* Calculate the mode. */
1197   most_often = -1;
1198   X_mode = SYSMIS;
1199   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1200     {
1201       if (most_often < f->c)
1202         {
1203           most_often = f->c;
1204           X_mode = f->v.f;
1205         }
1206       else if (most_often == f->c)
1207         {
1208           /* A duplicate mode is undefined.
1209              FIXME: keep track of *all* the modes. */
1210           X_mode = SYSMIS;
1211         }
1212     }
1213
1214   /* Calculate moments about the mean. */
1215   M2 = M3 = M4 = 0.0;
1216   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1217     {
1218       double dev = f->v.f - X_bar;
1219       double tmp;
1220       tmp = dev * dev;
1221       M2 += f->c * tmp;
1222       tmp *= dev;
1223       M3 += f->c * tmp;
1224       tmp *= dev;
1225       M4 += f->c * tmp;
1226     }
1227
1228   /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1229   d[frq_min] = v->p.frq.tab.valid[0].v.f;
1230   d[frq_max] = v->p.frq.tab.valid[v->p.frq.tab.n_valid - 1].v.f;
1231   d[frq_mode] = X_mode;
1232   d[frq_range] = d[frq_max] - d[frq_min];
1233   d[frq_median] = SYSMIS;
1234   d[frq_mean] = X_bar;
1235   d[frq_sum] = X_bar * W;
1236   d[frq_variance] = M2 / (W - 1);
1237   d[frq_stddev] = sqrt (d[frq_variance]);
1238   d[frq_semean] = d[frq_stddev] / sqrt (W);
1239   if (W >= 3.0 && d[frq_variance] > 0)
1240     {
1241       double S = d[frq_stddev];
1242       d[frq_skew] = (W * M3 / ((W - 1.0) * (W - 2.0) * S * S * S));
1243       d[frq_seskew] = sqrt (6.0 * W * (W - 1.0)
1244                             / ((W - 2.0) * (W + 1.0) * (W + 3.0)));
1245     }
1246   else
1247     {
1248       d[frq_skew] = d[frq_seskew] = SYSMIS;
1249     }
1250   if (W >= 4.0 && d[frq_variance] > 0)
1251     {
1252       double S2 = d[frq_variance];
1253       double SE_g1 = d[frq_seskew];
1254
1255       d[frq_kurt] = ((W * (W + 1.0) * M4 - 3.0 * M2 * M2 * (W - 1.0))
1256                      / ((W - 1.0) * (W - 2.0) * (W - 3.0) * S2 * S2));
1257       d[frq_sekurt] = sqrt ((4.0 * (W * W - 1.0) * SE_g1 * SE_g1)
1258                             / ((W - 3.0) * (W + 5.0)));
1259     }
1260   else
1261     {
1262       d[frq_kurt] = d[frq_sekurt] = SYSMIS;
1263     }
1264 }
1265
1266 /* Displays a table of all the statistics requested for variable V. */
1267 static void
1268 dump_statistics (struct variable * v, int show_varname)
1269 {
1270   double stat_value[frq_n_stats];
1271   struct tab_table *t;
1272   int i, r;
1273
1274   if (v->type == ALPHA)
1275     return;
1276   if (v->p.frq.tab.n_valid == 0)
1277     {
1278       msg (SW, _("No valid data for variable %s; statistics not displayed."),
1279            v->name);
1280       return;
1281     }
1282   calc_stats (v, stat_value);
1283
1284   t = tab_create (2, n_stats + n_percentiles, 0);
1285   tab_dim (t, tab_natural_dimensions);
1286   tab_vline (t, TAL_1 | TAL_SPACING, 1, 0, n_stats - 1);
1287   for (i = r = 0; i < frq_n_stats; i++)
1288     if (stats & BIT_INDEX (i))
1289       {
1290         tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1291                       gettext (st_name[i].s10));
1292         tab_float (t, 1, r, TAB_NONE, stat_value[i], 11, 3);
1293         r++;
1294       }
1295
1296   for (i = 0; i < n_percentiles; i++, r++)
1297     {
1298       struct string ds;
1299
1300       ds_init (gen_pool, &ds, 20);
1301       ds_printf (&ds, "%s %d", _("Percentile"), (int) (percentiles[i] * 100));
1302
1303       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds.string);
1304       tab_float (t, 1, r, TAB_NONE, percentile_values[i], 11, 3);
1305
1306       ds_destroy (&ds);
1307     }
1308
1309   tab_columns (t, SOM_COL_DOWN, 1);
1310   if (show_varname)
1311     {
1312       if (v->label)
1313         tab_title (t, 1, "%s: %s", v->name, v->label);
1314       else
1315         tab_title (t, 0, v->name);
1316     }
1317   else
1318     tab_flags (t, SOMF_NO_TITLE);
1319
1320   tab_submit (t);
1321 }
1322 /*
1323    Local Variables:
1324    mode: c
1325    End:
1326 */