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., 59 Temple Place - Suite 330, 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 #include "debug-print.h"
61 format=cond:condense/onepage(*n:onepage_limit,"%s>=0")/!standard,
62 table:limit(n:limit,"%s>0")/notable/!table,
63 labels:!labels/nolabels,
64 sort:!avalue/dvalue/afreq/dfreq,
65 spaces:!single/double,
66 paging:newpage/!oldpage;
67 missing=miss:include/!exclude;
68 barchart(ba_)=:minimum(d:min),
70 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0");
71 piechart(pie_)=:minimum(d:min),
73 missing:missing/!nomissing;
74 histogram(hi_)=:minimum(d:min),
76 scale:freq(*n:freq,"%s>0")/percent(*n:pcnt,"%s>0"),
77 norm:!nonormal/normal,
78 incr:increment(d:inc,"%s>0");
79 hbar(hb_)=: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");
86 +percentiles = double list;
87 statistics[st_]=1|mean,2|semean,3|median,4|mode,5|stddev,6|variance,
88 7|kurtosis,8|skewness,9|range,10|minimum,11|maximum,12|sum,
89 13|default,14|seskewness,15|sekurtosis,all,none.
97 frq_mean = 0, frq_semean, frq_median, frq_mode, frq_stddev, frq_variance,
98 frq_kurt, frq_sekurt, frq_skew, frq_seskew, frq_range, frq_min, frq_max,
102 /* Description of a statistic. */
105 int st_indx; /* Index into a_statistics[]. */
106 const char *s10; /* Identifying string. */
109 /* Table of statistics, indexed by dsc_*. */
110 static struct frq_info st_name[frq_n_stats + 1] =
112 {FRQ_ST_MEAN, N_("Mean")},
113 {FRQ_ST_SEMEAN, N_("S.E. Mean")},
114 {FRQ_ST_MEDIAN, N_("Median")},
115 {FRQ_ST_MODE, N_("Mode")},
116 {FRQ_ST_STDDEV, N_("Std Dev")},
117 {FRQ_ST_VARIANCE, N_("Variance")},
118 {FRQ_ST_KURTOSIS, N_("Kurtosis")},
119 {FRQ_ST_SEKURTOSIS, N_("S.E. Kurt")},
120 {FRQ_ST_SKEWNESS, N_("Skewness")},
121 {FRQ_ST_SESKEWNESS, N_("S.E. Skew")},
122 {FRQ_ST_RANGE, N_("Range")},
123 {FRQ_ST_MINIMUM, N_("Minimum")},
124 {FRQ_ST_MAXIMUM, N_("Maximum")},
125 {FRQ_ST_SUM, N_("Sum")},
129 /* Percentiles to calculate. */
133 double p; /* the %ile to be calculated */
134 double value; /* the %ile's value */
135 double x1; /* The datum value <= the percentile */
136 double x2; /* The datum value >= the percentile */
138 int flag2; /* Set to 1 if this percentile value has been found */
142 static void add_percentile (double x) ;
144 static struct percentile *percentiles;
145 static int n_percentiles;
147 static int implicit_50th ;
149 /* Groups of statistics. */
151 #define frq_default \
152 (BI (frq_mean) | BI (frq_stddev) | BI (frq_min) | BI (frq_max))
154 (BI (frq_sum) | BI(frq_min) | BI(frq_max) \
155 | BI(frq_mean) | BI(frq_semean) | BI(frq_stddev) \
156 | BI(frq_variance) | BI(frq_kurt) | BI(frq_sekurt) \
157 | BI(frq_skew) | BI(frq_seskew) | BI(frq_range) \
158 | BI(frq_range) | BI(frq_mode) | BI(frq_median))
160 /* Statistics; number of statistics. */
161 static unsigned long stats;
164 /* Types of graphs. */
167 GFT_NONE, /* Don't draw graphs. */
168 GFT_BAR, /* Draw bar charts. */
169 GFT_HIST, /* Draw histograms. */
170 GFT_PIE, /* Draw piechart */
171 GFT_HBAR /* Draw bar charts or histograms at our discretion. */
174 /* Parsed command. */
175 static struct cmd_frequencies cmd;
177 /* Summary of the barchart, histogram, and hbar subcommands. */
178 /* FIXME: These should not be mututally exclusive */
179 static int chart; /* NONE/BAR/HIST/HBAR/PIE. */
180 static double min, max; /* Minimum, maximum on y axis. */
181 static int format; /* FREQ/PERCENT: Scaling of y axis. */
182 static double scale, incr; /* FIXME */
183 static int normal; /* FIXME */
185 /* Variables for which to calculate statistics. */
186 static int n_variables;
187 static struct variable **v_variables;
189 /* Arenas used to store semi-permanent storage. */
190 static struct pool *int_pool; /* Integer mode. */
191 static struct pool *gen_pool; /* General mode. */
193 /* Frequency tables. */
195 /* Frequency table entry. */
198 union value v; /* The value. */
199 double c; /* The number of occurrences of the value. */
202 /* Types of frequency tables. */
209 /* Entire frequency table. */
212 int mode; /* FRQM_GENERAL or FRQM_INTEGER. */
215 struct hsh_table *data; /* Undifferentiated data. */
218 double *vector; /* Frequencies proper. */
219 int min, max; /* The boundaries of the table. */
220 double out_of_range; /* Sum of weights of out-of-range values. */
221 double sysmis; /* Sum of weights of SYSMIS values. */
224 struct freq *valid; /* Valid freqs. */
225 int n_valid; /* Number of total freqs. */
227 struct freq *missing; /* Missing freqs. */
228 int n_missing; /* Number of missing freqs. */
231 double total_cases; /* Sum of weights of all cases. */
232 double valid_cases; /* Sum of weights of valid cases. */
236 /* Per-variable frequency data. */
239 /* Freqency table. */
240 struct freq_tab tab; /* Frequencies table to use. */
243 int n_groups; /* Number of groups. */
244 double *groups; /* Groups. */
247 double stat[frq_n_stats];
250 static inline struct var_freqs *
251 get_var_freqs (struct variable *v)
254 assert (v->aux != NULL);
258 static void determine_charts (void);
260 static void calc_stats (struct variable *v, double d[frq_n_stats]);
262 static void precalc (void *);
263 static int calc (struct ccase *, void *);
264 static void postcalc (void *);
266 static void postprocess_freq_tab (struct variable *);
267 static void dump_full (struct variable *);
268 static void dump_condensed (struct variable *);
269 static void dump_statistics (struct variable *, int show_varname);
270 static void cleanup_freq_tab (struct variable *);
272 static hsh_hash_func hash_value_numeric, hash_value_alpha;
273 static hsh_compare_func compare_value_numeric_a, compare_value_alpha_a;
274 static hsh_compare_func compare_value_numeric_d, compare_value_alpha_d;
275 static hsh_compare_func compare_freq_numeric_a, compare_freq_alpha_a;
276 static hsh_compare_func compare_freq_numeric_d, compare_freq_alpha_d;
279 static void do_piechart(const struct variable *var,
280 const struct freq_tab *frq_tab);
283 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var);
287 /* Parser and outline. */
289 static int internal_cmd_frequencies (void);
292 cmd_frequencies (void)
296 int_pool = pool_create ();
297 result = internal_cmd_frequencies ();
298 pool_destroy (int_pool);
300 pool_destroy (gen_pool);
308 internal_cmd_frequencies (void)
318 if (!parse_frequencies (&cmd))
321 if (cmd.onepage_limit == NOT_LONG)
322 cmd.onepage_limit = 50;
324 /* Figure out statistics to calculate. */
326 if (cmd.a_statistics[FRQ_ST_DEFAULT] || !cmd.sbc_statistics)
327 stats |= frq_default;
328 if (cmd.a_statistics[FRQ_ST_ALL])
330 if (cmd.sort != FRQ_AVALUE && cmd.sort != FRQ_DVALUE)
331 stats &= ~frq_median;
332 for (i = 0; i < frq_n_stats; i++)
333 if (cmd.a_statistics[st_name[i].st_indx])
334 stats |= BIT_INDEX (i);
335 if (stats & frq_kurt)
337 if (stats & frq_skew)
340 /* Calculate n_stats. */
342 for (i = 0; i < frq_n_stats; i++)
343 if ((stats & BIT_INDEX (i)))
348 if (chart != GFT_NONE || cmd.sbc_ntiles)
349 cmd.sort = FRQ_AVALUE;
351 /* Work out what percentiles need to be calculated */
352 if ( cmd.sbc_percentiles )
354 for ( i = 0 ; i < MAXLISTS ; ++i )
357 subc_list_double *ptl_list = &cmd.dl_percentiles[i];
358 for ( pl = 0 ; pl < subc_list_double_count(ptl_list); ++pl)
359 add_percentile(subc_list_double_at(ptl_list,pl) / 100.0 );
362 if ( cmd.sbc_ntiles )
364 for ( i = 0 ; i < cmd.sbc_ntiles ; ++i )
367 for (j = 0; j <= cmd.n_ntiles[i]; ++j )
368 add_percentile(j / (double) cmd.n_ntiles[i]);
374 procedure_with_splits (precalc, calc, postcalc, NULL);
376 free_frequencies(&cmd);
381 /* Figure out which charts the user requested. */
383 determine_charts (void)
385 int count = (!!cmd.sbc_histogram) + (!!cmd.sbc_barchart) +
386 (!!cmd.sbc_hbar) + (!!cmd.sbc_piechart);
396 msg (SW, _("At most one of BARCHART, HISTOGRAM, or HBAR should be "
397 "given. HBAR will be assumed. Argument values will be "
398 "given precedence increasing along the order given."));
400 else if (cmd.sbc_histogram)
402 else if (cmd.sbc_barchart)
404 else if (cmd.sbc_piechart)
415 if (cmd.sbc_barchart)
417 if (cmd.ba_min != SYSMIS)
419 if (cmd.ba_max != SYSMIS)
421 if (cmd.ba_scale == FRQ_FREQ)
426 else if (cmd.ba_scale == FRQ_PERCENT)
428 format = FRQ_PERCENT;
433 if (cmd.sbc_histogram)
435 if (cmd.hi_min != SYSMIS)
437 if (cmd.hi_max != SYSMIS)
439 if (cmd.hi_scale == FRQ_FREQ)
444 else if (cmd.hi_scale == FRQ_PERCENT)
446 format = FRQ_PERCENT;
449 if (cmd.hi_norm != FRQ_NONORMAL )
451 if (cmd.hi_incr == FRQ_INCREMENT)
457 if (cmd.hb_min != SYSMIS)
459 if (cmd.hb_max != SYSMIS)
461 if (cmd.hb_scale == FRQ_FREQ)
466 else if (cmd.hb_scale == FRQ_PERCENT)
468 format = FRQ_PERCENT;
473 if (cmd.hb_incr == FRQ_INCREMENT)
477 if (min != SYSMIS && max != SYSMIS && min >= max)
479 msg (SE, _("MAX must be greater than or equal to MIN, if both are "
480 "specified. However, MIN was specified as %g and MAX as %g. "
481 "MIN and MAX will be ignored."), min, max);
486 /* Add data from case C to the frequency table. */
488 calc (struct ccase *c, void *aux UNUSED)
494 weight = dict_get_case_weight (default_dict, c, &bad_warn);
496 for (i = 0; i < n_variables; i++)
498 struct variable *v = v_variables[i];
499 const union value *val = case_data (c, v->fv);
500 struct freq_tab *ft = &get_var_freqs (v)->tab;
508 struct freq **fpp = (struct freq **) hsh_probe (ft->data, val);
514 struct freq *fp = *fpp = pool_alloc (gen_pool, sizeof *fp);
522 if (val->f == SYSMIS)
523 ft->sysmis += weight;
524 else if (val->f > INT_MIN+1 && val->f < INT_MAX-1)
527 if (i >= ft->min && i <= ft->max)
528 ft->vector[i - ft->min] += weight;
531 ft->out_of_range += weight;
540 /* Prepares each variable that is the target of FREQUENCIES by setting
541 up its hash table. */
543 precalc (void *aux UNUSED)
547 pool_destroy (gen_pool);
548 gen_pool = pool_create ();
550 for (i = 0; i < n_variables; i++)
552 struct variable *v = v_variables[i];
553 struct freq_tab *ft = &get_var_freqs (v)->tab;
555 if (ft->mode == FRQM_GENERAL)
558 hsh_compare_func *compare;
560 if (v->type == NUMERIC)
562 hash = hash_value_numeric;
563 compare = compare_value_numeric_a;
567 hash = hash_value_alpha;
568 compare = compare_value_alpha_a;
570 ft->data = hsh_create (16, compare, hash, NULL, v);
576 for (j = (ft->max - ft->min); j >= 0; j--)
578 ft->out_of_range = 0.0;
584 /* Finishes up with the variables after frequencies have been
585 calculated. Displays statistics, percentiles, ... */
587 postcalc (void *aux UNUSED)
591 for (i = 0; i < n_variables; i++)
593 struct variable *v = v_variables[i];
594 struct var_freqs *vf = get_var_freqs (v);
595 struct freq_tab *ft = &vf->tab;
597 int dumped_freq_tab = 1;
599 postprocess_freq_tab (v);
601 /* Frequencies tables. */
602 n_categories = ft->n_valid + ft->n_missing;
603 if (cmd.table == FRQ_TABLE
604 || (cmd.table == FRQ_LIMIT && n_categories <= cmd.limit))
614 if (n_categories > cmd.onepage_limit)
627 dump_statistics (v, !dumped_freq_tab);
631 if ( chart == GFT_HIST)
633 double d[frq_n_stats];
634 struct normal_curve norm;
635 gsl_histogram *hist ;
638 norm.N = vf->tab.valid_cases;
641 norm.mean = d[frq_mean];
642 norm.stddev = d[frq_stddev];
644 hist = freq_tab_to_hist(ft,v);
646 histogram_plot(hist, var_to_string(v), &norm, normal);
648 gsl_histogram_free(hist);
652 if ( chart == GFT_PIE)
654 do_piechart(v_variables[i], ft);
659 cleanup_freq_tab (v);
664 /* Returns the comparison function that should be used for
665 sorting a frequency table by FRQ_SORT using VAR_TYPE
667 static hsh_compare_func *
668 get_freq_comparator (int frq_sort, int var_type)
670 /* Note that q2c generates tags beginning with 1000. */
671 switch (frq_sort | (var_type << 16))
673 case FRQ_AVALUE | (NUMERIC << 16): return compare_value_numeric_a;
674 case FRQ_AVALUE | (ALPHA << 16): return compare_value_alpha_a;
675 case FRQ_DVALUE | (NUMERIC << 16): return compare_value_numeric_d;
676 case FRQ_DVALUE | (ALPHA << 16): return compare_value_alpha_d;
677 case FRQ_AFREQ | (NUMERIC << 16): return compare_freq_numeric_a;
678 case FRQ_AFREQ | (ALPHA << 16): return compare_freq_alpha_a;
679 case FRQ_DFREQ | (NUMERIC << 16): return compare_freq_numeric_d;
680 case FRQ_DFREQ | (ALPHA << 16): return compare_freq_alpha_d;
687 /* Returns nonzero iff the value in struct freq F is non-missing
690 not_missing (const void *f_, void *v_)
692 const struct freq *f = f_;
693 struct variable *v = v_;
695 return !is_missing (&f->v, v);
698 /* Summarizes the frequency table data for variable V. */
700 postprocess_freq_tab (struct variable *v)
702 hsh_compare_func *compare;
706 struct freq *freqs, *f;
709 ft = &get_var_freqs (v)->tab;
710 assert (ft->mode == FRQM_GENERAL);
711 compare = get_freq_comparator (cmd.sort, v->type);
713 /* Extract data from hash table. */
714 count = hsh_count (ft->data);
715 data = hsh_data (ft->data);
717 /* Copy dereferenced data into freqs. */
718 freqs = xmalloc (count * sizeof *freqs);
719 for (i = 0; i < count; i++)
721 struct freq *f = data[i];
725 /* Put data into ft. */
727 ft->n_valid = partition (freqs, count, sizeof *freqs, not_missing, v);
728 ft->missing = freqs + ft->n_valid;
729 ft->n_missing = count - ft->n_valid;
732 sort (ft->valid, ft->n_valid, sizeof *ft->valid, compare, v);
733 sort (ft->missing, ft->n_missing, sizeof *ft->missing, compare, v);
735 /* Summary statistics. */
736 ft->valid_cases = 0.0;
737 for(i = 0 ; i < ft->n_valid ; ++i )
740 ft->valid_cases += f->c;
744 ft->total_cases = ft->valid_cases ;
745 for(i = 0 ; i < ft->n_missing ; ++i )
748 ft->total_cases += f->c;
753 /* Frees the frequency table for variable V. */
755 cleanup_freq_tab (struct variable *v)
757 struct freq_tab *ft = &get_var_freqs (v)->tab;
758 assert (ft->mode == FRQM_GENERAL);
760 hsh_destroy (ft->data);
763 /* Parses the VARIABLES subcommand, adding to
764 {n_variables,v_variables}. */
766 frq_custom_variables (struct cmd_frequencies *cmd UNUSED)
769 int min = 0, max = 0;
771 int old_n_variables = n_variables;
775 if (token != T_ALL && (token != T_ID
776 || dict_lookup_var (default_dict, tokid) == NULL))
779 if (!parse_variables (default_dict, &v_variables, &n_variables,
780 PV_APPEND | PV_NO_SCRATCH))
783 if (!lex_match ('('))
788 if (!lex_force_int ())
790 min = lex_integer ();
792 if (!lex_force_match (','))
794 if (!lex_force_int ())
796 max = lex_integer ();
798 if (!lex_force_match (')'))
802 msg (SE, _("Upper limit of integer mode value range must be "
803 "greater than lower limit."));
808 for (i = old_n_variables; i < n_variables; i++)
810 struct variable *v = v_variables[i];
811 struct var_freqs *vf;
815 msg (SE, _("Variable %s specified multiple times on VARIABLES "
816 "subcommand."), v->name);
819 if (mode == FRQM_INTEGER && v->type != NUMERIC)
821 msg (SE, _("Integer mode specified, but %s is not a numeric "
822 "variable."), v->name);
826 vf = var_attach_aux (v, xmalloc (sizeof *vf), var_dtor_free);
828 vf->tab.valid = vf->tab.missing = NULL;
829 if (mode == FRQM_INTEGER)
833 vf->tab.vector = pool_alloc (int_pool,
834 sizeof (struct freq) * (max - min + 1));
837 vf->tab.vector = NULL;
844 /* Parses the GROUPED subcommand, setting the n_grouped, grouped
845 fields of specified variables. */
847 frq_custom_grouped (struct cmd_frequencies *cmd UNUSED)
850 if ((token == T_ID && dict_lookup_var (default_dict, tokid) != NULL)
856 /* Max, current size of list; list itself. */
864 if (!parse_variables (default_dict, &v, &n,
865 PV_NO_DUPLICATE | PV_NUMERIC))
871 while (token == T_NUM)
876 dl = pool_realloc (int_pool, dl, ml * sizeof (double));
882 /* Note that nl might still be 0 and dl might still be
883 NULL. That's okay. */
884 if (!lex_match (')'))
887 msg (SE, _("`)' expected after GROUPED interval list."));
897 for (i = 0; i < n; i++)
898 if (v[i]->aux == NULL)
899 msg (SE, _("Variables %s specified on GROUPED but not on "
900 "VARIABLES."), v[i]->name);
903 struct var_freqs *vf = get_var_freqs (v[i]);
905 if (vf->groups != NULL)
906 msg (SE, _("Variables %s specified multiple times on GROUPED "
907 "subcommand."), v[i]->name);
915 if (!lex_match ('/'))
917 if ((token != T_ID || dict_lookup_var (default_dict, tokid) != NULL)
928 /* Adds X to the list of percentiles, keeping the list in proper
931 add_percentile (double x)
935 for (i = 0; i < n_percentiles; i++)
937 /* Do nothing if it's already in the list */
938 if ( fabs(x - percentiles[i].p) < DBL_EPSILON )
941 if (x < percentiles[i].p)
945 if (i >= n_percentiles || tokval != percentiles[i].p)
948 = pool_realloc (int_pool, percentiles,
949 (n_percentiles + 1) * sizeof (struct percentile ));
951 if (i < n_percentiles)
952 memmove (&percentiles[i + 1], &percentiles[i],
953 (n_percentiles - i) * sizeof (struct percentile) );
955 percentiles[i].p = x;
960 /* Comparison functions. */
962 /* Hash of numeric values. */
964 hash_value_numeric (const void *value_, void *foo UNUSED)
966 const struct freq *value = value_;
967 return hsh_hash_double (value->v.f);
970 /* Hash of string values. */
972 hash_value_alpha (const void *value_, void *v_)
974 const struct freq *value = value_;
975 struct variable *v = v_;
977 return hsh_hash_bytes (value->v.s, v->width);
980 /* Ascending numeric compare of values. */
982 compare_value_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
984 const struct freq *a = a_;
985 const struct freq *b = b_;
989 else if (a->v.f < b->v.f)
995 /* Ascending string compare of values. */
997 compare_value_alpha_a (const void *a_, const void *b_, void *v_)
999 const struct freq *a = a_;
1000 const struct freq *b = b_;
1001 const struct variable *v = v_;
1003 return memcmp (a->v.s, b->v.s, v->width);
1006 /* Descending numeric compare of values. */
1008 compare_value_numeric_d (const void *a, const void *b, void *foo UNUSED)
1010 return -compare_value_numeric_a (a, b, foo);
1013 /* Descending string compare of values. */
1015 compare_value_alpha_d (const void *a, const void *b, void *v)
1017 return -compare_value_alpha_a (a, b, v);
1020 /* Ascending numeric compare of frequency;
1021 secondary key on ascending numeric value. */
1023 compare_freq_numeric_a (const void *a_, const void *b_, void *foo UNUSED)
1025 const struct freq *a = a_;
1026 const struct freq *b = b_;
1030 else if (a->c < b->c)
1033 if (a->v.f > b->v.f)
1035 else if (a->v.f < b->v.f)
1041 /* Ascending numeric compare of frequency;
1042 secondary key on ascending string value. */
1044 compare_freq_alpha_a (const void *a_, const void *b_, void *v_)
1046 const struct freq *a = a_;
1047 const struct freq *b = b_;
1048 const struct variable *v = v_;
1052 else if (a->c < b->c)
1055 return memcmp (a->v.s, b->v.s, v->width);
1058 /* Descending numeric compare of frequency;
1059 secondary key on ascending numeric value. */
1061 compare_freq_numeric_d (const void *a_, const void *b_, void *foo UNUSED)
1063 const struct freq *a = a_;
1064 const struct freq *b = b_;
1068 else if (a->c < b->c)
1071 if (a->v.f > b->v.f)
1073 else if (a->v.f < b->v.f)
1079 /* Descending numeric compare of frequency;
1080 secondary key on ascending string value. */
1082 compare_freq_alpha_d (const void *a_, const void *b_, void *v_)
1084 const struct freq *a = a_;
1085 const struct freq *b = b_;
1086 const struct variable *v = v_;
1090 else if (a->c < b->c)
1093 return memcmp (a->v.s, b->v.s, v->width);
1096 /* Frequency table display. */
1098 /* Sets the widths of all the columns and heights of all the rows in
1099 table T for driver D. */
1101 full_dim (struct tab_table *t, struct outp_driver *d)
1103 int lab = cmd.labels == FRQ_LABELS;
1107 t->w[0] = min (tab_natural_width (t, d, 0), d->prop_em_width * 15);
1108 for (i = lab; i < lab + 5; i++)
1109 t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
1110 for (i = 0; i < t->nr; i++)
1111 t->h[i] = d->font_height;
1114 /* Displays a full frequency table for variable V. */
1116 dump_full (struct variable *v)
1119 struct freq_tab *ft;
1121 struct tab_table *t;
1123 double cum_total = 0.0;
1124 double cum_freq = 0.0;
1134 static struct init vec[] =
1136 {4, 0, N_("Valid")},
1138 {1, 1, N_("Value")},
1139 {2, 1, N_("Frequency")},
1140 {3, 1, N_("Percent")},
1141 {4, 1, N_("Percent")},
1142 {5, 1, N_("Percent")},
1150 int lab = cmd.labels == FRQ_LABELS;
1152 ft = &get_var_freqs (v)->tab;
1153 n_categories = ft->n_valid + ft->n_missing;
1154 t = tab_create (5 + lab, n_categories + 3, 0);
1155 tab_headers (t, 0, 0, 2, 0);
1156 tab_dim (t, full_dim);
1159 tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value Label"));
1160 for (p = vec; p->s; p++)
1161 tab_text (t, p->c - (p->r ? !lab : 0), p->r,
1162 TAB_CENTER | TAT_TITLE, gettext (p->s));
1165 for (f = ft->valid; f < ft->missing; f++)
1167 double percent, valid_percent;
1171 percent = f->c / ft->total_cases * 100.0;
1172 valid_percent = f->c / ft->valid_cases * 100.0;
1173 cum_total += valid_percent;
1177 const char *label = val_labs_find (v->val_labs, f->v);
1179 tab_text (t, 0, r, TAB_LEFT, label);
1182 tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1183 tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1184 tab_float (t, 2 + lab, r, TAB_NONE, percent, 5, 1);
1185 tab_float (t, 3 + lab, r, TAB_NONE, valid_percent, 5, 1);
1186 tab_float (t, 4 + lab, r, TAB_NONE, cum_total, 5, 1);
1189 for (; f < &ft->valid[n_categories]; f++)
1195 const char *label = val_labs_find (v->val_labs, f->v);
1197 tab_text (t, 0, r, TAB_LEFT, label);
1200 tab_value (t, 0 + lab, r, TAB_NONE, &f->v, &v->print);
1201 tab_float (t, 1 + lab, r, TAB_NONE, f->c, 8, 0);
1202 tab_float (t, 2 + lab, r, TAB_NONE,
1203 f->c / ft->total_cases * 100.0, 5, 1);
1204 tab_text (t, 3 + lab, r, TAB_NONE, _("Missing"));
1208 tab_box (t, TAL_1, TAL_1,
1209 cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1211 tab_hline (t, TAL_2, 0, 4 + lab, 2);
1212 tab_hline (t, TAL_2, 0, 4 + lab, r);
1213 tab_joint_text (t, 0, r, 0 + lab, r, TAB_RIGHT | TAT_TITLE, _("Total"));
1214 tab_vline (t, TAL_0, 1, r, r);
1215 tab_float (t, 1 + lab, r, TAB_NONE, cum_freq, 8, 0);
1216 tab_float (t, 2 + lab, r, TAB_NONE, 100.0, 5, 1);
1217 tab_float (t, 3 + lab, r, TAB_NONE, 100.0, 5, 1);
1219 tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1224 /* Sets the widths of all the columns and heights of all the rows in
1225 table T for driver D. */
1227 condensed_dim (struct tab_table *t, struct outp_driver *d)
1229 int cum_w = max (outp_string_width (d, _("Cum")),
1230 max (outp_string_width (d, _("Cum")),
1231 outp_string_width (d, "000")));
1235 for (i = 0; i < 2; i++)
1236 t->w[i] = max (tab_natural_width (t, d, i), d->prop_em_width * 8);
1237 for (i = 2; i < 4; i++)
1239 for (i = 0; i < t->nr; i++)
1240 t->h[i] = d->font_height;
1243 /* Display condensed frequency table for variable V. */
1245 dump_condensed (struct variable *v)
1248 struct freq_tab *ft;
1250 struct tab_table *t;
1252 double cum_total = 0.0;
1254 ft = &get_var_freqs (v)->tab;
1255 n_categories = ft->n_valid + ft->n_missing;
1256 t = tab_create (4, n_categories + 2, 0);
1258 tab_headers (t, 0, 0, 2, 0);
1259 tab_text (t, 0, 1, TAB_CENTER | TAT_TITLE, _("Value"));
1260 tab_text (t, 1, 1, TAB_CENTER | TAT_TITLE, _("Freq"));
1261 tab_text (t, 2, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1262 tab_text (t, 3, 0, TAB_CENTER | TAT_TITLE, _("Cum"));
1263 tab_text (t, 3, 1, TAB_CENTER | TAT_TITLE, _("Pct"));
1264 tab_dim (t, condensed_dim);
1267 for (f = ft->valid; f < ft->missing; f++)
1271 percent = f->c / ft->total_cases * 100.0;
1272 cum_total += f->c / ft->valid_cases * 100.0;
1274 tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1275 tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1276 tab_float (t, 2, r, TAB_NONE, percent, 3, 0);
1277 tab_float (t, 3, r, TAB_NONE, cum_total, 3, 0);
1280 for (; f < &ft->valid[n_categories]; f++)
1282 tab_value (t, 0, r, TAB_NONE, &f->v, &v->print);
1283 tab_float (t, 1, r, TAB_NONE, f->c, 8, 0);
1284 tab_float (t, 2, r, TAB_NONE,
1285 f->c / ft->total_cases * 100.0, 3, 0);
1289 tab_box (t, TAL_1, TAL_1,
1290 cmd.spaces == FRQ_SINGLE ? -1 : (TAL_1 | TAL_SPACING), TAL_1,
1292 tab_hline (t, TAL_2, 0, 3, 2);
1293 tab_title (t, 1, "%s: %s", v->name, v->label ? v->label : "");
1294 tab_columns (t, SOM_COL_DOWN, 1);
1298 /* Statistical display. */
1300 /* Calculates all the pertinent statistics for variable V, putting
1301 them in array D[]. FIXME: This could be made much more optimal. */
1303 calc_stats (struct variable *v, double d[frq_n_stats])
1305 struct freq_tab *ft = &get_var_freqs (v)->tab;
1306 double W = ft->valid_cases;
1315 double *median_value;
1317 /* Calculate percentiles. */
1319 /* If the 50th percentile was not explicitly requested then we must
1320 calculate it anyway --- it's the median */
1322 for (i = 0; i < n_percentiles; i++)
1324 if (percentiles[i].p == 0.5)
1326 median_value = &percentiles[i].value;
1331 if ( 0 == median_value )
1333 add_percentile (0.5);
1337 for (i = 0; i < n_percentiles; i++)
1339 percentiles[i].flag = 0;
1340 percentiles[i].flag2 = 0;
1344 for (idx = 0; idx < ft->n_valid; ++idx)
1346 static double prev_value = SYSMIS;
1347 f = &ft->valid[idx];
1349 for (i = 0; i < n_percentiles; i++)
1352 if ( percentiles[i].flag2 ) continue ;
1354 if ( get_algorithm() != COMPATIBLE )
1356 (ft->valid_cases - 1) * percentiles[i].p;
1359 (ft->valid_cases + 1) * percentiles[i].p - 1;
1361 if ( percentiles[i].flag )
1363 percentiles[i].x2 = f->v.f;
1364 percentiles[i].x1 = prev_value;
1365 percentiles[i].flag2 = 1;
1371 if ( f->c > 1 && rank - (f->c - 1) > tp )
1373 percentiles[i].x2 = percentiles[i].x1 = f->v.f;
1374 percentiles[i].flag2 = 1;
1378 percentiles[i].flag=1;
1384 prev_value = f->v.f;
1387 for (i = 0; i < n_percentiles; i++)
1389 /* Catches the case when p == 100% */
1390 if ( ! percentiles[i].flag2 )
1391 percentiles[i].x1 = percentiles[i].x2 = f->v.f;
1394 printf("percentile %d (p==%.2f); X1 = %g; X2 = %g\n",
1395 i,percentiles[i].p,percentiles[i].x1,percentiles[i].x2);
1399 for (i = 0; i < n_percentiles; i++)
1401 struct freq_tab *ft = &get_var_freqs (v)->tab;
1405 if ( get_algorithm() != COMPATIBLE )
1407 s = modf((ft->valid_cases - 1) * percentiles[i].p , &dummy);
1411 s = modf((ft->valid_cases + 1) * percentiles[i].p -1, &dummy);
1414 percentiles[i].value = percentiles[i].x1 +
1415 ( percentiles[i].x2 - percentiles[i].x1) * s ;
1417 if ( percentiles[i].p == 0.50)
1418 median_value = &percentiles[i].value;
1422 /* Calculate the mode. */
1425 for (f = ft->valid; f < ft->missing; f++)
1427 if (most_often < f->c)
1432 else if (most_often == f->c)
1434 /* A duplicate mode is undefined.
1435 FIXME: keep track of *all* the modes. */
1440 /* Calculate moments. */
1441 m = moments_create (MOMENT_KURTOSIS);
1442 for (f = ft->valid; f < ft->missing; f++)
1443 moments_pass_one (m, f->v.f, f->c);
1444 for (f = ft->valid; f < ft->missing; f++)
1445 moments_pass_two (m, f->v.f, f->c);
1446 moments_calculate (m, NULL, &d[frq_mean], &d[frq_variance],
1447 &d[frq_skew], &d[frq_kurt]);
1448 moments_destroy (m);
1450 /* Formulas below are taken from _SPSS Statistical Algorithms_. */
1451 d[frq_min] = ft->valid[0].v.f;
1452 d[frq_max] = ft->valid[ft->n_valid - 1].v.f;
1453 d[frq_mode] = X_mode;
1454 d[frq_range] = d[frq_max] - d[frq_min];
1455 d[frq_median] = *median_value;
1456 d[frq_sum] = d[frq_mean] * W;
1457 d[frq_stddev] = sqrt (d[frq_variance]);
1458 d[frq_semean] = d[frq_stddev] / sqrt (W);
1459 d[frq_seskew] = calc_seskew (W);
1460 d[frq_sekurt] = calc_sekurt (W);
1463 /* Displays a table of all the statistics requested for variable V. */
1465 dump_statistics (struct variable *v, int show_varname)
1467 struct freq_tab *ft;
1468 double stat_value[frq_n_stats];
1469 struct tab_table *t;
1472 int n_explicit_percentiles = n_percentiles;
1474 if ( implicit_50th && n_percentiles > 0 )
1477 if (v->type == ALPHA)
1479 ft = &get_var_freqs (v)->tab;
1480 if (ft->n_valid == 0)
1482 msg (SW, _("No valid data for variable %s; statistics not displayed."),
1486 calc_stats (v, stat_value);
1488 t = tab_create (3, n_stats + n_explicit_percentiles + 2, 0);
1489 tab_dim (t, tab_natural_dimensions);
1491 tab_box (t, TAL_1, TAL_1, -1, -1 , 0 , 0 , 2, tab_nr(t) - 1) ;
1494 tab_vline (t, TAL_1 , 2, 0, tab_nr(t) - 1);
1495 tab_vline (t, TAL_1 | TAL_SPACING , 1, 0, tab_nr(t) - 1 ) ;
1497 r=2; /* N missing and N valid are always dumped */
1499 for (i = 0; i < frq_n_stats; i++)
1500 if (stats & BIT_INDEX (i))
1502 tab_text (t, 0, r, TAB_LEFT | TAT_TITLE,
1503 gettext (st_name[i].s10));
1504 tab_float (t, 2, r, TAB_NONE, stat_value[i], 11, 3);
1508 tab_text (t, 0, 0, TAB_LEFT | TAT_TITLE, _("N"));
1509 tab_text (t, 1, 0, TAB_LEFT | TAT_TITLE, _("Valid"));
1510 tab_text (t, 1, 1, TAB_LEFT | TAT_TITLE, _("Missing"));
1512 tab_float(t, 2, 0, TAB_NONE, ft->valid_cases, 11, 0);
1513 tab_float(t, 2, 1, TAB_NONE, ft->total_cases - ft->valid_cases, 11, 0);
1516 for (i = 0; i < n_explicit_percentiles; i++, r++)
1520 tab_text (t, 0, r, TAB_LEFT | TAT_TITLE, _("Percentiles"));
1523 tab_float (t, 1, r, TAB_LEFT, percentiles[i].p * 100, 3, 0 );
1524 tab_float (t, 2, r, TAB_NONE, percentiles[i].value, 11, 3);
1528 tab_columns (t, SOM_COL_DOWN, 1);
1532 tab_title (t, 1, "%s: %s", v->name, v->label);
1534 tab_title (t, 0, v->name);
1537 tab_flags (t, SOMF_NO_TITLE);
1544 /* Create a gsl_histogram from a freq_tab */
1546 freq_tab_to_hist(const struct freq_tab *ft, const struct variable *var)
1549 double x_min = DBL_MAX;
1550 double x_max = -DBL_MAX;
1552 gsl_histogram *hist;
1553 const double bins = 11;
1555 struct hsh_iterator hi;
1556 struct hsh_table *fh = ft->data;
1559 /* Find out the extremes of the x value */
1560 for ( frq = hsh_first(fh, &hi); frq != 0; frq = hsh_next(fh, &hi) )
1562 if ( is_missing(&frq->v, var))
1565 if ( frq->v.f < x_min ) x_min = frq->v.f ;
1566 if ( frq->v.f > x_max ) x_max = frq->v.f ;
1569 hist = histogram_create(bins, x_min, x_max);
1571 for( i = 0 ; i < ft->n_valid ; ++i )
1573 frq = &ft->valid[i];
1574 gsl_histogram_accumulate(hist, frq->v.f, frq->c);
1581 static struct slice *
1582 freq_tab_to_slice_array(const struct freq_tab *frq_tab,
1583 const struct variable *var,
1587 /* Allocate an array of slices and fill them from the data in frq_tab
1588 n_slices will contain the number of slices allocated.
1589 The caller is responsible for freeing slices
1591 static struct slice *
1592 freq_tab_to_slice_array(const struct freq_tab *frq_tab,
1593 const struct variable *var,
1597 struct slice *slices;
1599 *n_slices = frq_tab->n_valid;
1601 slices = xmalloc ( *n_slices * sizeof (struct slice ) );
1603 for (i = 0 ; i < *n_slices ; ++i )
1605 const struct freq *frq = &frq_tab->valid[i];
1607 slices[i].label = value_to_string(&frq->v, var);
1609 slices[i].magnetude = frq->c;
1619 do_piechart(const struct variable *var, const struct freq_tab *frq_tab)
1621 struct slice *slices;
1624 slices = freq_tab_to_slice_array(frq_tab, var, &n_slices);
1626 piechart_plot(var_to_string(var), slices, n_slices);