b4d1ee69612fba7447001dcd065a718b0d28a8ab
[pspp] / src / language / stats / frequencies.c
1 /*
2   PSPP - a program for statistical analysis.
3   Copyright (C) 1997-9, 2000, 2007, 2009, 2010, 2011, 2014 Free Software Foundation, Inc.
4    
5   This program is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   This program is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU 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, see <http://www.gnu.org/licenses/>.
17 */
18
19 #include <config.h>
20 #include <stdlib.h>
21 #include <gsl/gsl_histogram.h>
22
23
24 #include "data/case.h"
25 #include "data/casegrouper.h"
26 #include "data/casereader.h"
27 #include "data/dataset.h"
28 #include "data/dictionary.h"
29 #include "data/format.h"
30 #include "data/missing-values.h"
31 #include "data/settings.h"
32 #include "data/value-labels.h"
33 #include "data/variable.h"
34
35 #include "language/dictionary/split-file.h"
36
37 #include "language/command.h"
38 #include "language/lexer/lexer.h"
39 #include "language/lexer/variable-parser.h"
40 #include "language/stats/freq.h"
41
42 #include "libpspp/array.h"
43 #include "libpspp/bit-vector.h"
44 #include "libpspp/compiler.h"
45 #include "libpspp/hmap.h"
46 #include "libpspp/message.h"
47 #include "libpspp/misc.h"
48 #include "libpspp/pool.h"
49
50 #include "math/histogram.h"
51 #include "math/moments.h"
52 #include "math/chart-geometry.h"
53
54
55 #include "output/chart-item.h"
56 #include "output/charts/piechart.h"
57 #include "output/charts/plot-hist.h"
58 #include "output/tab.h"
59
60 #include "gl/minmax.h"
61 #include "gl/xalloc.h"
62
63 #include "gettext.h"
64 #define _(msgid) gettext (msgid)
65 #define N_(msgid) msgid
66
67 /* Percentiles to calculate. */
68
69 struct percentile
70 {
71   double p;        /* the %ile to be calculated */
72   double value;    /* the %ile's value */
73   bool show;       /* True to show this percentile in the statistics box. */
74 };
75
76 static int
77 ptile_3way (const void *_p1, const void *_p2)
78 {
79   const struct percentile *p1 = _p1;
80   const struct percentile *p2 = _p2;
81
82   if (p1->p < p2->p)
83     return -1;
84
85   return (p1->p > p2->p);
86 }
87
88
89 enum
90   {
91     FRQ_NONORMAL,
92     FRQ_NORMAL
93   };
94
95 enum
96   {
97     FRQ_FREQ,
98     FRQ_PERCENT
99   };
100
101 enum sortprops 
102   {
103     FRQ_AFREQ,
104     FRQ_DFREQ,
105     FRQ_AVALUE,
106     FRQ_DVALUE
107   };
108
109 /* Array indices for STATISTICS subcommand. */
110 enum
111   {
112     FRQ_ST_MEAN,
113     FRQ_ST_SEMEAN,
114     FRQ_ST_MEDIAN,
115     FRQ_ST_MODE,
116     FRQ_ST_STDDEV,
117     FRQ_ST_VARIANCE,
118     FRQ_ST_KURTOSIS,
119     FRQ_ST_SEKURTOSIS,
120     FRQ_ST_SKEWNESS,
121     FRQ_ST_SESKEWNESS,
122     FRQ_ST_RANGE,
123     FRQ_ST_MINIMUM,
124     FRQ_ST_MAXIMUM,
125     FRQ_ST_SUM,
126     FRQ_ST_count
127   };
128
129 /* Description of statistics. */
130 static const char *st_name[FRQ_ST_count] =
131 {
132    N_("Mean"),
133    N_("S.E. Mean"),
134    N_("Median"),
135    N_("Mode"),
136    N_("Std Dev"),
137    N_("Variance"),
138    N_("Kurtosis"),
139    N_("S.E. Kurt"),
140    N_("Skewness"),
141    N_("S.E. Skew"),
142    N_("Range"),
143    N_("Minimum"),
144    N_("Maximum"),
145    N_("Sum")
146 };
147
148 struct freq_tab
149   {
150     struct hmap data;           /* Hash table for accumulating counts. */
151     struct freq *valid;         /* Valid freqs. */
152     int n_valid;                /* Number of total freqs. */
153     const struct dictionary *dict; /* Source of entries in the table. */
154
155     struct freq *missing;       /* Missing freqs. */
156     int n_missing;              /* Number of missing freqs. */
157
158     /* Statistics. */
159     double total_cases;         /* Sum of weights of all cases. */
160     double valid_cases;         /* Sum of weights of valid cases. */
161   };
162
163 struct frq_chart
164   {
165     double x_min;               /* X axis minimum value. */
166     double x_max;               /* X axis maximum value. */
167     int y_scale;                /* Y axis scale: FRQ_FREQ or FRQ_PERCENT. */
168
169     /* Histograms only. */
170     double y_max;               /* Y axis maximum value. */
171     bool draw_normal;           /* Whether to draw normal curve. */
172
173     /* Pie charts only. */
174     bool include_missing;       /* Whether to include missing values. */
175   };
176
177 /* Per-variable frequency data. */
178 struct var_freqs
179   {
180     const struct variable *var;
181
182     /* Freqency table. */
183     struct freq_tab tab;        /* Frequencies table to use. */
184
185     /* Percentiles. */
186     int n_groups;               /* Number of groups. */
187     double *groups;             /* Groups. */
188
189     /* Statistics. */
190     double stat[FRQ_ST_count];
191
192     /* Variable attributes. */
193     int width;
194   };
195
196 struct frq_proc
197   {
198     struct pool *pool;
199
200     struct var_freqs *vars;
201     size_t n_vars;
202
203     /* Percentiles to calculate and possibly display. */
204     struct percentile *percentiles;
205     int n_percentiles, n_show_percentiles;
206
207     /* Frequency table display. */
208     int max_categories;         /* Maximum categories to show. */
209     int sort;                   /* FRQ_AVALUE or FRQ_DVALUE
210                                    or FRQ_AFREQ or FRQ_DFREQ. */
211
212     /* Statistics; number of statistics. */
213     unsigned long stats;
214     int n_stats;
215
216     /* Histogram and pie chart settings. */
217     struct frq_chart *hist, *pie;
218   };
219
220
221 struct freq_compare_aux
222   {
223     bool by_freq;
224     bool ascending_freq;
225
226     int width;
227     bool ascending_value;
228   };
229
230 static void calc_stats (const struct var_freqs *vf, double d[FRQ_ST_count]);
231
232 static void do_piechart(const struct frq_chart *pie, 
233                         const struct variable *var,
234                         const struct freq_tab *frq_tab);
235
236 static void dump_statistics (const struct frq_proc *frq, 
237                              const struct var_freqs *vf,
238                              const struct variable *wv);
239
240 static int
241 compare_freq (const void *a_, const void *b_, const void *aux_)
242 {
243   const struct freq_compare_aux *aux = aux_;
244   const struct freq *a = a_;
245   const struct freq *b = b_;
246
247   if (aux->by_freq && a->count != b->count)
248     {
249       int cmp = a->count > b->count ? 1 : -1;
250       return aux->ascending_freq ? cmp : -cmp;
251     }
252   else
253     {
254       int cmp = value_compare_3way (&a->value, &b->value, aux->width);
255       return aux->ascending_value ? cmp : -cmp;
256     }
257 }
258
259 /* Create a gsl_histogram from a freq_tab */
260 static struct histogram *
261 freq_tab_to_hist (const struct frq_proc *frq, const struct freq_tab *ft,
262                   const struct variable *var);
263
264
265 /* Displays a full frequency table for variable V. */
266 static void
267 dump_freq_table (const struct var_freqs *vf, const struct variable *wv)
268 {
269   const struct fmt_spec *wfmt = wv ? var_get_print_format (wv) : &F_8_0;
270   const struct freq_tab *ft = &vf->tab;
271   int n_categories;
272   struct freq *f;
273   struct tab_table *t;
274   int r, x;
275   double cum_total = 0.0;
276   double cum_freq = 0.0;
277
278   static const char *headings[] = {
279     N_("Value Label"),
280     N_("Value"),
281     N_("Frequency"),
282     N_("Percent"),
283     N_("Valid Percent"),
284     N_("Cum Percent")
285   };
286
287   n_categories = ft->n_valid + ft->n_missing;
288   t = tab_create (6, n_categories + 2);
289   tab_set_format (t, RC_WEIGHT, wfmt);
290   tab_headers (t, 0, 0, 1, 0);
291
292   for (x = 0; x < 6; x++)
293     tab_text (t, x, 0, TAB_CENTER | TAT_TITLE, gettext (headings[x]));
294
295   r = 1;
296   for (f = ft->valid; f < ft->missing; f++)
297     {
298       const char *label;
299       double percent, valid_percent;
300
301       cum_freq += f->count;
302
303       percent = f->count / ft->total_cases * 100.0;
304       valid_percent = f->count / ft->valid_cases * 100.0;
305       cum_total += valid_percent;
306
307       label = var_lookup_value_label (vf->var, &f->value);
308       if (label != NULL)
309         tab_text (t, 0, r, TAB_LEFT, label);
310
311       tab_value (t, 1, r, TAB_NONE, &f->value, vf->var, NULL);
312       tab_double (t, 2, r, TAB_NONE, f->count, NULL, RC_WEIGHT);
313       tab_double (t, 3, r, TAB_NONE, percent, NULL, RC_OTHER);
314       tab_double (t, 4, r, TAB_NONE, valid_percent, NULL, RC_OTHER);
315       tab_double (t, 5, r, TAB_NONE, cum_total, NULL, RC_OTHER);
316       r++;
317     }
318   for (; f < &ft->valid[n_categories]; f++)
319     {
320       const char *label;
321
322       cum_freq += f->count;
323
324       label = var_lookup_value_label (vf->var, &f->value);
325       if (label != NULL)
326         tab_text (t, 0, r, TAB_LEFT, label);
327
328       tab_value (t, 1, r, TAB_NONE, &f->value, vf->var, NULL);
329       tab_double (t, 2, r, TAB_NONE, f->count, NULL, RC_WEIGHT);
330       tab_double (t, 3, r, TAB_NONE,
331                   f->count / ft->total_cases * 100.0, NULL, RC_OTHER);
332       tab_text (t, 4, r, TAB_NONE, _("Missing"));
333       r++;
334     }
335
336   tab_box (t, TAL_1, TAL_1, -1, TAL_1, 0, 0, 5, r);
337   tab_hline (t, TAL_2, 0, 5, 1);
338   tab_hline (t, TAL_2, 0, 5, r);
339   tab_joint_text (t, 0, r, 1, r, TAB_RIGHT | TAT_TITLE, _("Total"));
340   tab_vline (t, TAL_0, 1, r, r);
341   tab_double (t, 2, r, TAB_NONE, cum_freq, NULL, RC_WEIGHT);
342   tab_double (t, 3, r, TAB_NONE, 100.0, &F_5_1, RC_OTHER);
343   tab_double (t, 4, r, TAB_NONE, 100.0, &F_5_1, RC_OTHER);
344
345   tab_title (t, "%s", var_to_string (vf->var));
346   tab_submit (t);
347 }
348 \f
349 /* Statistical display. */
350
351 static double
352 calc_percentile (double p, double valid_cases, double x1, double x2)
353 {
354   double s, dummy;
355
356   s = (settings_get_algorithm () != COMPATIBLE
357        ? modf ((valid_cases - 1) * p, &dummy)
358        : modf ((valid_cases + 1) * p - 1, &dummy));
359
360   return x1 + (x2 - x1) * s;
361 }
362
363 /* Calculates all of the percentiles for VF within FRQ. */
364 static void
365 calc_percentiles (const struct frq_proc *frq, const struct var_freqs *vf)
366 {
367   const struct freq_tab *ft = &vf->tab;
368   double W = ft->valid_cases;
369   const struct freq *f;
370   int percentile_idx;
371   double rank;
372
373   assert (ft->n_valid > 0);
374
375   rank = 0;
376   percentile_idx = 0;
377   for (f = ft->valid; f < ft->missing; f++)
378     {
379       rank += f->count;
380       for (; percentile_idx < frq->n_percentiles; percentile_idx++)
381         {
382           struct percentile *pc = &frq->percentiles[percentile_idx];
383           double tp;
384
385           tp = (settings_get_algorithm () == ENHANCED
386                 ? (W - 1) * pc->p
387                 : (W + 1) * pc->p - 1);
388
389           if (rank <= tp)
390             break;
391
392           if (tp + 1 < rank || f + 1 >= ft->missing)
393             pc->value = f->value.f;
394           else
395             pc->value = calc_percentile (pc->p, W, f->value.f, f[1].value.f);
396         }
397     }
398   for (; percentile_idx < frq->n_percentiles; percentile_idx++)
399     {
400       struct percentile *pc = &frq->percentiles[percentile_idx];
401       pc->value = ft->valid[ft->n_valid - 1].value.f;
402     }
403 }
404
405 /* Returns true iff the value in struct freq F is non-missing
406    for variable V. */
407 static bool
408 not_missing (const void *f_, const void *v_)
409 {
410   const struct freq *f = f_;
411   const struct variable *v = v_;
412
413   return !var_is_value_missing (v, &f->value, MV_ANY);
414 }
415
416
417 /* Summarizes the frequency table data for variable V. */
418 static void
419 postprocess_freq_tab (const struct frq_proc *frq, struct var_freqs *vf)
420 {
421   struct freq_tab *ft = &vf->tab;
422   struct freq_compare_aux aux;
423   size_t count;
424   struct freq *freqs, *f;
425   size_t i;
426
427   /* Extract data from hash table. */
428   count = hmap_count (&ft->data);
429   freqs = freq_hmap_extract (&ft->data);
430
431   /* Put data into ft. */
432   ft->valid = freqs;
433   ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, vf->var);
434   ft->missing = freqs + ft->n_valid;
435   ft->n_missing = count - ft->n_valid;
436
437   /* Sort data. */
438   aux.by_freq = frq->sort == FRQ_AFREQ || frq->sort == FRQ_DFREQ;
439   aux.ascending_freq = frq->sort != FRQ_DFREQ;
440   aux.width = vf->width;
441   aux.ascending_value = frq->sort != FRQ_DVALUE;
442   sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare_freq, &aux);
443   sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare_freq, &aux);
444
445   /* Summary statistics. */
446   ft->valid_cases = 0.0;
447   for(i = 0 ;  i < ft->n_valid ; ++i )
448     {
449       f = &ft->valid[i];
450       ft->valid_cases += f->count;
451
452     }
453
454   ft->total_cases = ft->valid_cases ;
455   for(i = 0 ;  i < ft->n_missing ; ++i )
456     {
457       f = &ft->missing[i];
458       ft->total_cases += f->count;
459     }
460
461 }
462
463 /* Frees the frequency table for variable V. */
464 static void
465 cleanup_freq_tab (struct var_freqs *vf)
466 {
467   free (vf->tab.valid);
468   freq_hmap_destroy (&vf->tab.data, vf->width);
469 }
470
471 /* Add data from case C to the frequency table. */
472 static void
473 calc (struct frq_proc *frq, const struct ccase *c, const struct dataset *ds)
474 {
475   double weight = dict_get_case_weight (dataset_dict (ds), c, NULL);
476   size_t i;
477
478   for (i = 0; i < frq->n_vars; i++)
479     {
480       struct var_freqs *vf = &frq->vars[i];
481       const union value *value = case_data (c, vf->var);
482       size_t hash = value_hash (value, vf->width, 0);
483       struct freq *f;
484
485       f = freq_hmap_search (&vf->tab.data, value, vf->width, hash);
486       if (f == NULL)
487         f = freq_hmap_insert (&vf->tab.data, value, vf->width, hash);
488
489       f->count += weight;
490     }
491 }
492
493 /* Prepares each variable that is the target of FREQUENCIES by setting
494    up its hash table. */
495 static void
496 precalc (struct frq_proc *frq, struct casereader *input, struct dataset *ds)
497 {
498   struct ccase *c;
499   size_t i;
500
501   c = casereader_peek (input, 0);
502   if (c != NULL)
503     {
504       output_split_file_values (ds, c);
505       case_unref (c);
506     }
507
508   for (i = 0; i < frq->n_vars; i++)
509     hmap_init (&frq->vars[i].tab.data);
510 }
511
512 /* Finishes up with the variables after frequencies have been
513    calculated.  Displays statistics, percentiles, ... */
514 static void
515 postcalc (struct frq_proc *frq, const struct dataset *ds)
516 {
517   const struct dictionary *dict = dataset_dict (ds);
518   const struct variable *wv = dict_get_weight (dict);
519   size_t i;
520
521   for (i = 0; i < frq->n_vars; i++)
522     {
523       struct var_freqs *vf = &frq->vars[i];
524
525       postprocess_freq_tab (frq, vf);
526
527       /* Frequencies tables. */
528       if (vf->tab.n_valid + vf->tab.n_missing <= frq->max_categories)
529         dump_freq_table (vf, wv);
530
531       calc_percentiles (frq, vf);
532
533       /* Statistics. */
534       if (frq->n_stats)
535         dump_statistics (frq, vf, wv);
536
537       if (frq->hist && var_is_numeric (vf->var) && vf->tab.n_valid > 0)
538         {
539           double d[FRQ_ST_count];
540           struct histogram *histogram;
541
542           calc_stats (vf, d);
543
544           histogram = freq_tab_to_hist (frq, &vf->tab, vf->var);
545
546           if ( histogram)
547             {
548               chart_item_submit (histogram_chart_create (
549                                histogram->gsl_hist, var_to_string(vf->var),
550                                vf->tab.valid_cases,
551                                d[FRQ_ST_MEAN],
552                                d[FRQ_ST_STDDEV],
553                                frq->hist->draw_normal));
554
555               statistic_destroy (&histogram->parent);
556             }
557         }
558
559       if (frq->pie)
560         do_piechart(frq->pie, vf->var, &vf->tab);
561
562       cleanup_freq_tab (vf);
563     }
564 }
565
566 int
567 cmd_frequencies (struct lexer *lexer, struct dataset *ds)
568 {
569   int i;
570   struct frq_proc frq;
571   const struct variable **vars;
572
573   bool sbc_barchart = false;
574   bool sbc_piechart = false;
575   bool sbc_histogram = false;
576
577   double pie_min = -DBL_MAX;
578   double pie_max = DBL_MAX;
579   bool pie_missing = false;
580
581   double hi_min = -DBL_MAX;
582   double hi_max = DBL_MAX;
583   int hi_scale = FRQ_FREQ;
584   int hi_freq = INT_MIN;
585   int hi_pcnt = INT_MIN;
586   int hi_norm = FRQ_NONORMAL;
587
588   frq.pool = pool_create ();
589   frq.sort = FRQ_AVALUE;
590
591   frq.vars = NULL;
592   frq.n_vars = 0;
593   
594   frq.stats = BIT_INDEX (FRQ_ST_MEAN) 
595     | BIT_INDEX (FRQ_ST_STDDEV) 
596     | BIT_INDEX (FRQ_ST_MINIMUM)
597     | BIT_INDEX (FRQ_ST_MAXIMUM);
598
599   frq.n_stats = 4;
600
601   frq.max_categories = INT_MAX;
602
603   frq.percentiles = NULL;
604   frq.n_percentiles = 0;
605   frq.n_show_percentiles = 0;
606
607   frq.hist = NULL;
608   frq.pie = NULL;
609
610
611   /* Accept an optional, completely pointless "/VARIABLES=" */
612   lex_match (lexer, T_SLASH);
613   if (lex_match_id  (lexer, "VARIABLES"))
614     {
615       if (! lex_force_match (lexer, T_EQUALS) )
616         goto error;
617     }
618
619   if (!parse_variables_const (lexer, dataset_dict (ds),
620                               &vars,
621                               &frq.n_vars,
622                               PV_NO_DUPLICATE))
623     goto error;
624
625   frq.vars = xzalloc (frq.n_vars * sizeof (*frq.vars));
626   for (i = 0; i < frq.n_vars; ++i)
627     {
628       frq.vars[i].var = vars[i];
629     }
630
631   while (lex_token (lexer) != T_ENDCMD)
632     {
633       lex_match (lexer, T_SLASH);
634
635       if (lex_match_id (lexer, "STATISTICS"))
636         {
637           lex_match (lexer, T_EQUALS);
638
639           frq.stats = 0;
640           frq.n_stats = 0;
641
642           while (lex_token (lexer) != T_ENDCMD
643                  && lex_token (lexer) != T_SLASH)
644             {
645               if (lex_match_id (lexer, "DEFAULT"))
646                 {
647                   frq.stats = BIT_INDEX (FRQ_ST_MEAN) 
648                     | BIT_INDEX (FRQ_ST_STDDEV) 
649                     | BIT_INDEX (FRQ_ST_MINIMUM)
650                     | BIT_INDEX (FRQ_ST_MAXIMUM);
651
652                   frq.n_stats = 4;
653                 }
654               else if (lex_match_id (lexer, "MEAN"))
655                 {
656                   frq.stats |= BIT_INDEX (FRQ_ST_MEAN);
657                   frq.n_stats++;
658                 }
659               else if (lex_match_id (lexer, "SEMEAN"))
660                 {
661                   frq.stats |= BIT_INDEX (FRQ_ST_SEMEAN);
662                   frq.n_stats++;
663                 }
664               else if (lex_match_id (lexer, "MEDIAN"))
665                 {
666                   frq.stats |= BIT_INDEX (FRQ_ST_MEDIAN);
667                   frq.n_stats++;
668                 }
669               else if (lex_match_id (lexer, "MODE"))
670                 {
671                   frq.stats |= BIT_INDEX (FRQ_ST_MODE);
672                   frq.n_stats++;
673                 }
674               else if (lex_match_id (lexer, "STDDEV"))
675                 {
676                   frq.stats |= BIT_INDEX (FRQ_ST_STDDEV);
677                   frq.n_stats++;
678                 }
679               else if (lex_match_id (lexer, "VARIANCE"))
680                 {
681                   frq.stats |= BIT_INDEX (FRQ_ST_MEAN);
682                   frq.n_stats++;
683                 }
684               else if (lex_match_id (lexer, "KURTOSIS"))
685                 {
686                   frq.stats |= BIT_INDEX (FRQ_ST_KURTOSIS);
687                   frq.n_stats++;
688                 }
689               else if (lex_match_id (lexer, "SKEWNESS"))
690                 {
691                   frq.stats |= BIT_INDEX (FRQ_ST_SKEWNESS);
692                   frq.n_stats++;
693                 }
694               else if (lex_match_id (lexer, "RANGE"))
695                 {
696                   frq.stats |= BIT_INDEX (FRQ_ST_RANGE);
697                   frq.n_stats++;
698                 }
699               else if (lex_match_id (lexer, "MINIMUM"))
700                 {
701                   frq.stats |= BIT_INDEX (FRQ_ST_MINIMUM);
702                   frq.n_stats++;
703                 }
704               else if (lex_match_id (lexer, "MAXIMUM"))
705                 {
706                   frq.stats |= BIT_INDEX (FRQ_ST_MAXIMUM);
707                   frq.n_stats++;
708                 }
709               else if (lex_match_id (lexer, "SUM"))
710                 {
711                   frq.stats |= BIT_INDEX (FRQ_ST_SUM);
712                   frq.n_stats++;
713                 }
714               else if (lex_match_id (lexer, "SESKEWNESS"))
715                 {
716                   frq.stats |= BIT_INDEX (FRQ_ST_SESKEWNESS);
717                   frq.n_stats++;
718                 }
719               else if (lex_match_id (lexer, "SEKURTOSIS"))
720                 {
721                   frq.stats |= BIT_INDEX (FRQ_ST_SEKURTOSIS);
722                   frq.n_stats++;
723                 }
724               else if (lex_match_id (lexer, "NONE"))
725                 {
726                   frq.stats = 0;
727                   frq.n_stats = 0;
728                 }
729               else if (lex_match (lexer, T_ALL))
730                 {
731                   frq.stats = ~0;
732                   frq.n_stats = FRQ_ST_count;
733                 }
734               else
735                 {
736                   lex_error (lexer, NULL);
737                   goto error;
738                 }
739             }
740         }
741       else if (lex_match_id (lexer, "PERCENTILES"))
742         {
743           lex_match (lexer, T_EQUALS);
744           while (lex_token (lexer) != T_ENDCMD
745                  && lex_token (lexer) != T_SLASH)
746             {
747               if (lex_force_num (lexer))
748                 {
749                   frq.percentiles =
750                     xrealloc (frq.percentiles, 
751                               (frq.n_percentiles + 1)
752                               * sizeof (*frq.percentiles));
753                   frq.percentiles[frq.n_percentiles].p = lex_number (lexer)  / 100.0;
754                   frq.percentiles[frq.n_percentiles].show = true;
755                   lex_get (lexer);
756                   frq.n_percentiles++;
757                   frq.n_show_percentiles++;
758                 }
759               else
760                 {
761                   lex_error (lexer, NULL);
762                   goto error;
763                 }
764             }
765         }
766       else if (lex_match_id (lexer, "FORMAT"))
767         {
768           lex_match (lexer, T_EQUALS);
769           while (lex_token (lexer) != T_ENDCMD
770                  && lex_token (lexer) != T_SLASH)
771             {
772               if (lex_match_id (lexer, "TABLE"))
773                 {
774                   
775                 }
776               else if (lex_match_id (lexer, "NOTABLE"))
777                 {
778                   frq.max_categories = 0;
779                 }
780               else if (lex_match_id (lexer, "AVALUE"))
781                 {
782                   frq.sort = FRQ_AVALUE;
783                 }
784               else if (lex_match_id (lexer, "DVALUE"))
785                 {
786                   frq.sort = FRQ_DVALUE;
787                 }
788               else if (lex_match_id (lexer, "AFREQ"))
789                 {
790                   frq.sort = FRQ_AFREQ;
791                 }
792               else if (lex_match_id (lexer, "DFREQ"))
793                 {
794                   frq.sort = FRQ_DFREQ;
795                 }
796               else
797                 {
798                   lex_error (lexer, NULL);
799                   goto error;
800                 }
801             }
802         }
803       else if (lex_match_id (lexer, "NTILES"))
804         {
805           lex_match (lexer, T_EQUALS);
806
807           if (lex_force_int (lexer))
808             {
809               int i;
810               int n = lex_integer (lexer);
811               lex_get (lexer);
812               for (i = 0; i < n + 1; ++i)
813                 {
814                   frq.percentiles =
815                     xrealloc (frq.percentiles, 
816                               (frq.n_percentiles + 1)
817                               * sizeof (*frq.percentiles));
818                   frq.percentiles[frq.n_percentiles].p =
819                     i / (double) n ;
820                   frq.percentiles[frq.n_percentiles].show = true;
821
822                   frq.n_percentiles++;
823                   frq.n_show_percentiles++;
824                 }
825             }
826           else
827             {
828               lex_error (lexer, NULL);
829               goto error;
830             }
831         }
832       else if (lex_match_id (lexer, "ALGORITHM"))
833         {
834           lex_match (lexer, T_EQUALS);
835
836           if (lex_match_id (lexer, "COMPATIBLE"))
837             {
838               settings_set_cmd_algorithm (COMPATIBLE);
839             }
840           else if (lex_match_id (lexer, "ENHANCED"))
841             {
842               settings_set_cmd_algorithm (ENHANCED);
843             }
844           else
845             {
846               lex_error (lexer, NULL);
847               goto error;
848             }
849         }
850       else if (lex_match_id (lexer, "HISTOGRAM"))
851         {
852           lex_match (lexer, T_EQUALS);
853           sbc_histogram = true;
854
855           while (lex_token (lexer) != T_ENDCMD
856                  && lex_token (lexer) != T_SLASH)
857             {
858               if (lex_match_id (lexer, "NORMAL"))
859                 {
860                   hi_norm = FRQ_NORMAL;
861                 }
862               else if (lex_match_id (lexer, "NONORMAL"))
863                 {
864                   hi_norm = FRQ_NONORMAL;
865                 }
866               else if (lex_match_id (lexer, "FREQ"))
867                 {
868                   hi_scale = FRQ_FREQ;
869                   if (lex_match (lexer, T_LPAREN))
870                     {
871                       if (lex_force_int (lexer))
872                         {
873                           hi_freq = lex_integer (lexer);
874                           if (hi_freq <= 0)
875                             {
876                               lex_error (lexer, _("Histogram frequency must be greater than zero."));
877                             }
878                           lex_get (lexer);
879                           lex_force_match (lexer, T_RPAREN);
880                         }
881                     }
882                 }
883               else if (lex_match_id (lexer, "PERCENT"))
884                 {
885                   hi_scale = FRQ_PERCENT;
886                   if (lex_match (lexer, T_LPAREN))
887                     {
888                       if (lex_force_int (lexer))
889                         {
890                           hi_pcnt = lex_integer (lexer);
891                           if (hi_pcnt <= 0)
892                             {
893                               lex_error (lexer, _("Histogram percentage must be greater than zero."));
894                             }
895                           lex_get (lexer);
896                           lex_force_match (lexer, T_RPAREN);
897                         }
898                     }
899                 }
900               else if (lex_match_id (lexer, "MINIMUM"))
901                 {
902                   lex_force_match (lexer, T_LPAREN);
903                   if (lex_force_num (lexer))
904                     {
905                       hi_min = lex_number (lexer);
906                       lex_get (lexer);
907                     }
908                   lex_force_match (lexer, T_RPAREN);
909                 }
910               else if (lex_match_id (lexer, "MAXIMUM"))
911                 {
912                   lex_force_match (lexer, T_LPAREN);
913                   if (lex_force_num (lexer))
914                     {
915                       hi_max = lex_number (lexer);
916                       lex_get (lexer);
917                     }
918                   lex_force_match (lexer, T_RPAREN);
919                 }
920               else
921                 {
922                   lex_error (lexer, NULL);
923                   goto error;
924                 }
925             }
926         }
927       else if (lex_match_id (lexer, "PIECHART"))
928         {
929           lex_match (lexer, T_EQUALS);
930           while (lex_token (lexer) != T_ENDCMD
931                  && lex_token (lexer) != T_SLASH)
932             {
933               if (lex_match_id (lexer, "MINIMUM"))
934                 {
935                   lex_force_match (lexer, T_LPAREN);
936                   if (lex_force_num (lexer))
937                     {
938                       pie_min = lex_number (lexer);
939                       lex_get (lexer);
940                     }
941                   lex_force_match (lexer, T_RPAREN);
942                 }
943               else if (lex_match_id (lexer, "MAXIMUM"))
944                 {
945                   lex_force_match (lexer, T_LPAREN);
946                   if (lex_force_num (lexer))
947                     {
948                       pie_max = lex_number (lexer);
949                       lex_get (lexer);
950                     }
951                   lex_force_match (lexer, T_RPAREN);
952                 }
953               else if (lex_match_id (lexer, "MISSING"))
954                 {
955                   pie_missing = true;
956                 }
957               else if (lex_match_id (lexer, "NOMISSING"))
958                 {
959                   pie_missing = false;
960                 }
961               else
962                 {
963                   lex_error (lexer, NULL);
964                   goto error;
965                 }
966             }
967           sbc_piechart = true;
968         }
969       else if (lex_match_id (lexer, "MISSING"))
970         {
971           lex_match (lexer, T_EQUALS);
972
973           while (lex_token (lexer) != T_ENDCMD
974                  && lex_token (lexer) != T_SLASH)
975             {
976               if (lex_match_id (lexer, "EXCLUDE"))
977                 {
978                 }
979               else if (lex_match_id (lexer, "INCLUDE"))
980                 {
981                 }
982               else
983                 {
984                   lex_error (lexer, NULL);
985                   goto error;
986                 }
987             }
988         }
989       else
990         {
991           lex_error (lexer, NULL);
992           goto error;
993         }
994     }
995
996   if (frq.stats & FRQ_ST_MEDIAN)
997     {
998         frq.percentiles =
999           xrealloc (frq.percentiles, 
1000                     (frq.n_percentiles + 1)
1001                     * sizeof (*frq.percentiles));
1002         
1003         frq.percentiles[frq.n_percentiles].p = 0.50;
1004         frq.percentiles[frq.n_percentiles].show = true;
1005
1006         frq.n_percentiles++;
1007     }
1008
1009
1010 /* Figure out which charts the user requested.  */
1011
1012   {
1013     if (sbc_barchart)
1014       msg (SW, _("Bar charts are not implemented."));
1015
1016     if (sbc_histogram)
1017       {
1018         struct frq_chart *hist;
1019
1020         hist = frq.hist = xmalloc (sizeof *frq.hist);
1021         hist->x_min = hi_min;
1022         hist->x_max = hi_max;
1023         hist->y_scale = hi_scale;
1024         hist->y_max = hi_scale == FRQ_FREQ ? hi_freq : hi_pcnt;
1025         hist->draw_normal = hi_norm != FRQ_NONORMAL;
1026         hist->include_missing = false;
1027
1028         if (hist->x_min != SYSMIS && hist->x_max != SYSMIS
1029             && hist->x_min >= hist->x_max)
1030           {
1031             msg (SE, _("%s for histogram must be greater than or equal to %s, "
1032                        "but %s was specified as %.15g and %s as %.15g.  "
1033                        "%s and %s will be ignored."),
1034                  "MAX", "MIN", 
1035                  "MIN", hist->x_min, 
1036                  "MAX", hist->x_max,
1037                  "MIN", "MAX");
1038             hist->x_min = hist->x_max = SYSMIS;
1039           }
1040
1041         frq.percentiles =
1042           xrealloc (frq.percentiles, 
1043                     (frq.n_percentiles + 2)
1044                     * sizeof (*frq.percentiles));
1045         
1046         frq.percentiles[frq.n_percentiles].p = 0.25;
1047         frq.percentiles[frq.n_percentiles].show = false;
1048
1049         frq.percentiles[frq.n_percentiles + 1].p = 0.75;
1050         frq.percentiles[frq.n_percentiles + 1].show = false;
1051         
1052         frq.n_percentiles+=2;
1053       }
1054
1055     if (sbc_piechart)
1056       {
1057         struct frq_chart *pie;
1058
1059         pie = frq.pie = xmalloc (sizeof *frq.pie);
1060         pie->x_min = pie_min;
1061         pie->x_max = pie_max;
1062         pie->include_missing = pie_missing;
1063
1064         if (pie->x_min != SYSMIS && pie->x_max != SYSMIS
1065             && pie->x_min >= pie->x_max)
1066           {
1067             msg (SE, _("%s for pie chart must be greater than or equal to %s, "
1068                        "but %s was specified as %.15g and %s as %.15g.  "
1069                        "%s and %s will be ignored."), 
1070                  "MAX", "MIN", 
1071                  "MIN", pie->x_min,
1072                  "MAX", pie->x_max,
1073                  "MIN", "MAX");
1074             pie->x_min = pie->x_max = SYSMIS;
1075           }
1076       }
1077   }
1078
1079   {
1080     int i,o;
1081     double previous_p = -1;
1082     qsort (frq.percentiles, frq.n_percentiles,
1083            sizeof (*frq.percentiles), 
1084            ptile_3way);
1085
1086     frq.n_show_percentiles = 0;
1087     for (i = o = 0; i < frq.n_percentiles; ++i)
1088       {
1089         frq.percentiles[o].p = frq.percentiles[i].p;
1090
1091         if (frq.percentiles[i].show)
1092           frq.percentiles[o].show = true;
1093
1094         if (frq.percentiles[i].p != previous_p)
1095           {
1096             if (frq.percentiles[i].show)
1097               frq.n_show_percentiles++;
1098
1099             o++;
1100           }
1101
1102         previous_p = frq.percentiles[i].p;
1103       }
1104
1105     frq.n_percentiles = o;
1106   }
1107
1108   {
1109     struct casegrouper *grouper;
1110     struct casereader *group;
1111     bool ok;
1112
1113     grouper = casegrouper_create_splits (proc_open (ds), dataset_dict (ds));
1114     while (casegrouper_get_next_group (grouper, &group))
1115       {
1116         struct ccase *c;
1117         precalc (&frq, group, ds);
1118         for (; (c = casereader_read (group)) != NULL; case_unref (c))
1119           calc (&frq, c, ds);
1120         postcalc (&frq, ds);
1121       }
1122     ok = casegrouper_destroy (grouper);
1123     ok = proc_commit (ds) && ok;
1124   }
1125
1126
1127   return CMD_SUCCESS;
1128
1129  error:
1130
1131   return CMD_FAILURE;
1132 }
1133
1134 static double
1135 calculate_iqr (const struct frq_proc *frq)
1136 {
1137   double q1 = SYSMIS;
1138   double q3 = SYSMIS;
1139   int i;
1140
1141   /* This cannot work unless the 25th and 75th percentile are calculated */
1142   assert (frq->n_percentiles >= 2);
1143   for (i = 0; i < frq->n_percentiles; i++)
1144     {
1145       struct percentile *pc = &frq->percentiles[i];
1146
1147       if (fabs (0.25 - pc->p) < DBL_EPSILON)
1148         q1 = pc->value;
1149       else if (fabs (0.75 - pc->p) < DBL_EPSILON)
1150         q3 = pc->value;
1151     }
1152
1153   return q1 == SYSMIS || q3 == SYSMIS ? SYSMIS : q3 - q1;
1154 }
1155
1156 static bool
1157 chart_includes_value (const struct frq_chart *chart,
1158                       const struct variable *var,
1159                       const union value *value)
1160 {
1161   if (!chart->include_missing && var_is_value_missing (var, value, MV_ANY))
1162     return false;
1163
1164   if (var_is_numeric (var)
1165       && ((chart->x_min != SYSMIS && value->f < chart->x_min)
1166           || (chart->x_max != SYSMIS && value->f > chart->x_max)))
1167     return false;
1168
1169   return true;
1170 }
1171
1172 /* Create a gsl_histogram from a freq_tab */
1173 static struct histogram *
1174 freq_tab_to_hist (const struct frq_proc *frq, const struct freq_tab *ft,
1175                   const struct variable *var)
1176 {
1177   double x_min, x_max, valid_freq;
1178   int i;
1179   double bin_width;
1180   struct histogram *histogram;
1181   double iqr;
1182
1183   /* Find out the extremes of the x value, within the range to be included in
1184      the histogram, and sum the total frequency of those values. */
1185   x_min = DBL_MAX;
1186   x_max = -DBL_MAX;
1187   valid_freq = 0;
1188   for (i = 0; i < ft->n_valid; i++)
1189     {
1190       const struct freq *f = &ft->valid[i];
1191       if (chart_includes_value (frq->hist, var, &f->value))
1192         {
1193           x_min = MIN (x_min, f->value.f);
1194           x_max = MAX (x_max, f->value.f);
1195           valid_freq += f->count;
1196         }
1197     }
1198
1199
1200   iqr = calculate_iqr (frq);
1201
1202   if (iqr > 0)
1203     /* Freedman-Diaconis' choice of bin width. */
1204     bin_width = 2 * iqr / pow (valid_freq, 1.0 / 3.0);
1205
1206   else
1207     /* Sturges Rule */
1208     bin_width = (x_max - x_min) / (1 + log2 (valid_freq));
1209
1210   histogram = histogram_create (bin_width, x_min, x_max);
1211
1212   if ( histogram == NULL)
1213     return NULL;
1214
1215   for (i = 0; i < ft->n_valid; i++)
1216     {
1217       const struct freq *f = &ft->valid[i];
1218       if (chart_includes_value (frq->hist, var, &f->value))
1219         histogram_add (histogram, f->value.f, f->count);
1220     }
1221
1222   return histogram;
1223 }
1224
1225 static int
1226 add_slice (const struct frq_chart *pie, const struct freq *freq,
1227            const struct variable *var, struct slice *slice)
1228 {
1229   if (chart_includes_value (pie, var, &freq->value))
1230     {
1231       ds_init_empty (&slice->label);
1232       var_append_value_name (var, &freq->value, &slice->label);
1233       slice->magnitude = freq->count;
1234       return 1;
1235     }
1236   else
1237     return 0;
1238 }
1239
1240 /* Allocate an array of slices and fill them from the data in frq_tab
1241    n_slices will contain the number of slices allocated.
1242    The caller is responsible for freeing slices
1243 */
1244 static struct slice *
1245 freq_tab_to_slice_array(const struct frq_chart *pie,
1246                         const struct freq_tab *frq_tab,
1247                         const struct variable *var,
1248                         int *n_slicesp)
1249 {
1250   struct slice *slices;
1251   int n_slices;
1252   int i;
1253
1254   slices = xnmalloc (frq_tab->n_valid + frq_tab->n_missing, sizeof *slices);
1255   n_slices = 0;
1256
1257   for (i = 0; i < frq_tab->n_valid; i++)
1258     n_slices += add_slice (pie, &frq_tab->valid[i], var, &slices[n_slices]);
1259   for (i = 0; i < frq_tab->n_missing; i++)
1260     n_slices += add_slice (pie, &frq_tab->missing[i], var, &slices[n_slices]);
1261
1262   *n_slicesp = n_slices;
1263   return slices;
1264 }
1265
1266
1267 static void
1268 do_piechart(const struct frq_chart *pie, const struct variable *var,
1269             const struct freq_tab *frq_tab)
1270 {
1271   struct slice *slices;
1272   int n_slices, i;
1273
1274   slices = freq_tab_to_slice_array (pie, frq_tab, var, &n_slices);
1275
1276   if (n_slices < 2)
1277     msg (SW, _("Omitting pie chart for %s, which has only %d unique values."),
1278          var_get_name (var), n_slices);
1279   else if (n_slices > 50)
1280     msg (SW, _("Omitting pie chart for %s, which has over 50 unique values."),
1281          var_get_name (var));
1282   else
1283     chart_item_submit (piechart_create (var_to_string(var), slices, n_slices));
1284
1285   for (i = 0; i < n_slices; i++)
1286     ds_destroy (&slices[i].label);
1287   free (slices);
1288 }
1289
1290 /* Calculates all the pertinent statistics for VF, putting them in array
1291    D[]. */
1292 static void
1293 calc_stats (const struct var_freqs *vf, double d[FRQ_ST_count])
1294 {
1295   const struct freq_tab *ft = &vf->tab;
1296   double W = ft->valid_cases;
1297   const struct freq *f;
1298   struct moments *m;
1299   int most_often;
1300   double X_mode;
1301
1302   assert (ft->n_valid > 0);
1303
1304   /* Calculate the mode. */
1305   most_often = -1;
1306   X_mode = SYSMIS;
1307   for (f = ft->valid; f < ft->missing; f++)
1308     {
1309       if (most_often < f->count)
1310         {
1311           most_often = f->count;
1312           X_mode = f->value.f;
1313         }
1314       else if (most_often == f->count)
1315         {
1316           /* A duplicate mode is undefined.
1317              FIXME: keep track of *all* the modes. */
1318           X_mode = SYSMIS;
1319         }
1320     }
1321
1322   /* Calculate moments. */
1323   m = moments_create (MOMENT_KURTOSIS);
1324   for (f = ft->valid; f < ft->missing; f++)
1325     moments_pass_one (m, f->value.f, f->count);
1326   for (f = ft->valid; f < ft->missing; f++)
1327     moments_pass_two (m, f->value.f, f->count);
1328   moments_calculate (m, NULL, &d[FRQ_ST_MEAN], &d[FRQ_ST_VARIANCE],
1329                      &d[FRQ_ST_SKEWNESS], &d[FRQ_ST_KURTOSIS]);
1330   moments_destroy (m);
1331
1332   /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1333   d[FRQ_ST_MINIMUM] = ft->valid[0].value.f;
1334   d[FRQ_ST_MAXIMUM] = ft->valid[ft->n_valid - 1].value.f;
1335   d[FRQ_ST_MODE] = X_mode;
1336   d[FRQ_ST_RANGE] = d[FRQ_ST_MAXIMUM] - d[FRQ_ST_MINIMUM];
1337   d[FRQ_ST_SUM] = d[FRQ_ST_MEAN] * W;
1338   d[FRQ_ST_STDDEV] = sqrt (d[FRQ_ST_VARIANCE]);
1339   d[FRQ_ST_SEMEAN] = d[FRQ_ST_STDDEV] / sqrt (W);
1340   d[FRQ_ST_SESKEWNESS] = calc_seskew (W);
1341   d[FRQ_ST_SEKURTOSIS] = calc_sekurt (W);
1342 }
1343
1344 /* Displays a table of all the statistics requested for variable V. */
1345 static void
1346 dump_statistics (const struct frq_proc *frq, const struct var_freqs *vf,
1347                  const struct variable *wv)
1348 {
1349   const struct fmt_spec *wfmt = wv ? var_get_print_format (wv) : &F_8_0;
1350   const struct freq_tab *ft = &vf->tab;
1351   double stat_value[FRQ_ST_count];
1352   struct tab_table *t;
1353   int i, r;
1354
1355   if (var_is_alpha (vf->var))
1356     return;
1357
1358   if (ft->n_valid == 0)
1359     {
1360       msg (SW, _("No valid data for variable %s; statistics not displayed."),
1361            var_get_name (vf->var));
1362       return;
1363     }
1364   calc_stats (vf, stat_value);
1365
1366   t = tab_create (3, ((frq->stats & FRQ_ST_MEDIAN) ? frq->n_stats - 1 : frq->n_stats)
1367                   + frq->n_show_percentiles + 2);
1368   tab_set_format (t, RC_WEIGHT, wfmt);
1369   tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1370
1371
1372   tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1373   tab_vline (t, TAL_GAP , 1, 0, tab_nr(t) - 1 ) ;
1374
1375   r = 2; /* N missing and N valid are always dumped */
1376
1377   for (i = 0; i < FRQ_ST_count; i++)
1378     {
1379       if (FRQ_ST_MEDIAN == i)
1380         continue;
1381
1382       if (frq->stats & BIT_INDEX (i))
1383       {
1384         tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1385                       gettext (st_name[i]));
1386         tab_double (t, 2, r, TAB_NONE, stat_value[i], NULL, RC_OTHER);
1387         r++;
1388       }
1389     }
1390
1391   tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("N"));
1392   tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Valid"));
1393   tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Missing"));
1394
1395   tab_double (t, 2, 0, TAB_NONE, ft->valid_cases, NULL, RC_WEIGHT);
1396   tab_double (t, 2, 1, TAB_NONE, ft->total_cases - ft->valid_cases, NULL, RC_WEIGHT);
1397
1398   for (i = 0; i < frq->n_percentiles; i++)
1399     {
1400       const struct percentile *pc = &frq->percentiles[i];
1401
1402       if (!pc->show)
1403         continue;
1404
1405       if ( i == 0 )
1406         {
1407           tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
1408         }
1409
1410       if (pc->p == 0.5)
1411         tab_text (t, 1, r, TAB_LEFT, _("50 (Median)"));
1412       else
1413         tab_double (t, 1, r, TAB_LEFT, pc->p * 100, NULL, RC_INTEGER);
1414       tab_double (t, 2, r, TAB_NONE, pc->value,
1415                   var_get_print_format (vf->var), RC_OTHER);
1416       r++;
1417     }
1418
1419   tab_title (t, "%s", var_to_string (vf->var));
1420
1421   tab_submit (t);
1422 }
1423