GH-37812: [MATLAB] Add `arrow.type.ListType` MATLAB class #38189

kevingurney · 2023-10-10T20:02:23Z

Rationale for this change

In support of adding an arrow.array.ListArray MATLAB class, this pull request adds a new arrow.type.ListType MATLAB class.

What changes are included in this PR?

New arrow.list(<type>) MATLAB construction function.
New arrow.list.ListType MATLAB class. ListType has a property named Type which indicates the inner type of the List. Type can be set to any subclass arrow.type.Type (including arrow.type.ListType, to support nested lists).
New arrow.type.ID.List type ID enumeration value.
New arrow.type.traits.ListTraits type traits class. Some of the properties, such as ArrayConstructor and ArrayProxyClassName, are set to missing because they are dependent on adding arrow.array.ListArray first.

Example

% Create a simple List<String> type.
>> stringListType = arrow.list(arrow.string())

stringListType = 

  ListType with properties:

      ID: List
    Type: [1x1 arrow.type.StringType]

% Create a nested List<List<Boolean>> type.
>> nestedListType = arrow.list(arrow.list(arrow.boolean()))

nestedListType = 

  ListType with properties:

      ID: List
    Type: [1x1 arrow.type.ListType]

% Extract the first-level, inner type, which is List<Boolean>.
>> innerType = nestedListType.Type

innerType = 

  ListType with properties:

      ID: List
    Type: [1x1 arrow.type.BooleanType]

% Extract the second-level, nested inner type, which is Boolean.
>> innerType.Type  

ans = 

  BooleanType with properties:

    ID: Boolean

Are these changes tested?

Yes.

Added tListType.m.
Added tListTraits.m.
Updated tField.m to include arrow.list.
Updated tID.m to include arrow.type.ID.List.
Updated tTypeDisplay.m to include arrow.type.ListType.
Updated ttraits.m to include arrow.type.traits.ListTraits.

Are there any user-facing changes?

Yes.

Client MATLAB code can now creates instances of arrow.type.ListType by using the arrow.list(<type>) construction function.

Future Directions

[MATLAB] Add arrow.array.ListArray MATLAB class #37815

Closes: [MATLAB] Add arrow.type.ListType MATLAB class #37812

2. Add list_type.cc to CMakeLists.txt sources.

2. Use libmexclass::proxy namespace. 3. Cast to `arrow::ListType`.

2. Add ListTraits.

2. Fix indentation of Struct type case.

