File: utils_csv.hpp

package info (click to toggle)
r-bioc-alabaster.base 1.6.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,652 kB
  • sloc: cpp: 11,377; sh: 29; makefile: 2
file content (380 lines) | stat: -rw-r--r-- 10,112 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
#ifndef TAKANE_UTILS_CSV_HPP
#define TAKANE_UTILS_CSV_HPP

#include "ritsuko/ritsuko.hpp"
#include "comservatory/comservatory.hpp"

#include <unordered_set>
#include <string>
#include <stdexcept>
#include <vector>
#include <memory>

/**
 * @file utils_csv.hpp
 * @brief Utilities for parsing CSVs.
 */

namespace takane {

/**
 * @brief Create `comservatory::Field` objects to capture column contents.
 *
 * Instances of `CsvFieldCreator` subclasses can be passed to CSV validators like `csv_data_frame::validate()`.
 * This allows the validator to execute user-defined code when parsing each column, typically to store the column's contents in a user-defined memory allocation.
 * The contents can then be extracted for later inspection by the caller (e.g., in R or Python-managed vectors).
 */
struct CsvFieldCreator {
    /**
     * @cond
     */
    ~CsvFieldCreator() = default;
    /**
     * @endcond
     */

    /**
     * @return Instance of a `comservatory::NumberField` subclass,
     * possibly specialized to hold integer data.
     */
    virtual comservatory::NumberField* integer() {
        return number();
    }

    /**
     * @return Instance of a `comservatory::StringField` subclass.
     */
    virtual comservatory::StringField* string() = 0;

    /**
     * @return Instance of a `comservatory::NumberField` subclass.
     */
    virtual comservatory::NumberField* number() = 0;

    /**
     * @return Instance of a `comservatory::BooleanField` subclass.
     */
    virtual comservatory::BooleanField* boolean() = 0;
};

/**
 * @brief Dummy column creator.
 *
 * This is used by default when no `CsvFieldCreator` is provided in the various validators.
 * The returned `comservatory::Field` objects are dummies that no-op upon `push_back()` or `add_missing()`.
 * This is useful when the column contents do not need to be retained in memory.
 */
struct DummyCsvFieldCreator : public CsvFieldCreator {
    comservatory::StringField* string() {
        return new comservatory::DummyStringField;
    }

    comservatory::NumberField* number() {
        return new comservatory::DummyNumberField;
    }

    comservatory::BooleanField* boolean() {
        return new comservatory::DummyBooleanField;
    }
};

/**
 * @brief Contents of the parsed CSV.
 */
struct CsvContents {
    /**
     * Vector corresponding to the fields in the CSV,
     * Each entry is either generated by one of the `CsvFieldCreator` methods or is a `comservatory::UnknownField`.
     */
    std::vector<std::unique_ptr<comservatory::Field> > fields;

    /**
     * @cond
     */
    void reconstitute(std::vector<std::unique_ptr<comservatory::Field> >& source) {
        for (size_t c = 0, total = source.size(); c < total; ++c) { 
            if (!fields[c]) {
                fields[c].swap(source[c]);
            }
        }
    }
    /**
     * @endcond
     */
};

/**
 * @cond
 */
struct CsvNameField : public comservatory::StringField {
    CsvNameField(bool ar, comservatory::StringField* p) : as_rownames(ar), child(p) {}

public:
    bool as_rownames;
    comservatory::StringField* child;

public:
    void add_missing() {
        throw std::runtime_error("missing values should not be present in the " + (as_rownames ? std::string("row names") : std::string("names")) + " column");
    }

    void push_back(std::string x) {
        child->push_back(std::move(x));
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const {
        return true;
    }
};

template<typename T>
constexpr T upper_integer_limit() {
    return 2147483647;
}

template<typename T>
constexpr T lower_integer_limit() {
    return -2147483648;
}

struct CsvIntegerField : public comservatory::NumberField {
    CsvIntegerField(int cid, comservatory::NumberField* p) : column_id(cid), child(p) {}

public:
    int column_id;
    comservatory::NumberField* child;

public:
    void add_missing() {
        child->add_missing();
    }

    void push_back(double x) {
        if (x < lower_integer_limit<double>() || x > upper_integer_limit<double>()) { // constrain within limits.
            throw std::runtime_error("value in column " + std::to_string(column_id + 1) + " does not fit inside a 32-bit signed integer");
        }
        if (x != std::floor(x)) {
            throw std::runtime_error("value in column " + std::to_string(column_id + 1) + " is not an integer");
        }
        child->push_back(x);
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const {
        return true;
    }
};

struct CsvNonNegativeIntegerField : public comservatory::NumberField {
    CsvNonNegativeIntegerField(int cid, comservatory::NumberField* p) : column_id(cid), child(p) {}

public:
    int column_id;
    comservatory::NumberField* child;

public:
    void add_missing() {
        child->add_missing();
    }

