More constness/namespace policing
[pspp-builds.git] / src / language / stats / frequencies.q
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 /*
21   TODO:
22
23   * Remember that histograms, bar charts need mean, stddev.
24 */
25
26 #include <config.h>
27
28 #include <math.h>
29 #include <stdlib.h>
30 #include <gsl/gsl_histogram.h>
31
32 #include <data/case.h>
33 #include <data/dictionary.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 (struct variable *v)
271 {
272   assert (v != NULL);
273   assert (v->aux != NULL);
274   return v->aux;
275 }
276
277 static void determine_charts (void);
278
279 static void calc_stats (struct variable *v, double d[frq_n_stats]);
280
281 static void precalc (const struct ccase *, void *);
282 static bool calc (const struct ccase *, void *);
283 static void postcalc (void *);
284
285 static void postprocess_freq_tab (struct variable *);
286 static void dump_full (struct variable *);
287 static void dump_condensed (struct variable *);
288 static void dump_statistics (struct variable *, int show_varname);
289 static void cleanup_freq_tab (struct variable *);
290
291 static hsh_hash_func hash_value_numeric, hash_value_alpha;
292 static hsh_compare_func compare_value_numeric_a, compare_value_alpha_a;
293 static hsh_compare_func compare_value_numeric_d, compare_value_alpha_d;
294 static hsh_compare_func compare_freq_numeric_a, compare_freq_alpha_a;
295 static hsh_compare_func compare_freq_numeric_d, compare_freq_alpha_d;
296
297
298 static void do_piechart(const struct variable *var,
299                         const struct freq_tab *frq_tab);
300
301 gsl_histogram * 
302 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var);
303
304
305 \f
306 /* Parser and outline. */
307
308 static int internal_cmd_frequencies (void);
309
310 int
311 cmd_frequencies (void)
312 {
313   int result;
314
315   int_pool = pool_create ();
316   result = internal_cmd_frequencies ();
317   pool_destroy (int_pool);
318   int_pool=0;
319   pool_destroy (gen_pool);
320   gen_pool=0;
321   free (v_variables);
322   v_variables=0;
323   return result;
324 }
325
326 static int
327 internal_cmd_frequencies (void)
328 {
329   int i;
330   bool ok;
331
332   n_percentiles = 0;
333   percentiles = NULL;
334
335   n_variables = 0;
336   v_variables = NULL;
337
338   if (!parse_frequencies (&cmd, NULL))
339     return CMD_FAILURE;
340
341   if (cmd.onepage_limit == NOT_LONG)
342     cmd.onepage_limit = 50;
343
344   /* Figure out statistics to calculate. */
345   stats = 0;
346   if (cmd.a_statistics[FRQ_ST_DEFAULT] || !cmd.sbc_statistics)
347     stats |= frq_default;
348   if (cmd.a_statistics[FRQ_ST_ALL])
349     stats |= frq_all;
350   if (cmd.sort != FRQ_AVALUE && cmd.sort != FRQ_DVALUE)
351     stats &= ~frq_median;
352   for (i = 0; i < frq_n_stats; i++)
353     if (cmd.a_statistics[st_name[i].st_indx])
354       stats |= BIT_INDEX (i);
355   if (stats & frq_kurt)
356     stats |= frq_sekurt;
357   if (stats & frq_skew)
358     stats |= frq_seskew;
359
360   /* Calculate n_stats. */
361   n_stats = 0;
362   for (i = 0; i < frq_n_stats; i++)
363     if ((stats & BIT_INDEX (i)))
364       n_stats++;
365
366   /* Charting. */
367   determine_charts ();
368   if (chart != GFT_NONE || cmd.sbc_ntiles)
369     cmd.sort = FRQ_AVALUE;
370
371   /* Work out what percentiles need to be calculated */
372   if ( cmd.sbc_percentiles ) 
373     {
374       for ( i = 0 ; i < MAXLISTS ; ++i ) 
375         {
376           int pl;
377           subc_list_double *ptl_list = &cmd.dl_percentiles[i];
378           for ( pl = 0 ; pl < subc_list_double_count(ptl_list); ++pl)
379               add_percentile(subc_list_double_at(ptl_list,pl) / 100.0 );
380         }
381     }
382   if ( cmd.sbc_ntiles ) 
383     {
384       for ( i = 0 ; i < cmd.sbc_ntiles ; ++i ) 
385         {
386           int j;
387           for (j = 0; j <= cmd.n_ntiles[i]; ++j ) 
388               add_percentile(j / (double) cmd.n_ntiles[i]);
389         }
390     }
391   
392
393   /* Do it! */
394   ok = procedure_with_splits (current_dataset, precalc, calc, postcalc, NULL);
395
396   free_frequencies(&cmd);
397
398   return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
399 }
400
401 /* Figure out which charts the user requested.  */
402 static void
403 determine_charts (void)
404 {
405   int count = (!!cmd.sbc_histogram) + (!!cmd.sbc_barchart) + 
406     (!!cmd.sbc_hbar) + (!!cmd.sbc_piechart);
407
408   if (!count)
409     {
410       chart = GFT_NONE;
411       return;
412     }
413   else if (count > 1)
414     {
415       chart = GFT_HBAR;
416       msg (SW, _("At most one of BARCHART, HISTOGRAM, or HBAR should be "
417            "given.  HBAR will be assumed.  Argument values will be "
418            "given precedence increasing along the order given."));
419     }
420   else if (cmd.sbc_histogram)
421     chart = GFT_HIST;
422   else if (cmd.sbc_barchart)
423     chart = GFT_BAR;
424   else if (cmd.sbc_piechart)
425     chart = GFT_PIE;
426   else
427     chart = GFT_HBAR;
428
429   min = max = SYSMIS;
430   format = FRQ_FREQ;
431   scale = SYSMIS;
432   incr = SYSMIS;
433   normal = 0;
434
435   if (cmd.sbc_barchart)
436     {
437       if (cmd.ba_min != SYSMIS)
438         min = cmd.ba_min;
439       if (cmd.ba_max != SYSMIS)
440         max = cmd.ba_max;
441       if (cmd.ba_scale == FRQ_FREQ)
442         {
443           format = FRQ_FREQ;
444           scale = cmd.ba_freq;
445         }
446       else if (cmd.ba_scale == FRQ_PERCENT)
447         {
448           format = FRQ_PERCENT;
449           scale = cmd.ba_pcnt;
450         }
451     }
452
453   if (cmd.sbc_histogram)
454     {
455       if (cmd.hi_min != SYSMIS)
456         min = cmd.hi_min;
457       if (cmd.hi_max != SYSMIS)
458         max = cmd.hi_max;
459       if (cmd.hi_scale == FRQ_FREQ)
460         {
461           format = FRQ_FREQ;
462           scale = cmd.hi_freq;
463         }
464       else if (cmd.hi_scale == FRQ_PERCENT)
465         {
466           format = FRQ_PERCENT;
467           scale = cmd.ba_pcnt;
468         }
469       if (cmd.hi_norm != FRQ_NONORMAL )
470         normal = 1;
471       if (cmd.hi_incr == FRQ_INCREMENT)
472         incr = cmd.hi_inc;
473     }
474
475   if (cmd.sbc_hbar)
476     {
477       if (cmd.hb_min != SYSMIS)
478         min = cmd.hb_min;
479       if (cmd.hb_max != SYSMIS)
480         max = cmd.hb_max;
481       if (cmd.hb_scale == FRQ_FREQ)
482         {
483           format = FRQ_FREQ;
484           scale = cmd.hb_freq;
485         }
486       else if (cmd.hb_scale == FRQ_PERCENT)
487         {
488           format = FRQ_PERCENT;
489           scale = cmd.ba_pcnt;
490         }
491       if (cmd.hb_norm)
492         normal = 1;
493       if (cmd.hb_incr == FRQ_INCREMENT)
494         incr = cmd.hb_inc;
495     }
496
497   if (min != SYSMIS && max != SYSMIS && min >= max)
498     {
499       msg (SE, _("MAX must be greater than or equal to MIN, if both are "
500            "specified.  However, MIN was specified as %g and MAX as %g.  "
501            "MIN and MAX will be ignored."), min, max);
502       min = max = SYSMIS;
503     }
504 }
505
506 /* Add data from case C to the frequency table. */
507 static bool
508 calc (const struct ccase *c, void *aux UNUSED)
509 {
510   double weight;
511   size_t i;
512   bool bad_warn = true;
513
514   weight = dict_get_case_weight (dataset_dict (current_dataset), c, &bad_warn);
515
516   for (i = 0; i < n_variables; i++)
517     {
518       struct variable *v = v_variables[i];
519       const union value *val = case_data (c, v->fv);
520       struct var_freqs *vf = get_var_freqs (v);
521       struct freq_tab *ft = &vf->tab;
522
523       switch (ft->mode)
524         {
525           case FRQM_GENERAL:
526             {
527               /* General mode. */
528               struct freq target;
529               struct freq **fpp;
530
531               target.v = (union value *) val;
532               fpp = (struct freq **) hsh_probe (ft->data, &target);
533
534               if (*fpp != NULL)
535                 (*fpp)->c += weight;
536               else
537                 {
538                   struct freq *fp = pool_alloc (gen_pool, sizeof *fp);
539                   fp->c = weight;
540                   fp->v = pool_clone (gen_pool,
541                                       val, MAX (MAX_SHORT_STRING, vf->width));
542                   *fpp = fp;
543                 }
544             }
545           break;
546         case FRQM_INTEGER:
547           /* Integer mode. */
548           if (val->f == SYSMIS)
549             ft->sysmis += weight;
550           else if (val->f > INT_MIN+1 && val->f < INT_MAX-1)
551             {
552               int i = val->f;
553               if (i >= ft->min && i <= ft->max)
554                 ft->vector[i - ft->min] += weight;
555             }
556           else
557             ft->out_of_range += weight;
558           break;
559         default:
560           NOT_REACHED ();
561         }
562     }
563   return true;
564 }
565
566 /* Prepares each variable that is the target of FREQUENCIES by setting
567    up its hash table. */
568 static void
569 precalc (const struct ccase *first, void *aux UNUSED)
570 {
571   size_t i;
572
573   output_split_file_values (first);
574
575   pool_destroy (gen_pool);
576   gen_pool = pool_create ();
577   
578   for (i = 0; i < n_variables; i++)
579     {
580       struct variable *v = v_variables[i];
581       struct freq_tab *ft = &get_var_freqs (v)->tab;
582
583       if (ft->mode == FRQM_GENERAL)
584         {
585           hsh_hash_func *hash;
586           hsh_compare_func *compare;
587
588           if (v->type == NUMERIC) 
589             {
590               hash = hash_value_numeric;
591               compare = compare_value_numeric_a; 
592             }
593           else 
594             {
595               hash = hash_value_alpha;
596               compare = compare_value_alpha_a;
597             }
598           ft->data = hsh_create (16, compare, hash, NULL, v);
599         }
600       else
601         {
602           int j;
603
604           for (j = (ft->max - ft->min); j >= 0; j--)
605             ft->vector[j] = 0.0;
606           ft->out_of_range = 0.0;
607           ft->sysmis = 0.0;
608         }
609     }
610 }
611
612 /* Finishes up with the variables after frequencies have been
613    calculated.  Displays statistics, percentiles, ... */
614 static void
615 postcalc (void *aux UNUSED)
616 {
617   size_t i;
618
619   for (i = 0; i < n_variables; i++)
620     {
621       struct variable *v = v_variables[i];
622       struct var_freqs *vf = get_var_freqs (v);
623       struct freq_tab *ft = &vf->tab;
624       int n_categories;
625       int dumped_freq_tab = 1;
626
627       postprocess_freq_tab (v);
628
629       /* Frequencies tables. */
630       n_categories = ft->n_valid + ft->n_missing;
631       if (cmd.table == FRQ_TABLE
632           || (cmd.table == FRQ_LIMIT && n_categories <= cmd.limit))
633         switch (cmd.cond)
634           {
635           case FRQ_CONDENSE:
636             dump_condensed (v);
637             break;
638           case FRQ_STANDARD:
639             dump_full (v);
640             break;
641           case FRQ_ONEPAGE:
642             if (n_categories > cmd.onepage_limit)
643               dump_condensed (v);
644             else
645               dump_full (v);
646             break;
647           default:
648             NOT_REACHED ();
649           }
650       else
651         dumped_freq_tab = 0;
652
653       /* Statistics. */
654       if (n_stats)
655         dump_statistics (v, !dumped_freq_tab);
656
657
658
659       if ( chart == GFT_HIST) 
660         {
661           double d[frq_n_stats];
662           struct normal_curve norm;
663           gsl_histogram *hist ;
664
665
666           norm.N = vf->tab.valid_cases;
667
668           calc_stats(v,d);
669           norm.mean = d[frq_mean];
670           norm.stddev = d[frq_stddev];
671
672           hist = freq_tab_to_hist(ft,v);
673
674           histogram_plot(hist, var_to_string(v), &norm, normal);
675
676           gsl_histogram_free(hist);
677         }
678
679
680       if ( chart == GFT_PIE) 
681         {
682           do_piechart(v_variables[i], ft);
683         }
684
685
686
687       cleanup_freq_tab (v);
688
689     }
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, int var_type) 
697 {
698   /* Note that q2c generates tags beginning with 1000. */
699   switch (frq_sort | (var_type << 16))
700     {
701     case FRQ_AVALUE | (NUMERIC << 16):  return compare_value_numeric_a;
702     case FRQ_AVALUE | (ALPHA << 16):    return compare_value_alpha_a;
703     case FRQ_DVALUE | (NUMERIC << 16):  return compare_value_numeric_d;
704     case FRQ_DVALUE | (ALPHA << 16):    return compare_value_alpha_d;
705     case FRQ_AFREQ | (NUMERIC << 16):   return compare_freq_numeric_a;
706     case FRQ_AFREQ | (ALPHA << 16):     return compare_freq_alpha_a;
707     case FRQ_DFREQ | (NUMERIC << 16):   return compare_freq_numeric_d;
708     case FRQ_DFREQ | (ALPHA << 16):     return compare_freq_alpha_d;
709     default: NOT_REACHED ();
710     }
711
712   return 0;
713 }
714
715 /* Returns true iff the value in struct freq F is non-missing
716    for variable V. */
717 static bool
718 not_missing (const void *f_, void *v_) 
719 {
720   const struct freq *f = f_;
721   struct variable *v = v_;
722
723   return !mv_is_value_missing (&v->miss, f->v);
724 }
725
726 /* Summarizes the frequency table data for variable V. */
727 static void
728 postprocess_freq_tab (struct variable *v)
729 {
730   hsh_compare_func *compare;
731   struct freq_tab *ft;
732   size_t count;
733   void *const *data;
734   struct freq *freqs, *f;
735   size_t i;
736
737   ft = &get_var_freqs (v)->tab;
738   assert (ft->mode == FRQM_GENERAL);
739   compare = get_freq_comparator (cmd.sort, v->type);
740
741   /* Extract data from hash table. */
742   count = hsh_count (ft->data);
743   data = hsh_data (ft->data);
744
745   /* Copy dereferenced data into freqs. */
746   freqs = xnmalloc (count, sizeof *freqs);
747   for (i = 0; i < count; i++) 
748     {
749       struct freq *f = data[i];
750       freqs[i] = *f; 
751     }
752
753   /* Put data into ft. */
754   ft->valid = freqs;
755   ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, v);
756   ft->missing = freqs + ft->n_valid;
757   ft->n_missing = count - ft->n_valid;
758
759   /* Sort data. */
760   sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare, v);
761   sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare, v);
762
763   /* Summary statistics. */
764   ft->valid_cases = 0.0;
765   for(i = 0 ;  i < ft->n_valid ; ++i ) 
766     {
767       f = &ft->valid[i];
768       ft->valid_cases += f->c;
769
770     }
771
772   ft->total_cases = ft->valid_cases ; 
773   for(i = 0 ;  i < ft->n_missing ; ++i ) 
774     {
775       f = &ft->missing[i];
776       ft->total_cases += f->c;
777     }
778
779 }
780
781 /* Frees the frequency table for variable V. */
782 static void
783 cleanup_freq_tab (struct variable *v)
784 {
785   struct freq_tab *ft = &get_var_freqs (v)->tab;
786   assert (ft->mode == FRQM_GENERAL);
787   free (ft->valid);
788   hsh_destroy (ft->data);
789 }
790
791 /* Parses the VARIABLES subcommand, adding to
792    {n_variables,v_variables}. */
793 static int
794 frq_custom_variables (struct cmd_frequencies *cmd UNUSED, void *aux UNUSED)
795 {
796   int mode;
797   int min = 0, max = 0;
798
799   size_t old_n_variables = n_variables;
800   size_t i;
801
802   lex_match ('=');
803   if (token != T_ALL && (token != T_ID
804                          || dict_lookup_var (dataset_dict (current_dataset), tokid) == NULL))
805     return 2;
806
807   if (!parse_variables (dataset_dict (current_dataset), &v_variables, &n_variables,
808                         PV_APPEND | PV_NO_SCRATCH))
809     return 0;
810
811   if (!lex_match ('('))
812     mode = FRQM_GENERAL;
813   else
814     {
815       mode = FRQM_INTEGER;
816       if (!lex_force_int ())
817         return 0;
818       min = lex_integer ();
819       lex_get ();
820       if (!lex_force_match (','))
821         return 0;
822       if (!lex_force_int ())
823         return 0;
824       max = lex_integer ();
825       lex_get ();
826       if (!lex_force_match (')'))
827         return 0;
828       if (max < min)
829         {
830           msg (SE, _("Upper limit of integer mode value range must be "
831                      "greater than lower limit."));
832           return 0;
833         }
834     }
835
836   for (i = old_n_variables; i < n_variables; i++)
837     {
838       struct variable *v = v_variables[i];
839       struct var_freqs *vf;
840
841       if (v->aux != NULL)
842         {
843           msg (SE, _("Variable %s specified multiple times on VARIABLES "
844                      "subcommand."), v->name);
845           return 0;
846         }
847       if (mode == FRQM_INTEGER && v->type != NUMERIC)
848         {
849           msg (SE, _("Integer mode specified, but %s is not a numeric "
850                      "variable."), v->name);
851           return 0;
852         }
853
854       vf = var_attach_aux (v, xmalloc (sizeof *vf), var_dtor_free);
855       vf->tab.mode = mode;
856       vf->tab.valid = vf->tab.missing = NULL;
857       if (mode == FRQM_INTEGER)
858         {
859           vf->tab.min = min;
860           vf->tab.max = max;
861           vf->tab.vector = pool_nalloc (int_pool,
862                                         max - min + 1, sizeof *vf->tab.vector);
863         }
864       else 
865         vf->tab.vector = NULL;
866       vf->n_groups = 0;
867       vf->groups = NULL;
868       vf->width = v->width;
869       vf->print = v->print;
870       if (vf->width > MAX_SHORT_STRING && get_algorithm () == COMPATIBLE) 
871         {
872           vf->width = MAX_SHORT_STRING;
873           vf->print.w = MAX_SHORT_STRING * (v->print.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 cmd_frequencies *cmd UNUSED, void *aux UNUSED)
883 {
884   lex_match ('=');
885   if ((token == T_ID && dict_lookup_var (dataset_dict (current_dataset), tokid) != NULL)
886       || token == 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 (dataset_dict (current_dataset), &v, &n,
900                               PV_NO_DUPLICATE | PV_NUMERIC))
901           return 0;
902         if (lex_match ('('))
903           {
904             nl = ml = 0;
905             dl = NULL;
906             while (lex_integer ())
907               {
908                 if (nl >= ml)
909                   {
910                     ml += 16;
911                     dl = pool_nrealloc (int_pool, dl, ml, sizeof *dl);
912                   }
913                 dl[nl++] = tokval;
914                 lex_get ();
915                 lex_match (',');
916               }
917             /* Note that nl might still be 0 and dl might still be
918                NULL.  That's okay. */
919             if (!lex_match (')'))
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 (v[i]->aux == NULL)
934             msg (SE, _("Variables %s specified on GROUPED but not on "
935                        "VARIABLES."), v[i]->name);
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."), v[i]->name);
943               else
944                 {
945                   vf->n_groups = nl;
946                   vf->groups = dl;
947                 }
948             }
949         free (v);
950         if (!lex_match ('/'))
951           break;
952         if ((token != T_ID || dict_lookup_var (dataset_dict (current_dataset), tokid) != NULL)
953             && token != T_ALL)
954           {
955             lex_put_back ('/');
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 || tokval != 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_, void *foo 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_, void *v_)
1007 {
1008   const struct freq *value = value_;
1009   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_, void *foo 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_, void *v_)
1033 {
1034   const struct freq *a = a_;
1035   const struct freq *b = b_;
1036   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, void *foo UNUSED)
1045 {
1046   return -compare_value_numeric_a (a, b, foo);
1047 }
1048
1049 /* Descending string compare of values. */
1050 static int
1051 compare_value_alpha_d (const void *a, const void *b, 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_, void *foo 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_, void *v_)
1081 {
1082   const struct freq *a = a_;
1083   const struct freq *b = b_;
1084   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_, void *foo 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_, void *v_)
1120 {
1121   const struct freq *a = a_;
1122   const struct freq *b = b_;
1123   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 = val_labs_find (v->val_labs, 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 = val_labs_find (v->val_labs, 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: %s", v->name, v->label ? v->label : "");
1260   tab_submit (t);
1261
1262 }
1263
1264 /* Sets the widths of all the columns and heights of all the rows in
1265    table T for driver D. */
1266 static void
1267 condensed_dim (struct tab_table *t, struct outp_driver *d)
1268 {
1269   int cum_w = max (outp_string_width (d, _("Cum"), OUTP_PROPORTIONAL),
1270                    max (outp_string_width (d, _("Cum"), OUTP_PROPORTIONAL),
1271                         outp_string_width (d, "000", OUTP_PROPORTIONAL)));
1272
1273   int i;
1274
1275   for (i = 0; i < 2; i++)
1276     t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
1277   for (i = 2; i < 4; i++)
1278     t->w[i] = cum_w;
1279   for (i = 0; i < t->nr; i++)
1280     t->h[i] = d->font_height;
1281 }
1282
1283 /* Display condensed frequency table for variable V. */
1284 static void
1285 dump_condensed (struct variable *v)
1286 {
1287   int n_categories;
1288   struct var_freqs *vf;
1289   struct freq_tab *ft;
1290   struct freq *f;
1291   struct tab_table *t;
1292   int r;
1293   double cum_total = 0.0;
1294
1295   vf = get_var_freqs (v);
1296   ft = &vf->tab;
1297   n_categories = ft->n_valid + ft->n_missing;
1298   t = tab_create (4, n_categories + 2, 0);
1299
1300   tab_headers (t, 0, 0, 2, 0);
1301   tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value"));
1302   tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Freq"));
1303   tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1304   tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Cum"));
1305   tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1306   tab_dim (t, condensed_dim);
1307
1308   r = 2;
1309   for (f = ft->valid; f < ft->missing; f++)
1310     {
1311       double percent;
1312
1313       percent = f->c / ft->total_cases * 100.0;
1314       cum_total += f->c / ft->valid_cases * 100.0;
1315
1316       tab_value (t, 0, r, TAB_NONE, f->v, &vf->print);
1317       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1318       tab_float (t, 2, r, TAB_NONE, percent, 3, 0);
1319       tab_float (t, 3, r, TAB_NONE, cum_total, 3, 0);
1320       r++;
1321     }
1322   for (; f < &ft->valid[n_categories]; f++)
1323     {
1324       tab_value (t, 0, r, TAB_NONE, f->v, &vf->print);
1325       tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1326       tab_float (t, 2, r, TAB_NONE,
1327                  f->c / ft->total_cases * 100.0, 3, 0);
1328       r++;
1329     }
1330
1331   tab_box (t, TAL_1, TAL_1,
1332            cmd.spaces == FRQ_SINGLE ? -1 : TAL_GAP, TAL_1,
1333            0, 0, 3, r - 1);
1334   tab_hline (t, TAL_2, 0, 3, 2);
1335   tab_title (t, "%s: %s", v->name, v->label ? v->label : "");
1336   tab_columns (t, SOM_COL_DOWN, 1);
1337   tab_submit (t);
1338 }
1339 \f
1340 /* Statistical display. */
1341
1342 /* Calculates all the pertinent statistics for variable V, putting
1343    them in array D[].  FIXME: This could be made much more optimal. */
1344 static void
1345 calc_stats (struct variable *v, double d[frq_n_stats])
1346 {
1347   struct freq_tab *ft = &get_var_freqs (v)->tab;
1348   double W = ft->valid_cases;
1349   struct moments *m;
1350   struct freq *f=0; 
1351   int most_often;
1352   double X_mode;
1353
1354   double rank;
1355   int i = 0;
1356   int idx;
1357   double *median_value;
1358
1359   /* Calculate percentiles. */
1360
1361   /* If the 50th percentile was not explicitly requested then we must 
1362      calculate it anyway --- it's the median */
1363   median_value = 0 ;
1364   for (i = 0; i < n_percentiles; i++) 
1365     {
1366       if (percentiles[i].p == 0.5)
1367         {
1368           median_value = &percentiles[i].value;
1369           break;
1370         }
1371     }
1372
1373   if ( 0 == median_value )  
1374     {
1375       add_percentile (0.5);
1376       implicit_50th = 1;
1377     }
1378
1379   for (i = 0; i < n_percentiles; i++) 
1380     {
1381       percentiles[i].flag = 0;
1382       percentiles[i].flag2 = 0;
1383     }
1384
1385   rank = 0;
1386   for (idx = 0; idx < ft->n_valid; ++idx)
1387     {
1388       static double prev_value = SYSMIS;
1389       f = &ft->valid[idx]; 
1390       rank += f->c ;
1391       for (i = 0; i < n_percentiles; i++) 
1392         {
1393           double tp;
1394           if ( percentiles[i].flag2  ) continue ; 
1395
1396           if ( get_algorithm() != COMPATIBLE ) 
1397             tp = 
1398               (ft->valid_cases - 1) *  percentiles[i].p;
1399           else
1400             tp = 
1401               (ft->valid_cases + 1) *  percentiles[i].p - 1;
1402
1403           if ( percentiles[i].flag ) 
1404             {
1405               percentiles[i].x2 = f->v[0].f;
1406               percentiles[i].x1 = prev_value;
1407               percentiles[i].flag2 = 1;
1408               continue;
1409             }
1410
1411           if (rank >  tp ) 
1412           {
1413             if ( f->c > 1 && rank - (f->c - 1) > tp ) 
1414               {
1415                 percentiles[i].x2 = percentiles[i].x1 = f->v[0].f;
1416                 percentiles[i].flag2 = 1;
1417               }
1418             else
1419               {
1420                 percentiles[i].flag=1;
1421               }
1422
1423             continue;
1424           }
1425         }
1426       prev_value = f->v[0].f;
1427     }
1428
1429   for (i = 0; i < n_percentiles; i++) 
1430     {
1431       /* Catches the case when p == 100% */
1432       if ( ! percentiles[i].flag2 ) 
1433         percentiles[i].x1 = percentiles[i].x2 = f->v[0].f;
1434
1435       /*
1436       printf("percentile %d (p==%.2f); X1 = %g; X2 = %g\n",
1437              i,percentiles[i].p,percentiles[i].x1,percentiles[i].x2);
1438       */
1439     }
1440
1441   for (i = 0; i < n_percentiles; i++) 
1442     {
1443       struct freq_tab *ft = &get_var_freqs (v)->tab;
1444       double s;
1445
1446       double dummy;
1447       if ( get_algorithm() != COMPATIBLE ) 
1448         {
1449           s = modf((ft->valid_cases - 1) * percentiles[i].p , &dummy);
1450         }
1451       else
1452         {
1453           s = modf((ft->valid_cases + 1) * percentiles[i].p -1, &dummy);
1454         }
1455
1456       percentiles[i].value = percentiles[i].x1 + 
1457         ( percentiles[i].x2 - percentiles[i].x1) * s ; 
1458
1459       if ( percentiles[i].p == 0.50) 
1460         median_value = &percentiles[i].value; 
1461     }
1462
1463
1464   /* Calculate the mode. */
1465   most_often = -1;
1466   X_mode = SYSMIS;
1467   for (f = ft->valid; f < ft->missing; f++)
1468     {
1469       if (most_often < f->c) 
1470         {
1471           most_often = f->c;
1472           X_mode = f->v[0].f;
1473         }
1474       else if (most_often == f->c) 
1475         {
1476           /* A duplicate mode is undefined.
1477              FIXME: keep track of *all* the modes. */
1478           X_mode = SYSMIS;
1479         }
1480     }
1481
1482   /* Calculate moments. */
1483   m = moments_create (MOMENT_KURTOSIS);
1484   for (f = ft->valid; f < ft->missing; f++)
1485     moments_pass_one (m, f->v[0].f, f->c);
1486   for (f = ft->valid; f < ft->missing; f++)
1487     moments_pass_two (m, f->v[0].f, f->c);
1488   moments_calculate (m, NULL, &d[frq_mean], &d[frq_variance],
1489                      &d[frq_skew], &d[frq_kurt]);
1490   moments_destroy (m);
1491                      
1492   /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1493   d[frq_min] = ft->valid[0].v[0].f;
1494   d[frq_max] = ft->valid[ft->n_valid - 1].v[0].f;
1495   d[frq_mode] = X_mode;
1496   d[frq_range] = d[frq_max] - d[frq_min];
1497   d[frq_median] = *median_value;
1498   d[frq_sum] = d[frq_mean] * W;
1499   d[frq_stddev] = sqrt (d[frq_variance]);
1500   d[frq_semean] = d[frq_stddev] / sqrt (W);
1501   d[frq_seskew] = calc_seskew (W);
1502   d[frq_sekurt] = calc_sekurt (W);
1503 }
1504
1505 /* Displays a table of all the statistics requested for variable V. */
1506 static void
1507 dump_statistics (struct variable *v, int show_varname)
1508 {
1509   struct freq_tab *ft;
1510   double stat_value[frq_n_stats];
1511   struct tab_table *t;
1512   int i, r;
1513
1514   int n_explicit_percentiles = n_percentiles;
1515
1516   if ( implicit_50th && n_percentiles > 0 ) 
1517     --n_percentiles;
1518
1519   if (v->type == ALPHA)
1520     return;
1521   ft = &get_var_freqs (v)->tab;
1522   if (ft->n_valid == 0)
1523     {
1524       msg (SW, _("No valid data for variable %s; statistics not displayed."),
1525            v->name);
1526       return;
1527     }
1528   calc_stats (v, stat_value);
1529
1530   t = tab_create (3, n_stats + n_explicit_percentiles + 2, 0);
1531   tab_dim (t, tab_natural_dimensions);
1532
1533   tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1534
1535
1536   tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1537   tab_vline (t, TAL_GAP , 1, 0, tab_nr(t) - 1 ) ;
1538   
1539   r=2; /* N missing and N valid are always dumped */
1540
1541   for (i = 0; i < frq_n_stats; i++)
1542     if (stats & BIT_INDEX (i))
1543       {
1544         tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1545                       gettext (st_name[i].s10));
1546         tab_float (t, 2, r, TAB_NONE, stat_value[i], 11, 3);
1547         r++;
1548       }
1549
1550   tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("N"));
1551   tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Valid"));
1552   tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Missing"));
1553
1554   tab_float(t, 2, 0, TAB_NONE, ft->valid_cases, 11, 0);
1555   tab_float(t, 2, 1, TAB_NONE, ft->total_cases - ft->valid_cases, 11, 0);
1556
1557
1558   for (i = 0; i < n_explicit_percentiles; i++, r++) 
1559     {
1560       if ( i == 0 ) 
1561         { 
1562           tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
1563         }
1564
1565       tab_float (t, 1, r, TAB_LEFT, percentiles[i].p * 100, 3, 0 );
1566       tab_float (t, 2, r, TAB_NONE, percentiles[i].value, 11, 3);
1567
1568     }
1569
1570   tab_columns (t, SOM_COL_DOWN, 1);
1571   if (show_varname)
1572     {
1573       if (v->label)
1574         tab_title (t, "%s: %s", v->name, v->label);
1575       else
1576         tab_title (t, "%s", v->name);
1577     }
1578   else
1579     tab_flags (t, SOMF_NO_TITLE);
1580
1581
1582   tab_submit (t);
1583 }
1584
1585
1586 /* Create a gsl_histogram from a freq_tab */
1587 gsl_histogram *
1588 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var)
1589 {
1590   int i;
1591   double x_min = DBL_MAX;
1592   double x_max = -DBL_MAX;
1593
1594   gsl_histogram *hist;
1595   const double bins = 11;
1596
1597   struct hsh_iterator hi;
1598   struct hsh_table *fh = ft->data;
1599   struct freq *frq;
1600
1601   /* Find out the extremes of the x value */
1602   for ( frq = hsh_first(fh, &hi); frq != 0; frq = hsh_next(fh, &hi) ) 
1603     {
1604       if ( mv_is_value_missing(&var->miss, frq->v))
1605         continue;
1606
1607       if ( frq->v[0].f < x_min ) x_min = frq->v[0].f ;
1608       if ( frq->v[0].f > x_max ) x_max = frq->v[0].f ;
1609     }
1610
1611   hist = histogram_create(bins, x_min, x_max);
1612
1613   for( i = 0 ; i < ft->n_valid ; ++i ) 
1614     {
1615       frq = &ft->valid[i];
1616       gsl_histogram_accumulate(hist, frq->v[0].f, frq->c);
1617     }
1618
1619   return hist;
1620 }
1621
1622
1623 static struct slice *
1624 freq_tab_to_slice_array(const struct freq_tab *frq_tab, 
1625                         const struct variable *var,
1626                         int *n_slices);
1627
1628
1629 /* Allocate an array of slices and fill them from the data in frq_tab
1630    n_slices will contain the number of slices allocated.
1631    The caller is responsible for freeing slices
1632 */
1633 static struct slice *
1634 freq_tab_to_slice_array(const struct freq_tab *frq_tab, 
1635                         const struct variable *var,
1636                         int *n_slices)
1637 {
1638   int i;
1639   struct slice *slices;
1640
1641   *n_slices = frq_tab->n_valid;
1642   
1643   slices = xnmalloc (*n_slices, sizeof *slices);
1644
1645   for (i = 0 ; i < *n_slices ; ++i ) 
1646     {
1647       const struct freq *frq = &frq_tab->valid[i];
1648
1649       slices[i].label = value_to_string(frq->v, var);
1650
1651       slices[i].magnetude = frq->c;
1652     }
1653
1654   return slices;
1655 }
1656
1657
1658
1659
1660 static void
1661 do_piechart(const struct variable *var, const struct freq_tab *frq_tab)
1662 {
1663   struct slice *slices;
1664   int n_slices;
1665
1666   slices = freq_tab_to_slice_array(frq_tab, var, &n_slices);
1667
1668   piechart_plot(var_to_string(var), slices, n_slices);
1669
1670   free(slices);
1671 }
1672
1673
1674 /* 
1675    Local Variables:
1676    mode: c
1677    End:
1678 */