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
|
%TDATE32ARRAY Unit tests for arrow.array.Date32Array
% 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 tDate32Array < matlab.unittest.TestCase
properties
ArrowArrayConstructorFcn = @arrow.array.Date32Array.fromMATLAB
end
properties (Constant)
UnixEpoch = datetime(0, ConvertFrom="posixtime");
MissingDates = [datetime(2023, 1, 1), NaT, NaT, datetime(2022, 1, 1), NaT];
end
methods (Test)
function TestBasic(testCase)
dates = testCase.UnixEpoch + days(1:10);
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyInstanceOf(array, "arrow.array.Date32Array");
end
function TestTypeIsDate32(testCase)
dates = testCase.UnixEpoch + days(1:10);
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyDate32Type(array.Type);
end
function TestNumElements(testCase)
dates = datetime.empty(0, 1);
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyEqual(array.NumElements, int64(0));
dates = datetime(2023, 1, 1);
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyEqual(array.NumElements, int64(1));
dates = testCase.UnixEpoch + days(1:10);
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyEqual(array.NumElements, int64(10));
end
function TestNumNulls(testCase)
% Verify the NumNulls property returns correct value.
% array1 has 0 null values.
dates = datetime(2023, 1, 1) + days(1:5)';
array1 = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyEqual(array1.NumNulls, int64(0));
% array2 has 3 null values.
array2 = testCase.ArrowArrayConstructorFcn(dates, Valid=[1 2]);
testCase.verifyEqual(array2.NumNulls, int64(3));
end
function TestNumNullsNoSetter(testCase)
% Verify the NumNulls property is read-only.
data = datetime(2023, 1, 1) + days(1:5)';
array = testCase.ArrowArrayConstructorFcn(data, Valid=[2 3]);
fcn = @() setfield(array, "NumNulls", 1);
testCase.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function TestToMATLAB(testCase)
% Verify toMATLAB() round-trips the original datetime array.
dates = testCase.UnixEpoch + days(1:10);
array = testCase.ArrowArrayConstructorFcn(dates);
values = toMATLAB(array);
testCase.verifyEqual(values, dates');
end
function TestDatetime(testCase)
% Verify datetime() round-trips the original datetime array.
dates = testCase.UnixEpoch + days(1:10);
array = testCase.ArrowArrayConstructorFcn(dates);
values = datetime(array);
testCase.verifyEqual(values, dates');
end
function TestValid(testCase)
% Verify the Valid property returns the expected logical vector.
dates = testCase.MissingDates;
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyEqual(array.Valid, [true; false; false; true; false]);
testCase.verifyEqual(toMATLAB(array), dates');
testCase.verifyEqual(datetime(array), dates');
end
function TestInferNullsTrueNVPair(testCase)
% Verify arrow.array.Date32Array.fromMATLAB() behaves as
% expected when InferNulls=true is provided.
dates = testCase.MissingDates;
array = testCase.ArrowArrayConstructorFcn(dates, InferNulls=true);
expectedValid = [true; false; false; true; false];
testCase.verifyEqual(array.Valid, expectedValid);
testCase.verifyEqual(toMATLAB(array), dates');
testCase.verifyEqual(datetime(array), dates');
end
function TestInferNullsFalseNVPair(testCase)
% Verify arrow.array.Date32Array.fromMATLAB() behaves as
% expected when InferNulls=false is provided.
dates = testCase.MissingDates;
array = testCase.ArrowArrayConstructorFcn(dates, InferNulls=false);
expectedValid = [true; true; true; true; true];
testCase.verifyEqual(array.Valid, expectedValid);
% If NaT datetimes were not considered null values, then they
% are treated like int32(0) - i.e. the Unix epoch.
expectedDates = dates';
expectedDates([2, 3, 5]) = testCase.UnixEpoch;
testCase.verifyEqual(toMATLAB(array), expectedDates);
testCase.verifyEqual(datetime(array), expectedDates);
end
function TestValidNVPair(testCase)
% Verify arrow.array.Date32Array.fromMATLAB() accepts the Valid
% nv-pair, and it behaves as expected.
dates = testCase.MissingDates;
% Supply the Valid name-value pair as vector of indices.
array = testCase.ArrowArrayConstructorFcn(dates, Valid=[1, 2, 3]);
testCase.verifyEqual(array.Valid, [true; true; true; false; false]);
expectedDates = dates';
expectedDates([2, 3]) = testCase.UnixEpoch;
expectedDates([4, 5]) = NaT;
testCase.verifyEqual(toMATLAB(array), expectedDates);
% Supply the Valid name-value pair as a logical scalar.
array = testCase.ArrowArrayConstructorFcn(dates, Valid=false);
testCase.verifyEqual(array.Valid, [false; false; false; false; false]);
expectedDates(:) = NaT;
testCase.verifyEqual(toMATLAB(array), expectedDates);
end
function TestEmptyDatetimeVector(testCase)
% Verify arrow.array.Date32Array.fromMATLAB() accepts any
% empty-shaped datetime as input.
dates = datetime.empty(0, 0);
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyEqual(array.NumElements, int64(0));
testCase.verifyEqual(array.Valid, logical.empty(0, 1));
testCase.verifyEqual(toMATLAB(array), datetime.empty(0, 1));
% Test with an N-Dimensional empty array
dates = datetime.empty(0, 1, 0);
array = testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyEqual(array.NumElements, int64(0));
testCase.verifyEqual(array.Valid, logical.empty(0, 1));
testCase.verifyEqual(toMATLAB(array), datetime.empty(0, 1));
end
function TestErrorIfNonVector(testCase)
% Verify arrow.array.Date32Array.fromMATLAB() throws an error
% if the input provided is not a vector.
dates = datetime(2023, 1, 1) + days(1:12);
dates = reshape(dates, 2, 6);
fcn = @() testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyError(fcn, "arrow:array:InvalidShape");
dates = reshape(dates, 3, 2, 2);
fcn = @() testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyError(fcn, "arrow:array:InvalidShape");
end
function TestErrorIfNonDatetime(testCase)
% Verify arrow.array.Date32Array.fromMATLAB() throws an error
% if not given a datetime as input.
dates = duration(1, 2, 3);
fcn = @() testCase.ArrowArrayConstructorFcn(dates);
testCase.verifyError(fcn, "arrow:array:InvalidType");
numbers = [1; 2; 3; 4];
fcn = @() testCase.ArrowArrayConstructorFcn(numbers);
testCase.verifyError(fcn, "arrow:array:InvalidType");
end
function TestInt32MaxDays(testCase)
% Verify that no precision is lost when trying to round-trip a
% datetime value that is within abs(intmin("int32")) days before
% and intmax("int32") days after the UNIX epoch.
% Cast to int64 before taking the absolute value to avoid loss
% of precision.
numDaysBefore = abs(int64(intmin("int32")));
numDaysAfter = intmax("int32");
expectedBefore = testCase.UnixEpoch - days(numDaysBefore);
expectedAfter = testCase.UnixEpoch + days(numDaysAfter);
array = testCase.ArrowArrayConstructorFcn(expectedBefore);
actualBefore = array.toMATLAB();
testCase.verifyEqual(actualBefore, expectedBefore);
array = testCase.ArrowArrayConstructorFcn(expectedAfter);
actualAfter = array.toMATLAB();
testCase.verifyEqual(actualAfter, expectedAfter);
end
function TestGreaterThanInt32MaxDays(testCase)
% Verify that precision is lost when trying to round-trip a
% datetime that is more than abs(intmin("int32")) days before
% or more than intmax("int32") after the UNIX epoch.
% Cast to int64 before taking the absolute value to avoid loss
% of precision.
numDaysBefore = abs(int64(intmin("int32"))) + 1;
numDaysAfter = int64(intmax("int32")) + 1;
expectedBefore = testCase.UnixEpoch - days(numDaysBefore);
expectedAfter = testCase.UnixEpoch + days(numDaysAfter);
array = testCase.ArrowArrayConstructorFcn(expectedBefore);
actualBefore = array.toMATLAB();
testCase.verifyNotEqual(actualBefore, expectedBefore);
array = testCase.ArrowArrayConstructorFcn(expectedAfter);
actualAfter = array.toMATLAB();
testCase.verifyNotEqual(actualAfter, expectedAfter);
end
function TestZonedDatetime(testCase)
% Verify that zoned datetimes are supported as inputs to the
% fromMATLAB method and that the output datetime returned by
% the toMATLAB method is unzoned.
expectedZoned = testCase.UnixEpoch + days(10);
expectedZoned.TimeZone = "America/New_York";
expected = expectedZoned;
expected.TimeZone = char.empty(0, 0);
array = testCase.ArrowArrayConstructorFcn(expectedZoned);
actual = array.toMATLAB();
testCase.verifyEqual(actual, expected);
end
function TestInt32MaxDaysZoned(testCase)
% Verify that zoned datetimes which are within abs(intmin("int32")) days
% before and intmax("int32") days after the UNIX epoch are round-tripped
% (not including the TimeZone).
% Cast to int64 before taking the absolute value to avoid loss
% of precision.
numDaysBefore = abs(int64(intmin("int32")));
numDaysAfter = intmax("int32");
expectedZonedBefore = testCase.UnixEpoch - days(numDaysBefore);
expectedZonedAfter = testCase.UnixEpoch + days(numDaysAfter);
expectedZonedBefore.TimeZone = "UTC";
expectedZonedAfter.TimeZone = "UTC";
expectedUnzonedBefore = expectedZonedBefore;
expectedUnzonedBefore.TimeZone = char.empty(0, 0);
expectedUnzonedAfter = expectedZonedAfter;
expectedUnzonedAfter.TimeZone = char.empty(0, 0);
array = testCase.ArrowArrayConstructorFcn(expectedZonedBefore);
actualBefore = array.toMATLAB();
testCase.verifyEqual(actualBefore, expectedUnzonedBefore);
array = testCase.ArrowArrayConstructorFcn(expectedUnzonedAfter);
actualAfter = array.toMATLAB();
testCase.verifyEqual(actualAfter, expectedUnzonedAfter);
end
function TestNonWholeDaysRoundDown(testCase)
% Verify that datetimes which are not whole days (i.e. are not
% datetimes with zero hours, zero minutes, and zero seconds),
% round down to the nearest whole day when round-tripping with
% Date32Array.
dates = testCase.UnixEpoch + days(10) + hours(20) + minutes(30) + seconds(40) + milliseconds(50);
% Round down to the nearest whole day when round-tripping.
expected = testCase.UnixEpoch + days(10);
array = testCase.ArrowArrayConstructorFcn(dates);
actual = array.toMATLAB();
testCase.verifyEqual(actual, expected);
dates = testCase.UnixEpoch + days(10) + hours(10) + minutes(20) + seconds(30) + milliseconds(20);
% Round down to the nearest whole day when round-tripping.
expected = testCase.UnixEpoch + days(10);
array = testCase.ArrowArrayConstructorFcn(dates);
actual = array.toMATLAB();
testCase.verifyEqual(actual, expected);
end
function TestIsEqualTrue(tc)
% Verifies arrays are considered equal if:
%
% 1. Their Type properties are equal
% 2. They have the same number of elements (i.e. their NumElements properties are equal)
% 3. They have the same validity bitmap (i.e. their Valid properties are equal)
% 4. All corresponding valid elements have the same values
dates1 = datetime(2023, 6, 22) + days(0:4);
dates2 = datetime(2023, 6, 22) + days([0 1 5 3 4]);
array1 = tc.ArrowArrayConstructorFcn(dates1, Valid=[1 2 4]);
array2 = tc.ArrowArrayConstructorFcn(dates1, Valid=[1 2 4]);
array3 = tc.ArrowArrayConstructorFcn(dates2, Valid=[1 2 4]);
tc.verifyTrue(isequal(array1, array2));
tc.verifyTrue(isequal(array1, array3));
% Test supplying more than two arrays to isequal
tc.verifyTrue(isequal(array1, array2, array3));
end
function TestIsEqualFalse(tc)
% Verify isequal returns false when expected.
dates1 = datetime(2023, 6, 22) + days(0:4);
dates2 = datetime(2023, 6, 22) + days([1 1 2 3 4]);
dates3 = datetime(2023, 6, 22) + days(0:5);
array1 = tc.ArrowArrayConstructorFcn(dates1, Valid=[1 2 4]);
array2 = tc.ArrowArrayConstructorFcn(dates1, Valid=[1 4]);
array3 = tc.ArrowArrayConstructorFcn(dates2, Valid=[1 2 4]);
array4 = arrow.array([true false true false]);
array5 = tc.ArrowArrayConstructorFcn(dates3, Valid=[1 2 4]);
% Their validity bitmaps are not equal
tc.verifyFalse(isequal(array1, array2));
% Not all corresponding valid elements are equal
tc.verifyFalse(isequal(array1, array3));
% Their Type properties are not equal
tc.verifyFalse(isequal(array1, array4));
% Their NumElements properties are not equal
tc.verifyFalse(isequal(array1, array5));
% Comparing an arrow.array.Array to a MATLAB double
tc.verifyFalse(isequal(array1, 1));
% Test supplying more than two arrays to isequal
tc.verifyFalse(isequal(array1, array1, array3, array4, array5));
end
end
methods
function verifyDate32Type(testCase, actual)
testCase.verifyInstanceOf(actual, "arrow.type.Date32Type");
testCase.verifyEqual(actual.ID, arrow.type.ID.Date32);
testCase.verifyEqual(actual.DateUnit, arrow.type.DateUnit.Day);
end
end
end
|
