-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GH-37996: [MATLAB] Add a static constructor method named fromMATLAB
to arrow.array.StructArray
#37998
Conversation
@arrow.array.StructArray.fromMATLAB
className is the string "table"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making this change!
+1 |
After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 081e354. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about 1 possible false positive for unstable benchmarks that are known to sometimes produce them. |
…ATLAB` to `arrow.array.StructArray` (apache#37998) ### Rationale for this change Right now, the only way to construct an `arrow.array.StructArray` is to call its static method `fromArrays` method. Doing so requires users to first construct the individual field arrays before creating the `StructArray`. ```matlab >> a1 = arrow.array([1 2 3 4]); >> a2 = arrow.array(["A" "B" "C" "D"]); >> s1 = arrow.array.StructArray.fromArrays(a1, a2, FieldNames=["Number" "String"]); >> class(s1) ans = 'arrow.array.StructArray' ``` It would be nice if users could construct `StructArray`s from MATLAB `table`s by either calling `arrow.array.StructArray.fromMATLAB()` or by passing a `table` to `arrow.array()`: ```matlab >> t = table([1 2 3 4]', ["A1" "A2" "A3" "A4"]', VariableNames=["Number", "String"]) % Call fromMATLAB method >> s1 = arrow.array.StructArray.fromMATLAB(t); >> class(s1) ans = 'arrow.array.StructArray' % Pass table to arrow.array() >> class(s2) ans = 'arrow.array.StructArray' ``` ### What changes are included in this PR? 1. Added static constructor method `fromMATLAB` to `arrow.array.StructArray`. It accepts a `table` as input and optionally two name-value pairs: `FieldNames` and `Valid`. 2. Set the `ArrayStaticConstructor` property of `arrow.type.traits.StructTraits` to `@ arrow.array.StructArray.fromMATLAB`. Previously, it was set to `missing`. 3. Updated `arrow.type.traits.traits(className)` to return `StructTraits` if `className` is the string `"table"`. 4. Updated `arrow.array` to accept a MATLAB `table` as input and return an `arrow.array.StructArray` if given a `table`. 5. Changed the signature of `arrow.array()` to accept `varargin` instead of pre-determined name-value pairs. The name-value pairs accepted depends on the type of array being constructed. For example, you can supply `TimeUnit` when constructing an `arrow.array.TimestampArray`, but `TimeUnit` will not be accepted when creating an `arrow.array.Int8Array`. ### Are these changes tested? Yes. Added new tests cases to `tArray.m`, `tStructArray.m`, `ttraits.m`, and `tStructTraits.m`. ### Are there any user-facing changes? Yes, users can now create `StructArray`s directly from MATLAB `table`s by calling either `arrow.array()` or `arrow.array.StructArray.fromMATLAB`. * Closes: apache#37996 Authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
…ATLAB` to `arrow.array.StructArray` (apache#37998) ### Rationale for this change Right now, the only way to construct an `arrow.array.StructArray` is to call its static method `fromArrays` method. Doing so requires users to first construct the individual field arrays before creating the `StructArray`. ```matlab >> a1 = arrow.array([1 2 3 4]); >> a2 = arrow.array(["A" "B" "C" "D"]); >> s1 = arrow.array.StructArray.fromArrays(a1, a2, FieldNames=["Number" "String"]); >> class(s1) ans = 'arrow.array.StructArray' ``` It would be nice if users could construct `StructArray`s from MATLAB `table`s by either calling `arrow.array.StructArray.fromMATLAB()` or by passing a `table` to `arrow.array()`: ```matlab >> t = table([1 2 3 4]', ["A1" "A2" "A3" "A4"]', VariableNames=["Number", "String"]) % Call fromMATLAB method >> s1 = arrow.array.StructArray.fromMATLAB(t); >> class(s1) ans = 'arrow.array.StructArray' % Pass table to arrow.array() >> class(s2) ans = 'arrow.array.StructArray' ``` ### What changes are included in this PR? 1. Added static constructor method `fromMATLAB` to `arrow.array.StructArray`. It accepts a `table` as input and optionally two name-value pairs: `FieldNames` and `Valid`. 2. Set the `ArrayStaticConstructor` property of `arrow.type.traits.StructTraits` to `@ arrow.array.StructArray.fromMATLAB`. Previously, it was set to `missing`. 3. Updated `arrow.type.traits.traits(className)` to return `StructTraits` if `className` is the string `"table"`. 4. Updated `arrow.array` to accept a MATLAB `table` as input and return an `arrow.array.StructArray` if given a `table`. 5. Changed the signature of `arrow.array()` to accept `varargin` instead of pre-determined name-value pairs. The name-value pairs accepted depends on the type of array being constructed. For example, you can supply `TimeUnit` when constructing an `arrow.array.TimestampArray`, but `TimeUnit` will not be accepted when creating an `arrow.array.Int8Array`. ### Are these changes tested? Yes. Added new tests cases to `tArray.m`, `tStructArray.m`, `ttraits.m`, and `tStructTraits.m`. ### Are there any user-facing changes? Yes, users can now create `StructArray`s directly from MATLAB `table`s by calling either `arrow.array()` or `arrow.array.StructArray.fromMATLAB`. * Closes: apache#37996 Authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
…ATLAB` to `arrow.array.StructArray` (apache#37998) ### Rationale for this change Right now, the only way to construct an `arrow.array.StructArray` is to call its static method `fromArrays` method. Doing so requires users to first construct the individual field arrays before creating the `StructArray`. ```matlab >> a1 = arrow.array([1 2 3 4]); >> a2 = arrow.array(["A" "B" "C" "D"]); >> s1 = arrow.array.StructArray.fromArrays(a1, a2, FieldNames=["Number" "String"]); >> class(s1) ans = 'arrow.array.StructArray' ``` It would be nice if users could construct `StructArray`s from MATLAB `table`s by either calling `arrow.array.StructArray.fromMATLAB()` or by passing a `table` to `arrow.array()`: ```matlab >> t = table([1 2 3 4]', ["A1" "A2" "A3" "A4"]', VariableNames=["Number", "String"]) % Call fromMATLAB method >> s1 = arrow.array.StructArray.fromMATLAB(t); >> class(s1) ans = 'arrow.array.StructArray' % Pass table to arrow.array() >> class(s2) ans = 'arrow.array.StructArray' ``` ### What changes are included in this PR? 1. Added static constructor method `fromMATLAB` to `arrow.array.StructArray`. It accepts a `table` as input and optionally two name-value pairs: `FieldNames` and `Valid`. 2. Set the `ArrayStaticConstructor` property of `arrow.type.traits.StructTraits` to `@ arrow.array.StructArray.fromMATLAB`. Previously, it was set to `missing`. 3. Updated `arrow.type.traits.traits(className)` to return `StructTraits` if `className` is the string `"table"`. 4. Updated `arrow.array` to accept a MATLAB `table` as input and return an `arrow.array.StructArray` if given a `table`. 5. Changed the signature of `arrow.array()` to accept `varargin` instead of pre-determined name-value pairs. The name-value pairs accepted depends on the type of array being constructed. For example, you can supply `TimeUnit` when constructing an `arrow.array.TimestampArray`, but `TimeUnit` will not be accepted when creating an `arrow.array.Int8Array`. ### Are these changes tested? Yes. Added new tests cases to `tArray.m`, `tStructArray.m`, `ttraits.m`, and `tStructTraits.m`. ### Are there any user-facing changes? Yes, users can now create `StructArray`s directly from MATLAB `table`s by calling either `arrow.array()` or `arrow.array.StructArray.fromMATLAB`. * Closes: apache#37996 Authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
Rationale for this change
Right now, the only way to construct an
arrow.array.StructArray
is to call its static methodfromArrays
method. Doing so requires users to first construct the individual field arrays before creating theStructArray
.It would be nice if users could construct
StructArray
s from MATLABtable
s by either callingarrow.array.StructArray.fromMATLAB()
or by passing atable
toarrow.array()
:What changes are included in this PR?
fromMATLAB
toarrow.array.StructArray
. It accepts atable
as input and optionally two name-value pairs:FieldNames
andValid
.ArrayStaticConstructor
property ofarrow.type.traits.StructTraits
to@arrow.array.StructArray.fromMATLAB
. Previously, it was set tomissing
.arrow.type.traits.traits(className)
to returnStructTraits
ifclassName
is the string"table"
.arrow.array
to accept a MATLABtable
as input and return anarrow.array.StructArray
if given atable
.arrow.array()
to acceptvarargin
instead of pre-determined name-value pairs. The name-value pairs accepted depends on the type of array being constructed. For example, you can supplyTimeUnit
when constructing anarrow.array.TimestampArray
, butTimeUnit
will not be accepted when creating anarrow.array.Int8Array
.Are these changes tested?
Yes. Added new tests cases to
tArray.m
,tStructArray.m
,ttraits.m
, andtStructTraits.m
.Are there any user-facing changes?
Yes, users can now create
StructArray
s directly from MATLABtable
s by calling eitherarrow.array()
orarrow.array.StructArray.fromMATLAB
.fromMATLAB
toarrow.array.StructArray
#37996