forked from AmbaPant/mantid
-
Notifications
You must be signed in to change notification settings - Fork 1
/
InterpolateTest.h
411 lines (337 loc) · 17.1 KB
/
InterpolateTest.h
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include <cxxtest/TestSuite.h>
#include "MantidHistogramData/Histogram.h"
#include "MantidHistogramData/Interpolate.h"
#include "MantidHistogramData/LinearGenerator.h"
using namespace Mantid::HistogramData;
class InterpolateTest : public CxxTest::TestSuite {
public:
// This pair of boilerplate methods prevent the suite being created statically
// This means the constructor isn't called when running other tests
static InterpolateTest *createSuite() { return new InterpolateTest(); }
static void destroySuite(InterpolateTest *suite) { delete suite; }
// ---------------------------------------------------------------------------
// Success cases - linear in-place no copy
// ---------------------------------------------------------------------------
void test_interpolateLinearInPlaceDoes_Not_Copy() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0, 0, 2});
auto xAddrBefore = &input.x();
auto yAddrBefore = &input.y();
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(input, 4));
TS_ASSERT_EQUALS(xAddrBefore, &input.x());
TS_ASSERT_EQUALS(yAddrBefore, &input.y());
}
// ---------------------------------------------------------------------------
// Success cases - linear, point X data
// ---------------------------------------------------------------------------
void test_interpolateLinearPointDataSet_Stepsize_One_Less_Point_Size() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0, 0, 2});
auto output = interpolateLinear(input, 4);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-2., -1., 0., 1., 2.};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(inOut, 4));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
void test_interpolateLinearPointDataSet_Even_StepSize() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0.5, 0, 2},
CountStandardDeviations{2., 0., 1., 0., 1.});
auto output = interpolateLinear(input, 2);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-2., -0.75, 0.5, 1.25, 2.};
std::vector<double> expectedE = {2., 0., 1., 0., 1.};
checkData(input, output, expectedY, expectedE);
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(inOut, 2));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
void test_interpolateLinearPointDataSet_Odd_StepSize() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0.0, 0.5, 2});
auto output = interpolateLinear(input, 3);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-2., -2 + (2.5 / 1.5) * 0.5, -1. / 3., 0.5, 2.};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(inOut, 3));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
void test_interpolateLinearPointDataSet_Errors_No_Interpolation_Error() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0., 0, 2}, CountStandardDeviations{2., 0., 1., 0., 1.});
auto output = interpolateLinear(input, 2, true);
checkSizesUnchanged(input, output);
std::vector<double> expectedE = {2., sqrt(5) / 2, 1., sqrt(2) / 2, 1.};
checkData(input, output, {}, expectedE);
}
void test_interpolateLinearPointDataSet_CorrelatedErrors_No_Interpolation_Error() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0., 0, 2}, CountStandardDeviations{2., 0., 1., 0., 1.});
auto output = interpolateLinear(input, 2, true, false);
checkSizesUnchanged(input, output);
std::vector<double> expectedE = {2., 1.5, 1., 1., 1.};
checkData(input, output, {}, expectedE);
}
void test_interpolateLinearPointDataSet_Errors() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0.5, 0, 2},
CountStandardDeviations{2., 0., 1., 0., 1.});
auto output = interpolateLinear(input, 2, true);
checkSizesUnchanged(input, output);
std::vector<double> expectedE_source = {2., sqrt(5) / 2, 1., sqrt(2) / 2, 1.};
std::vector<double> expectedE_interp = {0., 0.125, 0., 0.125, 0.};
std::vector<double> expectedE(expectedE_source.size());
for (size_t i = 0; i < expectedE_source.size(); i++) {
expectedE[i] = sqrt(pow(expectedE_source[i], 2) + pow(expectedE_interp[i], 2));
}
checkData(input, output, {}, expectedE);
}
void test_interpolateLinearInplace_interpolates() {
Histogram input(Points(2, LinearGenerator(0, 1.0)), {-0.72, -0.72});
Histogram output(Points(1, LinearGenerator(0.5, 1.0)), {0.0});
interpolateLinearInplace(input, output);
TS_ASSERT_EQUALS(output.y()[0], -0.72)
}
// ---------------------------------------------------------------------------
// Success cases - cspline in-place no copy
// ---------------------------------------------------------------------------
void test_interpolateCSplineInPlaceDoes_Not_Copy() {
Histogram input(Points(7, LinearGenerator(0, 0.5)), {-3, 0, -1, 0, 1, 0, 3});
auto xAddrBefore = &input.x();
auto yAddrBefore = &input.y();
TS_ASSERT_THROWS_NOTHING(interpolateCSplineInplace(input, 2));
TS_ASSERT_EQUALS(xAddrBefore, &input.x());
TS_ASSERT_EQUALS(yAddrBefore, &input.y());
}
// ---------------------------------------------------------------------------
// Success cases - cspline, point X data
// ---------------------------------------------------------------------------
void test_interpolateCSplinePointDataSet_Minimum_Calculated_Points() {
Histogram input(Points(7, LinearGenerator(0, 0.5)), Counts({-3, 0, -4, 0, 4, 0, 3}),
CountStandardDeviations({1., 0., 1., 0., 1., 0., 1.}));
auto output = interpolateCSpline(input, 2);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-3, -4.625, -4, 0., 4, 4.625, 3};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateCSplineInplace(inOut, 2));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
void test_interpolateCSplinePointDataSet_Errors() {
Histogram input(Points(7, LinearGenerator(0, 0.5)), Counts({-3, 0, -4, 0, 4, 0, 3}),
CountStandardDeviations{2., 0., 1., 0., 1., 0., 2.});
auto output = interpolateCSpline(input, 2, true);
checkSizesUnchanged(input, output);
// expect errors to follow formula:
// yint = A * y1 + B * y2 + C * ypp1 + D * ypp2;
// eyint = sqrt (A^2*e1^2 + B^2*e2^2 + 2*A*C*ey1ypp1 + "*B*D*ey2ypp2 *
// C^2*eypp1^2 + D^2*eypp2^2);
std::vector<double> expectedE = {2., 0, 1., 0, 1., 0., 2.};
double A = 0.5;
double B = 0.5;
double C = -0.0625;
double D = -0.0625;
expectedE[1] =
sqrt(A * A * pow(2., 2) + B * B * pow(1., 2) + 2 * A * C * 0 + 2 * B * D * 2.8 + C * C * 0 + D * D * 19.36);
expectedE[3] = sqrt(A * A * pow(1., 2) + B * B * pow(1., 2) + 2 * A * C * 2.8 + 2 * B * D * 2.8 + C * C * 19.36 +
D * D * 19.36);
expectedE[5] =
sqrt(A * A * pow(1., 2) + B * B * pow(2., 2) + 2 * A * C * 2.8 + 2 * B * D * 0 + C * C * 19.36 + D * D * 0);
checkData(input, output, {}, expectedE);
}
void test_interpolateCSplinePointDataSet_CorrelatedErrors() {
Histogram input(Points(7, LinearGenerator(0, 0.5)), Counts({-3, 0, -4, 0, 4, 0, 3}),
CountStandardDeviations{2., 0., 1., 0., 1., 0., 2.});
auto output = interpolateCSpline(input, 2, true, false);
checkSizesUnchanged(input, output);
std::vector<double> expectedE = {2., 1.5, 1., 1., 1., 1.5, 2.};
checkData(input, output, {}, expectedE);
}
void test_interpolateCSplineInplace_interpolates() {
Histogram input(Points(3, LinearGenerator(0, 1.0)), {-0.72, -0.72, -0.72});
Histogram output(Points(1, LinearGenerator(0.1, 1.0)), {0.0});
interpolateCSplineInplace(input, output);
TS_ASSERT_EQUALS(output.y()[0], -0.72);
}
// ---------------------------------------------------------------------------
// Success cases - linear edge X data
// ---------------------------------------------------------------------------
void test_interpolateLinearEdgeDataSet_Stepsize_One_Less_Point_Size() {
Histogram input(BinEdges(6, LinearGenerator(-0.25, 0.5)), Counts({-2, 0, 0, 0, 2}));
auto output = interpolateLinear(input, 4);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-2., -1., 0., 1., 2.};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(inOut, 4));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
void test_interpolateLinearEdgeDataSet_Even_StepSize() {
Histogram input(BinEdges(6, LinearGenerator(-0.25, 0.5)), {-2, 0, 0.5, 0, 2});
auto output = interpolateLinear(input, 2);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-2., -0.75, 0.5, 1.25, 2.};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(inOut, 2));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
void test_interpolateLinearEdgeDataSet_Odd_StepSize() {
Histogram input(BinEdges(6, LinearGenerator(-0.25, 0.5)), {-2, 0, 0.0, 0.5, 2});
Histogram output = interpolateLinear(input, 3);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-2., -2 + (2.5 / 1.5) * 0.5, -1. / 3., 0.5, 2.};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(inOut, 3));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
// ---------------------------------------------------------------------------
// Success cases - cspline edge X data
// ---------------------------------------------------------------------------
void test_interpolateCSplineEdgeDataSet_Minimum_Calculated_Points() {
Histogram input(BinEdges(8, LinearGenerator(-0.25, 0.5)), Counts({-3, 0, -1, 0, 1, 0, 3}));
auto output = interpolateCSpline(input, 2);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-3, -2, -1, 0, 1, 2, 3};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateCSplineInplace(inOut, 2));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
// ---------------------------------------------------------------------------
// Success cases - Point data with frequencies
// single test case as whitebox testing tells us the algorithm
// is the same
// ---------------------------------------------------------------------------
void test_interpolateLinearPointFrequencyData_Stepsize_One_Less_Point_Size() {
Histogram input(Points(5, LinearGenerator(0., 0.5)), Frequencies({-2, 0, 0, 0, 2}));
auto output = interpolateLinear(input, 4);
checkSizesUnchanged(input, output);
std::vector<double> expectedY = {-2., -1., 0., 1., 2.};
checkData(input, output, expectedY, {});
// Inplace
Histogram inOut(input);
TS_ASSERT_THROWS_NOTHING(interpolateLinearInplace(inOut, 4));
checkSizesUnchanged(input, inOut);
checkData(input, inOut, expectedY, {});
}
// ---------------------------------------------------------------------------
// Common checking code
// ---------------------------------------------------------------------------
void checkSizesUnchanged(const Histogram &input, const Histogram &output) {
TS_ASSERT_EQUALS(input.y().size(), output.y().size());
TS_ASSERT_EQUALS(input.x().size(), output.x().size());
}
void checkData(const Histogram &input, const Histogram &output, const std::vector<double> &expectedY,
const std::vector<double> &expectedE) {
TS_ASSERT_EQUALS(input.x(), output.x());
TS_ASSERT_EQUALS(input.xMode(), output.xMode());
TS_ASSERT_EQUALS(input.yMode(), output.yMode());
const auto &outY = output.y();
const auto &outE = output.e();
if (expectedY.size() > 0) {
TS_ASSERT_EQUALS(outY.size(), expectedY.size());
}
if (expectedE.size() > 0) {
TS_ASSERT_EQUALS(outE.size(), expectedE.size());
}
for (size_t i = 0; i < expectedY.size(); ++i) {
TS_ASSERT_DELTA(expectedY[i], outY[i], 1e-14);
}
for (size_t i = 0; i < expectedE.size(); ++i) {
TS_ASSERT_DELTA(expectedE[i], outE[i], 1e-14);
}
}
// ---------------------------------------------------------------------------
// Failure cases - linear
// ---------------------------------------------------------------------------
void test_interpolatelinear_throws_for_undefined_ymode_type() {
TS_ASSERT_THROWS(interpolateLinear(Histogram(Points(10, LinearGenerator(0, 0.5))), 10), const std::runtime_error &);
}
void test_interpolatelinear_throws_if_number_points_less_than_3() {
TS_ASSERT_THROWS(interpolateLinear(Histogram(Points(2, LinearGenerator(0, 0.5)), {-2, 2}), 1),
const std::runtime_error &);
TS_ASSERT_THROWS(interpolateLinear(Histogram(Points(2, LinearGenerator(0, 0.5))), 1), const std::runtime_error &);
}
void test_interpolatelinearinplace_throws_if_input_has_less_than_2_points() {
Histogram input(Points(1, LinearGenerator(0.1, 0.1)), {-2});
Histogram output(Points(1, LinearGenerator(0.1, 0.1)));
TS_ASSERT_THROWS(interpolateLinearInplace(input, output), const std::runtime_error &)
}
void test_interpolatelinear_throws_if_stepsize_greater_or_equal_number_points() {
TS_ASSERT_THROWS(interpolateLinear(Histogram(Points(6, LinearGenerator(0, 0.5))), 6), const std::runtime_error &);
TS_ASSERT_THROWS(interpolateLinear(Histogram(Points(6, LinearGenerator(0, 0.5))), 7), const std::runtime_error &);
}
void test_interpolateLinearPointDataSet_Errors_Too_Few_Points() {
Histogram input(Points(5, LinearGenerator(0, 0.5)), {-2, 0, 0, 0, 2}, CountStandardDeviations{1., 0., 0., 0., 1.});
TS_ASSERT_THROWS(interpolateLinear(input, 4, true), const std::runtime_error &);
}
// ---------------------------------------------------------------------------
// Failure cases - cspline
// ---------------------------------------------------------------------------
void test_interpolatecspline_throws_for_undefined_ymode_type() {
TS_ASSERT_THROWS(interpolateCSpline(Histogram(Points(10, LinearGenerator(0, 0.5))), 10),
const std::runtime_error &);
}
void test_interpolatecspline_throws_if_less_than_4_calculated_points() {
TS_ASSERT_THROWS(interpolateCSpline(Histogram(Points(2, LinearGenerator(0, 0.5))), 1), const std::runtime_error &);
TS_ASSERT_THROWS(interpolateCSpline(Histogram(Points(3, LinearGenerator(0, 0.5))), 1), const std::runtime_error &);
}
void test_interpolatecsplineinplace_throws_if_input_has_less_than_3_points() {
Histogram input(Points(2, LinearGenerator(0, 1.0)));
Histogram output(Points(5, LinearGenerator(0.1, 0.1)));
TS_ASSERT_THROWS(interpolateCSplineInplace(input, output), const std::runtime_error &)
}
void test_interpolatecspline_throws_if_stepsize_greater_or_equal_number_points() {
TS_ASSERT_THROWS(interpolateCSpline(Histogram(Points(6, LinearGenerator(0, 0.5))), 6), const std::runtime_error &);
TS_ASSERT_THROWS(interpolateCSpline(Histogram(Points(6, LinearGenerator(0, 0.5))), 7), const std::runtime_error &);
}
};
// ---------------------------------------------------------------------------
// Performance test
// ---------------------------------------------------------------------------
class InterpolateTestPerformance : public CxxTest::TestSuite {
public:
// This pair of boilerplate methods prevent the suite being created statically
// This means the constructor isn't called when running other tests
static InterpolateTestPerformance *createSuite() { return new InterpolateTestPerformance(); }
static void destroySuite(InterpolateTestPerformance *suite) { delete suite; }
InterpolateTestPerformance() : hist(BinEdges(binSize, LinearGenerator(0, 1))) {
Counts counts(binSize - 1, LinearGenerator(10, 0.1));
hist.setCounts(counts);
CountStandardDeviations errors(binSize - 1, LinearGenerator(10, 0.1));
hist.setCountStandardDeviations(errors);
}
void testInterpolateLinearSmallStep() {
for (size_t i = 0; i < nIters; i++)
interpolateLinear(hist, 2);
}
void testInterpolateSplineSmallStep() {
for (size_t i = 0; i < nIters; i++)
interpolateCSpline(hist, 2);
}
private:
const size_t binSize = 10000;
const size_t nIters = 5000;
Histogram hist;
};