Remove "Written by Ben Pfaff <blp@gnu.org>" lines everywhere.
[pspp-builds.git] / src / language / stats / frequencies.q
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or
5    modify it under the terms of the GNU General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful, but
10    WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    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, write to the Free Software
16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17    02110-1301, USA. */
18
19 /*
20   TODO:
21
22   * Remember that histograms, bar charts need mean, stddev.
23 */
24
25 #include <config.h>
26
27 #include <math.h>
28 #include <stdlib.h>
29 #include <gsl/gsl_histogram.h>
30
31 #include <data/case.h>
32 #include <data/dictionary.h>
33 #include <data/format.h>
34 #include <data/procedure.h>
35 #include <data/settings.h>
36 #include <data/value-labels.h>
37 #include <data/variable.h>
38 #include <language/command.h>
39 #include <language/dictionary/split-file.h>
40 #include <language/lexer/lexer.h>
41 #include <libpspp/alloc.h>
42 #include <libpspp/array.h>
43 #include <libpspp/bit-vector.h>
44 #include <libpspp/compiler.h>
45 #include <libpspp/hash.h>
46 #include <libpspp/magic.h>
47 #include <libpspp/message.h>
48 #include <libpspp/message.h>
49 #include <libpspp/misc.h>
50 #include <libpspp/pool.h>
51 #include <libpspp/str.h>
52 #include <math/histogram.h>
53 #include <math/moments.h>
54 #include <output/chart.h>
55 #include <output/charts/piechart.h>
56 #include <output/charts/plot-hist.h>
57 #include <output/manager.h>
58 #include <output/output.h>
59 #include <output/table.h>
60
61 #include "minmax.h"
62
63 #include "gettext.h"
64 #define _(msgid) gettext (msgid)
65 #define N_(msgid) msgid
66
67 /* (headers) */
68
69 /* (specification)
70    FREQUENCIES (frq_):
71      *+variables=custom;
72      +format=cond:condense/onepage(*n:onepage_limit,"%s>=0")/!standard,
73              table:limit(n:limit,"%s>0")/notable/!table, 
74              labels:!labels/nolabels,
75              sort:!avalue/dvalue/afreq/dfreq,
76              spaces:!single/double,
77              paging:newpage/!oldpage;
78      missing=miss:include/!exclude;
79      barchart(ba_)=:minimum(d:min),
80             :maximum(d:max),
81             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0");
82      piechart(pie_)=:minimum(d:min),
83             :maximum(d:max),
84             missing:missing/!nomissing;
85      histogram(hi_)=:minimum(d:min),
86             :maximum(d:max),
87             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
88             norm:!nonormal/normal,
89             incr:increment(d:inc,"%s>0");
90      hbar(hb_)=:minimum(d:min),
91             :maximum(d:max),
92             scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
93             norm:!nonormal/normal,
94             incr:increment(d:inc,"%s>0");
95      +grouped=custom;
96      +ntiles=integer;
97      +percentiles = double list;
98      +statistics[st_]=1|mean,2|semean,3|median,4|mode,5|stddev,6|variance,
99             7|kurtosis,8|skewness,9|range,10|minimum,11|maximum,12|sum,
100             13|default,14|seskewness,15|sekurtosis,all,none.
101 */
102 /* (declarations) */
103 /* (functions) */
104
105 /* Statistics. */
106 enum
107   {
108     frq_mean = 0, frq_semean, frq_median, frq_mode, frq_stddev, frq_variance,
109     frq_kurt, frq_sekurt, frq_skew, frq_seskew, frq_range, frq_min, frq_max,
110     frq_sum, frq_n_stats
111   };
112
113 /* Description of a statistic. */
114 struct frq_info
115   {
116     int st_indx;                /* Index into a_statistics[]. */
117     const char *s10;            /* Identifying string. */
118   };
119
120 /* Table of statistics, indexed by dsc_*. */
121 static const struct frq_info st_name[frq_n_stats + 1] =
122 {
123   {FRQ_ST_MEAN, N_("Mean")},
124   {FRQ_ST_SEMEAN, N_("S.E. Mean")},
125   {FRQ_ST_MEDIAN, N_("Median")},
126   {FRQ_ST_MODE, N_("Mode")},
127   {FRQ_ST_STDDEV, N_("Std Dev")},
128   {FRQ_ST_VARIANCE, N_("Variance")},
129   {FRQ_ST_KURTOSIS, N_("Kurtosis")},
130   {FRQ_ST_SEKURTOSIS, N_("S.E. Kurt")},
131   {FRQ_ST_SKEWNESS, N_("Skewness")},
132   {FRQ_ST_SESKEWNESS, N_("S.E. Skew")},
133   {FRQ_ST_RANGE, N_("Range")},
134   {FRQ_ST_MINIMUM, N_("Minimum")},
135   {FRQ_ST_MAXIMUM, N_("Maximum")},
136   {FRQ_ST_SUM, N_("Sum")},
137   {-1, 0},
138 };
139
140 /* Percentiles to calculate. */
141
142 struct percentile
143 {
144   double p;        /* the %ile to be calculated */
145   double value;    /* the %ile's value */
146   double x1;       /* The datum value <= the percentile */
147   double x2;       /* The datum value >= the percentile */
148   int flag;        
149   int flag2;       /* Set to 1 if this percentile value has been found */
150 };
151
152
153 static void add_percentile (double x) ;
154
155 static struct percentile *percentiles;
156 static int n_percentiles;
157
158 static int implicit_50th ; 
159
160 /* Groups of statistics. */
161 #define BI          BIT_INDEX
162 #define frq_default                                                     \
163         (BI (frq_mean) | BI (frq_stddev) | BI (frq_min) | BI (frq_max))
164 #define frq_all                                                 \
165         (BI (frq_sum) | BI(frq_min) | BI(frq_max)               \
166          | BI(frq_mean) | BI(frq_semean) | BI(frq_stddev)       \
167          | BI(frq_variance) | BI(frq_kurt) | BI(frq_sekurt)     \
168          | BI(frq_skew) | BI(frq_seskew) | BI(frq_range)        \
169          | BI(frq_range) | BI(frq_mode) | BI(frq_median))
170
171 /* Statistics; number of statistics. */
172 static unsigned long stats;
173 static int n_stats;
174
175 /* Types of graphs. */
176 enum
177   {
178     GFT_NONE,                   /* Don't draw graphs. */
179     GFT_BAR,                    /* Draw bar charts. */
180     GFT_HIST,                   /* Draw histograms. */
181     GFT_PIE,                    /* Draw piechart */
182     GFT_HBAR                    /* Draw bar charts or histograms at our discretion. */
183   };
184
185 /* Parsed command. */
186 static struct cmd_frequencies cmd;
187
188 /* Summary of the barchart, histogram, and hbar subcommands. */
189 /* FIXME: These should not be mututally exclusive */
190 static int chart;               /* NONE/BAR/HIST/HBAR/PIE. */
191 static double min, max;         /* Minimum, maximum on y axis. */
192 static int format;              /* FREQ/PERCENT: Scaling of y axis. */
193 static double scale, incr;      /* FIXME */
194 static int normal;              /* FIXME */
195
196 /* Variables for which to calculate statistics. */
197 static size_t n_variables;
198 static struct variable **v_variables;
199
200 /* Arenas used to store semi-permanent storage. */
201 static struct pool *int_pool;   /* Integer mode. */
202 static struct pool *gen_pool;   /* General mode. */
203
204 /* Frequency tables. */
205
206 /* Frequency table entry. */
207 struct freq
208   {
209     union value *v;             /* The value. */
210     double c;                   /* The number of occurrences of the value. */
211   };
212
213 /* Types of frequency tables. */
214 enum
215   {
216     FRQM_GENERAL,
217     FRQM_INTEGER
218   };
219
220 /* Entire frequency table. */
221 struct freq_tab
222   {
223     int mode;                   /* FRQM_GENERAL or FRQM_INTEGER. */
224
225     /* General mode. */
226     struct hsh_table *data;     /* Undifferentiated data. */
227
228     /* Integer mode. */
229     double *vector;             /* Frequencies proper. */
230     int min, max;               /* The boundaries of the table. */
231     double out_of_range;        /* Sum of weights of out-of-range values. */
232     double sysmis;              /* Sum of weights of SYSMIS values. */
233
234     /* All modes. */
235     struct freq *valid;         /* Valid freqs. */
236     int n_valid;                /* Number of total freqs. */
237
238     struct freq *missing;       /* Missing freqs. */
239     int n_missing;              /* Number of missing freqs. */
240
241     /* Statistics. */
242     double total_cases;         /* Sum of weights of all cases. */
243     double valid_cases;         /* Sum of weights of valid cases. */
244   };
245
246
247 /* Per-variable frequency data. */
248 struct var_freqs
249   {
250     /* Freqency table. */
251     struct freq_tab tab;        /* Frequencies table to use. */
252
253     /* Percentiles. */
254     int n_groups;               /* Number of groups. */
255     double *groups;             /* Groups. */
256
257     /* Statistics. */
258     double stat[frq_n_stats];
259
260     /* Width and format for analysis and display.
261        This is normally the same as "width" and "print" in struct
262        variable, but in SPSS-compatible mode only the first
263        MAX_SHORT_STRING bytes of long string variables are
264        included. */
265     int width;
266     struct fmt_spec print;
267   };
268
269 static inline struct var_freqs *
270 get_var_freqs (const struct variable *v)
271 {
272   return var_get_aux (v);
273 }
274
275 static void determine_charts (void);
276
277 static void calc_stats (struct variable *v, double d[frq_n_stats]);
278
279 static void precalc (const struct ccase *, void *, const struct dataset *);
280 static bool calc (const struct ccase *, void *, const struct dataset *);
281 static bool postcalc (void *, const struct dataset *);
282
283 static void postprocess_freq_tab (struct variable *);
284 static void dump_full (struct variable *);
285 static void dump_condensed (struct variable *);
286 static void dump_statistics (struct variable *, int show_varname);
287 static void cleanup_freq_tab (struct variable *);
288
289 static hsh_hash_func hash_value_numeric, hash_value_alpha;
290 static hsh_compare_func compare_value_numeric_a, compare_value_alpha_a;
291 static hsh_compare_func compare_value_numeric_d, compare_value_alpha_d;
292 static hsh_compare_func compare_freq_numeric_a, compare_freq_alpha_a;
293 static hsh_compare_func compare_freq_numeric_d, compare_freq_alpha_d;
294
295
296 static void do_piechart(const struct variable *var,
297                         const struct freq_tab *frq_tab);
298
299 gsl_histogram * 
300 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var);
301
302
303 \f
304 /* Parser and outline. */
305
306 static int internal_cmd_frequencies (struct lexer *lexer, struct dataset *ds);
307
308 int
309 cmd_frequencies (struct lexer *lexer, struct dataset *ds)
310 {
311   int result;
312
313   int_pool = pool_create ();
314   result = internal_cmd_frequencies (lexer, ds);
315   pool_destroy (int_pool);
316   int_pool=0;
317   pool_destroy (gen_pool);
318   gen_pool=0;
319   free (v_variables);
320   v_variables=0;
321   return result;
322 }
323
324 static int
325 internal_cmd_frequencies (struct lexer *lexer, struct dataset *ds)
326 {
327   int i;
328   bool ok;
329
330   n_percentiles = 0;
331   percentiles = NULL;
332
333   n_variables = 0;
334   v_variables = NULL;
335
336   if (!parse_frequencies (lexer, ds, &cmd, NULL))
337     return CMD_FAILURE;
338
339   if (cmd.onepage_limit == NOT_LONG)
340     cmd.onepage_limit = 50;
341
342   /* Figure out statistics to calculate. */
343   stats = 0;
344   if (cmd.a_statistics[FRQ_ST_DEFAULT] || !cmd.sbc_statistics)
345     stats |= frq_default;
346   if (cmd.a_statistics[FRQ_ST_ALL])
347     stats |= frq_all;
348   if (cmd.sort != FRQ_AVALUE && cmd.sort != FRQ_DVALUE)
349     stats &= ~frq_median;
350   for (i = 0; i < frq_n_stats; i++)
351     if (cmd.a_statistics[st_name[i].st_indx])
352       stats |= BIT_INDEX (i);
353   if (stats & frq_kurt)
354     stats |= frq_sekurt;
355   if (stats & frq_skew)
356     stats |= frq_seskew;
357
358   /* Calculate n_stats. */
359   n_stats = 0;
360   for (i = 0; i < frq_n_stats; i++)
361     if ((stats & BIT_INDEX (i)))
362       n_stats++;
363
364   /* Charting. */
365   determine_charts ();
366   if (chart != GFT_NONE || cmd.sbc_ntiles)
367     cmd.sort = FRQ_AVALUE;
368
369   /* Work out what percentiles need to be calculated */
370   if ( cmd.sbc_percentiles ) 
371     {
372       for ( i = 0 ; i < MAXLISTS ; ++i ) 
373         {
374           int pl;
375           subc_list_double *ptl_list = &cmd.dl_percentiles[i];
376           for ( pl = 0 ; pl < subc_list_double_count(ptl_list); ++pl)
377               add_percentile (subc_list_double_at(ptl_list, pl) / 100.0 );
378         }
379     }
380   if ( cmd.sbc_ntiles ) 
381     {
382       for ( i = 0 ; i < cmd.sbc_ntiles ; ++i ) 
383         {
384           int j;
385           for (j = 0; j <= cmd.n_ntiles[i]; ++j ) 
386               add_percentile (j / (double) cmd.n_ntiles[i]);
387         }
388     }
389   
390
391   /* Do it! */
392   ok = procedure_with_splits (ds, precalc, calc, postcalc, NULL);
393
394   free_frequencies(&cmd);
395
396   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
397 }
398
399 /* Figure out which charts the user requested.  */
400 static void
401 determine_charts (void)
402 {
403   int count = (!!cmd.sbc_histogram) + (!!cmd.sbc_barchart) + 
404     (!!cmd.sbc_hbar) + (!!cmd.sbc_piechart);
405
406   if (!count)
407     {
408       chart = GFT_NONE;
409       return;
410     }
411   else if (count > 1)
412     {
413       chart = GFT_HBAR;
414       msg (SW, _("At most one of BARCHART, HISTOGRAM, or HBAR should be "
415            "given.  HBAR will be assumed.  Argument values will be "
416            "given precedence increasing along the order given."));
417     }
418   else if (cmd.sbc_histogram)
419     chart = GFT_HIST;
420   else if (cmd.sbc_barchart)
421     chart = GFT_BAR;
422   else if (cmd.sbc_piechart)
423     chart = GFT_PIE;
424   else
425     chart = GFT_HBAR;
426
427   min = max = SYSMIS;
428   format = FRQ_FREQ;
429   scale = SYSMIS;
430   incr = SYSMIS;
431   normal = 0;
432
433   if (cmd.sbc_barchart)
434     {
435       if (cmd.ba_min != SYSMIS)
436         min = cmd.ba_min;
437       if (cmd.ba_max != SYSMIS)
438         max = cmd.ba_max;
439       if (cmd.ba_scale == FRQ_FREQ)
440         {
441           format = FRQ_FREQ;
442           scale = cmd.ba_freq;
443         }
444       else if (cmd.ba_scale == FRQ_PERCENT)
445         {
446           format = FRQ_PERCENT;
447           scale = cmd.ba_pcnt;
448         }
449     }
450
451   if (cmd.sbc_histogram)
452     {
453       if (cmd.hi_min != SYSMIS)
454         min = cmd.hi_min;
455       if (cmd.hi_max != SYSMIS)
456         max = cmd.hi_max;
457       if (cmd.hi_scale == FRQ_FREQ)
458         {
459           format = FRQ_FREQ;
460           scale = cmd.hi_freq;
461         }
462       else if (cmd.hi_scale == FRQ_PERCENT)
463         {
464           format = FRQ_PERCENT;
465           scale = cmd.ba_pcnt;
466         }
467       if (cmd.hi_norm != FRQ_NONORMAL )
468         normal = 1;
469       if (cmd.hi_incr == FRQ_INCREMENT)
470         incr = cmd.hi_inc;
471     }
472
473   if (cmd.sbc_hbar)
474     {
475       if (cmd.hb_min != SYSMIS)
476         min = cmd.hb_min;
477       if (cmd.hb_max != SYSMIS)
478         max = cmd.hb_max;
479       if (cmd.hb_scale == FRQ_FREQ)
480         {
481           format = FRQ_FREQ;
482           scale = cmd.hb_freq;
483         }
484       else if (cmd.hb_scale == FRQ_PERCENT)
485         {
486           format = FRQ_PERCENT;
487           scale = cmd.ba_pcnt;
488         }
489       if (cmd.hb_norm)
490         normal = 1;
491       if (cmd.hb_incr == FRQ_INCREMENT)
492         incr = cmd.hb_inc;
493     }
494
495   if (min != SYSMIS && max != SYSMIS && min >= max)
496     {
497       msg (SE, _("MAX must be greater than or equal to MIN, if both are "
498            "specified.  However, MIN was specified as %g and MAX as %g.  "
499            "MIN and MAX will be ignored."), min, max);
500       min = max = SYSMIS;
501     }
502 }
503
504 /* Add data from case C to the frequency table. */
505 static bool
506 calc (const struct ccase *c, void *aux UNUSED, const struct dataset *ds)
507 {
508   double weight;
509   size_t i;
510   bool bad_warn = true;
511
512   weight = dict_get_case_weight (dataset_dict (ds), c, &bad_warn);
513
514   for (i = 0; i < n_variables; i++)
515     {
516       const struct variable *v = v_variables[i];
517       const union value *val = case_data (c, v);
518       struct var_freqs *vf = get_var_freqs (v);
519       struct freq_tab *ft = &vf->tab;
520
521       switch (ft->mode)
522         {
523           case FRQM_GENERAL:
524             {
525               /* General mode. */
526               struct freq target;
527               struct freq **fpp;
528
529               target.v = (union value *) val;
530               fpp = (struct freq **) hsh_probe (ft->data, &target);
531
532               if (*fpp != NULL)
533                 (*fpp)->c += weight;
534               else
535                 {
536                   struct freq *fp = pool_alloc (gen_pool, sizeof *fp);
537                   fp->c = weight;
538                   fp->v = pool_clone (gen_pool,
539                                       val, MAX (MAX_SHORT_STRING, vf->width));
540                   *fpp = fp;
541                 }
542             }
543           break;
544         case FRQM_INTEGER:
545           /* Integer mode. */
546           if (val->f == SYSMIS)
547             ft->sysmis += weight;
548           else if (val->f > INT_MIN+1 && val->f < INT_MAX-1)
549             {
550               int i = val->f;
551               if (i >= ft->min && i <= ft->max)
552                 ft->vector[i - ft->min] += weight;
553             }
554           else
555             ft->out_of_range += weight;
556           break;
557         default:
558           NOT_REACHED ();
559         }
560     }
561   return true;
562 }
563
564 /* Prepares each variable that is the target of FREQUENCIES by setting
565    up its hash table. */
566 static void
567 precalc (const struct ccase *first, void *aux UNUSED, const struct dataset *ds)
568 {
569   size_t i;
570
571   output_split_file_values (ds, first);
572
573   pool_destroy (gen_pool);
574   gen_pool = pool_create ();
575   
576   for (i = 0; i < n_variables; i++)
577     {
578       struct variable *v = v_variables[i];
579       struct freq_tab *ft = &get_var_freqs (v)->tab;
580
581       if (ft->mode == FRQM_GENERAL)
582         {
583           hsh_hash_func *hash;
584           hsh_compare_func *compare;
585
586           if (var_is_numeric (v))
587             {
588               hash = hash_value_numeric;
589               compare = compare_value_numeric_a; 
590             }
591           else 
592             {
593               hash = hash_value_alpha;
594               compare = compare_value_alpha_a;
595             }
596           ft->data = hsh_create (16, compare, hash, NULL, v);
597         }
598       else
599         {
600           int j;
601
602           for (j = (ft->max - ft->min); j >= 0; j--)
603             ft->vector[j] = 0.0;
604           ft->out_of_range = 0.0;
605           ft->sysmis = 0.0;
606         }
607     }
608 }
609
610 /* Finishes up with the variables after frequencies have been
611    calculated.  Displays statistics, percentiles, ... */
612 static bool
613 postcalc (void *aux UNUSED, const struct dataset *ds  UNUSED)
614 {
615   size_t i;
616
617   for (i = 0; i < n_variables; i++)
618     {
619       struct variable *v = v_variables[i];
620       struct var_freqs *vf = get_var_freqs (v);
621       struct freq_tab *ft = &vf->tab;
622       int n_categories;
623       int dumped_freq_tab = 1;
624
625       postprocess_freq_tab (v);
626
627       /* Frequencies tables. */
628       n_categories = ft->n_valid + ft->n_missing;
629       if (cmd.table == FRQ_TABLE
630           || (cmd.table == FRQ_LIMIT && n_categories <= cmd.limit))
631         switch (cmd.cond)
632           {
633           case FRQ_CONDENSE:
634             dump_condensed (v);
635             break;
636           case FRQ_STANDARD:
637             dump_full (v);
638             break;
639           case FRQ_ONEPAGE:
640             if (n_categories > cmd.onepage_limit)
641               dump_condensed (v);
642             else
643               dump_full (v);
644             break;
645           default:
646             NOT_REACHED ();
647           }
648       else
649         dumped_freq_tab = 0;
650
651       /* Statistics. */
652       if (n_stats)
653         dump_statistics (v, !dumped_freq_tab);
654
655
656
657       if ( chart == GFT_HIST) 
658         {
659           double d[frq_n_stats];
660           struct normal_curve norm;
661           gsl_histogram *hist ;
662
663
664           norm.N = vf->tab.valid_cases;
665
666           calc_stats (v, d);
667           norm.mean = d[frq_mean];
668           norm.stddev = d[frq_stddev];
669
670           hist = freq_tab_to_hist(ft,v);
671
672           histogram_plot(hist, var_to_string(v), &norm, normal);
673
674           gsl_histogram_free(hist);
675         }
676
677
678       if ( chart == GFT_PIE) 
679         {
680           do_piechart(v_variables[i], ft);
681         }
682
683
684
685       cleanup_freq_tab (v);
686
687     }
688
689   return true;
690 }
691
692 /* Returns the comparison function that should be used for
693    sorting a frequency table by FRQ_SORT using VAR_TYPE
694    variables. */
695 static hsh_compare_func *
696 get_freq_comparator (int frq_sort, enum var_type var_type) 
697 {
698   bool is_numeric = var_type == VAR_NUMERIC;
699   switch (frq_sort)
700     {
701     case FRQ_AVALUE:
702       return is_numeric ? compare_value_numeric_a : compare_value_alpha_a;
703     case FRQ_DVALUE:
704       return is_numeric ? compare_value_numeric_d : compare_value_alpha_d;
705     case FRQ_AFREQ:
706       return is_numeric ? compare_freq_numeric_a : compare_freq_alpha_a;
707     case FRQ_DFREQ:
708       return is_numeric ? compare_freq_numeric_d : compare_freq_alpha_d;
709     default:
710       NOT_REACHED ();
711     }
712 }
713
714 /* Returns true iff the value in struct freq F is non-missing
715    for variable V. */
716 static bool
717 not_missing (const void *f_, const void *v_) 
718 {
719   const struct freq *f = f_;
720   const struct variable *v = v_;
721
722   return !var_is_value_missing (v, f->v);
723 }
724
725 /* Summarizes the frequency table data for variable V. */
726 static void
727 postprocess_freq_tab (struct variable *v)
728 {
729   hsh_compare_func *compare;
730   struct freq_tab *ft;
731   size_t count;
732   void *const *data;
733   struct freq *freqs, *f;
734   size_t i;
735
736   ft = &get_var_freqs (v)->tab;
737   assert (ft->mode == FRQM_GENERAL);
738   compare = get_freq_comparator (cmd.sort, var_get_type (v));
739
740   /* Extract data from hash table. */
741   count = hsh_count (ft->data);
742   data = hsh_data (ft->data);
743
744   /* Copy dereferenced data into freqs. */
745   freqs = xnmalloc (count, sizeof *freqs);
746   for (i = 0; i < count; i++) 
747     {
748       struct freq *f = data[i];
749       freqs[i] = *f; 
750     }
751
752   /* Put data into ft. */
753   ft->valid = freqs;
754   ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, v);
755   ft->missing = freqs + ft->n_valid;
756   ft->n_missing = count - ft->n_valid;
757
758   /* Sort data. */
759   sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare, v);
760   sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare, v);
761
762   /* Summary statistics. */
763   ft->valid_cases = 0.0;
764   for(i = 0 ;  i < ft->n_valid ; ++i ) 
765     {
766       f = &ft->valid[i];
767       ft->valid_cases += f->c;
768
769     }
770
771   ft->total_cases = ft->valid_cases ; 
772   for(i = 0 ;  i < ft->n_missing ; ++i ) 
773     {
774       f = &ft->missing[i];
775       ft->total_cases += f->c;
776     }
777
778 }
779
780 /* Frees the frequency table for variable V. */
781 static void
782 cleanup_freq_tab (struct variable *v)
783 {
784   struct freq_tab *ft = &get_var_freqs (v)->tab;
785   assert (ft->mode == FRQM_GENERAL);
786   free (ft->valid);
787   hsh_destroy (ft->data);
788 }
789
790 /* Parses the VARIABLES subcommand, adding to
791    {n_variables,v_variables}. */
792 static int
793 frq_custom_variables (struct lexer *lexer, struct dataset *ds, struct cmd_frequencies *cmd UNUSED, void *aux UNUSED)
794 {
795   int mode;
796   int min = 0, max = 0;
797
798   size_t old_n_variables = n_variables;
799   size_t i;
800
801   lex_match (lexer, '=');
802   if (lex_token (lexer) != T_ALL && (lex_token (lexer) != T_ID
803                          || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL))
804     return 2;
805
806   if (!parse_variables (lexer, dataset_dict (ds), &v_variables, &n_variables,
807                         PV_APPEND | PV_NO_SCRATCH))
808     return 0;
809
810   if (!lex_match (lexer, '('))
811     mode = FRQM_GENERAL;
812   else
813     {
814       mode = FRQM_INTEGER;
815       if (!lex_force_int (lexer))
816         return 0;
817       min = lex_integer (lexer);
818       lex_get (lexer);
819       if (!lex_force_match (lexer, ','))
820         return 0;
821       if (!lex_force_int (lexer))
822         return 0;
823       max = lex_integer (lexer);
824       lex_get (lexer);
825       if (!lex_force_match (lexer, ')'))
826         return 0;
827       if (max < min)
828         {
829           msg (SE, _("Upper limit of integer mode value range must be "
830                      "greater than lower limit."));
831           return 0;
832         }
833     }
834
835   for (i = old_n_variables; i < n_variables; i++)
836     {
837       struct variable *v = v_variables[i];
838       struct var_freqs *vf;
839
840       if (var_get_aux (v) != NULL)
841         {
842           msg (SE, _("Variable %s specified multiple times on VARIABLES "
843                      "subcommand."), var_get_name (v));
844           return 0;
845         }
846       if (mode == FRQM_INTEGER && !var_is_numeric (v))
847         {
848           msg (SE, _("Integer mode specified, but %s is not a numeric "
849                      "variable."), var_get_name (v));
850           return 0;
851         }
852
853       vf = var_attach_aux (v, xmalloc (sizeof *vf), var_dtor_free);
854       vf->tab.mode = mode;
855       vf->tab.valid = vf->tab.missing = NULL;
856       if (mode == FRQM_INTEGER)
857         {
858           vf->tab.min = min;
859           vf->tab.max = max;
860           vf->tab.vector = pool_nalloc (int_pool,
861                                         max - min + 1, sizeof *vf->tab.vector);
862         }
863       else 
864         vf->tab.vector = NULL;
865       vf->n_groups = 0;
866       vf->groups = NULL;
867       vf->width = var_get_width (v);
868       vf->print = *var_get_print_format (v);
869       if (vf->width > MAX_SHORT_STRING && get_algorithm () == COMPATIBLE) 
870         {
871           enum fmt_type type = var_get_print_format (v)->type;
872           vf->width = MAX_SHORT_STRING;
873           vf->print.w = MAX_SHORT_STRING * (type == FMT_AHEX ? 2 : 1);
874         }
875     }
876   return 1;
877 }
878
879 /* Parses the GROUPED subcommand, setting the n_grouped, grouped
880    fields of specified variables. */
881 static int
882 frq_custom_grouped (struct lexer *lexer, struct dataset *ds, struct cmd_frequencies *cmd UNUSED, void *aux UNUSED)
883 {
884   lex_match (lexer, '=');
885   if ((lex_token (lexer) == T_ID && dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) != NULL)
886       || lex_token (lexer) == T_ID)
887     for (;;)
888       {
889         size_t i;
890
891         /* Max, current size of list; list itself. */
892         int nl, ml;
893         double *dl;
894
895         /* Variable list. */
896         size_t n;
897         struct variable **v;
898
899         if (!parse_variables (lexer, dataset_dict (ds), &v, &n,
900                               PV_NO_DUPLICATE | PV_NUMERIC))
901           return 0;
902         if (lex_match (lexer, '('))
903           {
904             nl = ml = 0;
905             dl = NULL;
906             while (lex_integer (lexer))
907               {
908                 if (nl >= ml)
909                   {
910                     ml += 16;
911                     dl = pool_nrealloc (int_pool, dl, ml, sizeof *dl);
912                   }
913                 dl[nl++] = lex_tokval (lexer);
914                 lex_get (lexer);
915                 lex_match (lexer, ',');
916               }
917             /* Note that nl might still be 0 and dl might still be
918                NULL.  That's okay. */
919             if (!lex_match (lexer, ')'))
920               {
921                 free (v);
922                 msg (SE, _("`)' expected after GROUPED interval list."));
923                 return 0;
924               }
925           }
926         else 
927           {
928             nl = 0;
929             dl = NULL;
930           }
931
932         for (i = 0; i < n; i++)
933           if (var_get_aux (v[i]) == NULL)
934             msg (SE, _("Variables %s specified on GROUPED but not on "
935                        "VARIABLES."), var_get_name (v[i]));
936           else 
937             {
938               struct var_freqs *vf = get_var_freqs (v[i]);
939                 
940               if (vf->groups != NULL)
941                 msg (SE, _("Variables %s specified multiple times on GROUPED "
942                            "subcommand."), var_get_name (v[i]));
943               else
944                 {
945                   vf->n_groups = nl;
946                   vf->groups = dl;
947                 }
948             }
949         free (v);
950         if (!lex_match (lexer, '/'))
951           break;
952         if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) != NULL)
953             && lex_token (lexer) != T_ALL)
954           {
955             lex_put_back (lexer, '/');
956             break;
957           }
958       }
959
960   return 1;
961 }
962
963 /* Adds X to the list of percentiles, keeping the list in proper
964    order. */
965 static void
966 add_percentile (double x)
967 {
968   int i;
969
970   for (i = 0; i < n_percentiles; i++)
971     {
972       /* Do nothing if it's already in the list */
973       if ( fabs(x - percentiles[i].p) < DBL_EPSILON ) 
974         return;
975
976       if (x < percentiles[i].p)
977         break;
978     }
979
980   if (i >= n_percentiles || x != percentiles[i].p)
981     {
982       percentiles = pool_nrealloc (int_pool, percentiles,
983                                    n_percentiles + 1, sizeof *percentiles);
984
985       if (i < n_percentiles)
986           memmove (&percentiles[i + 1], &percentiles[i],
987                    (n_percentiles - i) * sizeof (struct percentile) );
988
989       percentiles[i].p = x;
990       n_percentiles++;
991     }
992 }
993
994 /* Comparison functions. */
995
996 /* Hash of numeric values. */
997 static unsigned
998 hash_value_numeric (const void *value_, const void *aux UNUSED)
999 {
1000   const struct freq *value = value_;
1001   return hsh_hash_double (value->v[0].f);
1002 }
1003
1004 /* Hash of string values. */
1005 static unsigned
1006 hash_value_alpha (const void *value_, const void *v_)
1007 {
1008   const struct freq *value = value_;
1009   const struct variable *v = v_;
1010   struct var_freqs *vf = get_var_freqs (v);
1011
1012   return hsh_hash_bytes (value->v[0].s, vf->width);
1013 }
1014
1015 /* Ascending numeric compare of values. */
1016 static int
1017 compare_value_numeric_a (const void *a_, const void *b_, const void *aux UNUSED)
1018 {
1019   const struct freq *a = a_;
1020   const struct freq *b = b_;
1021
1022   if (a->v[0].f > b->v[0].f)
1023     return 1;
1024   else if (a->v[0].f < b->v[0].f)
1025     return -1;
1026   else
1027     return 0;
1028 }
1029
1030 /* Ascending string compare of values. */
1031 static int
1032 compare_value_alpha_a (const void *a_, const void *b_, const void *v_)
1033 {
1034   const struct freq *a = a_;
1035   const struct freq *b = b_;
1036   const struct variable *v = v_;
1037   struct var_freqs *vf = get_var_freqs (v);
1038
1039   return memcmp (a->v[0].s, b->v[0].s, vf->width);
1040 }
1041
1042 /* Descending numeric compare of values. */
1043 static int
1044 compare_value_numeric_d (const void *a, const void *b, const void *aux UNUSED)
1045 {
1046   return -compare_value_numeric_a (a, b, aux);
1047 }
1048
1049 /* Descending string compare of values. */
1050 static int
1051 compare_value_alpha_d (const void *a, const void *b, const void *v)
1052 {
1053   return -compare_value_alpha_a (a, b, v);
1054 }
1055
1056 /* Ascending numeric compare of frequency;
1057    secondary key on ascending numeric value. */
1058 static int
1059 compare_freq_numeric_a (const void *a_, const void *b_, const void *aux UNUSED)
1060 {
1061   const struct freq *a = a_;
1062   const struct freq *b = b_;
1063
1064   if (a->c > b->c)
1065     return 1;
1066   else if (a->c < b->c)
1067     return -1;
1068
1069   if (a->v[0].f > b->v[0].f)
1070     return 1;
1071   else if (a->v[0].f < b->v[0].f)
1072     return -1;
1073   else
1074     return 0;
1075 }
1076
1077 /* Ascending numeric compare of frequency;
1078    secondary key on ascending string value. */
1079 static int
1080 compare_freq_alpha_a (const void *a_, const void *b_, const void *v_)
1081 {
1082   const struct freq *a = a_;
1083   const struct freq *b = b_;
1084   const struct variable *v = v_;
1085   struct var_freqs *vf = get_var_freqs (v);
1086
1087   if (a->c > b->c)
1088     return 1;
1089   else if (a->c < b->c)
1090     return -1;
1091   else
1092     return memcmp (a->v[0].s, b->v[0].s, vf->width);
1093 }
1094
1095 /* Descending numeric compare of frequency;
1096    secondary key on ascending numeric value. */
1097 static int
1098 compare_freq_numeric_d (const void *a_, const void *b_, const void *aux UNUSED)
1099 {
1100   const struct freq *a = a_;
1101   const struct freq *b = b_;
1102
1103   if (a->c > b->c)
1104     return -1;
1105   else if (a->c < b->c)
1106     return 1;
1107
1108   if (a->v[0].f > b->v[0].f)
1109     return 1;
1110   else if (a->v[0].f < b->v[0].f)
1111     return -1;
1112   else
1113     return 0;
1114 }
1115
1116 /* Descending numeric compare of frequency;
1117    secondary key on ascending string value. */
1118 static int
1119 compare_freq_alpha_d (const void *a_, const void *b_, const void *v_)
1120 {
1121   const struct freq *a = a_;
1122   const struct freq *b = b_;
1123   const struct variable *v = v_;
1124   struct var_freqs *vf = get_var_freqs (v);
1125
1126   if (a->c > b->c)
1127     return -1;
1128   else if (a->c < b->c)
1129     return 1;
1130   else
1131     return memcmp (a->v[0].s, b->v[0].s, vf->width);
1132 }
1133 \f
1134 /* Frequency table display. */
1135
1136 /* Sets the widths of all the columns and heights of all the rows in
1137    table T for driver D. */
1138 static void
1139 full_dim (struct tab_table *t, struct outp_driver *d)
1140 {
1141   int lab = cmd.labels == FRQ_LABELS;
1142   int i;
1143
1144   if (lab)
1145     t->w[0] = MIN (tab_natural_width (t, d, 0), d->prop_em_width * 15);
1146   for (i = lab; i < lab + 5; i++)
1147     t->w[i] = MAX (tab_natural_width (t, d, i), d->prop_em_width * 8);
1148   for (i = 0; i < t->nr; i++)
1149     t->h[i] = d->font_height;
1150 }
1151
1152 /* Displays a full frequency table for variable V. */
1153 static void
1154 dump_full (struct variable *v)
1155 {
1156   int n_categories;
1157   struct var_freqs *vf;
1158   struct freq_tab *ft;
1159   struct freq *f;
1160   struct tab_table *t;
1161   int r;
1162   double cum_total = 0.0;
1163   double cum_freq = 0.0;
1164
1165   struct init
1166     {
1167       int c, r;
1168       const char *s;
1169     };
1170
1171   const struct init *p;
1172
1173   static const struct init vec[] =
1174   {
1175     {4, 0, N_("Valid")},
1176     {5, 0, N_("Cum")},
1177     {1, 1, N_("Value")},
1178     {2, 1, N_("Frequency")},
1179     {3, 1, N_("Percent")},
1180     {4, 1, N_("Percent")},
1181     {5, 1, N_("Percent")},
1182     {0, 0, NULL},
1183     {1, 0, NULL},
1184     {2, 0, NULL},
1185     {3, 0, NULL},
1186     {-1, -1, NULL},
1187   };
1188
1189   int lab = cmd.labels == FRQ_LABELS;
1190
1191   vf = get_var_freqs (v);
1192   ft = &vf->tab;
1193   n_categories = ft->n_valid + ft->n_missing;
1194   t = tab_create (5 + lab, n_categories + 3, 0);
1195   tab_headers (t, 0, 0, 2, 0);
1196   tab_dim (t, full_dim);
1197
1198   if (lab)
1199     tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value Label"));
1200   for (p = vec; p->s; p++)
1201     tab_text (t, p->c - (p->r ? !lab : 0), p->r,
1202                   TAB_CENTER | TAT_TITLE, gettext (p->s));
1203
1204   r = 2;
1205   for (f = ft->valid; f < ft->missing; f++)
1206     {
1207       double percent, valid_percent;
1208
1209       cum_freq += f->c;
1210
1211       percent = f->c / ft->total_cases * 100.0;
1212       valid_percent = f->c / ft->valid_cases * 100.0;
1213       cum_total += valid_percent;
1214
1215       if (lab)
1216         {
1217           const char *label = var_lookup_value_label (v, &f->v[0]);
1218           if (label != NULL)
1219             tab_text (t, 0, r, TAB_LEFT, label);
1220         }
1221
1222       tab_value (t, 0 + lab, r, TAB_NONE, f->v, &vf->print);
1223       tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1224       tab_float (t, 2 + lab, r, TAB_NONE, percent, 5, 1);
1225       tab_float (t, 3 + lab, r, TAB_NONE, valid_percent, 5, 1);
1226       tab_float (t, 4 + lab, r, TAB_NONE, cum_total, 5, 1);
1227       r++;
1228     }
1229   for (; f < &ft->valid[n_categories]; f++)
1230     {
1231       cum_freq += f->c;
1232
1233       if (lab)
1234         {
1235           const char *label = var_lookup_value_label (v, &f->v[0]);
1236           if (label != NULL)
1237             tab_text (t, 0, r, TAB_LEFT, label);
1238         }
1239
1240       tab_value (t, 0 + lab, r, TAB_NONE, f->v, &vf->print);
1241       tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1242       tab_float (t, 2 + lab, r, TAB_NONE,
1243                      f->c / ft->total_cases * 100.0, 5, 1);
1244       tab_text (t, 3 + lab, r, TAB_NONE, _("Missing"));
1245       r++;
1246     }
1247
1248   tab_box (t, TAL_1, TAL_1,
1249            cmd.spaces == FRQ_SINGLE ? -1 : TAL_GAP, TAL_1,
1250            0, 0, 4 + lab, r);
1251   tab_hline (t, TAL_2, 0, 4 + lab, 2);
1252   tab_hline (t, TAL_2, 0, 4 + lab, r);
1253   tab_joint_text (t, 0, r, 0 + lab, r, TAB_RIGHT | TAT_TITLE, _("Total"));
1254   tab_vline (t, TAL_0, 1, r, r);
1255   tab_float (t, 1 + lab, r, TAB_NONE, cum_freq, 8, 0);
1256   tab_float (t, 2 + lab, r, TAB_NONE, 100.0, 5, 1);
1257   tab_float (t, 3 + lab, r, TAB_NONE, 100.0, 5, 1);
1258
1259   tab_title (t, "%s", var_to_string (v));
1260   tab_submit (t);
1261 }
1262
1263 /* Sets the widths of all the columns and heights of all the rows in
1264    table T for driver D. */
1265 static void
1266 condensed_dim (struct tab_table *t, struct outp_driver *d)
1267 {
1268   int cum_w = MAX (outp_string_width (d, _("Cum"), OUTP_PROPORTIONAL),
1269                    MAX (outp_string_width (d, _("Cum"), OUTP_PROPORTIONAL),
1270                         outp_string_width (d, "000", OUTP_PROPORTIONAL)));
1271
1272   int i;
1273
1274   for (i = 0; i < 2; i++)
1275     t->w[i] = MAX (tab_natural_width (t, d, i), d->prop_em_width * 8);
1276   for (i = 2; i < 4; i++)
1277     t->w[i] = cum_w;
1278   for (i = 0; i < t->nr; i++)
1279     t->h[i] = d->font_height;
1280 }
1281
1282 /* Display condensed frequency table for variable V. */
1283 static void
1284 dump_condensed (struct variable *v)
1285 {
1286   int n_categories;
1287   struct var_freqs *vf;
1288   struct freq_tab *ft;
1289   struct freq *f;
1290   struct tab_table *t;
1291   int r;
1292   double cum_total = 0.0;
1293
1294   vf = get_var_freqs (v);
1295   ft = &vf->tab;
1296   n_categories = ft->n_valid + ft->n_missing;
1297   t = tab_create (4, n_categories + 2, 0);
1298
1299   tab_headers (t, 0, 0, 2, 0);
1300   tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value"));
1301   tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Freq"));
1302   tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1303   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Cum"));
1304   tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1305   tab_dim (t, condensed_dim);
1306
1307   r = 2;
1308   for (f = ft->valid; f < ft->missing; f++)
1309     {
1310       double percent;
1311
1312       percent = f->c / ft->total_cases * 100.0;
1313       cum_total += f->c / ft->valid_cases * 100.0;
1314
1315       tab_value (t, 0, r, TAB_NONE, f->v, &vf->print);
1316       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1317       tab_float (t, 2, r, TAB_NONE, percent, 3, 0);
1318       tab_float (t, 3, r, TAB_NONE, cum_total, 3, 0);
1319       r++;
1320     }
1321   for (; f < &ft->valid[n_categories]; f++)
1322     {
1323       tab_value (t, 0, r, TAB_NONE, f->v, &vf->print);
1324       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1325       tab_float (t, 2, r, TAB_NONE,
1326                  f->c / ft->total_cases * 100.0, 3, 0);
1327       r++;
1328     }
1329
1330   tab_box (t, TAL_1, TAL_1,
1331            cmd.spaces == FRQ_SINGLE ? -1 : TAL_GAP, TAL_1,
1332            0, 0, 3, r - 1);
1333   tab_hline (t, TAL_2, 0, 3, 2);
1334   tab_title (t, "%s", var_to_string (v));
1335   tab_columns (t, SOM_COL_DOWN, 1);
1336   tab_submit (t);
1337 }
1338 \f
1339 /* Statistical display. */
1340
1341 /* Calculates all the pertinent statistics for variable V, putting
1342    them in array D[].  FIXME: This could be made much more optimal. */
1343 static void
1344 calc_stats (struct variable *v, double d[frq_n_stats])
1345 {
1346   struct freq_tab *ft = &get_var_freqs (v)->tab;
1347   double W = ft->valid_cases;
1348   struct moments *m;
1349   struct freq *f=0; 
1350   int most_often;
1351   double X_mode;
1352
1353   double rank;
1354   int i = 0;
1355   int idx;
1356   double *median_value;
1357
1358   /* Calculate percentiles. */
1359
1360   /* If the 50th percentile was not explicitly requested then we must 
1361      calculate it anyway --- it's the median */
1362   median_value = 0 ;
1363   for (i = 0; i < n_percentiles; i++) 
1364     {
1365       if (percentiles[i].p == 0.5)
1366         {
1367           median_value = &percentiles[i].value;
1368           break;
1369         }
1370     }
1371
1372   if ( 0 == median_value )  
1373     {
1374       add_percentile (0.5);
1375       implicit_50th = 1;
1376     }
1377
1378   for (i = 0; i < n_percentiles; i++) 
1379     {
1380       percentiles[i].flag = 0;
1381       percentiles[i].flag2 = 0;
1382     }
1383
1384   rank = 0;
1385   for (idx = 0; idx < ft->n_valid; ++idx)
1386     {
1387       static double prev_value = SYSMIS;
1388       f = &ft->valid[idx]; 
1389       rank += f->c ;
1390       for (i = 0; i < n_percentiles; i++) 
1391         {
1392           double tp;
1393           if ( percentiles[i].flag2  ) continue ; 
1394
1395           if ( get_algorithm() != COMPATIBLE ) 
1396             tp = 
1397               (ft->valid_cases - 1) *  percentiles[i].p;
1398           else
1399             tp = 
1400               (ft->valid_cases + 1) *  percentiles[i].p - 1;
1401
1402           if ( percentiles[i].flag ) 
1403             {
1404               percentiles[i].x2 = f->v[0].f;
1405               percentiles[i].x1 = prev_value;
1406               percentiles[i].flag2 = 1;
1407               continue;
1408             }
1409
1410           if (rank >  tp ) 
1411           {
1412             if ( f->c > 1 && rank - (f->c - 1) > tp ) 
1413               {
1414                 percentiles[i].x2 = percentiles[i].x1 = f->v[0].f;
1415                 percentiles[i].flag2 = 1;
1416               }
1417             else
1418               {
1419                 percentiles[i].flag=1;
1420               }
1421
1422             continue;
1423           }
1424         }
1425       prev_value = f->v[0].f;
1426     }
1427
1428   for (i = 0; i < n_percentiles; i++) 
1429     {
1430       /* Catches the case when p == 100% */
1431       if ( ! percentiles[i].flag2 ) 
1432         percentiles[i].x1 = percentiles[i].x2 = f->v[0].f;
1433
1434       /*
1435       printf("percentile %d (p==%.2f); X1 = %g; X2 = %g\n",
1436              i,percentiles[i].p,percentiles[i].x1,percentiles[i].x2);
1437       */
1438     }
1439
1440   for (i = 0; i < n_percentiles; i++) 
1441     {
1442       struct freq_tab *ft = &get_var_freqs (v)->tab;
1443       double s;
1444
1445       double dummy;
1446       if ( get_algorithm() != COMPATIBLE ) 
1447         {
1448           s = modf((ft->valid_cases - 1) * percentiles[i].p , &dummy);
1449         }
1450       else
1451         {
1452           s = modf((ft->valid_cases + 1) * percentiles[i].p -1, &dummy);
1453         }
1454
1455       percentiles[i].value = percentiles[i].x1 + 
1456         ( percentiles[i].x2 - percentiles[i].x1) * s ; 
1457
1458       if ( percentiles[i].p == 0.50) 
1459         median_value = &percentiles[i].value; 
1460     }
1461
1462
1463   /* Calculate the mode. */
1464   most_often = -1;
1465   X_mode = SYSMIS;
1466   for (f = ft->valid; f < ft->missing; f++)
1467     {
1468       if (most_often < f->c) 
1469         {
1470           most_often = f->c;
1471           X_mode = f->v[0].f;
1472         }
1473       else if (most_often == f->c) 
1474         {
1475           /* A duplicate mode is undefined.
1476              FIXME: keep track of *all* the modes. */
1477           X_mode = SYSMIS;
1478         }
1479     }
1480
1481   /* Calculate moments. */
1482   m = moments_create (MOMENT_KURTOSIS);
1483   for (f = ft->valid; f < ft->missing; f++)
1484     moments_pass_one (m, f->v[0].f, f->c);
1485   for (f = ft->valid; f < ft->missing; f++)
1486     moments_pass_two (m, f->v[0].f, f->c);
1487   moments_calculate (m, NULL, &d[frq_mean], &d[frq_variance],
1488                      &d[frq_skew], &d[frq_kurt]);
1489   moments_destroy (m);
1490                      
1491   /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1492   d[frq_min] = ft->valid[0].v[0].f;
1493   d[frq_max] = ft->valid[ft->n_valid - 1].v[0].f;
1494   d[frq_mode] = X_mode;
1495   d[frq_range] = d[frq_max] - d[frq_min];
1496   d[frq_median] = *median_value;
1497   d[frq_sum] = d[frq_mean] * W;
1498   d[frq_stddev] = sqrt (d[frq_variance]);
1499   d[frq_semean] = d[frq_stddev] / sqrt (W);
1500   d[frq_seskew] = calc_seskew (W);
1501   d[frq_sekurt] = calc_sekurt (W);
1502 }
1503
1504 /* Displays a table of all the statistics requested for variable V. */
1505 static void
1506 dump_statistics (struct variable *v, int show_varname)
1507 {
1508   struct freq_tab *ft;
1509   double stat_value[frq_n_stats];
1510   struct tab_table *t;
1511   int i, r;
1512
1513   int n_explicit_percentiles = n_percentiles;
1514
1515   if ( implicit_50th && n_percentiles > 0 ) 
1516     --n_percentiles;
1517
1518   if (var_is_alpha (v))
1519     return;
1520   ft = &get_var_freqs (v)->tab;
1521   if (ft->n_valid == 0)
1522     {
1523       msg (SW, _("No valid data for variable %s; statistics not displayed."),
1524            var_get_name (v));
1525       return;
1526     }
1527   calc_stats (v, stat_value);
1528
1529   t = tab_create (3, n_stats + n_explicit_percentiles + 2, 0);
1530   tab_dim (t, tab_natural_dimensions);
1531
1532   tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1533
1534
1535   tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1536   tab_vline (t, TAL_GAP , 1, 0, tab_nr(t) - 1 ) ;
1537   
1538   r=2; /* N missing and N valid are always dumped */
1539
1540   for (i = 0; i < frq_n_stats; i++)
1541     if (stats & BIT_INDEX (i))
1542       {
1543         tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1544                       gettext (st_name[i].s10));
1545         tab_float (t, 2, r, TAB_NONE, stat_value[i], 11, 3);
1546         r++;
1547       }
1548
1549   tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("N"));
1550   tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Valid"));
1551   tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Missing"));
1552
1553   tab_float(t, 2, 0, TAB_NONE, ft->valid_cases, 11, 0);
1554   tab_float(t, 2, 1, TAB_NONE, ft->total_cases - ft->valid_cases, 11, 0);
1555
1556
1557   for (i = 0; i < n_explicit_percentiles; i++, r++) 
1558     {
1559       if ( i == 0 ) 
1560         { 
1561           tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
1562         }
1563
1564       tab_float (t, 1, r, TAB_LEFT, percentiles[i].p * 100, 3, 0 );
1565       tab_float (t, 2, r, TAB_NONE, percentiles[i].value, 11, 3);
1566
1567     }
1568
1569   tab_columns (t, SOM_COL_DOWN, 1);
1570   if (show_varname)
1571     tab_title (t, "%s", var_to_string (v));
1572   else
1573     tab_flags (t, SOMF_NO_TITLE);
1574
1575
1576   tab_submit (t);
1577 }
1578
1579
1580 /* Create a gsl_histogram from a freq_tab */
1581 gsl_histogram *
1582 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var)
1583 {
1584   int i;
1585   double x_min = DBL_MAX;
1586   double x_max = -DBL_MAX;
1587
1588   gsl_histogram *hist;
1589   const double bins = 11;
1590
1591   struct hsh_iterator hi;
1592   struct hsh_table *fh = ft->data;
1593   struct freq *frq;
1594
1595   /* Find out the extremes of the x value */
1596   for ( frq = hsh_first(fh, &hi); frq != 0; frq = hsh_next(fh, &hi) ) 
1597     {
1598       if ( var_is_value_missing(var, frq->v))
1599         continue;
1600
1601       if ( frq->v[0].f < x_min ) x_min = frq->v[0].f ;
1602       if ( frq->v[0].f > x_max ) x_max = frq->v[0].f ;
1603     }
1604
1605   hist = histogram_create(bins, x_min, x_max);
1606
1607   for( i = 0 ; i < ft->n_valid ; ++i ) 
1608     {
1609       frq = &ft->valid[i];
1610       gsl_histogram_accumulate(hist, frq->v[0].f, frq->c);
1611     }
1612
1613   return hist;
1614 }
1615
1616
1617 static struct slice *
1618 freq_tab_to_slice_array(const struct freq_tab *frq_tab, 
1619                         const struct variable *var,
1620                         int *n_slices);
1621
1622
1623 /* Allocate an array of slices and fill them from the data in frq_tab
1624    n_slices will contain the number of slices allocated.
1625    The caller is responsible for freeing slices
1626 */
1627 static struct slice *
1628 freq_tab_to_slice_array(const struct freq_tab *frq_tab, 
1629                         const struct variable *var,
1630                         int *n_slices)
1631 {
1632   int i;
1633   struct slice *slices;
1634
1635   *n_slices = frq_tab->n_valid;
1636   
1637   slices = xnmalloc (*n_slices, sizeof *slices);
1638
1639   for (i = 0 ; i < *n_slices ; ++i ) 
1640     {
1641       const struct freq *frq = &frq_tab->valid[i];
1642
1643       slices[i].label = var_get_value_name (var, frq->v);
1644
1645       slices[i].magnetude = frq->c;
1646     }
1647
1648   return slices;
1649 }
1650
1651
1652
1653
1654 static void
1655 do_piechart(const struct variable *var, const struct freq_tab *frq_tab)
1656 {
1657   struct slice *slices;
1658   int n_slices;
1659
1660   slices = freq_tab_to_slice_array(frq_tab, var, &n_slices);
1661
1662   piechart_plot(var_to_string(var), slices, n_slices);
1663
1664   free(slices);
1665 }
1666
1667
1668 /* 
1669    Local Variables:
1670    mode: c
1671    End:
1672 */