2ff57c6e5ba6fa0a88a9237f95782cb55332bbd6
[pspp-builds.git] / src / math / merge.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2007, 2009 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 /* FIXME: error checking. */
18 /* FIXME: merge pattern should be improved, this one causes a
19    performance regression. */
20 #include <config.h>
21
22 #include <math/merge.h>
23
24 #include <data/case.h>
25 #include <data/casereader.h>
26 #include <data/casewriter.h>
27 #include <data/subcase.h>
28 #include <libpspp/array.h>
29 #include <libpspp/assertion.h>
30 #include <libpspp/taint.h>
31
32 #include "xalloc.h"
33
34 #define MAX_MERGE_ORDER 7
35
36 struct merge_input
37   {
38     struct casereader *reader;
39     struct ccase *c;
40   };
41
42 struct merge
43   {
44     struct subcase ordering;
45     struct merge_input inputs[MAX_MERGE_ORDER];
46     size_t input_cnt;
47     size_t value_cnt;
48   };
49
50 static void do_merge (struct merge *m);
51
52 struct merge *
53 merge_create (const struct subcase *ordering, size_t value_cnt)
54 {
55   struct merge *m = xmalloc (sizeof *m);
56   subcase_clone (&m->ordering, ordering);
57   m->input_cnt = 0;
58   m->value_cnt = value_cnt;
59   return m;
60 }
61
62 void
63 merge_destroy (struct merge *m)
64 {
65   if (m != NULL)
66     {
67       size_t i;
68
69       subcase_destroy (&m->ordering);
70       for (i = 0; i < m->input_cnt; i++)
71         casereader_destroy (m->inputs[i].reader);
72       free (m);
73     }
74 }
75
76 void
77 merge_append (struct merge *m, struct casereader *r)
78 {
79   r = casereader_rename (r);
80   m->inputs[m->input_cnt++].reader = r;
81   if (m->input_cnt >= MAX_MERGE_ORDER)
82     do_merge (m);
83 }
84
85 struct casereader *
86 merge_make_reader (struct merge *m)
87 {
88   struct casereader *r;
89
90   if (m->input_cnt > 1)
91     do_merge (m);
92
93   if (m->input_cnt == 1)
94     {
95       r = m->inputs[0].reader;
96       m->input_cnt = 0;
97     }
98   else if (m->input_cnt == 0)
99     {
100       struct casewriter *writer = mem_writer_create (m->value_cnt);
101       r = casewriter_make_reader (writer);
102     }
103   else
104     NOT_REACHED ();
105
106   return r;
107 }
108
109 static bool
110 read_input_case (struct merge *m, size_t idx)
111 {
112   struct merge_input *i = &m->inputs[idx];
113
114   i->c = casereader_read (i->reader);
115   if (i->c)
116     return true;
117   else
118     {
119       casereader_destroy (i->reader);
120       remove_element (m->inputs, m->input_cnt, sizeof *m->inputs, idx);
121       m->input_cnt--;
122       return false;
123     }
124 }
125
126 static void
127 do_merge (struct merge *m)
128 {
129   struct casewriter *w;
130   size_t i;
131
132   assert (m->input_cnt > 1);
133
134   w = tmpfile_writer_create (m->value_cnt);
135   for (i = 0; i < m->input_cnt; i++)
136     taint_propagate (casereader_get_taint (m->inputs[i].reader),
137                      casewriter_get_taint (w));
138
139   for (i = 0; i < m->input_cnt; )
140     if (read_input_case (m, i))
141       i++;
142   while (m->input_cnt > 0)
143     {
144       size_t min;
145
146       min = 0;
147       for (i = 1; i < m->input_cnt; i++)
148         if (subcase_compare_3way (&m->ordering, m->inputs[i].c,
149                                   &m->ordering, m->inputs[min].c) < 0)
150           min = i;
151
152       casewriter_write (w, m->inputs[min].c);
153       read_input_case (m, min);
154     }
155
156   m->input_cnt = 1;
157   m->inputs[0].reader = casewriter_make_reader (w);
158 }
159