File: tField.m

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (264 lines) | stat: -rw-r--r-- 10,650 bytes parent folder | download | duplicates (4)
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
% 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 tField < matlab.unittest.TestCase
% Test class for arrow.type.Field and arrow.field.

    methods(Test)
        function TestBasic(testCase)
            name = "A";
            type = arrow.uint64;
            field = arrow.field(name, type);

            testCase.verifyEqual(field.Name, name);
            testCase.verifyEqual(field.Type.ID, type.ID);
        end

        function TestSupportedTypes(testCase)
            name = "name";
            supportedTypes = { ...
                                 arrow.uint8, ...
                                 arrow.uint16, ...
                                 arrow.uint32, ...
                                 arrow.uint64, ...
                                 arrow.int8, ...
                                 arrow.int16, ...
                                 arrow.int32, ...
                                 arrow.int64, ...
                                 arrow.boolean, ...
                                 arrow.float32, ...
                                 arrow.float64, ...
                                 arrow.string, ...
                                 arrow.timestamp, ...
                                 arrow.list(arrow.uint64()), ...
                                 arrow.struct(arrow.field("A", arrow.float32()))
                             };
            for ii = 1:numel(supportedTypes)
                supportedType = supportedTypes{ii};
                field = arrow.field(name, supportedType);
                testCase.verifyEqual(field.Name, name);
                testCase.verifyEqual(field.Type.ID, supportedType.ID);
            end
        end

        function TestNameUnicode(testCase)
            smiley = "😀";
            tree =  "🌲";
            mango = "🥭";

            type = arrow.uint64;
            field = arrow.field(smiley, type);

            testCase.verifyEqual(field.Name, smiley);
            testCase.verifyEqual(field.Type.ID, type.ID);

            field = arrow.field(tree, type);

            testCase.verifyEqual(field.Name, tree);
            testCase.verifyEqual(field.Type.ID, type.ID);

            field = arrow.field(mango, type);

            testCase.verifyEqual(field.Name, mango);
            testCase.verifyEqual(field.Type.ID, type.ID);
        end

        function TestErrorIfNameStringMissing(testCase)
            name = string(missing);
            type = arrow.uint64;
            testCase.verifyError(@() arrow.field(name, type), "MATLAB:validators:mustBeNonmissing");
        end

        function TestNameEmptyString(testCase)
            name = "";
            type = arrow.uint64;
            field = arrow.field(name, type);

            testCase.verifyEqual(field.Name, name);
            testCase.verifyEqual(field.Type.ID, type.ID);
        end

        function TestNameCharVector(testCase)
            name = 'ABC';
            type = arrow.uint64;
            field = arrow.field(name, type);

            testCase.verifyEqual(field.Name, string(name));
            testCase.verifyEqual(field.Type.ID, type.ID);
        end

        function TestNameNumber(testCase)
            name = 123;
            type = arrow.uint64;
            field = arrow.field(name, type);

            testCase.verifyEqual(field.Name, string(123));
            testCase.verifyEqual(field.Type.ID, type.ID);
        end

        function TestArrowTypeUnsupportedInput(testCase)
            name = "A";
            type = { 123 };
            testCase.verifyError(@() arrow.field(name, type), "MATLAB:validation:UnableToConvert");
        end

        function TestNameUnsupportedInput(testCase)
            name = table();
            type = arrow.uint64;
            testCase.verifyError(@() arrow.field(name, type), "MATLAB:validation:UnableToConvert");
        end

        function TestImmutableProperties(testCase)
            name = "A";
            type = arrow.uint64;
            field = arrow.field(name, type);

            testCase.verifyError(@() setfield(field, "Name", "NewValue"), "MATLAB:class:noSetMethod")
            testCase.verifyError(@() setfield(field, "Type", arrow.boolean), "MATLAB:class:noSetMethod")
        end

        function TestIsEqualScalarTrue(testCase)
            % Two scalar arrow.type.Field objects are equal if:
            %
            %  1. Their Name properties are equal
            %  2. Their Type properties are equal

            f1 = arrow.field("A", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Second"));
            f2 = arrow.field("A", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Second"));
            testCase.verifyTrue(isequal(f1, f2));
        end

        function TestIsEqualScalarFalse(testCase)
            % Verifies isequal returns false when expected. 
            f1 = arrow.field("A", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Second"));
            f2 = arrow.field("B", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Second"));
            f3 = arrow.field("A", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Millisecond"));
            f4 = arrow.field("A", arrow.time32());

            % Name properties are not equal
            testCase.verifyFalse(isequal(f1, f2));

            % Type properties are not equal
            testCase.verifyFalse(isequal(f1, f3));

            % Type properties have different class types
            testCase.verifyFalse(isequal(f1, f4));

            % Compare arrow.type.Field and a string
            testCase.verifyFalse(isequal(f1, "A"));
        end

        function TestIsEqualNonScalarTrue(testCase)
            % Two nonscalar arrow.type.Field arrays are equal if:
            %  1. They have the same shape
            %  2. Their corresponding Field elements are equal
            
            f1 = arrow.field("A", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Second"));
            f2 = arrow.field("B", arrow.string());
            fieldArray1 = [f1 f2 f1; f2 f1 f1];
            fieldArray2 = [f1 f2 f1; f2 f1 f1];

            testCase.verifyTrue(isequal(fieldArray1, fieldArray2));
            testCase.verifyTrue(isequal(fieldArray1, fieldArray2, fieldArray1));
        end

        function TestIsEqualEmptyFields(testCase)
            % Verify isequal returns the expected value when at least one
            % of the inputs is empty.
            
            f1 = arrow.type.Field.empty(1, 0);
            f2 = arrow.type.Field.empty(0, 1);
            f3 = arrow.type.Field.empty(0, 0);
            f4 = arrow.field("B", arrow.string());

            % Compare two 1x0 Field arrays
            testCase.verifyTrue(isequal(f1, f1));
            
            % Compare two 0x1 Field arrays
            testCase.verifyTrue(isequal(f2, f2));

            % Compare two 0x0 Field arrays
            testCase.verifyTrue(isequal(f3, f3));

            % Compare 1x0 and 0x1 Field arrays
            testCase.verifyFalse(isequal(f1, f2));

            % Compare 1x0 and 0x0 Field arrays
            testCase.verifyFalse(isequal(f1, f3));

            % Compare 0x1 and 0x0 Field arrays
            testCase.verifyFalse(isequal(f2, f3));

            % Compare 1x0 and 1x1 Field arrays
            testCase.verifyFalse(isequal(f1, f4));
        end

        function TestIsEqualNonScalarFalse(testCase)
            % Verifies isequal returns false when expected for non-scalar
            % Field arrays.
            
            f1 = arrow.field("A", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Second"));
            f2 = arrow.field("B", arrow.string());
            f3 = arrow.field("B", arrow.date32());
            f4 = arrow.field("C", arrow.timestamp(TimeZone="America/New_York", TimeUnit="Second"));

            fieldArray1 = [f1 f2 f3; f4 f1 f2];
            fieldArray2 = reshape(fieldArray1, [3 2]);
            fieldArray3 = [f1 f3 f3; f4 f1 f2];
            fieldArray4 = [f4 f2 f3; f4 f1 f2];
            
            % They have different shapes
            testCase.verifyFalse(isequal(fieldArray1, fieldArray2));
            testCase.verifyFalse(isequal(fieldArray1, fieldArray2, fieldArray1));

            % Their corresponding elements are not equal - type mismatch
            testCase.verifyFalse(isequal(fieldArray1, fieldArray3));

            % Their corresponding elements are not equal - name mismatch
            testCase.verifyFalse(isequal(fieldArray1, fieldArray4));

            % Compare arrow.type.Field array and a string array
            testCase.verifyFalse(isequal(f1, strings(size(f1))));
        end

        function TestDisplay(testCase)
            % Verify the display of Field objects.
            %
            % Example:
            %
            %  Field with properties:
            %
            %        Name: FieldA
            %        Type: [1x2 arrow.type.Int32Type]

            import arrow.internal.test.display.verify
            import arrow.internal.test.display.makeLinkString
            import arrow.internal.test.display.makeDimensionString

            field = arrow.field("B", arrow.timestamp(TimeZone="America/Anchorage")); %#ok<NASGU>
            classnameLink = makeLinkString(FullClassName="arrow.type.Field", ClassName="Field", BoldFont=true);
            header = "  " + classnameLink + " with properties:" + newline;
            body = strjust(pad(["Name:"; "Type:"]));
            dimensionString = makeDimensionString([1 1]);
            fieldString = compose("[%s %s]", dimensionString, "arrow.type.TimestampType");
            body = body + " " + ["""B"""; fieldString];
            body = "    " + body;
            footer = string(newline);
            expectedDisplay = char(strjoin([header body' footer], newline));
            actualDisplay = evalc('disp(field)');
            verify(testCase, actualDisplay, expectedDisplay);
        end
    end
end