Redo VFM interface. Get rid of compaction_necessary, compaction_nval,
[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 <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_with_splits (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 /* Returns nonzero iff the value in struct freq F is non-missing
522    for variable V. */
523 static int
524 not_missing (const void *f_, void *v_) 
525 {
526   const struct freq *f = f_;
527   struct variable *v = v_;
528
529   return !is_missing (&f->v, v);
530 }
531
532 /* Summarizes the frequency table data for variable V. */
533 static void
534 postprocess_freq_tab (struct variable *v)
535 {
536   hsh_compare_func *compare;
537   struct freq_tab *ft;
538   size_t count;
539   void **data;
540   struct freq *freqs, *f;
541   size_t i;
542
543   assert (v->p.frq.tab.mode == FRQM_GENERAL);
544   compare = get_freq_comparator (cmd.sort, v->type);
545   ft = &v->p.frq.tab;
546
547   /* Extract data from hash table. */
548   count = hsh_count (ft->data);
549   data = hsh_data (ft->data);
550
551   /* Copy dereferenced data into freqs. */
552   freqs = xmalloc (count* sizeof *freqs);
553   for (i = 0; i < count; i++) 
554     {
555       struct freq *f = data[i];
556       freqs[i] = *f; 
557     }
558
559   /* Put data into ft. */
560   ft->valid = freqs;
561   ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, v);
562   ft->missing = freqs + ft->n_valid;
563   ft->n_missing = count - ft->n_valid;
564
565   /* Sort data. */
566   sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare, v);
567   sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare, v);
568
569   /* Summary statistics. */
570   ft->total_cases = ft->valid_cases = 0.0;
571   for (f = ft->valid; f < ft->valid + ft->n_valid; f++) 
572     {
573       ft->total_cases += f->c;
574
575       if ((v->type != NUMERIC || f->v.f != SYSMIS)
576           && (cmd.miss != FRQ_EXCLUDE || !is_user_missing (&f->v, v)))
577         ft->valid_cases += f->c;
578     }
579 }
580
581 /* Frees the frequency table for variable V. */
582 static void
583 cleanup_freq_tab (struct variable *v)
584 {
585   assert (v->p.frq.tab.mode == FRQM_GENERAL);
586   free (v->p.frq.tab.valid);
587   hsh_destroy (v->p.frq.tab.data);
588 }
589
590 /* Parses the VARIABLES subcommand, adding to
591    {n_variables,v_variables}. */
592 static int
593 frq_custom_variables (struct cmd_frequencies *cmd UNUSED)
594 {
595   int mode;
596   int min = 0, max = 0;
597
598   int old_n_variables = n_variables;
599   int i;
600
601   lex_match ('=');
602   if (token != T_ALL && (token != T_ID
603                          || dict_lookup_var (default_dict, tokid) == NULL))
604     return 2;
605
606   if (!parse_variables (default_dict, &v_variables, &n_variables,
607                         PV_APPEND | PV_NO_SCRATCH))
608     return 0;
609
610   for (i = old_n_variables; i < n_variables; i++)
611     v_variables[i]->p.frq.tab.mode = FRQM_GENERAL;
612
613   if (!lex_match ('('))
614     mode = FRQM_GENERAL;
615   else
616     {
617       mode = FRQM_INTEGER;
618       if (!lex_force_int ())
619         return 0;
620       min = lex_integer ();
621       lex_get ();
622       if (!lex_force_match (','))
623         return 0;
624       if (!lex_force_int ())
625         return 0;
626       max = lex_integer ();
627       lex_get ();
628       if (!lex_force_match (')'))
629         return 0;
630       if (max < min)
631         {
632           msg (SE, _("Upper limit of integer mode value range must be "
633                      "greater than lower limit."));
634           return 0;
635         }
636     }
637
638   for (i = old_n_variables; i < n_variables; i++)
639     {
640       struct variable *v = v_variables[i];
641
642       if (v->p.frq.used != 0)
643         {
644           msg (SE, _("Variable %s specified multiple times on VARIABLES "
645                      "subcommand."), v->name);
646           return 0;
647         }
648       
649       v->p.frq.used = 1;                /* Used simply as a marker. */
650
651       v->p.frq.tab.valid = v->p.frq.tab.missing = NULL;
652
653       if (mode == FRQM_INTEGER)
654         {
655           if (v->type != NUMERIC)
656             {
657               msg (SE, _("Integer mode specified, but %s is not a numeric "
658                          "variable."), v->name);
659               return 0;
660             }
661           
662           v->p.frq.tab.min = min;
663           v->p.frq.tab.max = max;
664           v->p.frq.tab.vector = pool_alloc (int_pool,
665                                             sizeof (struct freq) * (max - min + 1));
666         }
667       else
668         v->p.frq.tab.vector = NULL;
669
670       v->p.frq.n_groups = 0;
671       v->p.frq.groups = NULL;
672     }
673   return 1;
674 }
675
676 /* Parses the GROUPED subcommand, setting the frq.{n_grouped,grouped}
677    fields of specified variables. */
678 static int
679 frq_custom_grouped (struct cmd_frequencies *cmd UNUSED)
680 {
681   lex_match ('=');
682   if ((token == T_ID && dict_lookup_var (default_dict, tokid) != NULL)
683       || token == T_ID)
684     for (;;)
685       {
686         int i;
687
688         /* Max, current size of list; list itself. */
689         int nl, ml;
690         double *dl;
691
692         /* Variable list. */
693         int n;
694         struct variable **v;
695
696         if (!parse_variables (default_dict, &v, &n,
697                               PV_NO_DUPLICATE | PV_NUMERIC))
698           return 0;
699         if (lex_match ('('))
700           {
701             nl = ml = 0;
702             dl = NULL;
703             while (token == T_NUM)
704               {
705                 if (nl >= ml)
706                   {
707                     ml += 16;
708                     dl = pool_realloc (int_pool, dl, ml * sizeof (double));
709                   }
710                 dl[nl++] = tokval;
711                 lex_get ();
712                 lex_match (',');
713               }
714             /* Note that nl might still be 0 and dl might still be
715                NULL.  That's okay. */
716             if (!lex_match (')'))
717               {
718                 free (v);
719                 msg (SE, _("`)' expected after GROUPED interval list."));
720                 return 0;
721               }
722           }
723         else 
724           {
725             nl = 0;
726             dl = NULL;
727           }
728
729         for (i = 0; i < n; i++)
730           {
731             if (v[i]->p.frq.used == 0)
732               msg (SE, _("Variables %s specified on GROUPED but not on "
733                    "VARIABLES."), v[i]->name);
734             if (v[i]->p.frq.groups != NULL)
735               msg (SE, _("Variables %s specified multiple times on GROUPED "
736                    "subcommand."), v[i]->name);
737             else
738               {
739                 v[i]->p.frq.n_groups = nl;
740                 v[i]->p.frq.groups = dl;
741               }
742           }
743         free (v);
744         if (!lex_match ('/'))
745           break;
746         if ((token != T_ID || dict_lookup_var (default_dict, tokid) != NULL)
747             && token != T_ALL)
748           {
749             lex_put_back ('/');
750             break;
751           }
752       }
753
754   return 1;
755 }
756
757 /* Adds X to the list of percentiles, keeping the list in proper
758    order. */
759 static void
760 add_percentile (double x)
761 {
762   int i;
763
764   for (i = 0; i < n_percentiles; i++)
765     if (x <= percentiles[i])
766       break;
767   if (i >= n_percentiles || tokval != percentiles[i])
768     {
769       percentiles
770         = pool_realloc (int_pool, percentiles,
771                         (n_percentiles + 1) * sizeof *percentiles);
772       percentile_values
773         = pool_realloc (int_pool, percentile_values,
774                         (n_percentiles + 1) * sizeof *percentile_values);
775       if (i < n_percentiles) 
776         {
777           memmove (&percentiles[i + 1], &percentiles[i],
778                    (n_percentiles - i) * sizeof *percentiles);
779           memmove (&percentile_values[i + 1], &percentile_values[i],
780                    (n_percentiles - i) * sizeof *percentile_values);
781         }
782       percentiles[i] = x;
783       n_percentiles++;
784     }
785 }
786
787 /* Parses the PERCENTILES subcommand, adding user-specified
788    percentiles to the list. */
789 static int
790 frq_custom_percentiles (struct cmd_frequencies *cmd UNUSED)
791 {
792   lex_match ('=');
793   if (token != T_NUM)
794     {
795       msg (SE, _("Percentile list expected after PERCENTILES."));
796       return 0;
797     }
798   
799   do
800     {
801       if (tokval <= 0 || tokval >= 100)
802         {
803           msg (SE, _("Percentiles must be greater than "
804                      "0 and less than 100."));
805           return 0;
806         }
807       
808       add_percentile (tokval / 100.0);
809       lex_get ();
810       lex_match (',');
811     }
812   while (token == T_NUM);
813   return 1;
814 }
815
816 /* Parses the NTILES subcommand, adding the percentiles that
817    correspond to the specified evenly-distributed ntiles. */
818 static int
819 frq_custom_ntiles (struct cmd_frequencies *cmd UNUSED)
820 {
821   int i;
822
823   lex_match ('=');
824   if (!lex_force_int ())
825     return 0;
826   for (i = 1; i < lex_integer (); i++)
827     add_percentile (1.0 / lex_integer () * i);
828   lex_get ();
829   return 1;
830 }
831 \f
832 /* Comparison functions. */
833
834 /* Hash of numeric values. */
835 static unsigned
836 hash_value_numeric (const void *value_, void *foo UNUSED)
837 {
838   const struct freq *value = value_;
839   return hsh_hash_double (value->v.f);
840 }
841
842 /* Hash of string values. */
843 static unsigned
844 hash_value_alpha (const void *value_, void *v_)
845 {
846   const struct freq *value = value_;
847   struct variable *v = v_;
848
849   return hsh_hash_bytes (value->v.s, v->width);
850 }
851
852 /* Ascending numeric compare of values. */
853 static int
854 compare_value_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
855 {
856   const struct freq *a = a_;
857   const struct freq *b = b_;
858
859   if (a->v.f > b->v.f)
860     return 1;
861   else if (a->v.f < b->v.f)
862     return -1;
863   else
864     return 0;
865 }
866
867 /* Ascending string compare of values. */
868 static int
869 compare_value_alpha_a (const void *a_, const void *b_, void *v_)
870 {
871   const struct freq *a = a_;
872   const struct freq *b = b_;
873   const struct variable *v = v_;
874
875   return memcmp (a->v.s, b->v.s, v->width);
876 }
877
878 /* Descending numeric compare of values. */
879 static int
880 compare_value_numeric_d (const void *a, const void *b, void *foo UNUSED)
881 {
882   return -compare_value_numeric_a (a, b, foo);
883 }
884
885 /* Descending string compare of values. */
886 static int
887 compare_value_alpha_d (const void *a, const void *b, void *v)
888 {
889   return -compare_value_alpha_a (a, b, v);
890 }
891
892 /* Ascending numeric compare of frequency;
893    secondary key on ascending numeric value. */
894 static int
895 compare_freq_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
896 {
897   const struct freq *a = a_;
898   const struct freq *b = b_;
899
900   if (a->c > b->c)
901     return 1;
902   else if (a->c < b->c)
903     return -1;
904
905   if (a->v.f > b->v.f)
906     return 1;
907   else if (a->v.f < b->v.f)
908     return -1;
909   else
910     return 0;
911 }
912
913 /* Ascending numeric compare of frequency;
914    secondary key on ascending string value. */
915 static int
916 compare_freq_alpha_a (const void *a_, const void *b_, void *v_)
917 {
918   const struct freq *a = a_;
919   const struct freq *b = b_;
920   const struct variable *v = v_;
921
922   if (a->c > b->c)
923     return 1;
924   else if (a->c < b->c)
925     return -1;
926   else
927     return memcmp (a->v.s, b->v.s, v->width);
928 }
929
930 /* Descending numeric compare of frequency;
931    secondary key on ascending numeric value. */
932 static int
933 compare_freq_numeric_d (const void *a_, const void *b_, void *foo UNUSED)
934 {
935   const struct freq *a = a_;
936   const struct freq *b = b_;
937
938   if (a->c > b->c)
939     return -1;
940   else if (a->c < b->c)
941     return 1;
942
943   if (a->v.f > b->v.f)
944     return 1;
945   else if (a->v.f < b->v.f)
946     return -1;
947   else
948     return 0;
949 }
950
951 /* Descending numeric compare of frequency;
952    secondary key on ascending string value. */
953 static int
954 compare_freq_alpha_d (const void *a_, const void *b_, void *v_)
955 {
956   const struct freq *a = a_;
957   const struct freq *b = b_;
958   const struct variable *v = v_;
959
960   if (a->c > b->c)
961     return -1;
962   else if (a->c < b->c)
963     return 1;
964   else
965     return memcmp (a->v.s, b->v.s, v->width);
966 }
967 \f
968 /* Frequency table display. */
969
970 /* Sets the widths of all the columns and heights of all the rows in
971    table T for driver D. */
972 static void
973 full_dim (struct tab_table *t, struct outp_driver *d)
974 {
975   int lab = cmd.labels == FRQ_LABELS;
976   int i;
977
978   if (lab)
979     t->w[0] = min (tab_natural_width (t, d, 0), d->prop_em_width * 15);
980   for (i = lab; i < lab + 5; i++)
981     t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
982   for (i = 0; i < t->nr; i++)
983     t->h[i] = d->font_height;
984 }
985
986 /* Displays a full frequency table for variable V. */
987 static void
988 dump_full (struct variable * v)
989 {
990   int n_categories;
991   struct freq *f;
992   struct tab_table *t;
993   int r;
994   double cum_total = 0.0;
995   double cum_freq = 0.0;
996
997   struct init
998     {
999       int c, r;
1000       const char *s;
1001     };
1002
1003   struct init *p;
1004
1005   static struct init vec[] =
1006   {
1007     {4, 0, N_("Valid")},
1008     {5, 0, N_("Cum")},
1009     {1, 1, N_("Value")},
1010     {2, 1, N_("Frequency")},
1011     {3, 1, N_("Percent")},
1012     {4, 1, N_("Percent")},
1013     {5, 1, N_("Percent")},
1014     {0, 0, NULL},
1015     {1, 0, NULL},
1016     {2, 0, NULL},
1017     {3, 0, NULL},
1018     {-1, -1, NULL},
1019   };
1020
1021   int lab = cmd.labels == FRQ_LABELS;
1022
1023   n_categories = v->p.frq.tab.n_valid + v->p.frq.tab.n_missing;
1024   t = tab_create (5 + lab, n_categories + 3, 0);
1025   tab_headers (t, 0, 0, 2, 0);
1026   tab_dim (t, full_dim);
1027
1028   if (lab)
1029     tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value Label"));
1030   for (p = vec; p->s; p++)
1031     tab_text (t, p->c - (p->r ? !lab : 0), p->r,
1032                   TAB_CENTER | TAT_TITLE, gettext (p->s));
1033
1034   r = 2;
1035   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1036     {
1037       double percent, valid_percent;
1038
1039       cum_freq += f->c;
1040
1041       percent = f->c / v->p.frq.tab.total_cases * 100.0;
1042       valid_percent = f->c / v->p.frq.tab.valid_cases * 100.0;
1043       cum_total += valid_percent;
1044
1045       if (lab)
1046         {
1047           const char *label = val_labs_find (v->val_labs, f->v);
1048           if (label != NULL)
1049             tab_text (t, 0, r, TAB_LEFT, label);
1050         }
1051
1052       tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1053       tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1054       tab_float (t, 2 + lab, r, TAB_NONE, percent, 5, 1);
1055       tab_float (t, 3 + lab, r, TAB_NONE, valid_percent, 5, 1);
1056       tab_float (t, 4 + lab, r, TAB_NONE, cum_total, 5, 1);
1057       r++;
1058     }
1059   for (; f < &v->p.frq.tab.valid[n_categories]; f++)
1060     {
1061       cum_freq += f->c;
1062
1063       if (lab)
1064         {
1065           const char *label = val_labs_find (v->val_labs, f->v);
1066           if (label != NULL)
1067             tab_text (t, 0, r, TAB_LEFT, label);
1068         }
1069
1070       tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1071       tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1072       tab_float (t, 2 + lab, r, TAB_NONE,
1073                      f->c / v->p.frq.tab.total_cases * 100.0, 5, 1);
1074       tab_text (t, 3 + lab, r, TAB_NONE, _("Missing"));
1075       r++;
1076     }
1077
1078   tab_box (t, TAL_1, TAL_1,
1079            cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1080            0, 0, 4 + lab, r);
1081   tab_hline (t, TAL_2, 0, 4 + lab, 2);
1082   tab_hline (t, TAL_2, 0, 4 + lab, r);
1083   tab_joint_text (t, 0, r, 0 + lab, r, TAB_RIGHT | TAT_TITLE, _("Total"));
1084   tab_vline (t, TAL_0, 1, r, r);
1085   tab_float (t, 1 + lab, r, TAB_NONE, cum_freq, 8, 0);
1086   tab_float (t, 2 + lab, r, TAB_NONE, 100.0, 5, 1);
1087   tab_float (t, 3 + lab, r, TAB_NONE, 100.0, 5, 1);
1088
1089   tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1090   tab_submit (t);
1091 }
1092
1093 /* Sets the widths of all the columns and heights of all the rows in
1094    table T for driver D. */
1095 static void
1096 condensed_dim (struct tab_table *t, struct outp_driver *d)
1097 {
1098   int cum_w = max (outp_string_width (d, _("Cum")),
1099                    max (outp_string_width (d, _("Cum")),
1100                         outp_string_width (d, "000")));
1101
1102   int i;
1103
1104   for (i = 0; i < 2; i++)
1105     t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
1106   for (i = 2; i < 4; i++)
1107     t->w[i] = cum_w;
1108   for (i = 0; i < t->nr; i++)
1109     t->h[i] = d->font_height;
1110 }
1111
1112 /* Display condensed frequency table for variable V. */
1113 static void
1114 dump_condensed (struct variable * v)
1115 {
1116   int n_categories;
1117   struct freq *f;
1118   struct tab_table *t;
1119   int r;
1120   double cum_total = 0.0;
1121
1122   n_categories = v->p.frq.tab.n_valid + v->p.frq.tab.n_missing;
1123   t = tab_create (4, n_categories + 2, 0);
1124
1125   tab_headers (t, 0, 0, 2, 0);
1126   tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value"));
1127   tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Freq"));
1128   tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1129   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Cum"));
1130   tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1131   tab_dim (t, condensed_dim);
1132
1133   r = 2;
1134   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1135     {
1136       double percent;
1137
1138       percent = f->c / v->p.frq.tab.total_cases * 100.0;
1139       cum_total += f->c / v->p.frq.tab.valid_cases * 100.0;
1140
1141       tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1142       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1143       tab_float (t, 2, r, TAB_NONE, percent, 3, 0);
1144       tab_float (t, 3, r, TAB_NONE, cum_total, 3, 0);
1145       r++;
1146     }
1147   for (; f < &v->p.frq.tab.valid[n_categories]; f++)
1148     {
1149       tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1150       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1151       tab_float (t, 2, r, TAB_NONE,
1152                  f->c / v->p.frq.tab.total_cases * 100.0, 3, 0);
1153       r++;
1154     }
1155
1156   tab_box (t, TAL_1, TAL_1,
1157            cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1158            0, 0, 3, r - 1);
1159   tab_hline (t, TAL_2, 0, 3, 2);
1160   tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1161   tab_columns (t, SOM_COL_DOWN, 1);
1162   tab_submit (t);
1163 }
1164 \f
1165 /* Statistical display. */
1166
1167 /* Calculates all the pertinent statistics for variable V, putting
1168    them in array D[].  FIXME: This could be made much more optimal. */
1169 static void
1170 calc_stats (struct variable * v, double d[frq_n_stats])
1171 {
1172   double W = v->p.frq.tab.valid_cases;
1173   double X_bar, X_mode, M2, M3, M4;
1174   struct freq *f;
1175   int most_often;
1176
1177   double cum_total;
1178   int i = 0;
1179   double previous_value;
1180
1181   /* Calculate the mean. */
1182   X_bar = 0.0;
1183   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1184     X_bar += f->v.f * f->c;
1185   X_bar /= W;
1186
1187   /* Calculate percentiles. */
1188   cum_total = 0;
1189   previous_value = SYSMIS;
1190   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1191     {
1192       cum_total += f->c ;
1193       for (; i < n_percentiles; i++) 
1194         {
1195           if (cum_total / v->p.frq.tab.valid_cases < percentiles[i])
1196             break;
1197
1198           percentile_values[i] = previous_value;
1199         }
1200       previous_value = f->v.f;
1201     }
1202
1203   /* Calculate the mode. */
1204   most_often = -1;
1205   X_mode = SYSMIS;
1206   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1207     {
1208       if (most_often < f->c) 
1209         {
1210           most_often = f->c;
1211           X_mode = f->v.f;
1212         }
1213       else if (most_often == f->c) 
1214         {
1215           /* A duplicate mode is undefined.
1216              FIXME: keep track of *all* the modes. */
1217           X_mode = SYSMIS;
1218         }
1219     }
1220
1221   /* Calculate moments about the mean. */
1222   M2 = M3 = M4 = 0.0;
1223   for (f = v->p.frq.tab.valid; f < v->p.frq.tab.missing; f++)
1224     {
1225       double dev = f->v.f - X_bar;
1226       double tmp;
1227       tmp = dev * dev;
1228       M2 += f->c * tmp;
1229       tmp *= dev;
1230       M3 += f->c * tmp;
1231       tmp *= dev;
1232       M4 += f->c * tmp;
1233     }
1234
1235   /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1236   d[frq_min] = v->p.frq.tab.valid[0].v.f;
1237   d[frq_max] = v->p.frq.tab.valid[v->p.frq.tab.n_valid - 1].v.f;
1238   d[frq_mode] = X_mode;
1239   d[frq_range] = d[frq_max] - d[frq_min];
1240   d[frq_median] = SYSMIS;
1241   d[frq_mean] = X_bar;
1242   d[frq_sum] = X_bar * W;
1243   d[frq_variance] = M2 / (W - 1);
1244   d[frq_stddev] = sqrt (d[frq_variance]);
1245   d[frq_semean] = d[frq_stddev] / sqrt (W);
1246   if (W >= 3.0 && d[frq_variance] > 0)
1247     {
1248       double S = d[frq_stddev];
1249       d[frq_skew] = (W * M3 / ((W - 1.0) * (W - 2.0) * S * S * S));
1250       d[frq_seskew] = sqrt (6.0 * W * (W - 1.0)
1251                             / ((W - 2.0) * (W + 1.0) * (W + 3.0)));
1252     }
1253   else
1254     {
1255       d[frq_skew] = d[frq_seskew] = SYSMIS;
1256     }
1257   if (W >= 4.0 && d[frq_variance] > 0)
1258     {
1259       double S2 = d[frq_variance];
1260       double SE_g1 = d[frq_seskew];
1261
1262       d[frq_kurt] = ((W * (W + 1.0) * M4 - 3.0 * M2 * M2 * (W - 1.0))
1263                      / ((W - 1.0) * (W - 2.0) * (W - 3.0) * S2 * S2));
1264       d[frq_sekurt] = sqrt ((4.0 * (W * W - 1.0) * SE_g1 * SE_g1)
1265                             / ((W - 3.0) * (W + 5.0)));
1266     }
1267   else
1268     {
1269       d[frq_kurt] = d[frq_sekurt] = SYSMIS;
1270     }
1271 }
1272
1273 /* Displays a table of all the statistics requested for variable V. */
1274 static void
1275 dump_statistics (struct variable * v, int show_varname)
1276 {
1277   double stat_value[frq_n_stats];
1278   struct tab_table *t;
1279   int i, r;
1280
1281   if (v->type == ALPHA)
1282     return;
1283   if (v->p.frq.tab.n_valid == 0)
1284     {
1285       msg (SW, _("No valid data for variable %s; statistics not displayed."),
1286            v->name);
1287       return;
1288     }
1289   calc_stats (v, stat_value);
1290
1291   t = tab_create (2, n_stats + n_percentiles, 0);
1292   tab_dim (t, tab_natural_dimensions);
1293   tab_vline (t, TAL_1 | TAL_SPACING, 1, 0, n_stats - 1);
1294   for (i = r = 0; i < frq_n_stats; i++)
1295     if (stats & BIT_INDEX (i))
1296       {
1297         tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1298                       gettext (st_name[i].s10));
1299         tab_float (t, 1, r, TAB_NONE, stat_value[i], 11, 3);
1300         r++;
1301       }
1302
1303   for (i = 0; i < n_percentiles; i++, r++) 
1304     {
1305       struct string ds;
1306
1307       ds_init (gen_pool, &ds, 20);
1308       ds_printf (&ds, "%s %d", _("Percentile"), (int) (percentiles[i] * 100));
1309
1310       tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, ds.string);
1311       tab_float (t, 1, r, TAB_NONE, percentile_values[i], 11, 3);
1312
1313       ds_destroy (&ds);
1314     }
1315
1316   tab_columns (t, SOM_COL_DOWN, 1);
1317   if (show_varname)
1318     {
1319       if (v->label)
1320         tab_title (t, 1, "%s: %s", v->name, v->label);
1321       else
1322         tab_title (t, 0, v->name);
1323     }
1324   else
1325     tab_flags (t, SOMF_NO_TITLE);
1326   
1327   tab_submit (t);
1328 }
1329 /* 
1330    Local Variables:
1331    mode: c
1332    End:
1333 */