    void push_back(double x) {
        if (x < 0) {
            throw std::runtime_error("value in column " + std::to_string(column_id + 1) + " should not be negative");
        }
        if (x > upper_integer_limit<double>()) {
            throw std::runtime_error("value in column " + std::to_string(column_id + 1) + " does not fit inside a 32-bit signed integer");
        }
        if (x != std::floor(x)) {
            throw std::runtime_error("value in column " + std::to_string(column_id + 1) + " is not an integer");
        }
        child->push_back(x);
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const {
        return true;
    }
};

struct CsvDateField : public comservatory::StringField {
    CsvDateField(int cid, comservatory::StringField* p) : column_id(cid), child(p) {}

public:
    int column_id;
    comservatory::StringField* child;

public:
    void push_back(std::string x) {
        if (!ritsuko::is_date(x.c_str(), x.size())) {
            throw std::runtime_error("expected a date in column " + std::to_string(column_id + 1) + ", got '" + x + "' instead");
        }
        child->push_back(std::move(x));
    }

    void add_missing() {
        child->add_missing();
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const { 
        return true;
    }
};

struct CsvDateTimeField : public comservatory::StringField {
    CsvDateTimeField(int cid, comservatory::StringField* p) : column_id(cid), child(p) {}

public:
    int column_id;
    comservatory::StringField* child;

public:
    void push_back(std::string x) {
        if (!ritsuko::is_rfc3339(x.c_str(), x.size())) {
            throw std::runtime_error("expected an Internet date/time in column " + std::to_string(column_id + 1) + ", got '" + x + "' instead");
        }
        child->push_back(std::move(x));
    }

    void add_missing() {
        child->add_missing();
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const { 
        return true;
    }
};

struct CsvFactorV1Field : public comservatory::StringField {
    CsvFactorV1Field(int cid, const std::unordered_set<std::string>* l, comservatory::StringField* p) : column_id(cid), levels(l), child(p) {}

public:
    int column_id;
    const std::unordered_set<std::string>* levels;
    comservatory::StringField* child;

public:
    void push_back(std::string x) {
        if (levels->find(x) == levels->end()) {
            throw std::runtime_error("value '" + x + "' in column " + std::to_string(column_id + 1) + " does not refer to a valid level");
        }
        child->push_back(std::move(x));
    }

    void add_missing() {
        child->add_missing();
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const { 
        return true;
    }
};

struct CsvFactorV2Field : public comservatory::NumberField {
    CsvFactorV2Field(int cid, size_t l, comservatory::NumberField* p) : column_id(cid), nlevels(l), child(p) {
        if (nlevels > upper_integer_limit<size_t>()) {
            throw std::runtime_error("number of levels must fit into a 32-bit signed integer");
        }
    }

public:
    int column_id;
    double nlevels; // casting for an easier comparison.
    comservatory::NumberField* child;

public:
    void push_back(double x) {
        if (x < 0 || x >= nlevels) {
            throw std::runtime_error("code in column " + std::to_string(column_id + 1) + " should be non-negative and less than the number of levels");
        }
        if (x != std::floor(x)) {
            throw std::runtime_error("value in column " + std::to_string(column_id + 1) + " is not an integer");
        }
        child->push_back(x);
    }

    void add_missing() {
        child->add_missing();
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const { 
        return true;
    }
};

struct CsvCompressedLengthField : public CsvNonNegativeIntegerField {
    CsvCompressedLengthField(int cid, comservatory::NumberField* p) : CsvNonNegativeIntegerField(cid, p) {}

    void add_missing() {
        throw std::runtime_error("lengths should not be missing");
    }

    void push_back(double x) {
        CsvNonNegativeIntegerField::push_back(x);
        total += static_cast<size_t>(x);
    }

    size_t total = 0;
};

struct CsvUniqueStringField : public comservatory::StringField {
    CsvUniqueStringField(int cid, comservatory::StringField* p) : column_id(cid), child(p) {}

private:
    int column_id;
    comservatory::StringField* child;
    std::unordered_set<std::string> collected;

public:
    void add_missing() {
        throw std::runtime_error("missing values should not be present in column " + std::to_string(column_id));
    }

    void push_back(std::string x) {
        if (collected.find(x) != collected.end()) {
            throw std::runtime_error("duplicated value '" + x + "' in column " + std::to_string(column_id));
        }
        collected.insert(x);
        child->push_back(std::move(x));
    }

    size_t size() const {
        return child->size();
    }

    bool filled() const { 
        return true;
    }
};
/**
 * @endcond
 */

}

#endif