forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
apacheGH-41656: [MATLAB] Add C Data Interface format import/export fu…
…nctionality for `arrow.array.Array` (apache#41737) ### Rationale for this change Now that apache#41653 and apache#41654 have been addressed, we should add MATLAB APIs for importing/exporting `arrow.array.Array` objects using the C Data Interface format. This pull request adds two new APIs for importing and exporting `arrow.array.Array` objects using the C Data Interface format. #### Example ```matlab >> expected = arrow.array([1, 2, 3]) expected = Float64Array with 3 elements and 0 null values: 1 | 2 | 3 >> cArray = arrow.c.Array() cArray = Array with properties: Address: 140341875084944 >> cSchema = arrow.c.Schema() cSchema = Schema with properties: Address: 140341880022320 % Export the Array to C Data Interface Format >> expected.export(cArray.Address, cSchema.Address) % Import the Array from C Data Interface Format >> actual = arrow.array.Array.import(cArray, cSchema) actual = Float64Array with 3 elements and 0 null values: 1 | 2 | 3 % The Array is the same after round-tripping to C Data Interface format >> isequal(actual, expected) ans = logical 1 ``` ### What changes are included in this PR? 1. Added new `arrow.array.Array.export(cArrowArrayAddress, cArrowSchemaAddress)` method for exporting `Array` objects to C Data Interface format. 2. Added new static `arrow.array.Array.import(cArray, cSchema)` method for importing `Array`s from C Data Interface format. 3. Added new internal `arrow.c.internal.ArrayImporter` class for importing `Array` objects from C Data Interface format. ### Are these changes tested? Yes. 1. Added new test file `matlab/test/arrow/c/tRoundTrip.m` with basic round-trip tests for importing/exporting `Array` objects using the C Data Interface format. ### Are there any user-facing changes? Yes. 1. There are now two new user-facing APIs added to the `arrow.array.Array` class. These are `arrow.array.Array.export(cArrowArrayAddress, cArrowSchemaAddress)` and `arrow.array.Array.import(cArray, cSchema)`. These APIs can be used to import/export `Array` objects using the C Data Interface format. ### Future Directions 1. Add integration tests for sharing data between MATLAB/mlarrow and Python/pyarrow running in the same process using the [MATLAB interface to Python](https://www.mathworks.com/help/matlab/call-python-libraries.html). 2. Add support for exporting/importing `arrow.tabular.RecordBatch` objects using the C Data Interface format. 3. Add support for the Arrow [C stream interface format](https://arrow.apache.org/docs/format/CStreamInterface.html). ### Notes 1. Thanks @ sgilmore10 for your help with this pull request! * GitHub Issue: apache#41656 Lead-authored-by: Kevin Gurney <[email protected]> Co-authored-by: Kevin Gurney <[email protected]> Co-authored-by: Sutou Kouhei <[email protected]> Signed-off-by: Kevin Gurney <[email protected]>
- Loading branch information
3 people
authored
May 20, 2024
1 parent
cc3e2db
commit 5809daf
Showing
10 changed files
with
387 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // 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. | ||
|
|
||
| #include "arrow/array.h" | ||
| #include "arrow/c/bridge.h" | ||
|
|
||
| #include "arrow/matlab/array/proxy/wrap.h" | ||
| #include "arrow/matlab/c/proxy/array_importer.h" | ||
| #include "arrow/matlab/error/error.h" | ||
|
|
||
| #include "libmexclass/proxy/ProxyManager.h" | ||
|
|
||
| namespace arrow::matlab::c::proxy { | ||
|
|
||
| ArrayImporter::ArrayImporter() { REGISTER_METHOD(ArrayImporter, import); } | ||
|
|
||
| libmexclass::proxy::MakeResult ArrayImporter::make( | ||
| const libmexclass::proxy::FunctionArguments& constructor_arguments) { | ||
| return std::make_shared<ArrayImporter>(); | ||
| } | ||
|
|
||
| void ArrayImporter::import(libmexclass::proxy::method::Context& context) { | ||
| namespace mda = ::matlab::data; | ||
| using namespace libmexclass::proxy; | ||
|
|
||
| mda::StructArray args = context.inputs[0]; | ||
| const mda::TypedArray<uint64_t> arrow_array_address_mda = args[0]["ArrowArrayAddress"]; | ||
| const mda::TypedArray<uint64_t> arrow_schema_address_mda = | ||
| args[0]["ArrowSchemaAddress"]; | ||
|
|
||
| const auto arrow_array_address = uint64_t(arrow_array_address_mda[0]); | ||
| const auto arrow_schema_address = uint64_t(arrow_schema_address_mda[0]); | ||
|
|
||
| auto arrow_array = reinterpret_cast<struct ArrowArray*>(arrow_array_address); | ||
| auto arrow_schema = reinterpret_cast<struct ArrowSchema*>(arrow_schema_address); | ||
|
|
||
| MATLAB_ASSIGN_OR_ERROR_WITH_CONTEXT(auto array, | ||
| arrow::ImportArray(arrow_array, arrow_schema), | ||
| context, error::C_IMPORT_FAILED); | ||
|
|
||
| MATLAB_ASSIGN_OR_ERROR_WITH_CONTEXT(auto array_proxy, | ||
| arrow::matlab::array::proxy::wrap(array), context, | ||
| error::UNKNOWN_PROXY_FOR_ARRAY_TYPE); | ||
|
|
||
| mda::ArrayFactory factory; | ||
| const auto array_proxy_id = ProxyManager::manageProxy(array_proxy); | ||
| const auto array_proxy_id_mda = factory.createScalar(array_proxy_id); | ||
| const auto array_type_id_mda = | ||
| factory.createScalar(static_cast<int32_t>(array->type_id())); | ||
|
|
||
| context.outputs[0] = array_proxy_id_mda; | ||
| context.outputs[1] = array_type_id_mda; | ||
| } | ||
|
|
||
| } // namespace arrow::matlab::c::proxy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // 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. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "libmexclass/proxy/Proxy.h" | ||
|
|
||
| namespace arrow::matlab::c::proxy { | ||
|
|
||
| class ArrayImporter : public libmexclass::proxy::Proxy { | ||
| public: | ||
| ArrayImporter(); | ||
|
|
||
| ~ArrayImporter() = default; | ||
|
|
||
| static libmexclass::proxy::MakeResult make( | ||
| const libmexclass::proxy::FunctionArguments& constructor_arguments); | ||
|
|
||
| protected: | ||
| void import(libmexclass::proxy::method::Context& context); | ||
| }; | ||
|
|
||
| } // namespace arrow::matlab::c::proxy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| %ARRAYIMPORTER Imports Arrow Array using the C Data Interface Format. | ||
|
|
||
| % 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 ArrayImporter < matlab.mixin.Scalar | ||
|
|
||
| properties (Hidden, SetAccess=private, GetAccess=public) | ||
| Proxy | ||
| end | ||
|
|
||
| methods | ||
|
|
||
| function obj = ArrayImporter() | ||
| proxyName = "arrow.c.proxy.ArrayImporter"; | ||
| proxy = arrow.internal.proxy.create(proxyName, struct()); | ||
| obj.Proxy = proxy; | ||
| end | ||
|
|
||
| function array = import(obj, cArray, cSchema) | ||
| arguments | ||
| obj(1, 1) arrow.c.internal.ArrayImporter | ||
| cArray(1, 1) arrow.c.Array | ||
| cSchema(1, 1) arrow.c.Schema | ||
| end | ||
| args = struct(... | ||
| ArrowArrayAddress=cArray.Address,... | ||
| ArrowSchemaAddress=cSchema.Address... | ||
| ); | ||
| [proxyID, typeID] = obj.Proxy.import(args); | ||
| traits = arrow.type.traits.traits(arrow.type.ID(typeID)); | ||
| proxy = libmexclass.proxy.Proxy(Name=traits.ArrayProxyClassName, ID=proxyID); | ||
| array = traits.ArrayConstructor(proxy); | ||
| end | ||
|
|
||
| end | ||
|
|
||
| end | ||
|
|
Oops, something went wrong.