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