sgilmore10 commented on code in PR #37806: URL: https://github.com/apache/arrow/pull/37806#discussion_r1332035385
########## matlab/test/arrow/array/tStructArray.m: ########## @@ -0,0 +1,271 @@ +%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 + % length + 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 Length(tc) + % Verify the Length property is set to the expected value. + import arrow.array.StructArray + + array = StructArray.fromArrays(tc.Float64Array, tc.StringArray); + tc.verifyEqual(array.Length, int64(5)); + end + + function LengthNoSetter(tc) + % Verify the Length property is read-only. + import arrow.array.StructArray + + array = StructArray.fromArrays(tc.Float64Array, tc.StringArray); + fcn = @() setfield(array, "Length", 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); + expectedTable([3 4], :) = repmat({NaN string(missing)}, [2 1]); Review Comment: Good point. I'll make this change. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
