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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
|
%TCHUNKEDARRAY Unit tests arrow.array.ChunkedArray
% Licensed to the Apache Software Foundation (ASF) under one or more
% contributor license agreements. See the NOTICE file distributed with
% this work for additional information regarding copyright ownership.
% The ASF licenses this file to you under the Apache License, Version
% 2.0 (the "License"); you may not use this file except in compliance
% with the License. You may obtain a copy of the License at
%
% http://www.apache.org/licenses/LICENSE-2.0
%
% Unless required by applicable law or agreed to in writing, software
% distributed under the License is distributed on an "AS IS" BASIS,
% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
% implied. See the License for the specific language governing
% permissions and limitations under the License.
classdef tChunkedArray < matlab.unittest.TestCase
properties (Constant)
Float64Array1 = arrow.array([1 2 3 4]);
Float64Array2 = arrow.array([NaN 6 7]);
Float64Array3 = arrow.array([8 NaN 10 11 12]);
Float64Type = arrow.float64()
end
properties(TestParameter)
IntegerMatlabClass = {"uint8", ...
"uint16", ...
"uint32", ...
"uint64", ...
"int8", ...
"int16", ...
"int32", ...
"int64"};
FloatMatlabClass = {"single", "double"}
TimeZone = {"America/New_York", ""}
end
methods (Test)
function FromArraysTooFewInputsError(testCase)
% Verify an error is thrown when neither the Type nv-pair nor
% arrays are provided to fromArrays.
import arrow.array.ChunkedArray
fcn = @() ChunkedArray.fromArrays();
testCase.verifyError(fcn, "arrow:chunkedarray:TypeRequiredWithZeroArrayInputs");
end
function InconsistentArrayTypeError(testCase)
% Verify an error is thrown when arrays of different types are
% provided to fromArrays.
import arrow.array.ChunkedArray
float32Array = arrow.array(single([1 2 3]));
fcn = @() ChunkedArray.fromArrays(testCase.Float64Array1, float32Array);
testCase.verifyError(fcn, "arrow:chunkedarray:MakeFailed");
end
function ArrayTypeNVPairMismatchError(testCase)
% Verify an error is thrown when the provided Type name-value
% pair is not equal to the Type values of the provided arrays.
import arrow.array.ChunkedArray
fcn = @() ChunkedArray.fromArrays(testCase.Float64Array1, ...
testCase.Float64Array2, Type=arrow.int32());
testCase.verifyError(fcn, "arrow:chunkedarray:MakeFailed");
end
function ZeroArraysTypeNVPairProvided(testCase)
% Verify formArrays returns the expected ChunkedArray when zero
% arrays are provided as input, but the Type name-value pair is
% provided.
import arrow.array.ChunkedArray
chunkedArray = ChunkedArray.fromArrays(Type=arrow.string());
testCase.verifyChunkedArray(chunkedArray, ...
NumChunks=0, ...
Type=arrow.string(), ...
Arrays={});
end
function OneChunk(testCase)
% Verify fromArrays returns the expected ChunkedArray when one
% array is provided as input.
import arrow.array.ChunkedArray
chunkedArray = ChunkedArray.fromArrays(testCase.Float64Array1);
testCase.verifyChunkedArray(chunkedArray, ...
NumChunks=1, ...
Type=testCase.Float64Type, ...
Arrays={testCase.Float64Array1});
end
function MultipleChunks(testCase)
% Verify fromArrays returns the expected ChunkedArray when
% multiple arrays are provided as input.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
testCase.verifyChunkedArray(chunkedArray, ...
NumChunks=3, ...
Type=testCase.Float64Type, ...
Arrays=arrays);
end
function TestIsEqualTrue(testCase)
% Verifies ChunkedArrays are considered equal if:
%
% 1. Their Type properties are equal
% 2. Their NumElements properties are equal
% 3. Their NumNulls properties are equal
% 4. The same elements are considered null
% 5. All corresponding valid elements have the same values
%
% NOTE: Having the same "chunking" is not a requirement for two
% ChunkedArrays to be equal. ChunkedArrays are considered equal
% as long as "flattening" them produces the same array.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray1 = ChunkedArray.fromArrays(arrays{:});
data = [toMATLAB(arrays{1}); toMATLAB(arrays{2}); toMATLAB(arrays{3})];
floatArray = arrow.array(data);
chunkedArray2 = ChunkedArray.fromArrays(floatArray);
% Verify a chunked array is considered equal with itself
testCase.verifyTrue(isequal(chunkedArray1, chunkedArray1));
% Verify two chunked arrays are considered equal even if the
% way in which they are chunked is different.
testCase.verifyTrue(isequal(chunkedArray1, chunkedArray2));
end
function TestIsEqualFalse(testCase)
% Verify isequal returns false when expected.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray1 = ChunkedArray.fromArrays(arrays{:});
float64Array1 = arrow.array(toMATLAB(arrays{1}), InferNulls=false);
float64Array2 = arrow.array(toMATLAB(arrays{2}), InferNulls=false);
float64Array3 = arrow.array(toMATLAB(arrays{3}), InferNulls=false);
chunkedArray2 = ChunkedArray.fromArrays(float64Array1, float64Array2, float64Array3);
% Compare ChunkedArrays with different null values.
testCase.verifyFalse(isequal(chunkedArray1, chunkedArray2));
% Compare ChunkedArrays that have NaN values.
testCase.verifyFalse(isequal(chunkedArray2, chunkedArray2));
% Compare ChunkedArrays with different NumElements values.
chunkedArray3 = ChunkedArray.fromArrays(testCase.Float64Array1);
testCase.verifyFalse(isequal(chunkedArray1, chunkedArray3));
% Compare ChunkedArrays with different Type values.
float32Array1 = arrow.array(single(toMATLAB(arrays{1})));
float32Array2 = arrow.array(single(toMATLAB(arrays{2})));
float32Array3 = arrow.array(single(toMATLAB(arrays{3})));
chunkedArray3 = ChunkedArray.fromArrays(float32Array1, float32Array2, float32Array3);
testCase.verifyFalse(isequal(chunkedArray1, chunkedArray3));
end
function NumChunksNoSetter(testCase)
% Verify an error is thrown when trying to set the value
% of the NumChunks property.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
fcn = @() setfield(chunkedArray, "NumChunks", int32(6));
testCase.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function TypeNoSetter(testCase)
% Verify an error is thrown when trying to set the value
% of the Type property.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
fcn = @() setfield(chunkedArray, "Type", arrow.int32());
testCase.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function NumElementsNoSetter(testCase)
% Verify an error is thrown when trying to set the value
% of the NumElements property.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
fcn = @() setfield(chunkedArray, "NumElements", int64(100));
testCase.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function NumNullsNoSetter(testCase)
% Verify an error is thrown when trying to set the value
% of the NumNulls property.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
fcn = @() setfield(chunkedArray, "NumNulls", int64(100));
testCase.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function ChunkNonNumericIndexError(testCase)
% Verify that an error is thrown when a non-numeric index value
% is provided to the chunk() method.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
fcn = @() chunkedArray.chunk("INDEX");
testCase.verifyError(fcn, "arrow:badsubscript:NonNumeric");
end
function ChunkNonScalarIndexError(testCase)
% Verify that an error is thrown when a non-scalar index value
% is provided to the chunk() method.
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
% Provide a 1x2 array
fcn = @() chunkedArray.chunk([1 2]);
testCase.verifyError(fcn, "arrow:badsubscript:NonScalar");
% Provide a 0x0 array
fcn = @() chunkedArray.chunk([]);
testCase.verifyError(fcn, "arrow:badsubscript:NonScalar");
end
function NumericIndexWithEmptyChunkedArrayError(testCase)
% Verify that an error is thrown when a numeric value greater
% than NumChunks is provided to chunk().
import arrow.array.ChunkedArray
arrays = {testCase.Float64Array1, testCase.Float64Array2, testCase.Float64Array3};
chunkedArray = ChunkedArray.fromArrays(arrays{:});
% Provide an index greater than NumChunks
fcn = @() chunkedArray.chunk(4);
testCase.verifyError(fcn, "arrow:chunkedarray:InvalidNumericChunkIndex");
end
function NumericIndexEmptyChunkedArrayError(testCase)
% Verify that an error is thrown when calling chunk() on a
% zero-chunk ChunkedArray.
import arrow.array.ChunkedArray
chunkedArray = ChunkedArray.fromArrays(Type=arrow.time32());
fcn = @() chunkedArray.chunk(2);
testCase.verifyError(fcn, "arrow:chunkedarray:NumericIndexWithEmptyChunkedArray");
end
function ToMATLABBooleanType(testCase)
% Verify toMATLAB returns the expected MATLAB array when the
% Chunked Array contains boolean arrays.
import arrow.array.ChunkedArray
bools = true([1 11]);
bools([2 3 7 8 9]) = false;
a1 = arrow.array(bools(1:8));
a2 = arrow.array(bools(8:7));
a3 = arrow.array(bools(9:11));
% ChunkedArray with three chunks and at least 1 element
chunkedArray1 = ChunkedArray.fromArrays(a1, a2, a3);
actualArray1 = toMATLAB(chunkedArray1);
expectedArray1 = bools';
testCase.verifyEqual(actualArray1, expectedArray1);
% ChunkedArray with zero chunks and zero elements
chunkedArray2 = ChunkedArray.fromArrays(Type=a1.Type);
actualArray2 = toMATLAB(chunkedArray2);
expectedArray2 = logical.empty(0, 1);
testCase.verifyEqual(actualArray2, expectedArray2);
% ChunkedArray with two chunks and zero elements
chunkedArray3 = ChunkedArray.fromArrays(a2, a2);
actualArray3 = toMATLAB(chunkedArray3);
expectedArray3 = logical.empty(0, 1);
testCase.verifyEqual(actualArray3, expectedArray3);
end
function ToMATLABIntegerTypes(testCase, IntegerMatlabClass)
% Verify toMATLAB returns the expected MATLAB array when the
% Chunked Array contains integer arrays.
import arrow.array.ChunkedArray
a1 = arrow.array(cast([1 2 3 4], IntegerMatlabClass));
a2 = arrow.array(cast([], IntegerMatlabClass));
a3 = arrow.array(cast([5 6 7 8 9], IntegerMatlabClass));
% ChunkedArray with three chunks and at least 1 element
chunkedArray1 = ChunkedArray.fromArrays(a1, a2, a3);
actualArray1 = toMATLAB(chunkedArray1);
expectedArray1 = cast((1:9)', IntegerMatlabClass);
testCase.verifyEqual(actualArray1, expectedArray1);
% ChunkedArray with zero chunks and zero elements
chunkedArray2 = ChunkedArray.fromArrays(Type=a1.Type);
actualArray2 = toMATLAB(chunkedArray2);
expectedArray2 = cast(double.empty(0, 1), IntegerMatlabClass);
testCase.verifyEqual(actualArray2, expectedArray2);
% ChunkedArray with two chunks and zero elements
chunkedArray3 = ChunkedArray.fromArrays(a2, a2);
actualArray3 = toMATLAB(chunkedArray3);
expectedArray3 = cast(double.empty(0, 1), IntegerMatlabClass);
testCase.verifyEqual(actualArray3, expectedArray3);
end
function ToMATLABFloatTypes(testCase, FloatMatlabClass)
% Verify toMATLAB returns the expected MATLAB array when the
% Chunked Array contains float arrays.
import arrow.array.ChunkedArray
a1 = arrow.array(cast([1 NaN 3 4], FloatMatlabClass));
a2 = arrow.array(cast([], FloatMatlabClass));
a3 = arrow.array(cast([5 6 7 NaN 9], FloatMatlabClass));
% ChunkedArray with three chunks and at least 1 element
chunkedArray1 = ChunkedArray.fromArrays(a1, a2, a3);
actualArray1 = toMATLAB(chunkedArray1);
expectedArray1 = cast((1:9)', FloatMatlabClass);
expectedArray1([2 8]) = NaN;
testCase.verifyEqual(actualArray1, expectedArray1);
% ChunkedArray with zero chunks and zero elements
chunkedArray2 = ChunkedArray.fromArrays(Type=a1.Type);
actualArray2 = toMATLAB(chunkedArray2);
expectedArray2 = cast(double.empty(0, 1), FloatMatlabClass);
testCase.verifyEqual(actualArray2, expectedArray2);
% ChunkedArray with two chunks and zero elements
chunkedArray3 = ChunkedArray.fromArrays(a2, a2);
actualArray3 = toMATLAB(chunkedArray3);
expectedArray3 = cast(double.empty(0, 1), FloatMatlabClass);
testCase.verifyEqual(actualArray3, expectedArray3);
end
function ToMATLABTimeTypes(testCase)
% Verify toMATLAB returns the expected MATLAB array when the
% Chunked Array contains time arrays.
import arrow.array.ChunkedArray
a1 = arrow.array(seconds([1 NaN 3 4]));
a2 = arrow.array(seconds([]));
a3 = arrow.array(seconds([5 6 7 NaN 9]));
% ChunkedArray with three chunks and at least 1 element
chunkedArray1 = ChunkedArray.fromArrays(a1, a2, a3);
actualArray1 = toMATLAB(chunkedArray1);
expectedArray1 = seconds((1:9)');
expectedArray1([2 8]) = NaN;
testCase.verifyEqual(actualArray1, expectedArray1);
% ChunkedArray with zero chunks and zero elements
chunkedArray2 = ChunkedArray.fromArrays(Type=a1.Type);
actualArray2 = toMATLAB(chunkedArray2);
expectedArray2 = duration.empty(0, 1);
testCase.verifyEqual(actualArray2, expectedArray2);
% ChunkedArray with two chunks and zero elements
chunkedArray3 = ChunkedArray.fromArrays(a2, a2);
actualArray3 = toMATLAB(chunkedArray3);
expectedArray3 = duration.empty(0, 1);
testCase.verifyEqual(actualArray3, expectedArray3);
end
function ToMATLABDateTypes(testCase)
% Verify toMATLAB returns the expected MATLAB array when the
% Chunked Array contains date arrays.
import arrow.array.*
dates = datetime(2023, 9, 7) + days(0:10);
dates([5 9]) = NaT;
a1 = Date64Array.fromMATLAB(dates(1:5));
a2 = Date64Array.fromMATLAB(dates(6:5));
a3 = Date64Array.fromMATLAB(dates(6:end));
% ChunkedArray with three chunks and at least 1 element
chunkedArray1 = ChunkedArray.fromArrays(a1, a2, a3);
actualArray1 = toMATLAB(chunkedArray1);
expectedArray1 = dates';
testCase.verifyEqual(actualArray1, expectedArray1);
% ChunkedArray with zero chunks and zero elements
chunkedArray2 = ChunkedArray.fromArrays(Type=a1.Type);
actualArray2 = toMATLAB(chunkedArray2);
expectedArray2 = datetime.empty(0, 1);
testCase.verifyEqual(actualArray2, expectedArray2);
% ChunkedArray with two chunks and zero elements
chunkedArray3 = ChunkedArray.fromArrays(a2, a2);
actualArray3 = toMATLAB(chunkedArray3);
expectedArray3 = datetime.empty(0, 1);
testCase.verifyEqual(actualArray3, expectedArray3);
end
function ToMATLABTimestampType(testCase, TimeZone)
% Verify toMATLAB returns the expected MATLAB array when the
% Chunked Array contains timestamp arrays.
import arrow.array.ChunkedArray
dates = datetime(2023, 9, 7, TimeZone=TimeZone) + days(0:10);
dates([5 9]) = NaT;
a1 = arrow.array(dates(1:5));
a2 = arrow.array(dates(6:5));
a3 = arrow.array(dates(6:end));
% ChunkedArray with three chunks and at least one element
chunkedArray1 = ChunkedArray.fromArrays(a1, a2, a3);
actualArray1 = toMATLAB(chunkedArray1);
expectedArray1 = dates';
testCase.verifyEqual(actualArray1, expectedArray1);
% ChunkedArray with zero chunks and zero elements
chunkedArray2 = ChunkedArray.fromArrays(Type=a1.Type);
actualArray2 = toMATLAB(chunkedArray2);
expectedArray2 = datetime.empty(0, 1);
expectedArray2.TimeZone = TimeZone;
testCase.verifyEqual(actualArray2, expectedArray2);
% ChunkedArray with two chunks and zero elements
chunkedArray3 = ChunkedArray.fromArrays(a2, a2);
actualArray3 = toMATLAB(chunkedArray3);
expectedArray3 = datetime.empty(0, 1);
expectedArray3.TimeZone = TimeZone;
testCase.verifyEqual(actualArray3, expectedArray3);
end
function ToMATLABStringType(testCase)
% Verify toMATLAB returns the expected MATLAB array when the
% Chunked Array contains string arrays.
import arrow.array.*
strs = compose("%d", 1:11);
strs([5 9]) = missing;
a1 = arrow.array(strs(1:7));
a2 = arrow.array(strs(7:6));
a3 = arrow.array(strs(8:11));
% ChunkedArray with three chunks and nonzero at least 1 element
chunkedArray1 = ChunkedArray.fromArrays(a1, a2, a3);
actualArray1 = toMATLAB(chunkedArray1);
expectedArray1 = strs';
testCase.verifyEqual(actualArray1, expectedArray1);
% ChunkedArray with zero chunks and zero elements
chunkedArray2 = ChunkedArray.fromArrays(Type=a1.Type);
actualArray2 = toMATLAB(chunkedArray2);
expectedArray2 = string.empty(0, 1);
testCase.verifyEqual(actualArray2, expectedArray2);
% ChunkedArray with two chunks and zero elements
chunkedArray3 = ChunkedArray.fromArrays(a2, a2);
actualArray3 = toMATLAB(chunkedArray3);
expectedArray3 = string.empty(0, 1);
testCase.verifyEqual(actualArray3, expectedArray3);
end
end
methods
function verifyChunkedArray(testCase, chunkedArray, opts)
arguments
testCase
chunkedArray
opts.Type(1, 1) arrow.type.Type
opts.NumChunks(1, 1) int32
opts.Arrays(1, :) cell
end
testCase.assertTrue(numel(opts.Arrays) == opts.NumChunks);
allNumElements = cellfun(@(a) a.NumElements, opts.Arrays, UniformOutput=true);
allNumNulls = cellfun(@(a) a.NumNulls, opts.Arrays, UniformOutput=true);
expectedNumElements = int64(sum(allNumElements));
expectedNumNulls = int64(sum(allNumNulls));
testCase.verifyEqual(chunkedArray.NumChunks, opts.NumChunks);
testCase.verifyEqual(chunkedArray.NumElements, expectedNumElements);
testCase.verifyEqual(chunkedArray.NumNulls, expectedNumNulls);
testCase.verifyEqual(chunkedArray.Type, opts.Type);
for ii = 1:opts.NumChunks
testCase.verifyEqual(chunkedArray.chunk(ii), opts.Arrays{ii});
end
end
end
end
|
