u8-istream: Fix handling of partial reads.
[pspp] / src / math / box-whisker.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2008, 2009, 2011 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "box-whisker.h"
20
21 #include <math.h>
22 #include <float.h>
23
24 #include "data/case.h"
25 #include "data/data-out.h"
26 #include "data/val-type.h"
27 #include "data/variable.h"
28 #include "libpspp/assertion.h"
29 #include "libpspp/cast.h"
30 #include "libpspp/str.h"
31 #include "math/order-stats.h"
32 #include "math/tukey-hinges.h"
33
34 #include "gl/xalloc.h"
35
36 static void
37 destroy (struct statistic *s)
38 {
39   struct box_whisker *bw = UP_CAST (s, struct box_whisker, parent.parent);
40   struct order_stats *os = &bw->parent;
41   struct ll *ll;
42
43   for (ll = ll_head (&bw->outliers); ll != ll_null (&bw->outliers); )
44     {
45       struct outlier *e = ll_data (ll, struct outlier, ll);
46
47       ll = ll_next (ll);
48
49       ds_destroy (&e->label);
50       free (e);
51     }
52
53   free (os->k);
54   free (s);
55 };
56
57
58 static void
59 acc (struct statistic *s, const struct ccase *cx,
60      double c UNUSED, double cc UNUSED, double y)
61 {
62   struct box_whisker *bw = UP_CAST (s, struct box_whisker, parent.parent);
63   bool extreme;
64   struct outlier *o;
65
66   if ( y < bw->hinges[2] + bw->step)
67       bw->whiskers[1] = y;
68
69   if (bw->whiskers[0] == SYSMIS ||  bw->hinges[0] - bw->step > y)
70       bw->whiskers[0] = y;
71
72   if ( y > bw->hinges[2] + bw->step)
73     extreme = (y > bw->hinges[2] + 2 * bw->step) ;
74
75   else if (y < bw->hinges[0] - bw->step)
76     extreme = (y < bw->hinges[0] - 2 * bw->step) ;
77
78   else
79     return;
80
81   o = xzalloc (sizeof *o) ;
82   o->value = y;
83   o->extreme = extreme;
84   ds_init_empty (&o->label);
85
86   if (bw->id_var)
87     {
88       char *s = data_out (case_data_idx (cx, bw->id_idx),
89                            var_get_encoding (bw->id_var),
90                            var_get_print_format (bw->id_var));
91
92       ds_put_cstr (&o->label, s);
93       free (s);
94     }
95   else
96     {
97       ds_put_format (&o->label,
98                      "%ld",
99                      (casenumber) case_data_idx (cx, bw->id_idx)->f);
100     }
101
102   ll_push_head (&bw->outliers, &o->ll);
103 }
104
105 void
106 box_whisker_whiskers (const struct box_whisker *bw, double whiskers[2])
107 {
108   whiskers[0] = bw->whiskers[0];
109   whiskers[1] = bw->whiskers[1];
110 }
111
112 void
113 box_whisker_hinges (const struct box_whisker *bw, double hinges[3])
114 {
115   hinges[0] = bw->hinges[0];
116   hinges[1] = bw->hinges[1];
117   hinges[2] = bw->hinges[2];
118 }
119
120 const struct ll_list *
121 box_whisker_outliers (const struct box_whisker *bw)
122 {
123   return &bw->outliers;
124 }
125
126 /*
127   Create a box_whisker struct, suitable for generating a boxplot.
128
129   TH are the tukey hinges of the dataset.
130
131   id_idx is the index into the casereader which will be used to label 
132   outliers.
133   id_var is the variable from which that label came, or NULL
134 */
135 struct box_whisker *
136 box_whisker_create (const struct tukey_hinges *th,
137                     size_t id_idx, const struct variable *id_var)
138 {
139   struct box_whisker *w = xzalloc (sizeof (*w));
140   struct order_stats *os = &w->parent;
141   struct statistic *stat = &os->parent;
142
143   os->n_k = 0;
144
145   stat->destroy = destroy;
146   stat->accumulate = acc;
147
148   tukey_hinges_calculate (th, w->hinges);
149
150   w->id_idx = id_idx;
151   w->id_var = id_var;
152
153   w->step = (w->hinges[2] - w->hinges[0]) * 1.5;
154
155   w->whiskers[1] = w->hinges[2];
156   w->whiskers[0] = SYSMIS;
157
158   ll_init (&w->outliers);
159
160   return w;
161 }