casereader: New function casereader_translate_stateless().
[pspp-builds.git] / src / data / casereader.h
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 /* Casereader client interface.
18
19    A casereader abstracts interfaces through which cases may be
20    read.  A casereader may be a front-end for a system file, a
21    portable file, the active file in a data set, or anything else
22    on which a casereader interface has been overlaid.  Casereader
23    layering, in which a casereader acts as a filter or translator
24    on top of another casereader, is also supported.
25
26    There is no central interface for obtaining casereaders: a
27    casereader for reading a system file is obtained from the
28    system file reading module, and so on.  Once a casereader has
29    been obtained, by whatever means, the interface to it is
30    uniform.  The most important functions for casereader usage
31    are:
32
33      - casereader_read: Reads a case from the casereader.  The
34        case is consumed and cannot be read again.  The caller is
35        responsible for destroying the case.
36
37      - casereader_clone: Makes a copy of a casereader.  May be
38        used to read one or a set of cases from a casereader
39        repeatedly.
40
41      - casereader_destroy: Destroys a casereader.
42
43    Casereaders can encounter error conditions, such as I/O
44    errors, as they read cases.  Error conditions prevent any more
45    cases from being read from the casereader.  Error conditions
46    are reported by casereader_error.  Error condition may be
47    propagated to or from a casereader with taint_propagate using
48    the casereader's taint object, which may be obtained with
49    casereader_get_taint. */
50
51 #ifndef DATA_CASEREADER_H
52 #define DATA_CASEREADER_H 1
53
54 #include <libpspp/compiler.h>
55 #include <data/case.h>
56 #include <data/missing-values.h>
57
58 struct dictionary;
59 struct casereader;
60 struct casewriter;
61
62 struct ccase *casereader_read (struct casereader *);
63 bool casereader_destroy (struct casereader *);
64
65 struct casereader *casereader_clone (const struct casereader *);
66 void casereader_split (struct casereader *,
67                        struct casereader **, struct casereader **);
68 struct casereader *casereader_rename (struct casereader *);
69 void casereader_swap (struct casereader *, struct casereader *);
70
71 struct ccase *casereader_peek (struct casereader *, casenumber);
72 bool casereader_is_empty (struct casereader *);
73
74 bool casereader_error (const struct casereader *);
75 void casereader_force_error (struct casereader *);
76 const struct taint *casereader_get_taint (const struct casereader *);
77
78 casenumber casereader_get_case_cnt (struct casereader *);
79 casenumber casereader_count_cases (struct casereader *);
80 void casereader_truncate (struct casereader *, casenumber);
81 const struct caseproto *casereader_get_proto (const struct casereader *);
82
83 casenumber casereader_advance (struct casereader *, casenumber);
84 void casereader_transfer (struct casereader *, struct casewriter *);
85 \f
86 struct casereader *casereader_create_empty (const struct caseproto *);
87
88 struct casereader *
89 casereader_create_filter_func (struct casereader *,
90                                bool (*include) (const struct ccase *,
91                                                 void *aux),
92                                bool (*destroy) (void *aux),
93                                void *aux,
94                                struct casewriter *exclude);
95 struct casereader *
96 casereader_create_filter_weight (struct casereader *,
97                                  const struct dictionary *dict,
98                                  bool *warn_on_invalid,
99                                  struct casewriter *exclude);
100 struct casereader *
101 casereader_create_filter_missing (struct casereader *,
102                                   const struct variable **vars, size_t var_cnt,
103                                   enum mv_class,
104                                   casenumber *n_missing,
105                                   struct casewriter *exclude);
106
107 struct casereader *
108 casereader_create_counter (struct casereader *, casenumber *counter,
109                            casenumber initial_value);
110
111 struct casereader *
112 casereader_create_translator (struct casereader *,
113                               const struct caseproto *output_proto,
114                               struct ccase *(*translate) (struct ccase *,
115                                                           void *aux),
116                               bool (*destroy) (void *aux),
117                               void *aux);
118
119 struct casereader *
120 casereader_translate_stateless (struct casereader *,
121                                 const struct caseproto *output_proto,
122                                 struct ccase *(*translate) (struct ccase *,
123                                                             casenumber idx,
124                                                             const void *aux),
125                                 bool (*destroy) (void *aux),
126                                 void *aux);
127
128 /* A function which creates a numberic value from an existing case */
129 typedef double new_value_func (const struct ccase *, casenumber, void *);
130
131 struct casereader *
132 casereader_create_append_numeric (struct casereader *subreader,
133                                   new_value_func func, void *aux,
134                                   void (*destroy) (void *aux));
135
136 struct casereader *
137 casereader_create_arithmetic_sequence (struct casereader *,
138                                        double first, double increment);
139
140 enum rank_error
141   {
142     RANK_ERR_NONE = 0,
143     RANK_ERR_NEGATIVE_WEIGHT = 0x01,
144     RANK_ERR_UNSORTED = 0x02
145   };
146
147
148 typedef void distinct_func (double v, casenumber n, double w, void *aux);
149
150 struct casereader *
151 casereader_create_append_rank (struct casereader *,
152                                const struct variable *v, const struct variable *w,
153                                enum rank_error *err,
154                                distinct_func *distinct_callback, void *aux);
155
156 struct casereader *
157 casereader_create_distinct (struct casereader *input,
158                             const struct variable *key,
159                             const struct variable *weight);
160
161
162 #endif /* data/casereader.h */