…ng`. 2. Update `traits.m` to not include case for MATLAB `cell` type. 3. Update `tField.m` to include `arrow.list`. 4. Update `tID.m` to include `arrow.type.ID.List`. 5. Update `tTypeDisplay.m` to include `arrow.type.ListType`. 6. Update `ttraits.m` to include `arrow.type.traits.ListTraits`. 7. Add `tListTraits.m`.

sgilmore10

Thanks for adding this! Looks great!

matlab/src/cpp/arrow/matlab/type/proxy/list_type.cc

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

matlab/src/matlab/+arrow/list.m

matlab/test/arrow/type/tListType.m

kou

+1

matlab/src/cpp/arrow/matlab/type/proxy/list_type.h

header.

2. Add `ConstructionFcnTooManyInputsError` test.

kevingurney · 2023-10-11T15:32:41Z

+1

…he#38189) ### Rationale for this change In support of adding an [`arrow.array.ListArray`](apache#37815) MATLAB class, this pull request adds a new `arrow.type.ListType` MATLAB class. ### What changes are included in this PR? 1. New `arrow.list(<type>)` MATLAB construction function. 2. New `arrow.list.ListType` MATLAB class. `ListType` has a property named `Type` which indicates the inner type of the `List`. `Type` can be set to any subclass `arrow.type.Type` (including `arrow.type.ListType`, to support nested lists). 3. New `arrow.type.ID.List` type ID enumeration value. 4. New `arrow.type.traits.ListTraits` type traits class. Some of the properties, such as `ArrayConstructor` and `ArrayProxyClassName`, are set to `missing` because they are dependent on adding [`arrow.array.ListArray`](apache#37815) first. **Example** ```matlab % Create a simple List<String> type. >> stringListType = arrow.list(arrow.string()) stringListType = ListType with properties: ID: List Type: [1x1 arrow.type.StringType] % Create a nested List<List<Boolean>> type. >> nestedListType = arrow.list(arrow.list(arrow.boolean())) nestedListType = ListType with properties: ID: List Type: [1x1 arrow.type.ListType] % Extract the first-level, inner type, which is List<Boolean>. >> innerType = nestedListType.Type innerType = ListType with properties: ID: List Type: [1x1 arrow.type.BooleanType] % Extract the second-level, nested inner type, which is Boolean. >> innerType.Type ans = BooleanType with properties: ID: Boolean ``` ### Are these changes tested? Yes. 1. Added `tListType.m`. 2. Added `tListTraits.m`. 3. Updated `tField.m` to include `arrow.list`. 4. Updated `tID.m` to include `arrow.type.ID.List`. 6. Updated `tTypeDisplay.m` to include `arrow.type.ListType`. 7. Updated `ttraits.m` to include `arrow.type.traits.ListTraits`. ### Are there any user-facing changes? Yes. Client MATLAB code can now creates instances of `arrow.type.ListType` by using the `arrow.list(<type>)` construction function. ### Future Directions 1. apache#37815 * Closes: apache#37812 Authored-by: Kevin Gurney <[email protected]> Signed-off-by: Kevin Gurney <[email protected]>

conbench-apache-arrow · 2023-10-15T00:33:39Z

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 852f09d.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

…he#38189) ### Rationale for this change In support of adding an [`arrow.array.ListArray`](apache#37815) MATLAB class, this pull request adds a new `arrow.type.ListType` MATLAB class. ### What changes are included in this PR? 1. New `arrow.list(<type>)` MATLAB construction function. 2. New `arrow.list.ListType` MATLAB class. `ListType` has a property named `Type` which indicates the inner type of the `List`. `Type` can be set to any subclass `arrow.type.Type` (including `arrow.type.ListType`, to support nested lists). 3. New `arrow.type.ID.List` type ID enumeration value. 4. New `arrow.type.traits.ListTraits` type traits class. Some of the properties, such as `ArrayConstructor` and `ArrayProxyClassName`, are set to `missing` because they are dependent on adding [`arrow.array.ListArray`](apache#37815) first. **Example** ```matlab % Create a simple List<String> type. >> stringListType = arrow.list(arrow.string()) stringListType = ListType with properties: ID: List Type: [1x1 arrow.type.StringType] % Create a nested List<List<Boolean>> type. >> nestedListType = arrow.list(arrow.list(arrow.boolean())) nestedListType = ListType with properties: ID: List Type: [1x1 arrow.type.ListType] % Extract the first-level, inner type, which is List<Boolean>. >> innerType = nestedListType.Type innerType = ListType with properties: ID: List Type: [1x1 arrow.type.BooleanType] % Extract the second-level, nested inner type, which is Boolean. >> innerType.Type ans = BooleanType with properties: ID: Boolean ``` ### Are these changes tested? Yes. 1. Added `tListType.m`. 2. Added `tListTraits.m`. 3. Updated `tField.m` to include `arrow.list`. 4. Updated `tID.m` to include `arrow.type.ID.List`. 6. Updated `tTypeDisplay.m` to include `arrow.type.ListType`. 7. Updated `ttraits.m` to include `arrow.type.traits.ListTraits`. ### Are there any user-facing changes? Yes. Client MATLAB code can now creates instances of `arrow.type.ListType` by using the `arrow.list(<type>)` construction function. ### Future Directions 1. apache#37815 * Closes: apache#37812 Authored-by: Kevin Gurney <[email protected]> Signed-off-by: Kevin Gurney <[email protected]>

kevingurney added 13 commits October 4, 2023 14:45

Add C++ Proxy class for ListType.

9b6f616

1. Register ListType proxy.

e907fb6

2. Add list_type.cc to CMakeLists.txt sources.

1. Fix typo.

2d0e040

2. Use libmexclass::proxy namespace. 3. Cast to `arrow::ListType`.

Implement getType member function on ListType C++ Proxy class.

bfb2964

Add arrow.type.ListType and arrow.list.

4bc3bd2

Move list function from arrow.type package to arrow package.

06a75bc

1. Add List Type ID.

e7050c3

2. Add ListTraits.

Register getType Proxy method.

4455f09

Add custom error ID for type proxy creation failure.

dcc53af

1. Add List type case to type::proxy::wrap.

c87f26b

2. Fix indentation of Struct type case.

Add tests for ListType.

de948bd

Remove trailing whitespace.

1f0949e

kevingurney requested a review from kou as a code owner October 10, 2023 20:02

github-actions bot added Component: MATLAB awaiting committer review Awaiting committer review labels Oct 10, 2023

sgilmore10 approved these changes Oct 10, 2023

View reviewed changes

github-actions bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Oct 10, 2023

kou approved these changes Oct 11, 2023

View reviewed changes

matlab/src/cpp/arrow/matlab/type/proxy/list_type.h Outdated Show resolved Hide resolved

github-actions bot added awaiting merge Awaiting merge awaiting changes Awaiting changes and removed awaiting changes Awaiting changes awaiting merge Awaiting merge labels Oct 11, 2023

Align type ID enumeration values.

20b6bee

github-actions bot added awaiting change review Awaiting change review awaiting changes Awaiting changes and removed awaiting changes Awaiting changes awaiting change review Awaiting change review labels Oct 11, 2023

Fix copy/paste comment wording mistakes.

9f739b6

github-actions bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Oct 11, 2023

Move help text for arrow.list construction function above license

bb8f042

header.

github-actions bot added awaiting change review Awaiting change review awaiting changes Awaiting changes and removed awaiting changes Awaiting changes awaiting change review Awaiting change review labels Oct 11, 2023

Rename Type property to ValueType.

ce5f86a

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Oct 11, 2023

kevingurney added 2 commits October 11, 2023 10:36

Rename error ID to use ValueType instead of Type.

d37d469

1. Update ListType tests to use ValueType rather than Type.

2c06776

2. Add `ConstructionFcnTooManyInputsError` test.

github-actions bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Oct 11, 2023

kevingurney mentioned this pull request Oct 11, 2023

[CI][MATLAB] Add C++ linting checks (e.g. using clang-format) to MATLAB CI workflow #38208

Closed

Fix indentatino in list_type.h and struct_type.h.

b0b30d8

github-actions bot added awaiting change review Awaiting change review awaiting changes Awaiting changes and removed awaiting changes Awaiting changes awaiting change review Awaiting change review labels Oct 11, 2023

kevingurney merged commit 852f09d into apache:main Oct 11, 2023
10 checks passed

kevingurney deleted the GH-37812 branch October 11, 2023 15:33

kevingurney removed the awaiting changes Awaiting changes label Oct 11, 2023

kevingurney mentioned this pull request Oct 11, 2023

[MATLAB] Enable clang-format in the matlab/ subfolder. #35941

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GH-37812: [MATLAB] Add `arrow.type.ListType` MATLAB class #38189

GH-37812: [MATLAB] Add `arrow.type.ListType` MATLAB class #38189

kevingurney commented Oct 10, 2023 •

edited by github-actions bot

Loading

sgilmore10 left a comment

kou left a comment

kevingurney commented Oct 11, 2023

conbench-apache-arrow bot commented Oct 15, 2023

GH-37812: [MATLAB] Add arrow.type.ListType MATLAB class #38189

GH-37812: [MATLAB] Add arrow.type.ListType MATLAB class #38189

Conversation

kevingurney commented Oct 10, 2023 • edited by github-actions bot Loading

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

Future Directions

sgilmore10 left a comment

Choose a reason for hiding this comment

kou left a comment

Choose a reason for hiding this comment

kevingurney commented Oct 11, 2023

conbench-apache-arrow bot commented Oct 15, 2023

GH-37812: [MATLAB] Add `arrow.type.ListType` MATLAB class #38189

GH-37812: [MATLAB] Add `arrow.type.ListType` MATLAB class #38189

kevingurney commented Oct 10, 2023 •

edited by github-actions bot

Loading