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
|
% 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 hNumericArray < matlab.unittest.TestCase
% Test class containing shared tests for numeric arrays.
properties (Abstract)
ArrowArrayClassName(1, 1) string
ArrowArrayConstructorFcn
MatlabArrayFcn
MatlabConversionFcn
MaxValue (1, 1)
MinValue (1, 1)
NullSubstitutionValue(1, 1)
ArrowType(1, 1)
end
methods(TestClassSetup)
function verifyOnMatlabPath(tc)
% Verify the arrow array class is on the MATLAB Search Path.
tc.assertTrue(~isempty(which(tc.ArrowArrayClassName)), ...
"""" + tc.ArrowArrayClassName + """must be on the MATLAB path. " + ...
"Use ""addpath"" to add folders to the MATLAB path.");
end
end
methods(Test)
function BasicTest(tc)
A = tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn([1 2 3]));
className = string(class(A));
tc.verifyEqual(className, tc.ArrowArrayClassName);
end
function ToMATLAB(tc)
% Create array from a scalar
A1 = tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn(100));
data = toMATLAB(A1);
tc.verifyEqual(data, tc.MatlabArrayFcn(100));
% Create array from a vector
A2 = tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn([1 2 3]));
data = toMATLAB(A2);
tc.verifyEqual(data, tc.MatlabArrayFcn([1 2 3]'));
% Create a Float64Array from an empty double vector
A3 = tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn([]));
data = toMATLAB(A3);
tc.verifyEqual(data, tc.MatlabArrayFcn(reshape([], 0, 1)));
end
function MatlabConversion(tc)
% Tests the type-specific conversion methods, e.g. single for
% arrow.array.Float32Array, double for array.array.Float64Array
% Create array from a scalar
A1 = tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn(100));
data = tc.MatlabConversionFcn(A1);
tc.verifyEqual(data, tc.MatlabArrayFcn(100));
% Create array from a vector
A2 = tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn([1 2 3]));
data = tc.MatlabConversionFcn(A2);
tc.verifyEqual(data, tc.MatlabArrayFcn([1 2 3]'));
% Create an array from an empty vector
A3 = tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn([]));
data = tc.MatlabConversionFcn(A3);
tc.verifyEqual(data, tc.MatlabArrayFcn(reshape([], 0, 1)));
end
function MinValueTest(tc)
A = tc.ArrowArrayConstructorFcn(tc.MinValue);
tc.verifyEqual(toMATLAB(A), tc.MinValue);
end
function MaxValueTest(tc)
A1 = tc.ArrowArrayConstructorFcn(tc.MaxValue);
tc.verifyEqual(toMATLAB(A1), tc.MaxValue);
end
function ErrorIfComplex(tc)
fcn = @() tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn([10 + 1i, 4]));
tc.verifyError(fcn, "arrow:array:ComplexNumeric");
end
function ErrorIfNonVector(tc)
data = tc.MatlabArrayFcn([1 2 3 4 5 6 7 8 9]);
data = reshape(data, 3, 1, 3);
fcn = @() tc.ArrowArrayConstructorFcn(tc.MatlabArrayFcn(data));
tc.verifyError(fcn, "arrow:array:InvalidShape");
end
function ErrorIfInvalidType(tc)
data = 1:3;
if tc.ArrowType.ID == arrow.type.ID.Float64
data = single(data);
end
tc.verifyError(@() tc.ArrowArrayConstructorFcn(data), "arrow:array:InvalidType");
end
function AllowNDimensionalEmptyArray(tc)
data = tc.MatlabArrayFcn(reshape([], [1 0 0]));
A = tc.ArrowArrayConstructorFcn(data);
tc.verifyEqual(A.NumElements, int64(0));
tc.verifyEqual(toMATLAB(A), tc.MatlabArrayFcn(reshape([], [0 1])));
end
function LogicalValidNVPair(tc)
% Verify the expected elements are treated as null when Valid
% is provided as a logical array
data = tc.MatlabArrayFcn([1 2 3 4]);
arrowArray = tc.ArrowArrayConstructorFcn(data, Valid=[false true true false]);
expectedData = data';
expectedData([1 4]) = tc.NullSubstitutionValue;
tc.verifyEqual(tc.MatlabConversionFcn(arrowArray), expectedData);
tc.verifyEqual(toMATLAB(arrowArray), expectedData);
tc.verifyEqual(arrowArray.Valid, [false; true; true; false]);
end
function NumericValidNVPair(tc)
% Verify the expected elements are treated as null when Valid
% is provided as a array of indices
data = tc.MatlabArrayFcn([1 2 3 4]);
arrowArray = tc.ArrowArrayConstructorFcn(data, Valid=[2 4]);
expectedData = data';
expectedData([1 3]) = tc.NullSubstitutionValue;
tc.verifyEqual(tc.MatlabConversionFcn(arrowArray), expectedData);
tc.verifyEqual(toMATLAB(arrowArray), expectedData);
tc.verifyEqual(arrowArray.Valid, [false; true; false; true]);
% Make sure the optimization where the valid-bitmap is stored
% as a nullptr works as expected.
expectedData = data';
arrowArray = tc.ArrowArrayConstructorFcn(data, Valid=[1, 2, 3, 4]);
tc.verifyEqual(tc.MatlabConversionFcn(arrowArray), expectedData);
tc.verifyEqual(toMATLAB(arrowArray), expectedData);
tc.verifyEqual(arrowArray.Valid, [true; true; true; true]);
end
function TestArrowType(tc)
% Verify the array has the expected arrow.type.Type object
data = tc.MatlabArrayFcn([1 2 3 4]);
arrowArray = tc.ArrowArrayConstructorFcn(data);
tc.verifyEqual(arrowArray.Type.ID, tc.ArrowType.ID);
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
data1 = tc.MatlabArrayFcn([1 2 3 4]);
data2 = tc.MatlabArrayFcn([1 2 5 4]);
array1 = tc.ArrowArrayConstructorFcn(data1, Valid=[1 2 4]);
array2 = tc.ArrowArrayConstructorFcn(data1, Valid=[1 2 4]);
array3 = tc.ArrowArrayConstructorFcn(data2, 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.
data1 = tc.MatlabArrayFcn([1 2 3 4]);
data2 = tc.MatlabArrayFcn([5 2 3 4]);
data3 = tc.MatlabArrayFcn([1 2 3 4 5]);
array1 = tc.ArrowArrayConstructorFcn(data1, Valid=[1 2 4]);
array2 = tc.ArrowArrayConstructorFcn(data1, Valid=[1 4]);
array3 = tc.ArrowArrayConstructorFcn(data2, Valid=[1 2 4]);
array4 = arrow.array([true false true false]);
array5 = tc.ArrowArrayConstructorFcn(data3, 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
function TestNumNulls(tc)
% Verify the NumNulls property returns correct value.
% array1 has 0 null values.
data1 = tc.MatlabArrayFcn(1:10);
array1 = tc.ArrowArrayConstructorFcn(data1);
tc.verifyEqual(array1.NumNulls, int64(0));
% array2 has 8 null values.
array2 = tc.ArrowArrayConstructorFcn(data1, Valid=[1 4]);
tc.verifyEqual(array2.NumNulls, int64(8));
end
function TestNumNullsNoSetter(tc)
% Verify the NumNulls property is read-only.
data = tc.MatlabArrayFcn(1:10);
array = tc.ArrowArrayConstructorFcn(data);
fcn = @() setfield(array, "NumNulls", 1);
tc.verifyError(fcn, "MATLAB:class:SetProhibited");
end
end
end
|
