1 /* PSPP - computes sample statistics.
2 Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3 Written by Ben Pfaff <blp@gnu.org>.
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.
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.
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
23 * Remember that histograms, bar charts need mean, stddev.
30 #include <gsl/gsl_histogram.h>
32 #include <data/case.h>
33 #include <data/dictionary.h>
34 #include <data/format.h>
35 #include <data/procedure.h>
36 #include <data/settings.h>
37 #include <data/value-labels.h>
38 #include <data/variable.h>
39 #include <language/command.h>
40 #include <language/dictionary/split-file.h>
41 #include <language/lexer/lexer.h>
42 #include <libpspp/alloc.h>
43 #include <libpspp/array.h>
44 #include <libpspp/bit-vector.h>
45 #include <libpspp/compiler.h>
46 #include <libpspp/hash.h>
47 #include <libpspp/magic.h>
48 #include <libpspp/message.h>
49 #include <libpspp/message.h>
50 #include <libpspp/misc.h>
51 #include <libpspp/pool.h>
52 #include <libpspp/str.h>
53 #include <math/histogram.h>
54 #include <math/moments.h>
55 #include <output/chart.h>
56 #include <output/charts/piechart.h>
57 #include <output/charts/plot-hist.h>
58 #include <output/manager.h>
59 #include <output/output.h>
60 #include <output/table.h>
65 #define _(msgid) gettext (msgid)
66 #define N_(msgid) msgid
73 +format=cond:condense/onepage(*n:onepage_limit,"%s>=0")/!standard,
74 table:limit(n:limit,"%s>0")/notable/!table,
75 labels:!labels/nolabels,
76 sort:!avalue/dvalue/afreq/dfreq,
77 spaces:!single/double,
78 paging:newpage/!oldpage;
79 missing=miss:include/!exclude;
80 barchart(ba_)=:minimum(d:min),
82 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0");
83 piechart(pie_)=:minimum(d:min),
85 missing:missing/!nomissing;
86 histogram(hi_)=:minimum(d:min),
88 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
89 norm:!nonormal/normal,
90 incr:increment(d:inc,"%s>0");
91 hbar(hb_)=:minimum(d:min),
93 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
94 norm:!nonormal/normal,
95 incr:increment(d:inc,"%s>0");
98 +percentiles = double list;
99 +statistics[st_]=1|mean,2|semean,3|median,4|mode,5|stddev,6|variance,
100 7|kurtosis,8|skewness,9|range,10|minimum,11|maximum,12|sum,
101 13|default,14|seskewness,15|sekurtosis,all,none.
109 frq_mean = 0, frq_semean, frq_median, frq_mode, frq_stddev, frq_variance,
110 frq_kurt, frq_sekurt, frq_skew, frq_seskew, frq_range, frq_min, frq_max,
114 /* Description of a statistic. */
117 int st_indx; /* Index into a_statistics[]. */
118 const char *s10; /* Identifying string. */
121 /* Table of statistics, indexed by dsc_*. */
122 static const struct frq_info st_name[frq_n_stats + 1] =
124 {FRQ_ST_MEAN, N_("Mean")},
125 {FRQ_ST_SEMEAN, N_("S.E. Mean")},
126 {FRQ_ST_MEDIAN, N_("Median")},
127 {FRQ_ST_MODE, N_("Mode")},
128 {FRQ_ST_STDDEV, N_("Std Dev")},
129 {FRQ_ST_VARIANCE, N_("Variance")},
130 {FRQ_ST_KURTOSIS, N_("Kurtosis")},
131 {FRQ_ST_SEKURTOSIS, N_("S.E. Kurt")},
132 {FRQ_ST_SKEWNESS, N_("Skewness")},
133 {FRQ_ST_SESKEWNESS, N_("S.E. Skew")},
134 {FRQ_ST_RANGE, N_("Range")},
135 {FRQ_ST_MINIMUM, N_("Minimum")},
136 {FRQ_ST_MAXIMUM, N_("Maximum")},
137 {FRQ_ST_SUM, N_("Sum")},
141 /* Percentiles to calculate. */
145 double p; /* the %ile to be calculated */
146 double value; /* the %ile's value */
147 double x1; /* The datum value <= the percentile */
148 double x2; /* The datum value >= the percentile */
150 int flag2; /* Set to 1 if this percentile value has been found */
154 static void add_percentile (double x) ;
156 static struct percentile *percentiles;
157 static int n_percentiles;
159 static int implicit_50th ;
161 /* Groups of statistics. */
163 #define frq_default \
164 (BI (frq_mean) | BI (frq_stddev) | BI (frq_min) | BI (frq_max))
166 (BI (frq_sum) | BI(frq_min) | BI(frq_max) \
167 | BI(frq_mean) | BI(frq_semean) | BI(frq_stddev) \
168 | BI(frq_variance) | BI(frq_kurt) | BI(frq_sekurt) \
169 | BI(frq_skew) | BI(frq_seskew) | BI(frq_range) \
170 | BI(frq_range) | BI(frq_mode) | BI(frq_median))
172 /* Statistics; number of statistics. */
173 static unsigned long stats;
176 /* Types of graphs. */
179 GFT_NONE, /* Don't draw graphs. */
180 GFT_BAR, /* Draw bar charts. */
181 GFT_HIST, /* Draw histograms. */
182 GFT_PIE, /* Draw piechart */
183 GFT_HBAR /* Draw bar charts or histograms at our discretion. */
186 /* Parsed command. */
187 static struct cmd_frequencies cmd;
189 /* Summary of the barchart, histogram, and hbar subcommands. */
190 /* FIXME: These should not be mututally exclusive */
191 static int chart; /* NONE/BAR/HIST/HBAR/PIE. */
192 static double min, max; /* Minimum, maximum on y axis. */
193 static int format; /* FREQ/PERCENT: Scaling of y axis. */
194 static double scale, incr; /* FIXME */
195 static int normal; /* FIXME */
197 /* Variables for which to calculate statistics. */
198 static size_t n_variables;
199 static struct variable **v_variables;
201 /* Arenas used to store semi-permanent storage. */
202 static struct pool *int_pool; /* Integer mode. */
203 static struct pool *gen_pool; /* General mode. */
205 /* Frequency tables. */
207 /* Frequency table entry. */
210 union value *v; /* The value. */
211 double c; /* The number of occurrences of the value. */
214 /* Types of frequency tables. */
221 /* Entire frequency table. */
224 int mode; /* FRQM_GENERAL or FRQM_INTEGER. */
227 struct hsh_table *data; /* Undifferentiated data. */
230 double *vector; /* Frequencies proper. */
231 int min, max; /* The boundaries of the table. */
232 double out_of_range; /* Sum of weights of out-of-range values. */
233 double sysmis; /* Sum of weights of SYSMIS values. */
236 struct freq *valid; /* Valid freqs. */
237 int n_valid; /* Number of total freqs. */
239 struct freq *missing; /* Missing freqs. */
240 int n_missing; /* Number of missing freqs. */
243 double total_cases; /* Sum of weights of all cases. */
244 double valid_cases; /* Sum of weights of valid cases. */
248 /* Per-variable frequency data. */
251 /* Freqency table. */
252 struct freq_tab tab; /* Frequencies table to use. */
255 int n_groups; /* Number of groups. */
256 double *groups; /* Groups. */
259 double stat[frq_n_stats];
261 /* Width and format for analysis and display.
262 This is normally the same as "width" and "print" in struct
263 variable, but in SPSS-compatible mode only the first
264 MAX_SHORT_STRING bytes of long string variables are
267 struct fmt_spec print;
270 static inline struct var_freqs *
271 get_var_freqs (const struct variable *v)
273 return var_get_aux (v);
276 static void determine_charts (void);
278 static void calc_stats (struct variable *v, double d[frq_n_stats]);
280 static void precalc (const struct ccase *, void *, const struct dataset *);
281 static bool calc (const struct ccase *, void *, const struct dataset *);
282 static bool postcalc (void *, const struct dataset *);
284 static void postprocess_freq_tab (struct variable *);
285 static void dump_full (struct variable *);
286 static void dump_condensed (struct variable *);
287 static void dump_statistics (struct variable *, int show_varname);
288 static void cleanup_freq_tab (struct variable *);
290 static hsh_hash_func hash_value_numeric, hash_value_alpha;
291 static hsh_compare_func compare_value_numeric_a, compare_value_alpha_a;
292 static hsh_compare_func compare_value_numeric_d, compare_value_alpha_d;
293 static hsh_compare_func compare_freq_numeric_a, compare_freq_alpha_a;
294 static hsh_compare_func compare_freq_numeric_d, compare_freq_alpha_d;
297 static void do_piechart(const struct variable *var,
298 const struct freq_tab *frq_tab);
301 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var);
305 /* Parser and outline. */
307 static int internal_cmd_frequencies (struct lexer *lexer, struct dataset *ds);
310 cmd_frequencies (struct lexer *lexer, struct dataset *ds)
314 int_pool = pool_create ();
315 result = internal_cmd_frequencies (lexer, ds);
316 pool_destroy (int_pool);
318 pool_destroy (gen_pool);
326 internal_cmd_frequencies (struct lexer *lexer, struct dataset *ds)
337 if (!parse_frequencies (lexer, ds, &cmd, NULL))
340 if (cmd.onepage_limit == NOT_LONG)
341 cmd.onepage_limit = 50;
343 /* Figure out statistics to calculate. */
345 if (cmd.a_statistics[FRQ_ST_DEFAULT] || !cmd.sbc_statistics)
346 stats |= frq_default;
347 if (cmd.a_statistics[FRQ_ST_ALL])
349 if (cmd.sort != FRQ_AVALUE && cmd.sort != FRQ_DVALUE)
350 stats &= ~frq_median;
351 for (i = 0; i < frq_n_stats; i++)
352 if (cmd.a_statistics[st_name[i].st_indx])
353 stats |= BIT_INDEX (i);
354 if (stats & frq_kurt)
356 if (stats & frq_skew)
359 /* Calculate n_stats. */
361 for (i = 0; i < frq_n_stats; i++)
362 if ((stats & BIT_INDEX (i)))
367 if (chart != GFT_NONE || cmd.sbc_ntiles)
368 cmd.sort = FRQ_AVALUE;
370 /* Work out what percentiles need to be calculated */
371 if ( cmd.sbc_percentiles )
373 for ( i = 0 ; i < MAXLISTS ; ++i )
376 subc_list_double *ptl_list = &cmd.dl_percentiles[i];
377 for ( pl = 0 ; pl < subc_list_double_count(ptl_list); ++pl)
378 add_percentile (subc_list_double_at(ptl_list, pl) / 100.0 );
381 if ( cmd.sbc_ntiles )
383 for ( i = 0 ; i < cmd.sbc_ntiles ; ++i )
386 for (j = 0; j <= cmd.n_ntiles[i]; ++j )
387 add_percentile (j / (double) cmd.n_ntiles[i]);
393 ok = procedure_with_splits (ds, precalc, calc, postcalc, NULL);
395 free_frequencies(&cmd);
397 return ok ? CMD_SUCCESS : CMD_CASCADING_FAILURE;
400 /* Figure out which charts the user requested. */
402 determine_charts (void)
404 int count = (!!cmd.sbc_histogram) + (!!cmd.sbc_barchart) +
405 (!!cmd.sbc_hbar) + (!!cmd.sbc_piechart);
415 msg (SW, _("At most one of BARCHART, HISTOGRAM, or HBAR should be "
416 "given. HBAR will be assumed. Argument values will be "
417 "given precedence increasing along the order given."));
419 else if (cmd.sbc_histogram)
421 else if (cmd.sbc_barchart)
423 else if (cmd.sbc_piechart)
434 if (cmd.sbc_barchart)
436 if (cmd.ba_min != SYSMIS)
438 if (cmd.ba_max != SYSMIS)
440 if (cmd.ba_scale == FRQ_FREQ)
445 else if (cmd.ba_scale == FRQ_PERCENT)
447 format = FRQ_PERCENT;
452 if (cmd.sbc_histogram)
454 if (cmd.hi_min != SYSMIS)
456 if (cmd.hi_max != SYSMIS)
458 if (cmd.hi_scale == FRQ_FREQ)
463 else if (cmd.hi_scale == FRQ_PERCENT)
465 format = FRQ_PERCENT;
468 if (cmd.hi_norm != FRQ_NONORMAL )
470 if (cmd.hi_incr == FRQ_INCREMENT)
476 if (cmd.hb_min != SYSMIS)
478 if (cmd.hb_max != SYSMIS)
480 if (cmd.hb_scale == FRQ_FREQ)
485 else if (cmd.hb_scale == FRQ_PERCENT)
487 format = FRQ_PERCENT;
492 if (cmd.hb_incr == FRQ_INCREMENT)
496 if (min != SYSMIS && max != SYSMIS && min >= max)
498 msg (SE, _("MAX must be greater than or equal to MIN, if both are "
499 "specified. However, MIN was specified as %g and MAX as %g. "
500 "MIN and MAX will be ignored."), min, max);
505 /* Add data from case C to the frequency table. */
507 calc (const struct ccase *c, void *aux UNUSED, const struct dataset *ds)
511 bool bad_warn = true;
513 weight = dict_get_case_weight (dataset_dict (ds), c, &bad_warn);
515 for (i = 0; i < n_variables; i++)
517 const struct variable *v = v_variables[i];
518 const union value *val = case_data (c, v);
519 struct var_freqs *vf = get_var_freqs (v);
520 struct freq_tab *ft = &vf->tab;
530 target.v = (union value *) val;
531 fpp = (struct freq **) hsh_probe (ft->data, &target);
537 struct freq *fp = pool_alloc (gen_pool, sizeof *fp);
539 fp->v = pool_clone (gen_pool,
540 val, MAX (MAX_SHORT_STRING, vf->width));
547 if (val->f == SYSMIS)
548 ft->sysmis += weight;
549 else if (val->f > INT_MIN+1 && val->f < INT_MAX-1)
552 if (i >= ft->min && i <= ft->max)
553 ft->vector[i - ft->min] += weight;
556 ft->out_of_range += weight;
565 /* Prepares each variable that is the target of FREQUENCIES by setting
566 up its hash table. */
568 precalc (const struct ccase *first, void *aux UNUSED, const struct dataset *ds)
572 output_split_file_values (ds, first);
574 pool_destroy (gen_pool);
575 gen_pool = pool_create ();
577 for (i = 0; i < n_variables; i++)
579 struct variable *v = v_variables[i];
580 struct freq_tab *ft = &get_var_freqs (v)->tab;
582 if (ft->mode == FRQM_GENERAL)
585 hsh_compare_func *compare;
587 if (var_is_numeric (v))
589 hash = hash_value_numeric;
590 compare = compare_value_numeric_a;
594 hash = hash_value_alpha;
595 compare = compare_value_alpha_a;
597 ft->data = hsh_create (16, compare, hash, NULL, v);
603 for (j = (ft->max - ft->min); j >= 0; j--)
605 ft->out_of_range = 0.0;
611 /* Finishes up with the variables after frequencies have been
612 calculated. Displays statistics, percentiles, ... */
614 postcalc (void *aux UNUSED, const struct dataset *ds UNUSED)
618 for (i = 0; i < n_variables; i++)
620 struct variable *v = v_variables[i];
621 struct var_freqs *vf = get_var_freqs (v);
622 struct freq_tab *ft = &vf->tab;
624 int dumped_freq_tab = 1;
626 postprocess_freq_tab (v);
628 /* Frequencies tables. */
629 n_categories = ft->n_valid + ft->n_missing;
630 if (cmd.table == FRQ_TABLE
631 || (cmd.table == FRQ_LIMIT && n_categories <= cmd.limit))
641 if (n_categories > cmd.onepage_limit)
654 dump_statistics (v, !dumped_freq_tab);
658 if ( chart == GFT_HIST)
660 double d[frq_n_stats];
661 struct normal_curve norm;
662 gsl_histogram *hist ;
665 norm.N = vf->tab.valid_cases;
668 norm.mean = d[frq_mean];
669 norm.stddev = d[frq_stddev];
671 hist = freq_tab_to_hist(ft,v);
673 histogram_plot(hist, var_to_string(v), &norm, normal);
675 gsl_histogram_free(hist);
679 if ( chart == GFT_PIE)
681 do_piechart(v_variables[i], ft);
686 cleanup_freq_tab (v);
693 /* Returns the comparison function that should be used for
694 sorting a frequency table by FRQ_SORT using VAR_TYPE
696 static hsh_compare_func *
697 get_freq_comparator (int frq_sort, enum var_type var_type)
699 bool is_numeric = var_type == VAR_NUMERIC;
703 return is_numeric ? compare_value_numeric_a : compare_value_alpha_a;
705 return is_numeric ? compare_value_numeric_d : compare_value_alpha_d;
707 return is_numeric ? compare_freq_numeric_a : compare_freq_alpha_a;
709 return is_numeric ? compare_freq_numeric_d : compare_freq_alpha_d;
715 /* Returns true iff the value in struct freq F is non-missing
718 not_missing (const void *f_, const void *v_)
720 const struct freq *f = f_;
721 const struct variable *v = v_;
723 return !var_is_value_missing (v, f->v);
726 /* Summarizes the frequency table data for variable V. */
728 postprocess_freq_tab (struct variable *v)
730 hsh_compare_func *compare;
734 struct freq *freqs, *f;
737 ft = &get_var_freqs (v)->tab;
738 assert (ft->mode == FRQM_GENERAL);
739 compare = get_freq_comparator (cmd.sort, var_get_type (v));
741 /* Extract data from hash table. */
742 count = hsh_count (ft->data);
743 data = hsh_data (ft->data);
745 /* Copy dereferenced data into freqs. */
746 freqs = xnmalloc (count, sizeof *freqs);
747 for (i = 0; i < count; i++)
749 struct freq *f = data[i];
753 /* Put data into ft. */
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;
760 sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare, v);
761 sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare, v);
763 /* Summary statistics. */
764 ft->valid_cases = 0.0;
765 for(i = 0 ; i < ft->n_valid ; ++i )
768 ft->valid_cases += f->c;
772 ft->total_cases = ft->valid_cases ;
773 for(i = 0 ; i < ft->n_missing ; ++i )
776 ft->total_cases += f->c;
781 /* Frees the frequency table for variable V. */
783 cleanup_freq_tab (struct variable *v)
785 struct freq_tab *ft = &get_var_freqs (v)->tab;
786 assert (ft->mode == FRQM_GENERAL);
788 hsh_destroy (ft->data);
791 /* Parses the VARIABLES subcommand, adding to
792 {n_variables,v_variables}. */
794 frq_custom_variables (struct lexer *lexer, struct dataset *ds, struct cmd_frequencies *cmd UNUSED, void *aux UNUSED)
797 int min = 0, max = 0;
799 size_t old_n_variables = n_variables;
802 lex_match (lexer, '=');
803 if (lex_token (lexer) != T_ALL && (lex_token (lexer) != T_ID
804 || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) == NULL))
807 if (!parse_variables (lexer, dataset_dict (ds), &v_variables, &n_variables,
808 PV_APPEND | PV_NO_SCRATCH))
811 if (!lex_match (lexer, '('))
816 if (!lex_force_int (lexer))
818 min = lex_integer (lexer);
820 if (!lex_force_match (lexer, ','))
822 if (!lex_force_int (lexer))
824 max = lex_integer (lexer);
826 if (!lex_force_match (lexer, ')'))
830 msg (SE, _("Upper limit of integer mode value range must be "
831 "greater than lower limit."));
836 for (i = old_n_variables; i < n_variables; i++)
838 struct variable *v = v_variables[i];
839 struct var_freqs *vf;
841 if (var_get_aux (v) != NULL)
843 msg (SE, _("Variable %s specified multiple times on VARIABLES "
844 "subcommand."), var_get_name (v));
847 if (mode == FRQM_INTEGER && !var_is_numeric (v))
849 msg (SE, _("Integer mode specified, but %s is not a numeric "
850 "variable."), var_get_name (v));
854 vf = var_attach_aux (v, xmalloc (sizeof *vf), var_dtor_free);
856 vf->tab.valid = vf->tab.missing = NULL;
857 if (mode == FRQM_INTEGER)
861 vf->tab.vector = pool_nalloc (int_pool,
862 max - min + 1, sizeof *vf->tab.vector);
865 vf->tab.vector = NULL;
868 vf->width = var_get_width (v);
869 vf->print = *var_get_print_format (v);
870 if (vf->width > MAX_SHORT_STRING && get_algorithm () == COMPATIBLE)
872 enum fmt_type type = var_get_print_format (v)->type;
873 vf->width = MAX_SHORT_STRING;
874 vf->print.w = MAX_SHORT_STRING * (type == FMT_AHEX ? 2 : 1);
880 /* Parses the GROUPED subcommand, setting the n_grouped, grouped
881 fields of specified variables. */
883 frq_custom_grouped (struct lexer *lexer, struct dataset *ds, struct cmd_frequencies *cmd UNUSED, void *aux UNUSED)
885 lex_match (lexer, '=');
886 if ((lex_token (lexer) == T_ID && dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) != NULL)
887 || lex_token (lexer) == T_ID)
892 /* Max, current size of list; list itself. */
900 if (!parse_variables (lexer, dataset_dict (ds), &v, &n,
901 PV_NO_DUPLICATE | PV_NUMERIC))
903 if (lex_match (lexer, '('))
907 while (lex_integer (lexer))
912 dl = pool_nrealloc (int_pool, dl, ml, sizeof *dl);
914 dl[nl++] = lex_tokval (lexer);
916 lex_match (lexer, ',');
918 /* Note that nl might still be 0 and dl might still be
919 NULL. That's okay. */
920 if (!lex_match (lexer, ')'))
923 msg (SE, _("`)' expected after GROUPED interval list."));
933 for (i = 0; i < n; i++)
934 if (var_get_aux (v[i]) == NULL)
935 msg (SE, _("Variables %s specified on GROUPED but not on "
936 "VARIABLES."), var_get_name (v[i]));
939 struct var_freqs *vf = get_var_freqs (v[i]);
941 if (vf->groups != NULL)
942 msg (SE, _("Variables %s specified multiple times on GROUPED "
943 "subcommand."), var_get_name (v[i]));
951 if (!lex_match (lexer, '/'))
953 if ((lex_token (lexer) != T_ID || dict_lookup_var (dataset_dict (ds), lex_tokid (lexer)) != NULL)
954 && lex_token (lexer) != T_ALL)
956 lex_put_back (lexer, '/');
964 /* Adds X to the list of percentiles, keeping the list in proper
967 add_percentile (double x)
971 for (i = 0; i < n_percentiles; i++)
973 /* Do nothing if it's already in the list */
974 if ( fabs(x - percentiles[i].p) < DBL_EPSILON )
977 if (x < percentiles[i].p)
981 if (i >= n_percentiles || x != percentiles[i].p)
983 percentiles = pool_nrealloc (int_pool, percentiles,
984 n_percentiles + 1, sizeof *percentiles);
986 if (i < n_percentiles)
987 memmove (&percentiles[i + 1], &percentiles[i],
988 (n_percentiles - i) * sizeof (struct percentile) );
990 percentiles[i].p = x;
995 /* Comparison functions. */
997 /* Hash of numeric values. */
999 hash_value_numeric (const void *value_, const void *aux UNUSED)
1001 const struct freq *value = value_;
1002 return hsh_hash_double (value->v[0].f);
1005 /* Hash of string values. */
1007 hash_value_alpha (const void *value_, const void *v_)
1009 const struct freq *value = value_;
1010 const struct variable *v = v_;
1011 struct var_freqs *vf = get_var_freqs (v);
1013 return hsh_hash_bytes (value->v[0].s, vf->width);
1016 /* Ascending numeric compare of values. */
1018 compare_value_numeric_a (const void *a_, const void *b_, const void *aux UNUSED)
1020 const struct freq *a = a_;
1021 const struct freq *b = b_;
1023 if (a->v[0].f > b->v[0].f)
1025 else if (a->v[0].f < b->v[0].f)
1031 /* Ascending string compare of values. */
1033 compare_value_alpha_a (const void *a_, const void *b_, const void *v_)
1035 const struct freq *a = a_;
1036 const struct freq *b = b_;
1037 const struct variable *v = v_;
1038 struct var_freqs *vf = get_var_freqs (v);
1040 return memcmp (a->v[0].s, b->v[0].s, vf->width);
1043 /* Descending numeric compare of values. */
1045 compare_value_numeric_d (const void *a, const void *b, const void *aux UNUSED)
1047 return -compare_value_numeric_a (a, b, aux);
1050 /* Descending string compare of values. */
1052 compare_value_alpha_d (const void *a, const void *b, const void *v)
1054 return -compare_value_alpha_a (a, b, v);
1057 /* Ascending numeric compare of frequency;
1058 secondary key on ascending numeric value. */
1060 compare_freq_numeric_a (const void *a_, const void *b_, const void *aux UNUSED)
1062 const struct freq *a = a_;
1063 const struct freq *b = b_;
1067 else if (a->c < b->c)
1070 if (a->v[0].f > b->v[0].f)
1072 else if (a->v[0].f < b->v[0].f)
1078 /* Ascending numeric compare of frequency;
1079 secondary key on ascending string value. */
1081 compare_freq_alpha_a (const void *a_, const void *b_, const void *v_)
1083 const struct freq *a = a_;
1084 const struct freq *b = b_;
1085 const struct variable *v = v_;
1086 struct var_freqs *vf = get_var_freqs (v);
1090 else if (a->c < b->c)
1093 return memcmp (a->v[0].s, b->v[0].s, vf->width);
1096 /* Descending numeric compare of frequency;
1097 secondary key on ascending numeric value. */
1099 compare_freq_numeric_d (const void *a_, const void *b_, const void *aux UNUSED)
1101 const struct freq *a = a_;
1102 const struct freq *b = b_;
1106 else if (a->c < b->c)
1109 if (a->v[0].f > b->v[0].f)
1111 else if (a->v[0].f < b->v[0].f)
1117 /* Descending numeric compare of frequency;
1118 secondary key on ascending string value. */
1120 compare_freq_alpha_d (const void *a_, const void *b_, const void *v_)
1122 const struct freq *a = a_;
1123 const struct freq *b = b_;
1124 const struct variable *v = v_;
1125 struct var_freqs *vf = get_var_freqs (v);
1129 else if (a->c < b->c)
1132 return memcmp (a->v[0].s, b->v[0].s, vf->width);
1135 /* Frequency table display. */
1137 /* Sets the widths of all the columns and heights of all the rows in
1138 table T for driver D. */
1140 full_dim (struct tab_table *t, struct outp_driver *d)
1142 int lab = cmd.labels == FRQ_LABELS;
1146 t->w[0] = MIN (tab_natural_width (t, d, 0), d->prop_em_width * 15);
1147 for (i = lab; i < lab + 5; i++)
1148 t->w[i] = MAX (tab_natural_width (t, d, i), d->prop_em_width * 8);
1149 for (i = 0; i < t->nr; i++)
1150 t->h[i] = d->font_height;
1153 /* Displays a full frequency table for variable V. */
1155 dump_full (struct variable *v)
1158 struct var_freqs *vf;
1159 struct freq_tab *ft;
1161 struct tab_table *t;
1163 double cum_total = 0.0;
1164 double cum_freq = 0.0;
1172 const struct init *p;
1174 static const struct init vec[] =
1176 {4, 0, N_("Valid")},
1178 {1, 1, N_("Value")},
1179 {2, 1, N_("Frequency")},
1180 {3, 1, N_("Percent")},
1181 {4, 1, N_("Percent")},
1182 {5, 1, N_("Percent")},
1190 int lab = cmd.labels == FRQ_LABELS;
1192 vf = get_var_freqs (v);
1194 n_categories = ft->n_valid + ft->n_missing;
1195 t = tab_create (5 + lab, n_categories + 3, 0);
1196 tab_headers (t, 0, 0, 2, 0);
1197 tab_dim (t, full_dim);
1200 tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value Label"));
1201 for (p = vec; p->s; p++)
1202 tab_text (t, p->c - (p->r ? !lab : 0), p->r,
1203 TAB_CENTER | TAT_TITLE, gettext (p->s));
1206 for (f = ft->valid; f < ft->missing; f++)
1208 double percent, valid_percent;
1212 percent = f->c / ft->total_cases * 100.0;
1213 valid_percent = f->c / ft->valid_cases * 100.0;
1214 cum_total += valid_percent;
1218 const char *label = var_lookup_value_label (v, &f->v[0]);
1220 tab_text (t, 0, r, TAB_LEFT, label);
1223 tab_value (t, 0 + lab, r, TAB_NONE, f->v, &vf->print);
1224 tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1225 tab_float (t, 2 + lab, r, TAB_NONE, percent, 5, 1);
1226 tab_float (t, 3 + lab, r, TAB_NONE, valid_percent, 5, 1);
1227 tab_float (t, 4 + lab, r, TAB_NONE, cum_total, 5, 1);
1230 for (; f < &ft->valid[n_categories]; f++)
1236 const char *label = var_lookup_value_label (v, &f->v[0]);
1238 tab_text (t, 0, r, TAB_LEFT, label);
1241 tab_value (t, 0 + lab, r, TAB_NONE, f->v, &vf->print);
1242 tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1243 tab_float (t, 2 + lab, r, TAB_NONE,
1244 f->c / ft->total_cases * 100.0, 5, 1);
1245 tab_text (t, 3 + lab, r, TAB_NONE, _("Missing"));
1249 tab_box (t, TAL_1, TAL_1,
1250 cmd.spaces == FRQ_SINGLE ? -1 : TAL_GAP, TAL_1,
1252 tab_hline (t, TAL_2, 0, 4 + lab, 2);
1253 tab_hline (t, TAL_2, 0, 4 + lab, r);
1254 tab_joint_text (t, 0, r, 0 + lab, r, TAB_RIGHT | TAT_TITLE, _("Total"));
1255 tab_vline (t, TAL_0, 1, r, r);
1256 tab_float (t, 1 + lab, r, TAB_NONE, cum_freq, 8, 0);
1257 tab_float (t, 2 + lab, r, TAB_NONE, 100.0, 5, 1);
1258 tab_float (t, 3 + lab, r, TAB_NONE, 100.0, 5, 1);
1260 tab_title (t, "%s", var_to_string (v));
1264 /* Sets the widths of all the columns and heights of all the rows in
1265 table T for driver D. */
1267 condensed_dim (struct tab_table *t, struct outp_driver *d)
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)));
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++)
1279 for (i = 0; i < t->nr; i++)
1280 t->h[i] = d->font_height;
1283 /* Display condensed frequency table for variable V. */
1285 dump_condensed (struct variable *v)
1288 struct var_freqs *vf;
1289 struct freq_tab *ft;
1291 struct tab_table *t;
1293 double cum_total = 0.0;
1295 vf = get_var_freqs (v);
1297 n_categories = ft->n_valid + ft->n_missing;
1298 t = tab_create (4, n_categories + 2, 0);
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);
1309 for (f = ft->valid; f < ft->missing; f++)
1313 percent = f->c / ft->total_cases * 100.0;
1314 cum_total += f->c / ft->valid_cases * 100.0;
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);
1322 for (; f < &ft->valid[n_categories]; f++)
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);
1331 tab_box (t, TAL_1, TAL_1,
1332 cmd.spaces == FRQ_SINGLE ? -1 : TAL_GAP, TAL_1,
1334 tab_hline (t, TAL_2, 0, 3, 2);
1335 tab_title (t, "%s", var_to_string (v));
1336 tab_columns (t, SOM_COL_DOWN, 1);
1340 /* Statistical display. */
1342 /* Calculates all the pertinent statistics for variable V, putting
1343 them in array D[]. FIXME: This could be made much more optimal. */
1345 calc_stats (struct variable *v, double d[frq_n_stats])
1347 struct freq_tab *ft = &get_var_freqs (v)->tab;
1348 double W = ft->valid_cases;
1357 double *median_value;
1359 /* Calculate percentiles. */
1361 /* If the 50th percentile was not explicitly requested then we must
1362 calculate it anyway --- it's the median */
1364 for (i = 0; i < n_percentiles; i++)
1366 if (percentiles[i].p == 0.5)
1368 median_value = &percentiles[i].value;
1373 if ( 0 == median_value )
1375 add_percentile (0.5);
1379 for (i = 0; i < n_percentiles; i++)
1381 percentiles[i].flag = 0;
1382 percentiles[i].flag2 = 0;
1386 for (idx = 0; idx < ft->n_valid; ++idx)
1388 static double prev_value = SYSMIS;
1389 f = &ft->valid[idx];
1391 for (i = 0; i < n_percentiles; i++)
1394 if ( percentiles[i].flag2 ) continue ;
1396 if ( get_algorithm() != COMPATIBLE )
1398 (ft->valid_cases - 1) * percentiles[i].p;
1401 (ft->valid_cases + 1) * percentiles[i].p - 1;
1403 if ( percentiles[i].flag )
1405 percentiles[i].x2 = f->v[0].f;
1406 percentiles[i].x1 = prev_value;
1407 percentiles[i].flag2 = 1;
1413 if ( f->c > 1 && rank - (f->c - 1) > tp )
1415 percentiles[i].x2 = percentiles[i].x1 = f->v[0].f;
1416 percentiles[i].flag2 = 1;
1420 percentiles[i].flag=1;
1426 prev_value = f->v[0].f;
1429 for (i = 0; i < n_percentiles; i++)
1431 /* Catches the case when p == 100% */
1432 if ( ! percentiles[i].flag2 )
1433 percentiles[i].x1 = percentiles[i].x2 = f->v[0].f;
1436 printf("percentile %d (p==%.2f); X1 = %g; X2 = %g\n",
1437 i,percentiles[i].p,percentiles[i].x1,percentiles[i].x2);
1441 for (i = 0; i < n_percentiles; i++)
1443 struct freq_tab *ft = &get_var_freqs (v)->tab;
1447 if ( get_algorithm() != COMPATIBLE )
1449 s = modf((ft->valid_cases - 1) * percentiles[i].p , &dummy);
1453 s = modf((ft->valid_cases + 1) * percentiles[i].p -1, &dummy);
1456 percentiles[i].value = percentiles[i].x1 +
1457 ( percentiles[i].x2 - percentiles[i].x1) * s ;
1459 if ( percentiles[i].p == 0.50)
1460 median_value = &percentiles[i].value;
1464 /* Calculate the mode. */
1467 for (f = ft->valid; f < ft->missing; f++)
1469 if (most_often < f->c)
1474 else if (most_often == f->c)
1476 /* A duplicate mode is undefined.
1477 FIXME: keep track of *all* the modes. */
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);
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);
1505 /* Displays a table of all the statistics requested for variable V. */
1507 dump_statistics (struct variable *v, int show_varname)
1509 struct freq_tab *ft;
1510 double stat_value[frq_n_stats];
1511 struct tab_table *t;
1514 int n_explicit_percentiles = n_percentiles;
1516 if ( implicit_50th && n_percentiles > 0 )
1519 if (var_is_alpha (v))
1521 ft = &get_var_freqs (v)->tab;
1522 if (ft->n_valid == 0)
1524 msg (SW, _("No valid data for variable %s; statistics not displayed."),
1528 calc_stats (v, stat_value);
1530 t = tab_create (3, n_stats + n_explicit_percentiles + 2, 0);
1531 tab_dim (t, tab_natural_dimensions);
1533 tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1536 tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1537 tab_vline (t, TAL_GAP , 1, 0, tab_nr(t) - 1 ) ;
1539 r=2; /* N missing and N valid are always dumped */
1541 for (i = 0; i < frq_n_stats; i++)
1542 if (stats & BIT_INDEX (i))
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);
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"));
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);
1558 for (i = 0; i < n_explicit_percentiles; i++, r++)
1562 tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
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);
1570 tab_columns (t, SOM_COL_DOWN, 1);
1572 tab_title (t, "%s", var_to_string (v));
1574 tab_flags (t, SOMF_NO_TITLE);
1581 /* Create a gsl_histogram from a freq_tab */
1583 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var)
1586 double x_min = DBL_MAX;
1587 double x_max = -DBL_MAX;
1589 gsl_histogram *hist;
1590 const double bins = 11;
1592 struct hsh_iterator hi;
1593 struct hsh_table *fh = ft->data;
1596 /* Find out the extremes of the x value */
1597 for ( frq = hsh_first(fh, &hi); frq != 0; frq = hsh_next(fh, &hi) )
1599 if ( var_is_value_missing(var, frq->v))
1602 if ( frq->v[0].f < x_min ) x_min = frq->v[0].f ;
1603 if ( frq->v[0].f > x_max ) x_max = frq->v[0].f ;
1606 hist = histogram_create(bins, x_min, x_max);
1608 for( i = 0 ; i < ft->n_valid ; ++i )
1610 frq = &ft->valid[i];
1611 gsl_histogram_accumulate(hist, frq->v[0].f, frq->c);
1618 static struct slice *
1619 freq_tab_to_slice_array(const struct freq_tab *frq_tab,
1620 const struct variable *var,
1624 /* Allocate an array of slices and fill them from the data in frq_tab
1625 n_slices will contain the number of slices allocated.
1626 The caller is responsible for freeing slices
1628 static struct slice *
1629 freq_tab_to_slice_array(const struct freq_tab *frq_tab,
1630 const struct variable *var,
1634 struct slice *slices;
1636 *n_slices = frq_tab->n_valid;
1638 slices = xnmalloc (*n_slices, sizeof *slices);
1640 for (i = 0 ; i < *n_slices ; ++i )
1642 const struct freq *frq = &frq_tab->valid[i];
1644 slices[i].label = var_get_value_name (var, frq->v);
1646 slices[i].magnetude = frq->c;
1656 do_piechart(const struct variable *var, const struct freq_tab *frq_tab)
1658 struct slice *slices;
1661 slices = freq_tab_to_slice_array(frq_tab, var, &n_slices);
1663 piechart_plot(var_to_string(var), slices, n_slices);