gui: Fix behavior of print preview in psppire-output-window.
[pspp] / src / math / sort.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2006, 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 "math/sort.h"
20
21 #include <stdio.h>
22
23 #include "data/case.h"
24 #include "data/casereader.h"
25 #include "data/casewriter-provider.h"
26 #include "data/casewriter.h"
27 #include "data/settings.h"
28 #include "data/subcase.h"
29 #include "libpspp/array.h"
30 #include "libpspp/assertion.h"
31 #include "math/merge.h"
32
33 #include "gl/xalloc.h"
34
35 #include "gettext.h"
36 #define _(msgid) gettext (msgid)
37
38 /* These should only be changed for testing purposes. */
39 int min_buffers = 64;
40 int max_buffers = INT_MAX;
41
42 struct sort_writer
43   {
44     struct caseproto *proto;
45     struct subcase ordering;
46     struct merge *merge;
47     struct pqueue *pqueue;
48
49     struct casewriter *run;
50     casenumber run_id;
51     struct ccase *run_end;
52   };
53
54 static struct casewriter_class sort_casewriter_class;
55
56 static struct pqueue *pqueue_create (const struct subcase *,
57                                      const struct caseproto *);
58 static void pqueue_destroy (struct pqueue *);
59 static bool pqueue_is_full (const struct pqueue *);
60 static bool pqueue_is_empty (const struct pqueue *);
61 static void pqueue_push (struct pqueue *, struct ccase *, casenumber);
62 static struct ccase *pqueue_pop (struct pqueue *, casenumber *);
63
64 static void output_record (struct sort_writer *);
65
66 struct casewriter *
67 sort_create_writer (const struct subcase *ordering,
68                     const struct caseproto *proto)
69 {
70   struct sort_writer *sort;
71
72   sort = xmalloc (sizeof *sort);
73   sort->proto = caseproto_ref (proto);
74   subcase_clone (&sort->ordering, ordering);
75   sort->merge = merge_create (ordering, proto);
76   sort->pqueue = pqueue_create (ordering, proto);
77   sort->run = NULL;
78   sort->run_id = 0;
79   sort->run_end = NULL;
80
81   return casewriter_create (proto, &sort_casewriter_class, sort);
82 }
83
84 static void
85 sort_casewriter_write (struct casewriter *writer UNUSED, void *sort_,
86                        struct ccase *c)
87 {
88   struct sort_writer *sort = sort_;
89   bool next_run;
90
91   if (pqueue_is_full (sort->pqueue))
92     output_record (sort);
93
94   next_run = (sort->run_end == NULL
95               || subcase_compare_3way (&sort->ordering, c,
96                                        &sort->ordering, sort->run_end) < 0);
97   pqueue_push (sort->pqueue, c, sort->run_id + (next_run ? 1 : 0));
98 }
99
100 static void
101 sort_casewriter_destroy (struct casewriter *writer UNUSED, void *sort_)
102 {
103   struct sort_writer *sort = sort_;
104
105   subcase_destroy (&sort->ordering);
106   merge_destroy (sort->merge);
107   pqueue_destroy (sort->pqueue);
108   casewriter_destroy (sort->run);
109   case_unref (sort->run_end);
110   caseproto_unref (sort->proto);
111   free (sort);
112 }
113
114 static struct casereader *
115 sort_casewriter_convert_to_reader (struct casewriter *writer, void *sort_)
116 {
117   struct sort_writer *sort = sort_;
118   struct casereader *output;
119
120   if (sort->run == NULL && sort->run_id == 0)
121     {
122       /* In-core sort. */
123       sort->run = mem_writer_create (sort->proto);
124       sort->run_id = 1;
125     }
126   while (!pqueue_is_empty (sort->pqueue))
127     output_record (sort);
128
129   merge_append (sort->merge, casewriter_make_reader (sort->run));
130   sort->run = NULL;
131
132   output = merge_make_reader (sort->merge);
133   sort_casewriter_destroy (writer, sort);
134   return output;
135 }
136
137 static void
138 output_record (struct sort_writer *sort)
139 {
140   struct ccase *min_case;
141   casenumber min_run_id;
142
143   min_case = pqueue_pop (sort->pqueue, &min_run_id);
144 #if 0
145   printf ("\toutput: %f to run %d\n", case_num_idx (min_case, 0), min_run_id);
146 #endif
147
148   if (sort->run_id != min_run_id && sort->run != NULL)
149     {
150       merge_append (sort->merge, casewriter_make_reader (sort->run));
151       sort->run = NULL;
152     }
153   if (sort->run == NULL)
154     {
155       sort->run = tmpfile_writer_create (sort->proto);
156       sort->run_id = min_run_id;
157     }
158
159   case_unref (sort->run_end);
160   sort->run_end = case_ref (min_case);
161   casewriter_write (sort->run, min_case);
162 }
163
164 static struct casewriter_class sort_casewriter_class =
165   {
166     sort_casewriter_write,
167     sort_casewriter_destroy,
168     sort_casewriter_convert_to_reader,
169   };
170 \f
171 /* Reads all the cases from INPUT.  Sorts the cases according to
172    ORDERING.  Returns the sorted cases in a new casereader.
173    INPUT is destroyed by this function.
174  */
175 struct casereader *
176 sort_execute (struct casereader *input, const struct subcase *ordering)
177 {
178   struct casewriter *output =
179     sort_create_writer (ordering, casereader_get_proto (input));
180   casereader_transfer (input, output);
181   return casewriter_make_reader (output);
182 }
183
184 /* Reads all the cases from INPUT.  Sorts the cases in ascending
185    order according to VARIABLE.  Returns the sorted cases in a
186    new casereader.  INPUT is destroyed by this function. */
187 struct casereader *
188 sort_execute_1var (struct casereader *input, const struct variable *var)
189 {
190   struct subcase sc;
191   struct casereader *reader;
192
193   subcase_init_var (&sc, var, SC_ASCEND);
194   reader = sort_execute (input, &sc);
195   subcase_destroy (&sc);
196   return reader;
197 }
198 \f
199 struct pqueue
200   {
201     struct subcase ordering;
202     struct pqueue_record *records;
203     size_t record_cnt;
204     size_t record_cap;
205     casenumber idx;
206   };
207
208 struct pqueue_record
209   {
210     casenumber id;
211     struct ccase *c;
212     casenumber idx;
213   };
214
215 static int compare_pqueue_records_minheap (const void *a, const void *b,
216                                            const void *pq_);
217
218 static struct pqueue *
219 pqueue_create (const struct subcase *ordering, const struct caseproto *proto)
220 {
221   struct pqueue *pq;
222
223   pq = xmalloc (sizeof *pq);
224   subcase_clone (&pq->ordering, ordering);
225   pq->record_cap = settings_get_workspace_cases (proto);
226   if (pq->record_cap > max_buffers)
227     pq->record_cap = max_buffers;
228   else if (pq->record_cap < min_buffers)
229     pq->record_cap = min_buffers;
230   pq->record_cnt = 0;
231   pq->records = xnmalloc (pq->record_cap, sizeof *pq->records);
232   pq->idx = 0;
233
234   return pq;
235 }
236
237 static void
238 pqueue_destroy (struct pqueue *pq)
239 {
240   if (pq != NULL)
241     {
242       while (!pqueue_is_empty (pq))
243         {
244           casenumber id;
245           struct ccase *c = pqueue_pop (pq, &id);
246           case_unref (c);
247         }
248       subcase_destroy (&pq->ordering);
249       free (pq->records);
250       free (pq);
251     }
252 }
253
254 static bool
255 pqueue_is_full (const struct pqueue *pq)
256 {
257   return pq->record_cnt >= pq->record_cap;
258 }
259
260 static bool
261 pqueue_is_empty (const struct pqueue *pq)
262 {
263   return pq->record_cnt == 0;
264 }
265
266 static void
267 pqueue_push (struct pqueue *pq, struct ccase *c, casenumber id)
268 {
269   struct pqueue_record *r;
270
271   assert (!pqueue_is_full (pq));
272
273   r = &pq->records[pq->record_cnt++];
274   r->id = id;
275   r->c = c;
276   r->idx = pq->idx++;
277
278   push_heap (pq->records, pq->record_cnt, sizeof *pq->records,
279              compare_pqueue_records_minheap, pq);
280 }
281
282 static struct ccase *
283 pqueue_pop (struct pqueue *pq, casenumber *id)
284 {
285   struct pqueue_record *r;
286
287   assert (!pqueue_is_empty (pq));
288
289   pop_heap (pq->records, pq->record_cnt--, sizeof *pq->records,
290             compare_pqueue_records_minheap, pq);
291
292   r = &pq->records[pq->record_cnt];
293   *id = r->id;
294   return r->c;
295 }
296
297 /* Compares record-run tuples A and B on id, then on case data,
298    then on insertion order, in descending order. */
299 static int
300 compare_pqueue_records_minheap (const void *a_, const void *b_,
301                                 const void *pq_)
302 {
303   const struct pqueue_record *a = a_;
304   const struct pqueue_record *b = b_;
305   const struct pqueue *pq = pq_;
306   int result = a->id < b->id ? -1 : a->id > b->id;
307   if (result == 0)
308     result = subcase_compare_3way (&pq->ordering, a->c, &pq->ordering, b->c);
309   if (result == 0)
310     result = a->idx < b->idx ? -1 : a->idx > b->idx;
311   return -result;
312 }