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
|
%TSTRUCTARRAY Unit tests for arrow.array.StructArray
% 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 tStructArray < matlab.unittest.TestCase
properties
Float64Array = arrow.array([1 NaN 3 4 5]);
StringArray = arrow.array(["A" "B" "C" "D" missing]);
end
methods (Test)
function Basic(tc)
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
tc.verifyInstanceOf(array, "arrow.array.StructArray");
end
function FieldNames(tc)
% Verify the FieldNames property is set to the expected value.
import arrow.array.StructArray
% Default field names used
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
tc.verifyEqual(array.FieldNames, ["Field1", "Field2"]);
% Field names provided
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["A", "B"]);
tc.verifyEqual(array.FieldNames, ["A", "B"]);
% Duplicate field names provided
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["C", "C"]);
tc.verifyEqual(array.FieldNames, ["C", "C"]);
end
function FieldNamesError(tc)
% Verify the FieldNames nv-pair errors when expected.
import arrow.array.StructArray
% Wrong type provided
fcn = @() StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames={table table});
tc.verifyError(fcn, "MATLAB:validation:UnableToConvert");
% Wrong number of field names provided
fcn = @() StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames="A");
tc.verifyError(fcn, "arrow:tabular:WrongNumberColumnNames");
% Missing string provided
fcn = @() StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["A" missing]);
tc.verifyError(fcn, "MATLAB:validators:mustBeNonmissing");
end
function FieldNamesNoSetter(tc)
% Verify the FieldNames property is read-only.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"]);
fcn = @() setfield(array, "FieldNames", ["A", "B"]);
tc.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function NumFields(tc)
% Verify the NumFields property is set to the expected value.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
tc.verifyEqual(array.NumFields, int32(2));
end
function NumFieldsNoSetter(tc)
% Verify the NumFields property is read-only.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
fcn = @() setfield(array, "NumFields", 10);
tc.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function Valid(tc)
% Verify the Valid property is set to the expected value.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
expectedValid = true([5 1]);
tc.verifyEqual(array.Valid, expectedValid);
% Supply the Valid nv-pair
valid = [true true false true false];
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, Valid=valid);
tc.verifyEqual(array.Valid, valid');
end
function ValidNVPairError(tc)
% Verify the Valid nv-pair errors when expected.
import arrow.array.StructArray
% Provided an invalid index
fcn = @() StructArray.fromArrays(tc.Float64Array, tc.StringArray, Valid=10);
tc.verifyError(fcn, "MATLAB:notLessEqual");
% Provided a logical vector with more elements than the array
fcn = @() StructArray.fromArrays(tc.Float64Array, tc.StringArray, Valid=false([7 1]));
tc.verifyError(fcn, "MATLAB:incorrectNumel");
end
function ValidNoSetter(tc)
% Verify the Valid property is read-only.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
fcn = @() setfield(array, "Valid", false);
tc.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function NumElements(tc)
% Verify the NumElements property is set to the expected value.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
tc.verifyEqual(array.NumElements, int64(5));
end
function NumElementsNoSetter(tc)
% Verify the NumElements property is read-only.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
fcn = @() setfield(array, "NumElements", 1);
tc.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function NumNulls(tc)
% Verify the NumNulls property.
import arrow.array.StructArray
array1 = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
tc.verifyEqual(array1.NumNulls, int64(0));
array2 = StructArray.fromArrays(tc.Float64Array, tc.StringArray, Valid=[1 3 5]);
tc.verifyEqual(array2.NumNulls, int64(2));
end
function NumNullsNoSetter(tc)
% Verify the NumNulls property is read-only.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
fcn = @() setfield(array, "NumNulls", 1);
tc.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function Type(tc)
% Verify the Type property is set to the expected value.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"]);
field1 = arrow.field("X", arrow.float64());
field2 = arrow.field("Y", arrow.string());
expectedType = arrow.struct(field1, field2);
tc.verifyEqual(array.Type, expectedType);
end
function TypeNoSetter(tc)
% Verify the Type property is read-only.
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
fcn = @() setfield(array, "Type", tc.Float64Array.Type);
tc.verifyError(fcn, "MATLAB:class:SetProhibited");
end
function FieldByIndex(tc)
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
% Extract 1st field
field1 = array.field(1);
tc.verifyEqual(field1, tc.Float64Array);
% Extract 2nd field
field2 = array.field(2);
tc.verifyEqual(field2, tc.StringArray);
end
function FieldByIndexError(tc)
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
% Supply a nonscalar vector
fcn = @() array.field([1 2]);
tc.verifyError(fcn, "arrow:badsubscript:NonScalar");
% Supply a noninteger
fcn = @() array.field(1.1);
tc.verifyError(fcn, "arrow:badsubscript:NonInteger");
end
function FieldByName(tc)
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
% Extract 1st field
field1 = array.field("Field1");
tc.verifyEqual(field1, tc.Float64Array);
% Extract 2nd field
field2 = array.field("Field2");
tc.verifyEqual(field2, tc.StringArray);
end
function FieldByNameError(tc)
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray);
% Supply a nonscalar string array
fcn = @() array.field(["Field1" "Field2"]);
tc.verifyError(fcn, "arrow:badsubscript:NonScalar");
% Supply a nonexistent field name
fcn = @() array.field("B");
tc.verifyError(fcn, "arrow:tabular:schema:AmbiguousFieldName");
end
function toMATLAB(tc)
% Verify toMATLAB returns the expected MATLAB table
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"]);
expectedTable = table(toMATLAB(tc.Float64Array), toMATLAB(tc.StringArray), VariableNames=["X", "Y"]);
actualTable = toMATLAB(array);
tc.verifyEqual(actualTable, expectedTable);
% Verify table elements that correspond to "null" values
% in the StructArray are set to the type-specific null values.
valid = [1 2 5];
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"], Valid=valid);
float64NullValue = tc.Float64Array.NullSubstitutionValue;
stringNullValue = tc.StringArray.NullSubstitutionValue;
expectedTable([3 4], :) = repmat({float64NullValue stringNullValue}, [2 1]);
actualTable = toMATLAB(array);
tc.verifyEqual(actualTable, expectedTable);
end
function table(tc)
% Verify toMATLAB returns the expected MATLAB table
import arrow.array.StructArray
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"]);
expectedTable = table(toMATLAB(tc.Float64Array), toMATLAB(tc.StringArray), VariableNames=["X", "Y"]);
actualTable = table(array);
tc.verifyEqual(actualTable, expectedTable);
% Verify table elements that correspond to "null" values
% in the StructArray are set to the type-specific null values.
valid = [1 2 5];
array = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"], Valid=valid);
float64NullValue = tc.Float64Array.NullSubstitutionValue;
stringNullValue = tc.StringArray.NullSubstitutionValue;
expectedTable([3 4], :) = repmat({float64NullValue stringNullValue}, [2 1]);
actualTable = toMATLAB(array);
tc.verifyEqual(actualTable, expectedTable);
end
function IsEqualTrue(tc)
% Verify isequal returns true when expected.
import arrow.array.StructArray
array1 = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"]);
array2 = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"]);
tc.verifyTrue(isequal(array1, array2));
end
function IsEqualFalse(tc)
% Verify isequal returns false when expected.
import arrow.array.StructArray
array1 = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["X", "Y"]);
array2 = StructArray.fromArrays(tc.StringArray, tc.Float64Array, FieldNames=["X", "Y"]);
array3 = StructArray.fromArrays(tc.Float64Array, tc.StringArray, FieldNames=["A", "B"]);
% StructArrays have the same FieldNames but the Fields have different types.
tc.verifyFalse(isequal(array1, array2));
% Fields of the StructArrays have the same types but the StructArrays have different FieldNames.
tc.verifyFalse(isequal(array1, array3));
end
function FromMATLABBasic(tc)
% Verify StructArray.fromMATLAB returns the expected
% StructArray.
import arrow.array.StructArray
T = table([1 2]', ["A1" "A2"]', VariableNames=["Number" "String"]);
array = StructArray.fromMATLAB(T);
tc.verifyEqual(array.NumElements, int64(2));
tc.verifyEqual(array.NumFields, int32(2));
tc.verifyEqual(array.FieldNames, ["Number" "String"]);
field1 = arrow.array([1 2]');
field2 = arrow.array(["A1" "A2"]');
tc.verifyEqual(field1, array.field(1));
tc.verifyEqual(field2, array.field(2));
end
function FromMATLABFieldNames(tc)
% Verify StructArray.fromMATLAB returns the expected
% StructArray when the FieldNames nv-pair is supplied.
import arrow.array.StructArray
T = table([1 2]', ["A1" "A2"]', VariableNames=["Number" "String"]);
array = StructArray.fromMATLAB(T, FieldNames=["Custom" "Name"]);
tc.verifyEqual(array.NumElements, int64(2));
tc.verifyEqual(array.NumFields, int32(2));
tc.verifyEqual(array.FieldNames, ["Custom" "Name"]);
tc.verifyEqual(array.Valid, [true; true]);
field1 = arrow.array([1 2]');
field2 = arrow.array(["A1" "A2"]');
tc.verifyEqual(field1, array.field(1));
tc.verifyEqual(field2, array.field(2));
end
function FromMATLABValid(tc)
% Verify StructArray.fromMATLAB returns the expected
% StructArray when the Valid nv-pair is supplied.
import arrow.array.StructArray
T = table([1 2]', ["A1" "A2"]', VariableNames=["Number" "String"]);
array = StructArray.fromMATLAB(T, Valid=2);
tc.verifyEqual(array.NumElements, int64(2));
tc.verifyEqual(array.NumFields, int32(2));
tc.verifyEqual(array.FieldNames, ["Number" "String"]);
tc.verifyEqual(array.Valid, [false; true]);
field1 = arrow.array([1 2]');
field2 = arrow.array(["A1" "A2"]');
tc.verifyEqual(field1, array.field(1));
tc.verifyEqual(field2, array.field(2));
end
function FromMATLABZeroVariablesError(tc)
% Verify StructArray.fromMATLAB throws an error when the input
% table T has zero variables.
import arrow.array.StructArray
fcn = @() StructArray.fromMATLAB(table);
tc.verifyError(fcn, "arrow:struct:ZeroVariables");
end
function FromMATLABWrongNumberFieldNames(tc)
% Verify StructArray.fromMATLAB throws an error when the
% FieldNames nv-pair is provided and its number of elements
% does not equal the number of variables in the input table T.
import arrow.array.StructArray
fcn = @() StructArray.fromMATLAB(table(1), FieldNames=["A" "B"]);
tc.verifyError(fcn, "arrow:tabular:WrongNumberColumnNames");
end
function FromMATLABValidNVPairBadIndex(tc)
% Verify StructArray.fromMATLAB throws an error when the
% Valid nv-pair is provided and it contains an invalid index.
import arrow.array.StructArray
fcn = @() StructArray.fromMATLAB(table(1), Valid=2);
tc.verifyError(fcn, "MATLAB:notLessEqual");
end
end
end
|
