GH-37996: [MATLAB] Add a static constructor method named fromMATLAB to arrow.array.StructArray

matlab/src/matlab/+arrow/+array/StructArray.m

@@ -142,5 +142,38 @@
             proxy = arrow.internal.proxy.create(proxyName, args);
             array = arrow.array.StructArray(proxy);
         end
+
+        function array = fromMATLAB(T, opts)
+            arguments
+                T table
+                opts.FieldNames(1, :) string {mustBeNonmissing} = T.Properties.VariableNames
+                opts.Valid
+            end
+
+            import arrow.tabular.internal.decompose
+            import arrow.tabular.internal.validateColumnNames
+            import arrow.array.internal.getArrayProxyIDs
+            import arrow.internal.validate.parseValid
+
+            if width(T) == 0
+                % StructArrays require at least one field
+                error("arrow:struct:ZeroVariables", ...
+                    "Input table T must have at least one variable.");
+            end
+
+            % If FieldNames was provided, make sure the number of field
+            % names is equal to the width of the table.
+            validateColumnNames(opts.FieldNames, width(T));
+
+            arrowArrays = decompose(T);
+            arrayProxyIDs = getArrayProxyIDs(arrowArrays);
+            validElements = parseValid(opts, height(T));
+
+            args = struct(ArrayProxyIDs=arrayProxyIDs, ...
+                FieldNames=opts.FieldNames, Valid=validElements);
+            proxyName = "arrow.array.proxy.StructArray";
+            proxy = arrow.internal.proxy.create(proxyName, args);
+            array = arrow.array.StructArray(proxy);
+        end
     end
 end

matlab/src/matlab/+arrow/+type/+traits/StructTraits.m

@@ -19,10 +19,7 @@
         ArrayConstructor = @arrow.array.StructArray
         ArrayClassName = "arrow.array.StructArray"
         ArrayProxyClassName = "arrow.array.proxy.StructArray"
-
-        % TODO: Implement fromMATLAB
-        ArrayStaticConstructor = missing
-
+        ArrayStaticConstructor = @arrow.array.StructArray.fromMATLAB
         TypeConstructor = @arrow.type.StructType
         TypeClassName = "arrow.type.StructType"
         TypeProxyClassName = "arrow.type.proxy.StructType"

matlab/src/matlab/+arrow/+type/+traits/traits.m

@@ -91,6 +91,8 @@
                 typeTraits = TimestampTraits();
             case "duration"
                 typeTraits = Time64Traits();
+            case "table"
+                typeTraits = StructTraits();
             otherwise
                 error("arrow:type:traits:UnsupportedMatlabClass", "Unsupported MATLAB class: " + type);
         end

matlab/src/matlab/+arrow/array.m

@@ -13,46 +13,42 @@
 % implied.  See the License for the specific language governing
 % permissions and limitations under the License.
 
-function arrowArray = array(data, opts)
-    arguments
-        data
-        opts.InferNulls(1, 1) logical = true
-        opts.Valid
-    end
+function arrowArray = array(data, varargin)
 
     data = convertCellstrToString(data);
     classname = string(class(data));
-    args = namedargs2cell(opts);
 
     switch (classname)
         case "logical"
-            arrowArray = arrow.array.BooleanArray.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.BooleanArray.fromMATLAB(data, varargin{:});
         case "uint8"
-            arrowArray = arrow.array.UInt8Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.UInt8Array.fromMATLAB(data, varargin{:});
         case "uint16"
-            arrowArray = arrow.array.UInt16Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.UInt16Array.fromMATLAB(data, varargin{:});
         case "uint32"
-            arrowArray = arrow.array.UInt32Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.UInt32Array.fromMATLAB(data, varargin{:});
         case "uint64"
-            arrowArray = arrow.array.UInt64Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.UInt64Array.fromMATLAB(data, varargin{:});
         case "int8"
-            arrowArray = arrow.array.Int8Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.Int8Array.fromMATLAB(data, varargin{:});
         case "int16"
-            arrowArray = arrow.array.Int16Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.Int16Array.fromMATLAB(data, varargin{:});
         case "int32"
-            arrowArray = arrow.array.Int32Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.Int32Array.fromMATLAB(data, varargin{:});
         case "int64"
-            arrowArray = arrow.array.Int64Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.Int64Array.fromMATLAB(data, varargin{:});
         case "single"
-            arrowArray = arrow.array.Float32Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.Float32Array.fromMATLAB(data, varargin{:});
         case "double"
-            arrowArray = arrow.array.Float64Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.Float64Array.fromMATLAB(data, varargin{:});
         case "string"
-            arrowArray = arrow.array.StringArray.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.StringArray.fromMATLAB(data, varargin{:});
         case "datetime"
-            arrowArray = arrow.array.TimestampArray.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.TimestampArray.fromMATLAB(data, varargin{:});
         case "duration"
-            arrowArray = arrow.array.Time64Array.fromMATLAB(data, args{:});
+            arrowArray = arrow.array.Time64Array.fromMATLAB(data, varargin{:});
+        case "table"
+            arrowArray = arrow.array.StructArray.fromMATLAB(data, varargin{:});
         otherwise
             errid = "arrow:array:UnsupportedMATLABType";
             msg = join(["Unable to convert MATLAB type" classname "to arrow array."]);

matlab/test/arrow/array/tArray.m

@@ -32,7 +32,8 @@
             {[1 2],                "arrow.array.Float64Array"}, ...
             {datetime(2022, 1, 1), "arrow.array.TimestampArray"}, ...
             {seconds([1 2]),       "arrow.array.Time64Array"}, ...
-            {["A" "B"],            "arrow.array.StringArray"}};
+            {["A" "B"],            "arrow.array.StringArray"}, ...
+            {table(["A" "B"]'),    "arrow.array.StructArray"}};
     end
 
     methods(Test)        
@@ -50,7 +51,7 @@ function UnsupportedMATLABTypeError(testCase)
         % Verify arrow.array throws an error with the identifier
         % "arrow:array:UnsupportedMATLABType" if the input array is not one
         % we support converting into an Arrow array.
-            matlabArray = table;
+            matlabArray = {table};
             fcn = @() arrow.array(matlabArray);
             errID = "arrow:array:UnsupportedMATLABType";
             testCase.verifyError(fcn, errID);

matlab/test/arrow/array/tStructArray.m

@@ -273,5 +273,91 @@ function IsEqualFalse(tc)
             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.Length, 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.Length, 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.Length, 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

matlab/test/arrow/type/traits/tStructTraits.m

@@ -20,7 +20,7 @@
         ArrayConstructor = @arrow.array.StructArray
         ArrayClassName = "arrow.array.StructArray"
         ArrayProxyClassName = "arrow.array.proxy.StructArray"
-        ArrayStaticConstructor = missing
+        ArrayStaticConstructor = @arrow.array.StructArray.fromMATLAB
         TypeConstructor = @arrow.type.StructType
         TypeClassName = "arrow.type.StructType"
         TypeProxyClassName = "arrow.type.proxy.StructType"

matlab/test/arrow/type/traits/ttraits.m

@@ -365,6 +365,17 @@ function TestMatlabDuration(testCase)
             testCase.verifyEqual(actualTraits, expectedTraits);
         end
 
+        function TestMatlabTable(testCase)
+            import arrow.type.traits.*
+
+            type = "table";
+            expectedTraits = StructTraits();
+
+            actualTraits = traits(type);
+
+            testCase.verifyEqual(actualTraits, expectedTraits);
+        end
+
         function TestErrorIfUnsupportedMatlabClass(testCase)
             import arrow.type.traits.*