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>
33 #include "bitvector.h"
35 #include "dictionary.h"
42 #include "algorithm.h"
49 #include "value-labels.h"
56 #define _(msgid) gettext (msgid)
57 #define N_(msgid) msgid
61 #include "debug-print.h"
66 format=cond:condense/onepage(*n:onepage_limit,"%s>=0")/!standard,
67 table:limit(n:limit,"%s>0")/notable/!table,
68 labels:!labels/nolabels,
69 sort:!avalue/dvalue/afreq/dfreq,
70 spaces:!single/double,
71 paging:newpage/!oldpage;
72 missing=miss:include/!exclude;
73 barchart(ba_)=:minimum(d:min),
75 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0");
76 piechart(pie_)=:minimum(d:min),
78 missing:missing/!nomissing;
79 histogram(hi_)=:minimum(d:min),
81 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
82 norm:!nonormal/normal,
83 incr:increment(d:inc,"%s>0");
84 hbar(hb_)=:minimum(d:min),
86 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
87 norm:!nonormal/normal,
88 incr:increment(d:inc,"%s>0");
91 +percentiles = double list;
92 statistics[st_]=1|mean,2|semean,3|median,4|mode,5|stddev,6|variance,
93 7|kurtosis,8|skewness,9|range,10|minimum,11|maximum,12|sum,
94 13|default,14|seskewness,15|sekurtosis,all,none.
102 frq_mean = 0, frq_semean, frq_median, frq_mode, frq_stddev, frq_variance,
103 frq_kurt, frq_sekurt, frq_skew, frq_seskew, frq_range, frq_min, frq_max,
107 /* Description of a statistic. */
110 int st_indx; /* Index into a_statistics[]. */
111 const char *s10; /* Identifying string. */
114 /* Table of statistics, indexed by dsc_*. */
115 static struct frq_info st_name[frq_n_stats + 1] =
117 {FRQ_ST_MEAN, N_("Mean")},
118 {FRQ_ST_SEMEAN, N_("S.E. Mean")},
119 {FRQ_ST_MEDIAN, N_("Median")},
120 {FRQ_ST_MODE, N_("Mode")},
121 {FRQ_ST_STDDEV, N_("Std Dev")},
122 {FRQ_ST_VARIANCE, N_("Variance")},
123 {FRQ_ST_KURTOSIS, N_("Kurtosis")},
124 {FRQ_ST_SEKURTOSIS, N_("S.E. Kurt")},
125 {FRQ_ST_SKEWNESS, N_("Skewness")},
126 {FRQ_ST_SESKEWNESS, N_("S.E. Skew")},
127 {FRQ_ST_RANGE, N_("Range")},
128 {FRQ_ST_MINIMUM, N_("Minimum")},
129 {FRQ_ST_MAXIMUM, N_("Maximum")},
130 {FRQ_ST_SUM, N_("Sum")},
134 /* Percentiles to calculate. */
138 double p; /* the %ile to be calculated */
139 double value; /* the %ile's value */
140 double x1; /* The datum value <= the percentile */
141 double x2; /* The datum value >= the percentile */
143 int flag2; /* Set to 1 if this percentile value has been found */
147 static void add_percentile (double x) ;
149 static struct percentile *percentiles;
150 static int n_percentiles;
152 static int implicit_50th ;
154 /* Groups of statistics. */
156 #define frq_default \
157 (BI (frq_mean) | BI (frq_stddev) | BI (frq_min) | BI (frq_max))
159 (BI (frq_sum) | BI(frq_min) | BI(frq_max) \
160 | BI(frq_mean) | BI(frq_semean) | BI(frq_stddev) \
161 | BI(frq_variance) | BI(frq_kurt) | BI(frq_sekurt) \
162 | BI(frq_skew) | BI(frq_seskew) | BI(frq_range) \
163 | BI(frq_range) | BI(frq_mode) | BI(frq_median))
165 /* Statistics; number of statistics. */
166 static unsigned long stats;
169 /* Types of graphs. */
172 GFT_NONE, /* Don't draw graphs. */
173 GFT_BAR, /* Draw bar charts. */
174 GFT_HIST, /* Draw histograms. */
175 GFT_PIE, /* Draw piechart */
176 GFT_HBAR /* Draw bar charts or histograms at our discretion. */
179 /* Parsed command. */
180 static struct cmd_frequencies cmd;
182 /* Summary of the barchart, histogram, and hbar subcommands. */
183 /* FIXME: These should not be mututally exclusive */
184 static int chart; /* NONE/BAR/HIST/HBAR/PIE. */
185 static double min, max; /* Minimum, maximum on y axis. */
186 static int format; /* FREQ/PERCENT: Scaling of y axis. */
187 static double scale, incr; /* FIXME */
188 static int normal; /* FIXME */
190 /* Variables for which to calculate statistics. */
191 static size_t n_variables;
192 static struct variable **v_variables;
194 /* Arenas used to store semi-permanent storage. */
195 static struct pool *int_pool; /* Integer mode. */
196 static struct pool *gen_pool; /* General mode. */
198 /* Frequency tables. */
200 /* Frequency table entry. */
203 union value v; /* The value. */
204 double c; /* The number of occurrences of the value. */
207 /* Types of frequency tables. */
214 /* Entire frequency table. */
217 int mode; /* FRQM_GENERAL or FRQM_INTEGER. */
220 struct hsh_table *data; /* Undifferentiated data. */
223 double *vector; /* Frequencies proper. */
224 int min, max; /* The boundaries of the table. */
225 double out_of_range; /* Sum of weights of out-of-range values. */
226 double sysmis; /* Sum of weights of SYSMIS values. */
229 struct freq *valid; /* Valid freqs. */
230 int n_valid; /* Number of total freqs. */
232 struct freq *missing; /* Missing freqs. */
233 int n_missing; /* Number of missing freqs. */
236 double total_cases; /* Sum of weights of all cases. */
237 double valid_cases; /* Sum of weights of valid cases. */
241 /* Per-variable frequency data. */
244 /* Freqency table. */
245 struct freq_tab tab; /* Frequencies table to use. */
248 int n_groups; /* Number of groups. */
249 double *groups; /* Groups. */
252 double stat[frq_n_stats];
255 static inline struct var_freqs *
256 get_var_freqs (struct variable *v)
259 assert (v->aux != NULL);
263 static void determine_charts (void);
265 static void calc_stats (struct variable *v, double d[frq_n_stats]);
267 static void precalc (void *);
268 static int calc (struct ccase *, void *);
269 static void postcalc (void *);
271 static void postprocess_freq_tab (struct variable *);
272 static void dump_full (struct variable *);
273 static void dump_condensed (struct variable *);
274 static void dump_statistics (struct variable *, int show_varname);
275 static void cleanup_freq_tab (struct variable *);
277 static hsh_hash_func hash_value_numeric, hash_value_alpha;
278 static hsh_compare_func compare_value_numeric_a, compare_value_alpha_a;
279 static hsh_compare_func compare_value_numeric_d, compare_value_alpha_d;
280 static hsh_compare_func compare_freq_numeric_a, compare_freq_alpha_a;
281 static hsh_compare_func compare_freq_numeric_d, compare_freq_alpha_d;
284 static void do_piechart(const struct variable *var,
285 const struct freq_tab *frq_tab);
288 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var);
292 /* Parser and outline. */
294 static int internal_cmd_frequencies (void);
297 cmd_frequencies (void)
301 int_pool = pool_create ();
302 result = internal_cmd_frequencies ();
303 pool_destroy (int_pool);
305 pool_destroy (gen_pool);
313 internal_cmd_frequencies (void)
323 if (!parse_frequencies (&cmd))
326 if (cmd.onepage_limit == NOT_LONG)
327 cmd.onepage_limit = 50;
329 /* Figure out statistics to calculate. */
331 if (cmd.a_statistics[FRQ_ST_DEFAULT] || !cmd.sbc_statistics)
332 stats |= frq_default;
333 if (cmd.a_statistics[FRQ_ST_ALL])
335 if (cmd.sort != FRQ_AVALUE && cmd.sort != FRQ_DVALUE)
336 stats &= ~frq_median;
337 for (i = 0; i < frq_n_stats; i++)
338 if (cmd.a_statistics[st_name[i].st_indx])
339 stats |= BIT_INDEX (i);
340 if (stats & frq_kurt)
342 if (stats & frq_skew)
345 /* Calculate n_stats. */
347 for (i = 0; i < frq_n_stats; i++)
348 if ((stats & BIT_INDEX (i)))
353 if (chart != GFT_NONE || cmd.sbc_ntiles)
354 cmd.sort = FRQ_AVALUE;
356 /* Work out what percentiles need to be calculated */
357 if ( cmd.sbc_percentiles )
359 for ( i = 0 ; i < MAXLISTS ; ++i )
362 subc_list_double *ptl_list = &cmd.dl_percentiles[i];
363 for ( pl = 0 ; pl < subc_list_double_count(ptl_list); ++pl)
364 add_percentile(subc_list_double_at(ptl_list,pl) / 100.0 );
367 if ( cmd.sbc_ntiles )
369 for ( i = 0 ; i < cmd.sbc_ntiles ; ++i )
372 for (j = 0; j <= cmd.n_ntiles[i]; ++j )
373 add_percentile(j / (double) cmd.n_ntiles[i]);
379 procedure_with_splits (precalc, calc, postcalc, NULL);
381 free_frequencies(&cmd);
386 /* Figure out which charts the user requested. */
388 determine_charts (void)
390 int count = (!!cmd.sbc_histogram) + (!!cmd.sbc_barchart) +
391 (!!cmd.sbc_hbar) + (!!cmd.sbc_piechart);
401 msg (SW, _("At most one of BARCHART, HISTOGRAM, or HBAR should be "
402 "given. HBAR will be assumed. Argument values will be "
403 "given precedence increasing along the order given."));
405 else if (cmd.sbc_histogram)
407 else if (cmd.sbc_barchart)
409 else if (cmd.sbc_piechart)
420 if (cmd.sbc_barchart)
422 if (cmd.ba_min != SYSMIS)
424 if (cmd.ba_max != SYSMIS)
426 if (cmd.ba_scale == FRQ_FREQ)
431 else if (cmd.ba_scale == FRQ_PERCENT)
433 format = FRQ_PERCENT;
438 if (cmd.sbc_histogram)
440 if (cmd.hi_min != SYSMIS)
442 if (cmd.hi_max != SYSMIS)
444 if (cmd.hi_scale == FRQ_FREQ)
449 else if (cmd.hi_scale == FRQ_PERCENT)
451 format = FRQ_PERCENT;
454 if (cmd.hi_norm != FRQ_NONORMAL )
456 if (cmd.hi_incr == FRQ_INCREMENT)
462 if (cmd.hb_min != SYSMIS)
464 if (cmd.hb_max != SYSMIS)
466 if (cmd.hb_scale == FRQ_FREQ)
471 else if (cmd.hb_scale == FRQ_PERCENT)
473 format = FRQ_PERCENT;
478 if (cmd.hb_incr == FRQ_INCREMENT)
482 if (min != SYSMIS && max != SYSMIS && min >= max)
484 msg (SE, _("MAX must be greater than or equal to MIN, if both are "
485 "specified. However, MIN was specified as %g and MAX as %g. "
486 "MIN and MAX will be ignored."), min, max);
491 /* Add data from case C to the frequency table. */
493 calc (struct ccase *c, void *aux UNUSED)
499 weight = dict_get_case_weight (default_dict, c, &bad_warn);
501 for (i = 0; i < n_variables; i++)
503 struct variable *v = v_variables[i];
504 const union value *val = case_data (c, v->fv);
505 struct freq_tab *ft = &get_var_freqs (v)->tab;
513 struct freq **fpp = (struct freq **) hsh_probe (ft->data, val);
519 struct freq *fp = *fpp = pool_alloc (gen_pool, sizeof *fp);
527 if (val->f == SYSMIS)
528 ft->sysmis += weight;
529 else if (val->f > INT_MIN+1 && val->f < INT_MAX-1)
532 if (i >= ft->min && i <= ft->max)
533 ft->vector[i - ft->min] += weight;
536 ft->out_of_range += weight;
545 /* Prepares each variable that is the target of FREQUENCIES by setting
546 up its hash table. */
548 precalc (void *aux UNUSED)
552 pool_destroy (gen_pool);
553 gen_pool = pool_create ();
555 for (i = 0; i < n_variables; i++)
557 struct variable *v = v_variables[i];
558 struct freq_tab *ft = &get_var_freqs (v)->tab;
560 if (ft->mode == FRQM_GENERAL)
563 hsh_compare_func *compare;
565 if (v->type == NUMERIC)
567 hash = hash_value_numeric;
568 compare = compare_value_numeric_a;
572 hash = hash_value_alpha;
573 compare = compare_value_alpha_a;
575 ft->data = hsh_create (16, compare, hash, NULL, v);
581 for (j = (ft->max - ft->min); j >= 0; j--)
583 ft->out_of_range = 0.0;
589 /* Finishes up with the variables after frequencies have been
590 calculated. Displays statistics, percentiles, ... */
592 postcalc (void *aux UNUSED)
596 for (i = 0; i < n_variables; i++)
598 struct variable *v = v_variables[i];
599 struct var_freqs *vf = get_var_freqs (v);
600 struct freq_tab *ft = &vf->tab;
602 int dumped_freq_tab = 1;
604 postprocess_freq_tab (v);
606 /* Frequencies tables. */
607 n_categories = ft->n_valid + ft->n_missing;
608 if (cmd.table == FRQ_TABLE
609 || (cmd.table == FRQ_LIMIT && n_categories <= cmd.limit))
619 if (n_categories > cmd.onepage_limit)
632 dump_statistics (v, !dumped_freq_tab);
636 if ( chart == GFT_HIST)
638 double d[frq_n_stats];
639 struct normal_curve norm;
640 gsl_histogram *hist ;
643 norm.N = vf->tab.valid_cases;
646 norm.mean = d[frq_mean];
647 norm.stddev = d[frq_stddev];
649 hist = freq_tab_to_hist(ft,v);
651 histogram_plot(hist, var_to_string(v), &norm, normal);
653 gsl_histogram_free(hist);
657 if ( chart == GFT_PIE)
659 do_piechart(v_variables[i], ft);
664 cleanup_freq_tab (v);
669 /* Returns the comparison function that should be used for
670 sorting a frequency table by FRQ_SORT using VAR_TYPE
672 static hsh_compare_func *
673 get_freq_comparator (int frq_sort, int var_type)
675 /* Note that q2c generates tags beginning with 1000. */
676 switch (frq_sort | (var_type << 16))
678 case FRQ_AVALUE | (NUMERIC << 16): return compare_value_numeric_a;
679 case FRQ_AVALUE | (ALPHA << 16): return compare_value_alpha_a;
680 case FRQ_DVALUE | (NUMERIC << 16): return compare_value_numeric_d;
681 case FRQ_DVALUE | (ALPHA << 16): return compare_value_alpha_d;
682 case FRQ_AFREQ | (NUMERIC << 16): return compare_freq_numeric_a;
683 case FRQ_AFREQ | (ALPHA << 16): return compare_freq_alpha_a;
684 case FRQ_DFREQ | (NUMERIC << 16): return compare_freq_numeric_d;
685 case FRQ_DFREQ | (ALPHA << 16): return compare_freq_alpha_d;
692 /* Returns nonzero iff the value in struct freq F is non-missing
695 not_missing (const void *f_, void *v_)
697 const struct freq *f = f_;
698 struct variable *v = v_;
700 return !mv_is_value_missing (&v->miss, &f->v);
703 /* Summarizes the frequency table data for variable V. */
705 postprocess_freq_tab (struct variable *v)
707 hsh_compare_func *compare;
711 struct freq *freqs, *f;
714 ft = &get_var_freqs (v)->tab;
715 assert (ft->mode == FRQM_GENERAL);
716 compare = get_freq_comparator (cmd.sort, v->type);
718 /* Extract data from hash table. */
719 count = hsh_count (ft->data);
720 data = hsh_data (ft->data);
722 /* Copy dereferenced data into freqs. */
723 freqs = xnmalloc (count, sizeof *freqs);
724 for (i = 0; i < count; i++)
726 struct freq *f = data[i];
730 /* Put data into ft. */
732 ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, v);
733 ft->missing = freqs + ft->n_valid;
734 ft->n_missing = count - ft->n_valid;
737 sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare, v);
738 sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare, v);
740 /* Summary statistics. */
741 ft->valid_cases = 0.0;
742 for(i = 0 ; i < ft->n_valid ; ++i )
745 ft->valid_cases += f->c;
749 ft->total_cases = ft->valid_cases ;
750 for(i = 0 ; i < ft->n_missing ; ++i )
753 ft->total_cases += f->c;
758 /* Frees the frequency table for variable V. */
760 cleanup_freq_tab (struct variable *v)
762 struct freq_tab *ft = &get_var_freqs (v)->tab;
763 assert (ft->mode == FRQM_GENERAL);
765 hsh_destroy (ft->data);
768 /* Parses the VARIABLES subcommand, adding to
769 {n_variables,v_variables}. */
771 frq_custom_variables (struct cmd_frequencies *cmd UNUSED)
774 int min = 0, max = 0;
776 size_t old_n_variables = n_variables;
780 if (token != T_ALL && (token != T_ID
781 || dict_lookup_var (default_dict, tokid) == NULL))
784 if (!parse_variables (default_dict, &v_variables, &n_variables,
785 PV_APPEND | PV_NO_SCRATCH))
788 if (!lex_match ('('))
793 if (!lex_force_int ())
795 min = lex_integer ();
797 if (!lex_force_match (','))
799 if (!lex_force_int ())
801 max = lex_integer ();
803 if (!lex_force_match (')'))
807 msg (SE, _("Upper limit of integer mode value range must be "
808 "greater than lower limit."));
813 for (i = old_n_variables; i < n_variables; i++)
815 struct variable *v = v_variables[i];
816 struct var_freqs *vf;
820 msg (SE, _("Variable %s specified multiple times on VARIABLES "
821 "subcommand."), v->name);
824 if (mode == FRQM_INTEGER && v->type != NUMERIC)
826 msg (SE, _("Integer mode specified, but %s is not a numeric "
827 "variable."), v->name);
831 vf = var_attach_aux (v, xmalloc (sizeof *vf), var_dtor_free);
833 vf->tab.valid = vf->tab.missing = NULL;
834 if (mode == FRQM_INTEGER)
838 vf->tab.vector = pool_alloc (int_pool,
839 sizeof (struct freq) * (max - min + 1));
842 vf->tab.vector = NULL;
849 /* Parses the GROUPED subcommand, setting the n_grouped, grouped
850 fields of specified variables. */
852 frq_custom_grouped (struct cmd_frequencies *cmd UNUSED)
855 if ((token == T_ID && dict_lookup_var (default_dict, tokid) != NULL)
861 /* Max, current size of list; list itself. */
869 if (!parse_variables (default_dict, &v, &n,
870 PV_NO_DUPLICATE | PV_NUMERIC))
876 while (lex_integer ())
881 dl = pool_realloc (int_pool, dl, ml * sizeof (double));
887 /* Note that nl might still be 0 and dl might still be
888 NULL. That's okay. */
889 if (!lex_match (')'))
892 msg (SE, _("`)' expected after GROUPED interval list."));
902 for (i = 0; i < n; i++)
903 if (v[i]->aux == NULL)
904 msg (SE, _("Variables %s specified on GROUPED but not on "
905 "VARIABLES."), v[i]->name);
908 struct var_freqs *vf = get_var_freqs (v[i]);
910 if (vf->groups != NULL)
911 msg (SE, _("Variables %s specified multiple times on GROUPED "
912 "subcommand."), v[i]->name);
920 if (!lex_match ('/'))
922 if ((token != T_ID || dict_lookup_var (default_dict, tokid) != NULL)
933 /* Adds X to the list of percentiles, keeping the list in proper
936 add_percentile (double x)
940 for (i = 0; i < n_percentiles; i++)
942 /* Do nothing if it's already in the list */
943 if ( fabs(x - percentiles[i].p) < DBL_EPSILON )
946 if (x < percentiles[i].p)
950 if (i >= n_percentiles || tokval != percentiles[i].p)
953 = pool_realloc (int_pool, percentiles,
954 (n_percentiles + 1) * sizeof (struct percentile ));
956 if (i < n_percentiles)
957 memmove (&percentiles[i + 1], &percentiles[i],
958 (n_percentiles - i) * sizeof (struct percentile) );
960 percentiles[i].p = x;
965 /* Comparison functions. */
967 /* Hash of numeric values. */
969 hash_value_numeric (const void *value_, void *foo UNUSED)
971 const struct freq *value = value_;
972 return hsh_hash_double (value->v.f);
975 /* Hash of string values. */
977 hash_value_alpha (const void *value_, void *v_)
979 const struct freq *value = value_;
980 struct variable *v = v_;
982 return hsh_hash_bytes (value->v.s, v->width);
985 /* Ascending numeric compare of values. */
987 compare_value_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
989 const struct freq *a = a_;
990 const struct freq *b = b_;
994 else if (a->v.f < b->v.f)
1000 /* Ascending string compare of values. */
1002 compare_value_alpha_a (const void *a_, const void *b_, void *v_)
1004 const struct freq *a = a_;
1005 const struct freq *b = b_;
1006 const struct variable *v = v_;
1008 return memcmp (a->v.s, b->v.s, v->width);
1011 /* Descending numeric compare of values. */
1013 compare_value_numeric_d (const void *a, const void *b, void *foo UNUSED)
1015 return -compare_value_numeric_a (a, b, foo);
1018 /* Descending string compare of values. */
1020 compare_value_alpha_d (const void *a, const void *b, void *v)
1022 return -compare_value_alpha_a (a, b, v);
1025 /* Ascending numeric compare of frequency;
1026 secondary key on ascending numeric value. */
1028 compare_freq_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
1030 const struct freq *a = a_;
1031 const struct freq *b = b_;
1035 else if (a->c < b->c)
1038 if (a->v.f > b->v.f)
1040 else if (a->v.f < b->v.f)
1046 /* Ascending numeric compare of frequency;
1047 secondary key on ascending string value. */
1049 compare_freq_alpha_a (const void *a_, const void *b_, void *v_)
1051 const struct freq *a = a_;
1052 const struct freq *b = b_;
1053 const struct variable *v = v_;
1057 else if (a->c < b->c)
1060 return memcmp (a->v.s, b->v.s, v->width);
1063 /* Descending numeric compare of frequency;
1064 secondary key on ascending numeric value. */
1066 compare_freq_numeric_d (const void *a_, const void *b_, void *foo UNUSED)
1068 const struct freq *a = a_;
1069 const struct freq *b = b_;
1073 else if (a->c < b->c)
1076 if (a->v.f > b->v.f)
1078 else if (a->v.f < b->v.f)
1084 /* Descending numeric compare of frequency;
1085 secondary key on ascending string value. */
1087 compare_freq_alpha_d (const void *a_, const void *b_, void *v_)
1089 const struct freq *a = a_;
1090 const struct freq *b = b_;
1091 const struct variable *v = v_;
1095 else if (a->c < b->c)
1098 return memcmp (a->v.s, b->v.s, v->width);
1101 /* Frequency table display. */
1103 /* Sets the widths of all the columns and heights of all the rows in
1104 table T for driver D. */
1106 full_dim (struct tab_table *t, struct outp_driver *d)
1108 int lab = cmd.labels == FRQ_LABELS;
1112 t->w[0] = min (tab_natural_width (t, d, 0), d->prop_em_width * 15);
1113 for (i = lab; i < lab + 5; i++)
1114 t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
1115 for (i = 0; i < t->nr; i++)
1116 t->h[i] = d->font_height;
1119 /* Displays a full frequency table for variable V. */
1121 dump_full (struct variable *v)
1124 struct freq_tab *ft;
1126 struct tab_table *t;
1128 double cum_total = 0.0;
1129 double cum_freq = 0.0;
1139 static struct init vec[] =
1141 {4, 0, N_("Valid")},
1143 {1, 1, N_("Value")},
1144 {2, 1, N_("Frequency")},
1145 {3, 1, N_("Percent")},
1146 {4, 1, N_("Percent")},
1147 {5, 1, N_("Percent")},
1155 int lab = cmd.labels == FRQ_LABELS;
1157 ft = &get_var_freqs (v)->tab;
1158 n_categories = ft->n_valid + ft->n_missing;
1159 t = tab_create (5 + lab, n_categories + 3, 0);
1160 tab_headers (t, 0, 0, 2, 0);
1161 tab_dim (t, full_dim);
1164 tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value Label"));
1165 for (p = vec; p->s; p++)
1166 tab_text (t, p->c - (p->r ? !lab : 0), p->r,
1167 TAB_CENTER | TAT_TITLE, gettext (p->s));
1170 for (f = ft->valid; f < ft->missing; f++)
1172 double percent, valid_percent;
1176 percent = f->c / ft->total_cases * 100.0;
1177 valid_percent = f->c / ft->valid_cases * 100.0;
1178 cum_total += valid_percent;
1182 const char *label = val_labs_find (v->val_labs, f->v);
1184 tab_text (t, 0, r, TAB_LEFT, label);
1187 tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1188 tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1189 tab_float (t, 2 + lab, r, TAB_NONE, percent, 5, 1);
1190 tab_float (t, 3 + lab, r, TAB_NONE, valid_percent, 5, 1);
1191 tab_float (t, 4 + lab, r, TAB_NONE, cum_total, 5, 1);
1194 for (; f < &ft->valid[n_categories]; f++)
1200 const char *label = val_labs_find (v->val_labs, f->v);
1202 tab_text (t, 0, r, TAB_LEFT, label);
1205 tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1206 tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1207 tab_float (t, 2 + lab, r, TAB_NONE,
1208 f->c / ft->total_cases * 100.0, 5, 1);
1209 tab_text (t, 3 + lab, r, TAB_NONE, _("Missing"));
1213 tab_box (t, TAL_1, TAL_1,
1214 cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1216 tab_hline (t, TAL_2, 0, 4 + lab, 2);
1217 tab_hline (t, TAL_2, 0, 4 + lab, r);
1218 tab_joint_text (t, 0, r, 0 + lab, r, TAB_RIGHT | TAT_TITLE, _("Total"));
1219 tab_vline (t, TAL_0, 1, r, r);
1220 tab_float (t, 1 + lab, r, TAB_NONE, cum_freq, 8, 0);
1221 tab_float (t, 2 + lab, r, TAB_NONE, 100.0, 5, 1);
1222 tab_float (t, 3 + lab, r, TAB_NONE, 100.0, 5, 1);
1224 tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1229 /* Sets the widths of all the columns and heights of all the rows in
1230 table T for driver D. */
1232 condensed_dim (struct tab_table *t, struct outp_driver *d)
1234 int cum_w = max (outp_string_width (d, _("Cum")),
1235 max (outp_string_width (d, _("Cum")),
1236 outp_string_width (d, "000")));
1240 for (i = 0; i < 2; i++)
1241 t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
1242 for (i = 2; i < 4; i++)
1244 for (i = 0; i < t->nr; i++)
1245 t->h[i] = d->font_height;
1248 /* Display condensed frequency table for variable V. */
1250 dump_condensed (struct variable *v)
1253 struct freq_tab *ft;
1255 struct tab_table *t;
1257 double cum_total = 0.0;
1259 ft = &get_var_freqs (v)->tab;
1260 n_categories = ft->n_valid + ft->n_missing;
1261 t = tab_create (4, n_categories + 2, 0);
1263 tab_headers (t, 0, 0, 2, 0);
1264 tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value"));
1265 tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Freq"));
1266 tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1267 tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Cum"));
1268 tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1269 tab_dim (t, condensed_dim);
1272 for (f = ft->valid; f < ft->missing; f++)
1276 percent = f->c / ft->total_cases * 100.0;
1277 cum_total += f->c / ft->valid_cases * 100.0;
1279 tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1280 tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1281 tab_float (t, 2, r, TAB_NONE, percent, 3, 0);
1282 tab_float (t, 3, r, TAB_NONE, cum_total, 3, 0);
1285 for (; f < &ft->valid[n_categories]; f++)
1287 tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1288 tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1289 tab_float (t, 2, r, TAB_NONE,
1290 f->c / ft->total_cases * 100.0, 3, 0);
1294 tab_box (t, TAL_1, TAL_1,
1295 cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1297 tab_hline (t, TAL_2, 0, 3, 2);
1298 tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1299 tab_columns (t, SOM_COL_DOWN, 1);
1303 /* Statistical display. */
1305 /* Calculates all the pertinent statistics for variable V, putting
1306 them in array D[]. FIXME: This could be made much more optimal. */
1308 calc_stats (struct variable *v, double d[frq_n_stats])
1310 struct freq_tab *ft = &get_var_freqs (v)->tab;
1311 double W = ft->valid_cases;
1320 double *median_value;
1322 /* Calculate percentiles. */
1324 /* If the 50th percentile was not explicitly requested then we must
1325 calculate it anyway --- it's the median */
1327 for (i = 0; i < n_percentiles; i++)
1329 if (percentiles[i].p == 0.5)
1331 median_value = &percentiles[i].value;
1336 if ( 0 == median_value )
1338 add_percentile (0.5);
1342 for (i = 0; i < n_percentiles; i++)
1344 percentiles[i].flag = 0;
1345 percentiles[i].flag2 = 0;
1349 for (idx = 0; idx < ft->n_valid; ++idx)
1351 static double prev_value = SYSMIS;
1352 f = &ft->valid[idx];
1354 for (i = 0; i < n_percentiles; i++)
1357 if ( percentiles[i].flag2 ) continue ;
1359 if ( get_algorithm() != COMPATIBLE )
1361 (ft->valid_cases - 1) * percentiles[i].p;
1364 (ft->valid_cases + 1) * percentiles[i].p - 1;
1366 if ( percentiles[i].flag )
1368 percentiles[i].x2 = f->v.f;
1369 percentiles[i].x1 = prev_value;
1370 percentiles[i].flag2 = 1;
1376 if ( f->c > 1 && rank - (f->c - 1) > tp )
1378 percentiles[i].x2 = percentiles[i].x1 = f->v.f;
1379 percentiles[i].flag2 = 1;
1383 percentiles[i].flag=1;
1389 prev_value = f->v.f;
1392 for (i = 0; i < n_percentiles; i++)
1394 /* Catches the case when p == 100% */
1395 if ( ! percentiles[i].flag2 )
1396 percentiles[i].x1 = percentiles[i].x2 = f->v.f;
1399 printf("percentile %d (p==%.2f); X1 = %g; X2 = %g\n",
1400 i,percentiles[i].p,percentiles[i].x1,percentiles[i].x2);
1404 for (i = 0; i < n_percentiles; i++)
1406 struct freq_tab *ft = &get_var_freqs (v)->tab;
1410 if ( get_algorithm() != COMPATIBLE )
1412 s = modf((ft->valid_cases - 1) * percentiles[i].p , &dummy);
1416 s = modf((ft->valid_cases + 1) * percentiles[i].p -1, &dummy);
1419 percentiles[i].value = percentiles[i].x1 +
1420 ( percentiles[i].x2 - percentiles[i].x1) * s ;
1422 if ( percentiles[i].p == 0.50)
1423 median_value = &percentiles[i].value;
1427 /* Calculate the mode. */
1430 for (f = ft->valid; f < ft->missing; f++)
1432 if (most_often < f->c)
1437 else if (most_often == f->c)
1439 /* A duplicate mode is undefined.
1440 FIXME: keep track of *all* the modes. */
1445 /* Calculate moments. */
1446 m = moments_create (MOMENT_KURTOSIS);
1447 for (f = ft->valid; f < ft->missing; f++)
1448 moments_pass_one (m, f->v.f, f->c);
1449 for (f = ft->valid; f < ft->missing; f++)
1450 moments_pass_two (m, f->v.f, f->c);
1451 moments_calculate (m, NULL, &d[frq_mean], &d[frq_variance],
1452 &d[frq_skew], &d[frq_kurt]);
1453 moments_destroy (m);
1455 /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1456 d[frq_min] = ft->valid[0].v.f;
1457 d[frq_max] = ft->valid[ft->n_valid - 1].v.f;
1458 d[frq_mode] = X_mode;
1459 d[frq_range] = d[frq_max] - d[frq_min];
1460 d[frq_median] = *median_value;
1461 d[frq_sum] = d[frq_mean] * W;
1462 d[frq_stddev] = sqrt (d[frq_variance]);
1463 d[frq_semean] = d[frq_stddev] / sqrt (W);
1464 d[frq_seskew] = calc_seskew (W);
1465 d[frq_sekurt] = calc_sekurt (W);
1468 /* Displays a table of all the statistics requested for variable V. */
1470 dump_statistics (struct variable *v, int show_varname)
1472 struct freq_tab *ft;
1473 double stat_value[frq_n_stats];
1474 struct tab_table *t;
1477 int n_explicit_percentiles = n_percentiles;
1479 if ( implicit_50th && n_percentiles > 0 )
1482 if (v->type == ALPHA)
1484 ft = &get_var_freqs (v)->tab;
1485 if (ft->n_valid == 0)
1487 msg (SW, _("No valid data for variable %s; statistics not displayed."),
1491 calc_stats (v, stat_value);
1493 t = tab_create (3, n_stats + n_explicit_percentiles + 2, 0);
1494 tab_dim (t, tab_natural_dimensions);
1496 tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1499 tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1500 tab_vline (t, TAL_1 | TAL_SPACING , 1, 0, tab_nr(t) - 1 ) ;
1502 r=2; /* N missing and N valid are always dumped */
1504 for (i = 0; i < frq_n_stats; i++)
1505 if (stats & BIT_INDEX (i))
1507 tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1508 gettext (st_name[i].s10));
1509 tab_float (t, 2, r, TAB_NONE, stat_value[i], 11, 3);
1513 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("N"));
1514 tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Valid"));
1515 tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Missing"));
1517 tab_float(t, 2, 0, TAB_NONE, ft->valid_cases, 11, 0);
1518 tab_float(t, 2, 1, TAB_NONE, ft->total_cases - ft->valid_cases, 11, 0);
1521 for (i = 0; i < n_explicit_percentiles; i++, r++)
1525 tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
1528 tab_float (t, 1, r, TAB_LEFT, percentiles[i].p * 100, 3, 0 );
1529 tab_float (t, 2, r, TAB_NONE, percentiles[i].value, 11, 3);
1533 tab_columns (t, SOM_COL_DOWN, 1);
1537 tab_title (t, 1, "%s: %s", v->name, v->label);
1539 tab_title (t, 0, v->name);
1542 tab_flags (t, SOMF_NO_TITLE);
1549 /* Create a gsl_histogram from a freq_tab */
1551 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var)
1554 double x_min = DBL_MAX;
1555 double x_max = -DBL_MAX;
1557 gsl_histogram *hist;
1558 const double bins = 11;
1560 struct hsh_iterator hi;
1561 struct hsh_table *fh = ft->data;
1564 /* Find out the extremes of the x value */
1565 for ( frq = hsh_first(fh, &hi); frq != 0; frq = hsh_next(fh, &hi) )
1567 if ( mv_is_value_missing(&var->miss, &frq->v))
1570 if ( frq->v.f < x_min ) x_min = frq->v.f ;
1571 if ( frq->v.f > x_max ) x_max = frq->v.f ;
1574 hist = histogram_create(bins, x_min, x_max);
1576 for( i = 0 ; i < ft->n_valid ; ++i )
1578 frq = &ft->valid[i];
1579 gsl_histogram_accumulate(hist, frq->v.f, frq->c);
1586 static struct slice *
1587 freq_tab_to_slice_array(const struct freq_tab *frq_tab,
1588 const struct variable *var,
1592 /* Allocate an array of slices and fill them from the data in frq_tab
1593 n_slices will contain the number of slices allocated.
1594 The caller is responsible for freeing slices
1596 static struct slice *
1597 freq_tab_to_slice_array(const struct freq_tab *frq_tab,
1598 const struct variable *var,
1602 struct slice *slices;
1604 *n_slices = frq_tab->n_valid;
1606 slices = xnmalloc (*n_slices, sizeof *slices);
1608 for (i = 0 ; i < *n_slices ; ++i )
1610 const struct freq *frq = &frq_tab->valid[i];
1612 slices[i].label = value_to_string(&frq->v, var);
1614 slices[i].magnetude = frq->c;
1624 do_piechart(const struct variable *var, const struct freq_tab *frq_tab)
1626 struct slice *slices;
1629 slices = freq_tab_to_slice_array(frq_tab, var, &n_slices);
1631 piechart_plot(var_to_string(var), slices, n_slices);