FREQUENCIES: Fix treatment of string variables.
[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       frq.vars[i].width = var_get_width (vars[i]);
630     }
631
632   while (lex_token (lexer) != T_ENDCMD)
633     {
634       lex_match (lexer, T_SLASH);
635
636       if (lex_match_id (lexer, "STATISTICS"))
637         {
638           lex_match (lexer, T_EQUALS);
639
640           frq.stats = 0;
641           frq.n_stats = 0;
642
643           while (lex_token (lexer) != T_ENDCMD
644                  && lex_token (lexer) != T_SLASH)
645             {
646               if (lex_match_id (lexer, "DEFAULT"))
647                 {
648                   frq.stats = BIT_INDEX (FRQ_ST_MEAN) 
649                     | BIT_INDEX (FRQ_ST_STDDEV) 
650                     | BIT_INDEX (FRQ_ST_MINIMUM)
651                     | BIT_INDEX (FRQ_ST_MAXIMUM);
652
653                   frq.n_stats = 4;
654                 }
655               else if (lex_match_id (lexer, "MEAN"))
656                 {
657                   frq.stats |= BIT_INDEX (FRQ_ST_MEAN);
658                   frq.n_stats++;
659                 }
660               else if (lex_match_id (lexer, "SEMEAN"))
661                 {
662                   frq.stats |= BIT_INDEX (FRQ_ST_SEMEAN);
663                   frq.n_stats++;
664                 }
665               else if (lex_match_id (lexer, "MEDIAN"))
666                 {
667                   frq.stats |= BIT_INDEX (FRQ_ST_MEDIAN);
668                   frq.n_stats++;
669                 }
670               else if (lex_match_id (lexer, "MODE"))
671                 {
672                   frq.stats |= BIT_INDEX (FRQ_ST_MODE);
673                   frq.n_stats++;
674                 }
675               else if (lex_match_id (lexer, "STDDEV"))
676                 {
677                   frq.stats |= BIT_INDEX (FRQ_ST_STDDEV);
678                   frq.n_stats++;
679                 }
680               else if (lex_match_id (lexer, "VARIANCE"))
681                 {
682                   frq.stats |= BIT_INDEX (FRQ_ST_MEAN);
683                   frq.n_stats++;
684                 }
685               else if (lex_match_id (lexer, "KURTOSIS"))
686                 {
687                   frq.stats |= BIT_INDEX (FRQ_ST_KURTOSIS);
688                   frq.n_stats++;
689                 }
690               else if (lex_match_id (lexer, "SKEWNESS"))
691                 {
692                   frq.stats |= BIT_INDEX (FRQ_ST_SKEWNESS);
693                   frq.n_stats++;
694                 }
695               else if (lex_match_id (lexer, "RANGE"))
696                 {
697                   frq.stats |= BIT_INDEX (FRQ_ST_RANGE);
698                   frq.n_stats++;
699                 }
700               else if (lex_match_id (lexer, "MINIMUM"))
701                 {
702                   frq.stats |= BIT_INDEX (FRQ_ST_MINIMUM);
703                   frq.n_stats++;
704                 }
705               else if (lex_match_id (lexer, "MAXIMUM"))
706                 {
707                   frq.stats |= BIT_INDEX (FRQ_ST_MAXIMUM);
708                   frq.n_stats++;
709                 }
710               else if (lex_match_id (lexer, "SUM"))
711                 {
712                   frq.stats |= BIT_INDEX (FRQ_ST_SUM);
713                   frq.n_stats++;
714                 }
715               else if (lex_match_id (lexer, "SESKEWNESS"))
716                 {
717                   frq.stats |= BIT_INDEX (FRQ_ST_SESKEWNESS);
718                   frq.n_stats++;
719                 }
720               else if (lex_match_id (lexer, "SEKURTOSIS"))
721                 {
722                   frq.stats |= BIT_INDEX (FRQ_ST_SEKURTOSIS);
723                   frq.n_stats++;
724                 }
725               else if (lex_match_id (lexer, "NONE"))
726                 {
727                   frq.stats = 0;
728                   frq.n_stats = 0;
729                 }
730               else if (lex_match (lexer, T_ALL))
731                 {
732                   frq.stats = ~0;
733                   frq.n_stats = FRQ_ST_count;
734                 }
735               else
736                 {
737                   lex_error (lexer, NULL);
738                   goto error;
739                 }
740             }
741         }
742       else if (lex_match_id (lexer, "PERCENTILES"))
743         {
744           lex_match (lexer, T_EQUALS);
745           while (lex_token (lexer) != T_ENDCMD
746                  && lex_token (lexer) != T_SLASH)
747             {
748               if (lex_force_num (lexer))
749                 {
750                   frq.percentiles =
751                     xrealloc (frq.percentiles, 
752                               (frq.n_percentiles + 1)
753                               * sizeof (*frq.percentiles));
754                   frq.percentiles[frq.n_percentiles].p = lex_number (lexer)  / 100.0;
755                   frq.percentiles[frq.n_percentiles].show = true;
756                   lex_get (lexer);
757                   frq.n_percentiles++;
758                   frq.n_show_percentiles++;
759                 }
760               else
761                 {
762                   lex_error (lexer, NULL);
763                   goto error;
764                 }
765             }
766         }
767       else if (lex_match_id (lexer, "FORMAT"))
768         {
769           lex_match (lexer, T_EQUALS);
770           while (lex_token (lexer) != T_ENDCMD
771                  && lex_token (lexer) != T_SLASH)
772             {
773               if (lex_match_id (lexer, "TABLE"))
774                 {
775                   
776                 }
777               else if (lex_match_id (lexer, "NOTABLE"))
778                 {
779                   frq.max_categories = 0;
780                 }
781               else if (lex_match_id (lexer, "AVALUE"))
782                 {
783                   frq.sort = FRQ_AVALUE;
784                 }
785               else if (lex_match_id (lexer, "DVALUE"))
786                 {
787                   frq.sort = FRQ_DVALUE;
788                 }
789               else if (lex_match_id (lexer, "AFREQ"))
790                 {
791                   frq.sort = FRQ_AFREQ;
792                 }
793               else if (lex_match_id (lexer, "DFREQ"))
794                 {
795                   frq.sort = FRQ_DFREQ;
796                 }
797               else
798                 {
799                   lex_error (lexer, NULL);
800                   goto error;
801                 }
802             }
803         }
804       else if (lex_match_id (lexer, "NTILES"))
805         {
806           lex_match (lexer, T_EQUALS);
807
808           if (lex_force_int (lexer))
809             {
810               int i;
811               int n = lex_integer (lexer);
812               lex_get (lexer);
813               for (i = 0; i < n + 1; ++i)
814                 {
815                   frq.percentiles =
816                     xrealloc (frq.percentiles, 
817                               (frq.n_percentiles + 1)
818                               * sizeof (*frq.percentiles));
819                   frq.percentiles[frq.n_percentiles].p =
820                     i / (double) n ;
821                   frq.percentiles[frq.n_percentiles].show = true;
822
823                   frq.n_percentiles++;
824                   frq.n_show_percentiles++;
825                 }
826             }
827           else
828             {
829               lex_error (lexer, NULL);
830               goto error;
831             }
832         }
833       else if (lex_match_id (lexer, "ALGORITHM"))
834         {
835           lex_match (lexer, T_EQUALS);
836
837           if (lex_match_id (lexer, "COMPATIBLE"))
838             {
839               settings_set_cmd_algorithm (COMPATIBLE);
840             }
841           else if (lex_match_id (lexer, "ENHANCED"))
842             {
843               settings_set_cmd_algorithm (ENHANCED);
844             }
845           else
846             {
847               lex_error (lexer, NULL);
848               goto error;
849             }
850         }
851       else if (lex_match_id (lexer, "HISTOGRAM"))
852         {
853           lex_match (lexer, T_EQUALS);
854           sbc_histogram = true;
855
856           while (lex_token (lexer) != T_ENDCMD
857                  && lex_token (lexer) != T_SLASH)
858             {
859               if (lex_match_id (lexer, "NORMAL"))
860                 {
861                   hi_norm = FRQ_NORMAL;
862                 }
863               else if (lex_match_id (lexer, "NONORMAL"))
864                 {
865                   hi_norm = FRQ_NONORMAL;
866                 }
867               else if (lex_match_id (lexer, "FREQ"))
868                 {
869                   hi_scale = FRQ_FREQ;
870                   if (lex_match (lexer, T_LPAREN))
871                     {
872                       if (lex_force_int (lexer))
873                         {
874                           hi_freq = lex_integer (lexer);
875                           if (hi_freq <= 0)
876                             {
877                               lex_error (lexer, _("Histogram frequency must be greater than zero."));
878                             }
879                           lex_get (lexer);
880                           lex_force_match (lexer, T_RPAREN);
881                         }
882                     }
883                 }
884               else if (lex_match_id (lexer, "PERCENT"))
885                 {
886                   hi_scale = FRQ_PERCENT;
887                   if (lex_match (lexer, T_LPAREN))
888                     {
889                       if (lex_force_int (lexer))
890                         {
891                           hi_pcnt = lex_integer (lexer);
892                           if (hi_pcnt <= 0)
893                             {
894                               lex_error (lexer, _("Histogram percentage must be greater than zero."));
895                             }
896                           lex_get (lexer);
897                           lex_force_match (lexer, T_RPAREN);
898                         }
899                     }
900                 }
901               else if (lex_match_id (lexer, "MINIMUM"))
902                 {
903                   lex_force_match (lexer, T_LPAREN);
904                   if (lex_force_num (lexer))
905                     {
906                       hi_min = lex_number (lexer);
907                       lex_get (lexer);
908                     }
909                   lex_force_match (lexer, T_RPAREN);
910                 }
911               else if (lex_match_id (lexer, "MAXIMUM"))
912                 {
913                   lex_force_match (lexer, T_LPAREN);
914                   if (lex_force_num (lexer))
915                     {
916                       hi_max = lex_number (lexer);
917                       lex_get (lexer);
918                     }
919                   lex_force_match (lexer, T_RPAREN);
920                 }
921               else
922                 {
923                   lex_error (lexer, NULL);
924                   goto error;
925                 }
926             }
927         }
928       else if (lex_match_id (lexer, "PIECHART"))
929         {
930           lex_match (lexer, T_EQUALS);
931           while (lex_token (lexer) != T_ENDCMD
932                  && lex_token (lexer) != T_SLASH)
933             {
934               if (lex_match_id (lexer, "MINIMUM"))
935                 {
936                   lex_force_match (lexer, T_LPAREN);
937                   if (lex_force_num (lexer))
938                     {
939                       pie_min = lex_number (lexer);
940                       lex_get (lexer);
941                     }
942                   lex_force_match (lexer, T_RPAREN);
943                 }
944               else if (lex_match_id (lexer, "MAXIMUM"))
945                 {
946                   lex_force_match (lexer, T_LPAREN);
947                   if (lex_force_num (lexer))
948                     {
949                       pie_max = lex_number (lexer);
950                       lex_get (lexer);
951                     }
952                   lex_force_match (lexer, T_RPAREN);
953                 }
954               else if (lex_match_id (lexer, "MISSING"))
955                 {
956                   pie_missing = true;
957                 }
958               else if (lex_match_id (lexer, "NOMISSING"))
959                 {
960                   pie_missing = false;
961                 }
962               else
963                 {
964                   lex_error (lexer, NULL);
965                   goto error;
966                 }
967             }
968           sbc_piechart = true;
969         }
970       else if (lex_match_id (lexer, "MISSING"))
971         {
972           lex_match (lexer, T_EQUALS);
973
974           while (lex_token (lexer) != T_ENDCMD
975                  && lex_token (lexer) != T_SLASH)
976             {
977               if (lex_match_id (lexer, "EXCLUDE"))
978                 {
979                 }
980               else if (lex_match_id (lexer, "INCLUDE"))
981                 {
982                 }
983               else
984                 {
985                   lex_error (lexer, NULL);
986                   goto error;
987                 }
988             }
989         }
990       else
991         {
992           lex_error (lexer, NULL);
993           goto error;
994         }
995     }
996
997   if (frq.stats & FRQ_ST_MEDIAN)
998     {
999         frq.percentiles =
1000           xrealloc (frq.percentiles, 
1001                     (frq.n_percentiles + 1)
1002                     * sizeof (*frq.percentiles));
1003         
1004         frq.percentiles[frq.n_percentiles].p = 0.50;
1005         frq.percentiles[frq.n_percentiles].show = true;
1006
1007         frq.n_percentiles++;
1008     }
1009
1010
1011 /* Figure out which charts the user requested.  */
1012
1013   {
1014     if (sbc_barchart)
1015       msg (SW, _("Bar charts are not implemented."));
1016
1017     if (sbc_histogram)
1018       {
1019         struct frq_chart *hist;
1020
1021         hist = frq.hist = xmalloc (sizeof *frq.hist);
1022         hist->x_min = hi_min;
1023         hist->x_max = hi_max;
1024         hist->y_scale = hi_scale;
1025         hist->y_max = hi_scale == FRQ_FREQ ? hi_freq : hi_pcnt;
1026         hist->draw_normal = hi_norm != FRQ_NONORMAL;
1027         hist->include_missing = false;
1028
1029         if (hist->x_min != SYSMIS && hist->x_max != SYSMIS
1030             && hist->x_min >= hist->x_max)
1031           {
1032             msg (SE, _("%s for histogram must be greater than or equal to %s, "
1033                        "but %s was specified as %.15g and %s as %.15g.  "
1034                        "%s and %s will be ignored."),
1035                  "MAX", "MIN", 
1036                  "MIN", hist->x_min, 
1037                  "MAX", hist->x_max,
1038                  "MIN", "MAX");
1039             hist->x_min = hist->x_max = SYSMIS;
1040           }
1041
1042         frq.percentiles =
1043           xrealloc (frq.percentiles, 
1044                     (frq.n_percentiles + 2)
1045                     * sizeof (*frq.percentiles));
1046         
1047         frq.percentiles[frq.n_percentiles].p = 0.25;
1048         frq.percentiles[frq.n_percentiles].show = false;
1049
1050         frq.percentiles[frq.n_percentiles + 1].p = 0.75;
1051         frq.percentiles[frq.n_percentiles + 1].show = false;
1052         
1053         frq.n_percentiles+=2;
1054       }
1055
1056     if (sbc_piechart)
1057       {
1058         struct frq_chart *pie;
1059
1060         pie = frq.pie = xmalloc (sizeof *frq.pie);
1061         pie->x_min = pie_min;
1062         pie->x_max = pie_max;
1063         pie->include_missing = pie_missing;
1064
1065         if (pie->x_min != SYSMIS && pie->x_max != SYSMIS
1066             && pie->x_min >= pie->x_max)
1067           {
1068             msg (SE, _("%s for pie chart must be greater than or equal to %s, "
1069                        "but %s was specified as %.15g and %s as %.15g.  "
1070                        "%s and %s will be ignored."), 
1071                  "MAX", "MIN", 
1072                  "MIN", pie->x_min,
1073                  "MAX", pie->x_max,
1074                  "MIN", "MAX");
1075             pie->x_min = pie->x_max = SYSMIS;
1076           }
1077       }
1078   }
1079
1080   {
1081     int i,o;
1082     double previous_p = -1;
1083     qsort (frq.percentiles, frq.n_percentiles,
1084            sizeof (*frq.percentiles), 
1085            ptile_3way);
1086
1087     frq.n_show_percentiles = 0;
1088     for (i = o = 0; i < frq.n_percentiles; ++i)
1089       {
1090         frq.percentiles[o].p = frq.percentiles[i].p;
1091
1092         if (frq.percentiles[i].show)
1093           frq.percentiles[o].show = true;
1094
1095         if (frq.percentiles[i].p != previous_p)
1096           {
1097             if (frq.percentiles[i].show)
1098               frq.n_show_percentiles++;
1099
1100             o++;
1101           }
1102
1103         previous_p = frq.percentiles[i].p;
1104       }
1105
1106     frq.n_percentiles = o;
1107   }
1108
1109   {
1110     struct casegrouper *grouper;
1111     struct casereader *group;
1112     bool ok;
1113
1114     grouper = casegrouper_create_splits (proc_open (ds), dataset_dict (ds));
1115     while (casegrouper_get_next_group (grouper, &group))
1116       {
1117         struct ccase *c;
1118         precalc (&frq, group, ds);
1119         for (; (c = casereader_read (group)) != NULL; case_unref (c))
1120           calc (&frq, c, ds);
1121         postcalc (&frq, ds);
1122       }
1123     ok = casegrouper_destroy (grouper);
1124     ok = proc_commit (ds) && ok;
1125   }
1126
1127
1128   return CMD_SUCCESS;
1129
1130  error:
1131
1132   return CMD_FAILURE;
1133 }
1134
1135 static double
1136 calculate_iqr (const struct frq_proc *frq)
1137 {
1138   double q1 = SYSMIS;
1139   double q3 = SYSMIS;
1140   int i;
1141
1142   /* This cannot work unless the 25th and 75th percentile are calculated */
1143   assert (frq->n_percentiles >= 2);
1144   for (i = 0; i < frq->n_percentiles; i++)
1145     {
1146       struct percentile *pc = &frq->percentiles[i];
1147
1148       if (fabs (0.25 - pc->p) < DBL_EPSILON)
1149         q1 = pc->value;
1150       else if (fabs (0.75 - pc->p) < DBL_EPSILON)
1151         q3 = pc->value;
1152     }
1153
1154   return q1 == SYSMIS || q3 == SYSMIS ? SYSMIS : q3 - q1;
1155 }
1156
1157 static bool
1158 chart_includes_value (const struct frq_chart *chart,
1159                       const struct variable *var,
1160                       const union value *value)
1161 {
1162   if (!chart->include_missing && var_is_value_missing (var, value, MV_ANY))
1163     return false;
1164
1165   if (var_is_numeric (var)
1166       && ((chart->x_min != SYSMIS && value->f < chart->x_min)
1167           || (chart->x_max != SYSMIS && value->f > chart->x_max)))
1168     return false;
1169
1170   return true;
1171 }
1172
1173 /* Create a gsl_histogram from a freq_tab */
1174 static struct histogram *
1175 freq_tab_to_hist (const struct frq_proc *frq, const struct freq_tab *ft,
1176                   const struct variable *var)
1177 {
1178   double x_min, x_max, valid_freq;
1179   int i;
1180   double bin_width;
1181   struct histogram *histogram;
1182   double iqr;
1183
1184   /* Find out the extremes of the x value, within the range to be included in
1185      the histogram, and sum the total frequency of those values. */
1186   x_min = DBL_MAX;
1187   x_max = -DBL_MAX;
1188   valid_freq = 0;
1189   for (i = 0; i < ft->n_valid; i++)
1190     {
1191       const struct freq *f = &ft->valid[i];
1192       if (chart_includes_value (frq->hist, var, &f->value))
1193         {
1194           x_min = MIN (x_min, f->value.f);
1195           x_max = MAX (x_max, f->value.f);
1196           valid_freq += f->count;
1197         }
1198     }
1199
1200
1201   iqr = calculate_iqr (frq);
1202
1203   if (iqr > 0)
1204     /* Freedman-Diaconis' choice of bin width. */
1205     bin_width = 2 * iqr / pow (valid_freq, 1.0 / 3.0);
1206
1207   else
1208     /* Sturges Rule */
1209     bin_width = (x_max - x_min) / (1 + log2 (valid_freq));
1210
1211   histogram = histogram_create (bin_width, x_min, x_max);
1212
1213   if ( histogram == NULL)
1214     return NULL;
1215
1216   for (i = 0; i < ft->n_valid; i++)
1217     {
1218       const struct freq *f = &ft->valid[i];
1219       if (chart_includes_value (frq->hist, var, &f->value))
1220         histogram_add (histogram, f->value.f, f->count);
1221     }
1222
1223   return histogram;
1224 }
1225
1226 static int
1227 add_slice (const struct frq_chart *pie, const struct freq *freq,
1228            const struct variable *var, struct slice *slice)
1229 {
1230   if (chart_includes_value (pie, var, &freq->value))
1231     {
1232       ds_init_empty (&slice->label);
1233       var_append_value_name (var, &freq->value, &slice->label);
1234       slice->magnitude = freq->count;
1235       return 1;
1236     }
1237   else
1238     return 0;
1239 }
1240
1241 /* Allocate an array of slices and fill them from the data in frq_tab
1242    n_slices will contain the number of slices allocated.
1243    The caller is responsible for freeing slices
1244 */
1245 static struct slice *
1246 freq_tab_to_slice_array(const struct frq_chart *pie,
1247                         const struct freq_tab *frq_tab,
1248                         const struct variable *var,
1249                         int *n_slicesp)
1250 {
1251   struct slice *slices;
1252   int n_slices;
1253   int i;
1254
1255   slices = xnmalloc (frq_tab->n_valid + frq_tab->n_missing, sizeof *slices);
1256   n_slices = 0;
1257
1258   for (i = 0; i < frq_tab->n_valid; i++)
1259     n_slices += add_slice (pie, &frq_tab->valid[i], var, &slices[n_slices]);
1260   for (i = 0; i < frq_tab->n_missing; i++)
1261     n_slices += add_slice (pie, &frq_tab->missing[i], var, &slices[n_slices]);
1262
1263   *n_slicesp = n_slices;
1264   return slices;
1265 }
1266
1267
1268 static void
1269 do_piechart(const struct frq_chart *pie, const struct variable *var,
1270             const struct freq_tab *frq_tab)
1271 {
1272   struct slice *slices;
1273   int n_slices, i;
1274
1275   slices = freq_tab_to_slice_array (pie, frq_tab, var, &n_slices);
1276
1277   if (n_slices < 2)
1278     msg (SW, _("Omitting pie chart for %s, which has only %d unique values."),
1279          var_get_name (var), n_slices);
1280   else if (n_slices > 50)
1281     msg (SW, _("Omitting pie chart for %s, which has over 50 unique values."),
1282          var_get_name (var));
1283   else
1284     chart_item_submit (piechart_create (var_to_string(var), slices, n_slices));
1285
1286   for (i = 0; i < n_slices; i++)
1287     ds_destroy (&slices[i].label);
1288   free (slices);
1289 }
1290
1291 /* Calculates all the pertinent statistics for VF, putting them in array
1292    D[]. */
1293 static void
1294 calc_stats (const struct var_freqs *vf, double d[FRQ_ST_count])
1295 {
1296   const struct freq_tab *ft = &vf->tab;
1297   double W = ft->valid_cases;
1298   const struct freq *f;
1299   struct moments *m;
1300   int most_often;
1301   double X_mode;
1302
1303   assert (ft->n_valid > 0);
1304
1305   /* Calculate the mode. */
1306   most_often = -1;
1307   X_mode = SYSMIS;
1308   for (f = ft->valid; f < ft->missing; f++)
1309     {
1310       if (most_often < f->count)
1311         {
1312           most_often = f->count;
1313           X_mode = f->value.f;
1314         }
1315       else if (most_often == f->count)
1316         {
1317           /* A duplicate mode is undefined.
1318              FIXME: keep track of *all* the modes. */
1319           X_mode = SYSMIS;
1320         }
1321     }
1322
1323   /* Calculate moments. */
1324   m = moments_create (MOMENT_KURTOSIS);
1325   for (f = ft->valid; f < ft->missing; f++)
1326     moments_pass_one (m, f->value.f, f->count);
1327   for (f = ft->valid; f < ft->missing; f++)
1328     moments_pass_two (m, f->value.f, f->count);
1329   moments_calculate (m, NULL, &d[FRQ_ST_MEAN], &d[FRQ_ST_VARIANCE],
1330                      &d[FRQ_ST_SKEWNESS], &d[FRQ_ST_KURTOSIS]);
1331   moments_destroy (m);
1332
1333   /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1334   d[FRQ_ST_MINIMUM] = ft->valid[0].value.f;
1335   d[FRQ_ST_MAXIMUM] = ft->valid[ft->n_valid - 1].value.f;
1336   d[FRQ_ST_MODE] = X_mode;
1337   d[FRQ_ST_RANGE] = d[FRQ_ST_MAXIMUM] - d[FRQ_ST_MINIMUM];
1338   d[FRQ_ST_SUM] = d[FRQ_ST_MEAN] * W;
1339   d[FRQ_ST_STDDEV] = sqrt (d[FRQ_ST_VARIANCE]);
1340   d[FRQ_ST_SEMEAN] = d[FRQ_ST_STDDEV] / sqrt (W);
1341   d[FRQ_ST_SESKEWNESS] = calc_seskew (W);
1342   d[FRQ_ST_SEKURTOSIS] = calc_sekurt (W);
1343 }
1344
1345 /* Displays a table of all the statistics requested for variable V. */
1346 static void
1347 dump_statistics (const struct frq_proc *frq, const struct var_freqs *vf,
1348                  const struct variable *wv)
1349 {
1350   const struct fmt_spec *wfmt = wv ? var_get_print_format (wv) : &F_8_0;
1351   const struct freq_tab *ft = &vf->tab;
1352   double stat_value[FRQ_ST_count];
1353   struct tab_table *t;
1354   int i, r;
1355
1356   if (var_is_alpha (vf->var))
1357     return;
1358
1359   if (ft->n_valid == 0)
1360     {
1361       msg (SW, _("No valid data for variable %s; statistics not displayed."),
1362            var_get_name (vf->var));
1363       return;
1364     }
1365   calc_stats (vf, stat_value);
1366
1367   t = tab_create (3, ((frq->stats & FRQ_ST_MEDIAN) ? frq->n_stats - 1 : frq->n_stats)
1368                   + frq->n_show_percentiles + 2);
1369   tab_set_format (t, RC_WEIGHT, wfmt);
1370   tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1371
1372
1373   tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1374   tab_vline (t, TAL_GAP , 1, 0, tab_nr(t) - 1 ) ;
1375
1376   r = 2; /* N missing and N valid are always dumped */
1377
1378   for (i = 0; i < FRQ_ST_count; i++)
1379     {
1380       if (FRQ_ST_MEDIAN == i)
1381         continue;
1382
1383       if (frq->stats & BIT_INDEX (i))
1384       {
1385         tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1386                       gettext (st_name[i]));
1387         tab_double (t, 2, r, TAB_NONE, stat_value[i], NULL, RC_OTHER);
1388         r++;
1389       }
1390     }
1391
1392   tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("N"));
1393   tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Valid"));
1394   tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Missing"));
1395
1396   tab_double (t, 2, 0, TAB_NONE, ft->valid_cases, NULL, RC_WEIGHT);
1397   tab_double (t, 2, 1, TAB_NONE, ft->total_cases - ft->valid_cases, NULL, RC_WEIGHT);
1398
1399   for (i = 0; i < frq->n_percentiles; i++)
1400     {
1401       const struct percentile *pc = &frq->percentiles[i];
1402
1403       if (!pc->show)
1404         continue;
1405
1406       if ( i == 0 )
1407         {
1408           tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
1409         }
1410
1411       if (pc->p == 0.5)
1412         tab_text (t, 1, r, TAB_LEFT, _("50 (Median)"));
1413       else
1414         tab_double (t, 1, r, TAB_LEFT, pc->p * 100, NULL, RC_INTEGER);
1415       tab_double (t, 2, r, TAB_NONE, pc->value,
1416                   var_get_print_format (vf->var), RC_OTHER);
1417       r++;
1418     }
1419
1420   tab_title (t, "%s", var_to_string (vf->var));
1421
1422   tab_submit (t);
1423 }
1424