Fix memory leak in MRSETS
[pspp] / src / language / stats / frequencies.q
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2007, 2009, 2010 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include <math.h>
20 #include <stdlib.h>
21 #include <gsl/gsl_histogram.h>
22
23 #include "data/case.h"
24 #include "data/casegrouper.h"
25 #include "data/casereader.h"
26 #include "data/dictionary.h"
27 #include "data/format.h"
28 #include "data/procedure.h"
29 #include "data/settings.h"
30 #include "data/value-labels.h"
31 #include "data/variable.h"
32 #include "language/command.h"
33 #include "language/dictionary/split-file.h"
34 #include "language/lexer/lexer.h"
35 #include "language/stats/freq.h"
36 #include "libpspp/array.h"
37 #include "libpspp/bit-vector.h"
38 #include "libpspp/compiler.h"
39 #include "libpspp/hmap.h"
40 #include "libpspp/message.h"
41 #include "libpspp/misc.h"
42 #include "libpspp/pool.h"
43 #include "libpspp/str.h"
44 #include "math/histogram.h"
45 #include "math/moments.h"
46 #include "output/chart-item.h"
47 #include "output/charts/piechart.h"
48 #include "output/charts/plot-hist.h"
49 #include "output/tab.h"
50
51 #include "gl/minmax.h"
52 #include "gl/xalloc.h"
53
54 #include "gettext.h"
55 #define _(msgid) gettext (msgid)
56 #define N_(msgid) msgid
57
58 /* (headers) */
59
60 /* (specification)
61    FREQUENCIES (frq_):
62      *+variables=custom;
63      +format=table:limit(n:limit,"%s>0")/notable/!table,
64              sort:!avalue/dvalue/afreq/dfreq;
65      missing=miss:include/!exclude;
66      barchart(ba_)=:minimum(d:min),
67             :maximum(d:max),
68             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0");
69      piechart(pie_)=:minimum(d:min),
70             :maximum(d:max),
71             missing:missing/!nomissing,
72             scale:!freq/percent;
73      histogram(hi_)=:minimum(d:min),
74             :maximum(d:max),
75             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
76             norm:!nonormal/normal;
77      +grouped=custom;
78      +ntiles=integer;
79      +percentiles = double list;
80      +statistics[st_]=mean,semean,median,mode,stddev,variance,
81             kurtosis,skewness,range,minimum,maximum,sum,
82             default,seskewness,sekurtosis,all,none.
83 */
84 /* (declarations) */
85 /* (functions) */
86
87 /* Statistics. */
88 enum
89   {
90     FRQ_MEAN, FRQ_SEMEAN, FRQ_MEDIAN, FRQ_MODE, FRQ_STDDEV, FRQ_VARIANCE,
91     FRQ_KURT, FRQ_SEKURT, FRQ_SKEW, FRQ_SESKEW, FRQ_RANGE, FRQ_MIN, FRQ_MAX,
92     FRQ_SUM, FRQ_N_STATS
93   };
94
95 /* Description of a statistic. */
96 struct frq_info
97   {
98     int st_indx;                /* Index into a_statistics[]. */
99     const char *s10;            /* Identifying string. */
100   };
101
102 /* Table of statistics, indexed by dsc_*. */
103 static const struct frq_info st_name[FRQ_N_STATS + 1] =
104 {
105   {FRQ_ST_MEAN, N_("Mean")},
106   {FRQ_ST_SEMEAN, N_("S.E. Mean")},
107   {FRQ_ST_MEDIAN, N_("Median")},
108   {FRQ_ST_MODE, N_("Mode")},
109   {FRQ_ST_STDDEV, N_("Std Dev")},
110   {FRQ_ST_VARIANCE, N_("Variance")},
111   {FRQ_ST_KURTOSIS, N_("Kurtosis")},
112   {FRQ_ST_SEKURTOSIS, N_("S.E. Kurt")},
113   {FRQ_ST_SKEWNESS, N_("Skewness")},
114   {FRQ_ST_SESKEWNESS, N_("S.E. Skew")},
115   {FRQ_ST_RANGE, N_("Range")},
116   {FRQ_ST_MINIMUM, N_("Minimum")},
117   {FRQ_ST_MAXIMUM, N_("Maximum")},
118   {FRQ_ST_SUM, N_("Sum")},
119   {-1, 0},
120 };
121
122 /* Percentiles to calculate. */
123
124 struct percentile
125 {
126   double p;        /* the %ile to be calculated */
127   double value;    /* the %ile's value */
128   bool show;       /* True to show this percentile in the statistics box. */
129 };
130
131 /* Groups of statistics. */
132 #define BI          BIT_INDEX
133 #define FRQ_DEFAULT                                                     \
134         (BI (FRQ_MEAN) | BI (FRQ_STDDEV) | BI (FRQ_MIN) | BI (FRQ_MAX))
135 #define FRQ_ALL                                                 \
136         (BI (FRQ_SUM) | BI(FRQ_MIN) | BI(FRQ_MAX)               \
137          | BI(FRQ_MEAN) | BI(FRQ_SEMEAN) | BI(FRQ_STDDEV)       \
138          | BI(FRQ_VARIANCE) | BI(FRQ_KURT) | BI(FRQ_SEKURT)     \
139          | BI(FRQ_SKEW) | BI(FRQ_SESKEW) | BI(FRQ_RANGE)        \
140          | BI(FRQ_RANGE) | BI(FRQ_MODE) | BI(FRQ_MEDIAN))
141
142 struct frq_chart
143   {
144     double x_min;               /* X axis minimum value. */
145     double x_max;               /* X axis maximum value. */
146     int y_scale;                /* Y axis scale: FRQ_FREQ or FRQ_PERCENT. */
147
148     /* Histograms only. */
149     double y_max;               /* Y axis maximum value. */
150     bool draw_normal;           /* Whether to draw normal curve. */
151
152     /* Pie charts only. */
153     bool include_missing;       /* Whether to include missing values. */
154   };
155
156 /* Frequency tables. */
157
158 /* Entire frequency table. */
159 struct freq_tab
160   {
161     struct hmap data;           /* Hash table for accumulating counts. */
162     struct freq *valid;         /* Valid freqs. */
163     int n_valid;                /* Number of total freqs. */
164     const struct dictionary *dict; /* Source of entries in the table. */
165
166     struct freq *missing;       /* Missing freqs. */
167     int n_missing;              /* Number of missing freqs. */
168
169     /* Statistics. */
170     double total_cases;         /* Sum of weights of all cases. */
171     double valid_cases;         /* Sum of weights of valid cases. */
172   };
173
174 /* Per-variable frequency data. */
175 struct var_freqs
176   {
177     struct variable *var;
178
179     /* Freqency table. */
180     struct freq_tab tab;        /* Frequencies table to use. */
181
182     /* Percentiles. */
183     int n_groups;               /* Number of groups. */
184     double *groups;             /* Groups. */
185
186     /* Statistics. */
187     double stat[FRQ_N_STATS];
188
189     /* Variable attributes. */
190     int width;
191     struct fmt_spec print;
192   };
193
194 struct frq_proc
195   {
196     struct pool *pool;
197
198     struct var_freqs *vars;
199     size_t n_vars;
200
201     /* Percentiles to calculate and possibly display. */
202     struct percentile *percentiles;
203     int n_percentiles, n_show_percentiles;
204
205     /* Frequency table display. */
206     int max_categories;         /* Maximum categories to show. */
207     int sort;                   /* FRQ_AVALUE or FRQ_DVALUE
208                                    or FRQ_ACOUNT or FRQ_DCOUNT. */
209
210     /* Statistics; number of statistics. */
211     unsigned long stats;
212     int n_stats;
213
214     /* Histogram and pie chart settings. */
215     struct frq_chart *hist, *pie;
216   };
217
218 static void determine_charts (struct frq_proc *,
219                               const struct cmd_frequencies *);
220
221 static void calc_stats (const struct var_freqs *, double d[FRQ_N_STATS]);
222 static void calc_percentiles (const struct frq_proc *,
223                               const struct var_freqs *);
224
225 static void precalc (struct frq_proc *, struct casereader *, struct dataset *);
226 static void calc (struct frq_proc *, const struct ccase *,
227                   const struct dataset *);
228 static void postcalc (struct frq_proc *, const struct dataset *);
229
230 static void postprocess_freq_tab (const struct frq_proc *, struct var_freqs *);
231 static void dump_freq_table (const struct var_freqs *,
232                              const struct variable *weight_var);
233 static void dump_statistics (const struct frq_proc *, const struct var_freqs *,
234                              const struct variable *weight_var);
235 static void cleanup_freq_tab (struct var_freqs *);
236
237 static void add_percentile (struct frq_proc *, double x, bool show,
238                             size_t *allocated_percentiles);
239
240 static void do_piechart(const struct frq_chart *, const struct variable *,
241                         const struct freq_tab *);
242
243 struct histogram *freq_tab_to_hist(const struct frq_proc *,
244                                    const struct freq_tab *,
245                                    const struct variable *);
246 \f
247 /* Parser and outline. */
248
249 int
250 cmd_frequencies (struct lexer *lexer, struct dataset *ds)
251 {
252   struct cmd_frequencies cmd;
253   struct frq_proc frq;
254   struct casegrouper *grouper;
255   struct casereader *input, *group;
256   size_t allocated_percentiles;
257   bool ok;
258   int i;
259
260   frq.pool = pool_create ();
261
262   frq.vars = NULL;
263   frq.n_vars = 0;
264
265   frq.percentiles = NULL;
266   frq.n_percentiles = 0;
267   frq.n_show_percentiles = 0;
268
269   frq.hist = NULL;
270   frq.pie = NULL;
271
272   allocated_percentiles = 0;
273
274   if (!parse_frequencies (lexer, ds, &cmd, &frq))
275     {
276       pool_destroy (frq.pool);
277       return CMD_FAILURE;
278     }
279
280   /* Figure out when to show frequency tables. */
281   frq.max_categories = (cmd.table == FRQ_NOTABLE ? -1
282                         : cmd.table == FRQ_TABLE ? INT_MAX
283                         : cmd.limit);
284   frq.sort = cmd.sort;
285
286   /* Figure out statistics to calculate. */
287   frq.stats = 0;
288   if (cmd.a_statistics[FRQ_ST_DEFAULT] || !cmd.sbc_statistics)
289     frq.stats |= FRQ_DEFAULT;
290   if (cmd.a_statistics[FRQ_ST_ALL])
291     frq.stats |= FRQ_ALL;
292   if (cmd.sort != FRQ_AVALUE && cmd.sort != FRQ_DVALUE)
293     frq.stats &= ~BIT_INDEX (FRQ_MEDIAN);
294   for (i = 0; i < FRQ_N_STATS; i++)
295     if (cmd.a_statistics[st_name[i].st_indx])
296       frq.stats |= BIT_INDEX (i);
297   if (frq.stats & FRQ_KURT)
298     frq.stats |= BIT_INDEX (FRQ_SEKURT);
299   if (frq.stats & FRQ_SKEW)
300     frq.stats |= BIT_INDEX (FRQ_SESKEW);
301
302   /* Calculate n_stats. */
303   frq.n_stats = 0;
304   for (i = 0; i < FRQ_N_STATS; i++)
305     if ((frq.stats & BIT_INDEX (i)))
306       frq.n_stats++;
307
308   /* Charting. */
309   determine_charts (&frq, &cmd);
310   if (cmd.sbc_histogram || cmd.sbc_piechart || cmd.sbc_ntiles)
311     cmd.sort = FRQ_AVALUE;
312
313   /* Work out what percentiles need to be calculated */
314   if ( cmd.sbc_percentiles )
315     {
316       for ( i = 0 ; i < MAXLISTS ; ++i )
317         {
318           int pl;
319           subc_list_double *ptl_list = &cmd.dl_percentiles[i];
320           for ( pl = 0 ; pl < subc_list_double_count(ptl_list); ++pl)
321             add_percentile (&frq, subc_list_double_at(ptl_list, pl) / 100.0,
322                             true, &allocated_percentiles);
323         }
324     }
325   if ( cmd.sbc_ntiles )
326     {
327       for ( i = 0 ; i < cmd.sbc_ntiles ; ++i )
328         {
329           int j;
330           for (j = 0; j <= cmd.n_ntiles[i]; ++j )
331             add_percentile (&frq, j / (double) cmd.n_ntiles[i], true,
332                             &allocated_percentiles);
333         }
334     }
335   if (frq.stats & BIT_INDEX (FRQ_MEDIAN))
336     {
337       /* Treat the median as the 50% percentile.
338          We output it in the percentiles table as "50 (Median)." */
339       add_percentile (&frq, 0.5, true, &allocated_percentiles);
340       frq.stats &= ~BIT_INDEX (FRQ_MEDIAN);
341       frq.n_stats--;
342     }
343   if (cmd.sbc_histogram)
344     {
345       add_percentile (&frq, 0.25, false, &allocated_percentiles);
346       add_percentile (&frq, 0.75, false, &allocated_percentiles);
347     }
348
349   /* Do it! */
350   input = casereader_create_filter_weight (proc_open (ds), dataset_dict (ds),
351                                            NULL, NULL);
352   grouper = casegrouper_create_splits (input, dataset_dict (ds));
353   for (; casegrouper_get_next_group (grouper, &group);
354        casereader_destroy (group))
355     {
356       struct ccase *c;
357
358       precalc (&frq, group, ds);
359       for (; (c = casereader_read (group)) != NULL; case_unref (c))
360         calc (&frq, c, ds);
361       postcalc (&frq, ds);
362     }
363   ok = casegrouper_destroy (grouper);
364   ok = proc_commit (ds) && ok;
365
366   free_frequencies(&cmd);
367
368   pool_destroy (frq.pool);
369   free (frq.vars);
370   free (frq.percentiles);
371   free (frq.hist);
372   free (frq.pie);
373
374   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
375 }
376
377 /* Figure out which charts the user requested.  */
378 static void
379 determine_charts (struct frq_proc *frq, const struct cmd_frequencies *cmd)
380 {
381   if (cmd->sbc_barchart)
382     msg (SW, _("Bar charts are not implemented."));
383
384   if (cmd->sbc_histogram)
385     {
386       struct frq_chart *hist;
387
388       hist = frq->hist = xmalloc (sizeof *frq->hist);
389       hist->x_min = cmd->hi_min;
390       hist->x_max = cmd->hi_max;
391       hist->y_scale = cmd->hi_scale;
392       hist->y_max = cmd->hi_scale == FRQ_FREQ ? cmd->hi_freq : cmd->hi_pcnt;
393       hist->draw_normal = cmd->hi_norm != FRQ_NONORMAL;
394       hist->include_missing = false;
395
396       if (hist->x_min != SYSMIS && hist->x_max != SYSMIS
397           && hist->x_min >= hist->x_max)
398         {
399           msg (SE, _("MAX for histogram must be greater than or equal to MIN, "
400                      "but MIN was specified as %.15g and MAX as %.15g.  "
401                      "MIN and MAX will be ignored."),
402                hist->x_min, hist->x_max);
403           hist->x_min = hist->x_max = SYSMIS;
404         }
405     }
406
407   if (cmd->sbc_piechart)
408     {
409       struct frq_chart *pie;
410
411       pie = frq->pie = xmalloc (sizeof *frq->pie);
412       pie->x_min = cmd->pie_min;
413       pie->x_max = cmd->pie_max;
414       pie->y_scale = cmd->pie_scale;
415       pie->include_missing = cmd->pie_missing == FRQ_MISSING;
416
417       if (pie->x_min != SYSMIS && pie->x_max != SYSMIS
418           && pie->x_min >= pie->x_max)
419         {
420           msg (SE, _("MAX for pie chart must be greater than or equal to MIN, "
421                      "but MIN was specified as %.15g and MAX as %.15g.  "
422                      "MIN and MAX will be ignored."), pie->x_min, pie->x_max);
423           pie->x_min = pie->x_max = SYSMIS;
424         }
425     }
426 }
427
428 /* Add data from case C to the frequency table. */
429 static void
430 calc (struct frq_proc *frq, const struct ccase *c, const struct dataset *ds)
431 {
432   double weight = dict_get_case_weight (dataset_dict (ds), c, NULL);
433   size_t i;
434
435   for (i = 0; i < frq->n_vars; i++)
436     {
437       struct var_freqs *vf = &frq->vars[i];
438       const union value *value = case_data (c, vf->var);
439       size_t hash = value_hash (value, vf->width, 0);
440       struct freq *f;
441
442       f = freq_hmap_search (&vf->tab.data, value, vf->width, hash);
443       if (f == NULL)
444         f = freq_hmap_insert (&vf->tab.data, value, vf->width, hash);
445
446       f->count += weight;
447     }
448 }
449
450 /* Prepares each variable that is the target of FREQUENCIES by setting
451    up its hash table. */
452 static void
453 precalc (struct frq_proc *frq, struct casereader *input, struct dataset *ds)
454 {
455   struct ccase *c;
456   size_t i;
457
458   c = casereader_peek (input, 0);
459   if (c != NULL)
460     {
461       output_split_file_values (ds, c);
462       case_unref (c);
463     }
464
465   for (i = 0; i < frq->n_vars; i++)
466     hmap_init (&frq->vars[i].tab.data);
467 }
468
469 /* Finishes up with the variables after frequencies have been
470    calculated.  Displays statistics, percentiles, ... */
471 static void
472 postcalc (struct frq_proc *frq, const struct dataset *ds)
473 {
474   const struct dictionary *dict = dataset_dict (ds);
475   const struct variable *wv = dict_get_weight (dict);
476   size_t i;
477
478   for (i = 0; i < frq->n_vars; i++)
479     {
480       struct var_freqs *vf = &frq->vars[i];
481
482       postprocess_freq_tab (frq, vf);
483
484       /* Frequencies tables. */
485       if (vf->tab.n_valid + vf->tab.n_missing <= frq->max_categories)
486         dump_freq_table (vf, wv);
487
488       /* Statistics. */
489       if (frq->n_stats)
490         dump_statistics (frq, vf, wv);
491
492       if (frq->hist && var_is_numeric (vf->var) && vf->tab.n_valid > 0)
493         {
494           double d[FRQ_N_STATS];
495           struct histogram *histogram;
496
497           calc_stats (vf, d);
498
499           histogram = freq_tab_to_hist (frq, &vf->tab, vf->var);
500
501           chart_item_submit (histogram_chart_create (
502                                histogram->gsl_hist, var_to_string(vf->var),
503                                vf->tab.valid_cases,
504                                d[FRQ_MEAN],
505                                d[FRQ_STDDEV],
506                                frq->hist->draw_normal));
507
508           statistic_destroy (&histogram->parent);
509         }
510
511       if (frq->pie)
512         do_piechart(frq->pie, vf->var, &vf->tab);
513
514       cleanup_freq_tab (vf);
515
516     }
517 }
518
519 /* Returns true iff the value in struct freq F is non-missing
520    for variable V. */
521 static bool
522 not_missing (const void *f_, const void *v_)
523 {
524   const struct freq *f = f_;
525   const struct variable *v = v_;
526
527   return !var_is_value_missing (v, &f->value, MV_ANY);
528 }
529
530 struct freq_compare_aux
531   {
532     bool by_freq;
533     bool ascending_freq;
534
535     int width;
536     bool ascending_value;
537   };
538
539 static int
540 compare_freq (const void *a_, const void *b_, const void *aux_)
541 {
542   const struct freq_compare_aux *aux = aux_;
543   const struct freq *a = a_;
544   const struct freq *b = b_;
545
546   if (aux->by_freq && a->count != b->count)
547     {
548       int cmp = a->count > b->count ? 1 : -1;
549       return aux->ascending_freq ? cmp : -cmp;
550     }
551   else
552     {
553       int cmp = value_compare_3way (&a->value, &b->value, aux->width);
554       return aux->ascending_value ? cmp : -cmp;
555     }
556 }
557 /* Summarizes the frequency table data for variable V. */
558 static void
559 postprocess_freq_tab (const struct frq_proc *frq, struct var_freqs *vf)
560 {
561   struct freq_tab *ft = &vf->tab;
562   struct freq_compare_aux aux;
563   size_t count;
564   struct freq *freqs, *f;
565   size_t i;
566
567   /* Extract data from hash table. */
568   count = hmap_count (&ft->data);
569   freqs = freq_hmap_extract (&ft->data);
570
571   /* Put data into ft. */
572   ft->valid = freqs;
573   ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, vf->var);
574   ft->missing = freqs + ft->n_valid;
575   ft->n_missing = count - ft->n_valid;
576
577   /* Sort data. */
578   aux.by_freq = frq->sort == FRQ_AFREQ || frq->sort == FRQ_DFREQ;
579   aux.ascending_freq = frq->sort != FRQ_DFREQ;
580   aux.width = vf->width;
581   aux.ascending_value = frq->sort != FRQ_DVALUE;
582   sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare_freq, &aux);
583   sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare_freq, &aux);
584
585   /* Summary statistics. */
586   ft->valid_cases = 0.0;
587   for(i = 0 ;  i < ft->n_valid ; ++i )
588     {
589       f = &ft->valid[i];
590       ft->valid_cases += f->count;
591
592     }
593
594   ft->total_cases = ft->valid_cases ;
595   for(i = 0 ;  i < ft->n_missing ; ++i )
596     {
597       f = &ft->missing[i];
598       ft->total_cases += f->count;
599     }
600
601 }
602
603 /* Frees the frequency table for variable V. */
604 static void
605 cleanup_freq_tab (struct var_freqs *vf)
606 {
607   free (vf->tab.valid);
608   freq_hmap_destroy (&vf->tab.data, vf->width);
609 }
610
611 /* Parses the VARIABLES subcommand. */
612 static int
613 frq_custom_variables (struct lexer *lexer, struct dataset *ds,
614                       struct cmd_frequencies *cmd UNUSED, void *frq_ UNUSED)
615 {
616   struct frq_proc *frq = frq_;
617   struct variable **vars;
618   size_t n_vars;
619   size_t i;
620
621   lex_match (lexer, '=');
622   if (lex_token (lexer) != T_ALL
623       && (lex_token (lexer) != T_ID
624           || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL))
625     return 2;
626
627   /* Get list of current variables, to avoid duplicates. */
628   vars = xmalloc (frq->n_vars * sizeof *vars);
629   n_vars = frq->n_vars;
630   for (i = 0; i < frq->n_vars; i++)
631     vars[i] = frq->vars[i].var;
632
633   if (!parse_variables (lexer, dataset_dict (ds), &vars, &n_vars,
634                         PV_APPEND | PV_NO_SCRATCH))
635     return 0;
636
637   frq->vars = xrealloc (frq->vars, n_vars * sizeof *frq->vars);
638   for (i = frq->n_vars; i < n_vars; i++)
639     {
640       struct variable *var = vars[i];
641       struct var_freqs *vf = &frq->vars[i];
642
643       vf->var = var;
644       vf->tab.valid = vf->tab.missing = NULL;
645       vf->tab.dict = dataset_dict (ds);
646       vf->n_groups = 0;
647       vf->groups = NULL;
648       vf->width = var_get_width (var);
649       vf->print = *var_get_print_format (var);
650     }
651   frq->n_vars = n_vars;
652
653   free (vars);
654
655   return 1;
656 }
657
658 /* Parses the GROUPED subcommand, setting the n_grouped, grouped
659    fields of specified variables. */
660 static int
661 frq_custom_grouped (struct lexer *lexer, struct dataset *ds, struct cmd_frequencies *cmd UNUSED, void *frq_ UNUSED)
662 {
663   struct frq_proc *frq = frq_;
664
665   lex_match (lexer, '=');
666   if ((lex_token (lexer) == T_ID && dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) != NULL)
667       || lex_token (lexer) == T_ID)
668     for (;;)
669       {
670         size_t i;
671
672         /* Max, current size of list; list itself. */
673         int nl, ml;
674         double *dl;
675
676         /* Variable list. */
677         size_t n;
678         const struct variable **v;
679
680         if (!parse_variables_const (lexer, dataset_dict (ds), &v, &n,
681                               PV_NO_DUPLICATE | PV_NUMERIC))
682           return 0;
683         if (lex_match (lexer, '('))
684           {
685             nl = ml = 0;
686             dl = NULL;
687             while (lex_integer (lexer))
688               {
689                 if (nl >= ml)
690                   {
691                     ml += 16;
692                     dl = pool_nrealloc (frq->pool, dl, ml, sizeof *dl);
693                   }
694                 dl[nl++] = lex_tokval (lexer);
695                 lex_get (lexer);
696                 lex_match (lexer, ',');
697               }
698             /* Note that nl might still be 0 and dl might still be
699                NULL.  That's okay. */
700             if (!lex_match (lexer, ')'))
701               {
702                 free (v);
703                 msg (SE, _("`)' expected after GROUPED interval list."));
704                 return 0;
705               }
706           }
707         else
708           {
709             nl = 0;
710             dl = NULL;
711           }
712
713         for (i = 0; i < n; i++)
714           {
715             size_t j;
716
717             for (j = 0; j < frq->n_vars; j++)
718               {
719                 struct var_freqs *vf = &frq->vars[j];
720                 if (vf->var == v[i])
721                   {
722                     if (vf->groups != NULL)
723                       msg (SE, _("Variables %s specified multiple times on "
724                                  "GROUPED subcommand."), var_get_name (v[i]));
725                     else
726                       {
727                         vf->n_groups = nl;
728                         vf->groups = dl;
729                       }
730                     goto found;
731                   }
732               }
733             msg (SE, _("Variables %s specified on GROUPED but not on "
734                        "VARIABLES."), var_get_name (v[i]));
735
736           found:;
737           }
738
739         free (v);
740         if (!lex_match (lexer, '/'))
741           break;
742         if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) != NULL)
743             && lex_token (lexer) != T_ALL)
744           {
745             lex_put_back (lexer, '/');
746             break;
747           }
748       }
749
750   return 1;
751 }
752
753 /* Adds X to the list of percentiles, keeping the list in proper
754    order.  If SHOW is true, the percentile will be shown in the statistics
755    box, otherwise it will be hidden. */
756 static void
757 add_percentile (struct frq_proc *frq, double x, bool show,
758                 size_t *allocated_percentiles)
759 {
760   int i;
761
762   /* Do nothing if it's already in the list */
763   for (i = 0; i < frq->n_percentiles; i++)
764     {
765       struct percentile *pc = &frq->percentiles[i];
766
767       if ( fabs(x - pc->p) < DBL_EPSILON )
768         {
769           if (show && !pc->show)
770             {
771               frq->n_show_percentiles++;
772               pc->show = true;
773             }
774           return;
775         }
776
777       if (x < pc->p)
778         break;
779     }
780
781   if (frq->n_percentiles >= *allocated_percentiles)
782     frq->percentiles = x2nrealloc (frq->percentiles, allocated_percentiles,
783                                    sizeof *frq->percentiles);
784   insert_element (frq->percentiles, frq->n_percentiles,
785                   sizeof *frq->percentiles, i);
786   frq->percentiles[i].p = x;
787   frq->percentiles[i].show = show;
788   frq->n_percentiles++;
789   if (show)
790     frq->n_show_percentiles++;
791 }
792
793 /* Comparison functions. */
794
795 \f
796 /* Frequency table display. */
797
798 /* Displays a full frequency table for variable V. */
799 static void
800 dump_freq_table (const struct var_freqs *vf, const struct variable *wv)
801 {
802   const struct fmt_spec *wfmt = wv ? var_get_print_format (wv) : &F_8_0;
803   const struct freq_tab *ft = &vf->tab;
804   int n_categories;
805   struct freq *f;
806   struct tab_table *t;
807   int r, x;
808   double cum_total = 0.0;
809   double cum_freq = 0.0;
810
811   static const char *headings[] = {
812     N_("Value Label"),
813     N_("Value"),
814     N_("Frequency"),
815     N_("Percent"),
816     N_("Valid Percent"),
817     N_("Cum Percent")
818   };
819
820   n_categories = ft->n_valid + ft->n_missing;
821   t = tab_create (6, n_categories + 2);
822   tab_headers (t, 0, 0, 1, 0);
823
824   for (x = 0; x < 6; x++)
825     tab_text (t, x, 0, TAB_CENTER | TAT_TITLE, gettext (headings[x]));
826
827   r = 1;
828   for (f = ft->valid; f < ft->missing; f++)
829     {
830       const char *label;
831       double percent, valid_percent;
832
833       cum_freq += f->count;
834
835       percent = f->count / ft->total_cases * 100.0;
836       valid_percent = f->count / ft->valid_cases * 100.0;
837       cum_total += valid_percent;
838
839       label = var_lookup_value_label (vf->var, &f->value);
840       if (label != NULL)
841         tab_text (t, 0, r, TAB_LEFT, label);
842
843       tab_value (t, 1, r, TAB_NONE, &f->value, ft->dict, &vf->print);
844       tab_double (t, 2, r, TAB_NONE, f->count, wfmt);
845       tab_double (t, 3, r, TAB_NONE, percent, NULL);
846       tab_double (t, 4, r, TAB_NONE, valid_percent, NULL);
847       tab_double (t, 5, r, TAB_NONE, cum_total, NULL);
848       r++;
849     }
850   for (; f < &ft->valid[n_categories]; f++)
851     {
852       const char *label;
853
854       cum_freq += f->count;
855
856       label = var_lookup_value_label (vf->var, &f->value);
857       if (label != NULL)
858         tab_text (t, 0, r, TAB_LEFT, label);
859
860       tab_value (t, 1, r, TAB_NONE, &f->value, ft->dict, &vf->print);
861       tab_double (t, 2, r, TAB_NONE, f->count, wfmt);
862       tab_double (t, 3, r, TAB_NONE,
863                      f->count / ft->total_cases * 100.0, NULL);
864       tab_text (t, 4, r, TAB_NONE, _("Missing"));
865       r++;
866     }
867
868   tab_box (t, TAL_1, TAL_1, -1, TAL_1, 0, 0, 5, r);
869   tab_hline (t, TAL_2, 0, 5, 1);
870   tab_hline (t, TAL_2, 0, 5, r);
871   tab_joint_text (t, 0, r, 1, r, TAB_RIGHT | TAT_TITLE, _("Total"));
872   tab_vline (t, TAL_0, 1, r, r);
873   tab_double (t, 2, r, TAB_NONE, cum_freq, wfmt);
874   tab_fixed (t, 3, r, TAB_NONE, 100.0, 5, 1);
875   tab_fixed (t, 4, r, TAB_NONE, 100.0, 5, 1);
876
877   tab_title (t, "%s", var_to_string (vf->var));
878   tab_submit (t);
879 }
880 \f
881 /* Statistical display. */
882
883 static double
884 calc_percentile (double p, double valid_cases, double x1, double x2)
885 {
886   double s, dummy;
887
888   s = (settings_get_algorithm () != COMPATIBLE
889        ? modf ((valid_cases - 1) * p, &dummy)
890        : modf ((valid_cases + 1) * p - 1, &dummy));
891
892   return x1 + (x2 - x1) * s;
893 }
894
895 /* Calculates all of the percentiles for VF within FRQ. */
896 static void
897 calc_percentiles (const struct frq_proc *frq, const struct var_freqs *vf)
898 {
899   const struct freq_tab *ft = &vf->tab;
900   double W = ft->valid_cases;
901   const struct freq *f;
902   int percentile_idx;
903   double rank;
904
905   assert (ft->n_valid > 0);
906
907   rank = 0;
908   percentile_idx = 0;
909   for (f = ft->valid; f < ft->missing; f++)
910     {
911       rank += f->count;
912       for (; percentile_idx < frq->n_percentiles; percentile_idx++)
913         {
914           struct percentile *pc = &frq->percentiles[percentile_idx];
915           double tp;
916
917           tp = (settings_get_algorithm () == ENHANCED
918                 ? (W - 1) * pc->p
919                 : (W + 1) * pc->p - 1);
920
921           if (rank <= tp)
922             break;
923
924           if (f->count > 1
925               && (rank - (f->count - 1) > tp || f + 1 >= ft->missing))
926             pc->value = f->value.f;
927           else
928             pc->value = calc_percentile (pc->p, W, f->value.f, f[1].value.f);
929         }
930     }
931   for (; percentile_idx < frq->n_percentiles; percentile_idx++)
932     {
933       struct percentile *pc = &frq->percentiles[percentile_idx];
934       pc->value = ft->valid[ft->n_valid - 1].value.f;
935     }
936 }
937
938 /* Calculates all the pertinent statistics for VF, putting them in array
939    D[]. */
940 static void
941 calc_stats (const struct var_freqs *vf, double d[FRQ_N_STATS])
942 {
943   const struct freq_tab *ft = &vf->tab;
944   double W = ft->valid_cases;
945   const struct freq *f;
946   struct moments *m;
947   int most_often;
948   double X_mode;
949
950   assert (ft->n_valid > 0);
951
952   /* Calculate the mode. */
953   most_often = -1;
954   X_mode = SYSMIS;
955   for (f = ft->valid; f < ft->missing; f++)
956     {
957       if (most_often < f->count)
958         {
959           most_often = f->count;
960           X_mode = f->value.f;
961         }
962       else if (most_often == f->count)
963         {
964           /* A duplicate mode is undefined.
965              FIXME: keep track of *all* the modes. */
966           X_mode = SYSMIS;
967         }
968     }
969
970   /* Calculate moments. */
971   m = moments_create (MOMENT_KURTOSIS);
972   for (f = ft->valid; f < ft->missing; f++)
973     moments_pass_one (m, f->value.f, f->count);
974   for (f = ft->valid; f < ft->missing; f++)
975     moments_pass_two (m, f->value.f, f->count);
976   moments_calculate (m, NULL, &d[FRQ_MEAN], &d[FRQ_VARIANCE],
977                      &d[FRQ_SKEW], &d[FRQ_KURT]);
978   moments_destroy (m);
979
980   /* Formulas below are taken from _SPSS Statistical Algorithms_. */
981   d[FRQ_MIN] = ft->valid[0].value.f;
982   d[FRQ_MAX] = ft->valid[ft->n_valid - 1].value.f;
983   d[FRQ_MODE] = X_mode;
984   d[FRQ_RANGE] = d[FRQ_MAX] - d[FRQ_MIN];
985   d[FRQ_SUM] = d[FRQ_MEAN] * W;
986   d[FRQ_STDDEV] = sqrt (d[FRQ_VARIANCE]);
987   d[FRQ_SEMEAN] = d[FRQ_STDDEV] / sqrt (W);
988   d[FRQ_SESKEW] = calc_seskew (W);
989   d[FRQ_SEKURT] = calc_sekurt (W);
990 }
991
992 /* Displays a table of all the statistics requested for variable V. */
993 static void
994 dump_statistics (const struct frq_proc *frq, const struct var_freqs *vf,
995                  const struct variable *wv)
996 {
997   const struct fmt_spec *wfmt = wv ? var_get_print_format (wv) : &F_8_0;
998   const struct freq_tab *ft = &vf->tab;
999   double stat_value[FRQ_N_STATS];
1000   struct tab_table *t;
1001   int i, r;
1002
1003   if (var_is_alpha (vf->var))
1004     return;
1005
1006   if (ft->n_valid == 0)
1007     {
1008       msg (SW, _("No valid data for variable %s; statistics not displayed."),
1009            var_get_name (vf->var));
1010       return;
1011     }
1012   calc_stats (vf, stat_value);
1013   calc_percentiles (frq, vf);
1014
1015   t = tab_create (3, frq->n_stats + frq->n_show_percentiles + 2);
1016
1017   tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1018
1019
1020   tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1021   tab_vline (t, TAL_GAP , 1, 0, tab_nr(t) - 1 ) ;
1022
1023   r=2; /* N missing and N valid are always dumped */
1024
1025   for (i = 0; i < FRQ_N_STATS; i++)
1026     if (frq->stats & BIT_INDEX (i))
1027       {
1028         tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1029                       gettext (st_name[i].s10));
1030         tab_double (t, 2, r, TAB_NONE, stat_value[i], NULL);
1031         r++;
1032       }
1033
1034   tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("N"));
1035   tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Valid"));
1036   tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Missing"));
1037
1038   tab_double (t, 2, 0, TAB_NONE, ft->valid_cases, wfmt);
1039   tab_double (t, 2, 1, TAB_NONE, ft->total_cases - ft->valid_cases, wfmt);
1040
1041   for (i = 0; i < frq->n_percentiles; i++, r++)
1042     {
1043       struct percentile *pc = &frq->percentiles[i];
1044
1045       if (!pc->show)
1046         continue;
1047
1048       if ( i == 0 )
1049         {
1050           tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
1051         }
1052
1053       if (pc->p == 0.5)
1054         tab_text (t, 1, r, TAB_LEFT, _("50 (Median)"));
1055       else
1056         tab_fixed (t, 1, r, TAB_LEFT, pc->p * 100, 3, 0);
1057       tab_double (t, 2, r, TAB_NONE, pc->value,
1058                   var_get_print_format (vf->var));
1059     }
1060
1061   tab_title (t, "%s", var_to_string (vf->var));
1062
1063   tab_submit (t);
1064 }
1065
1066 static double
1067 calculate_iqr (const struct frq_proc *frq)
1068 {
1069   double q1 = SYSMIS;
1070   double q3 = SYSMIS;
1071   int i;
1072
1073   for (i = 0; i < frq->n_percentiles; i++)
1074     {
1075       struct percentile *pc = &frq->percentiles[i];
1076
1077       if (fabs (0.25 - pc->p) < DBL_EPSILON)
1078         q1 = pc->value;
1079       else if (fabs (0.75 - pc->p) < DBL_EPSILON)
1080         q3 = pc->value;
1081     }
1082
1083   return q1 == SYSMIS || q3 == SYSMIS ? SYSMIS : q3 - q1;
1084 }
1085
1086 static bool
1087 chart_includes_value (const struct frq_chart *chart,
1088                       const struct variable *var,
1089                       const union value *value)
1090 {
1091   if (!chart->include_missing && var_is_value_missing (var, value, MV_ANY))
1092     return false;
1093
1094   if (var_is_numeric (var)
1095       && ((chart->x_min != SYSMIS && value->f < chart->x_min)
1096           || (chart->x_max != SYSMIS && value->f > chart->x_max)))
1097     return false;
1098
1099   return true;
1100 }
1101
1102 /* Create a gsl_histogram from a freq_tab */
1103 struct histogram *
1104 freq_tab_to_hist (const struct frq_proc *frq, const struct freq_tab *ft,
1105                   const struct variable *var)
1106 {
1107   double x_min, x_max, valid_freq;
1108   int i;
1109
1110   struct histogram *histogram;
1111   double iqr;
1112   int bins;
1113
1114   /* Find out the extremes of the x value, within the range to be included in
1115      the histogram, and sum the total frequency of those values. */
1116   x_min = DBL_MAX;
1117   x_max = -DBL_MAX;
1118   valid_freq = 0;
1119   for (i = 0; i < ft->n_valid; i++)
1120     {
1121       const struct freq *f = &ft->valid[i];
1122       if (chart_includes_value (frq->hist, var, &f->value))
1123         {
1124           x_min = MIN (x_min, f->value.f);
1125           x_max = MAX (x_max, f->value.f);
1126           valid_freq += f->count;
1127         }
1128     }
1129
1130   /* Freedman-Diaconis' choice of bin width. */
1131   iqr = calculate_iqr (frq);
1132   if (iqr != SYSMIS)
1133     {
1134       double bin_width = 2 * iqr / pow (valid_freq, 1.0 / 3.0);
1135       bins = (x_max - x_min) / bin_width;
1136       if (bins < 5)
1137         bins = 5;
1138       else if (bins > 400)
1139         bins = 400;
1140     }
1141   else
1142     bins = 5;
1143
1144   histogram = histogram_create (bins, x_min, x_max);
1145   for (i = 0; i < ft->n_valid; i++)
1146     {
1147       const struct freq *f = &ft->valid[i];
1148       if (chart_includes_value (frq->hist, var, &f->value))
1149         histogram_add (histogram, f->value.f, f->count);
1150     }
1151
1152   return histogram;
1153 }
1154
1155 static int
1156 add_slice (const struct frq_chart *pie, const struct freq *freq,
1157            const struct variable *var, struct slice *slice)
1158 {
1159   if (chart_includes_value (pie, var, &freq->value))
1160     {
1161       ds_init_empty (&slice->label);
1162       var_append_value_name (var, &freq->value, &slice->label);
1163       slice->magnitude = freq->count;
1164       return 1;
1165     }
1166   else
1167     return 0;
1168 }
1169
1170 /* Allocate an array of slices and fill them from the data in frq_tab
1171    n_slices will contain the number of slices allocated.
1172    The caller is responsible for freeing slices
1173 */
1174 static struct slice *
1175 freq_tab_to_slice_array(const struct frq_chart *pie,
1176                         const struct freq_tab *frq_tab,
1177                         const struct variable *var,
1178                         int *n_slicesp)
1179 {
1180   struct slice *slices;
1181   int n_slices;
1182   int i;
1183
1184   slices = xnmalloc (frq_tab->n_valid + frq_tab->n_missing, sizeof *slices);
1185   n_slices = 0;
1186
1187   for (i = 0; i < frq_tab->n_valid; i++)
1188     n_slices += add_slice (pie, &frq_tab->valid[i], var, &slices[n_slices]);
1189   for (i = 0; i < frq_tab->n_missing; i++)
1190     n_slices += add_slice (pie, &frq_tab->missing[i], var, &slices[n_slices]);
1191
1192   *n_slicesp = n_slices;
1193   return slices;
1194 }
1195
1196
1197
1198
1199 static void
1200 do_piechart(const struct frq_chart *pie, const struct variable *var,
1201             const struct freq_tab *frq_tab)
1202 {
1203   struct slice *slices;
1204   int n_slices, i;
1205
1206   slices = freq_tab_to_slice_array (pie, frq_tab, var, &n_slices);
1207
1208   if (n_slices < 2)
1209     msg (SW, _("Omitting pie chart for %s, which has only %d unique values."),
1210          var_get_name (var), n_slices);
1211   else if (n_slices > 50)
1212     msg (SW, _("Omitting pie chart for %s, which has over 50 unique values."),
1213          var_get_name (var));
1214   else
1215     chart_item_submit (piechart_create (var_to_string(var), slices, n_slices));
1216
1217   for (i = 0; i < n_slices; i++)
1218     ds_destroy (&slices[i].label);
1219   free (slices);
1220 }
1221
1222
1223 /*
1224    Local Variables:
1225    mode: c
1226    End:
1227 */