kevingurney commented on code in PR #46907: URL: https://github.com/apache/arrow/pull/46907#discussion_r2167535146
########## matlab/src/cpp/arrow/matlab/proxy/wrap.h: ########## @@ -0,0 +1,54 @@ +// 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 "MatlabDataArray.hpp" +#include "arrow/array.h" +#include "arrow/matlab/array/proxy/array.h" +#include "arrow/matlab/type/proxy/type.h" +#include "arrow/result.h" + +namespace arrow::matlab::proxy { + +/// \brief Wraps an array within a proxy::Array. +/// +/// \return arrow::result<std::shared_ptr<arrow::matlab::array::proxy::Array>> +arrow::Result<std::shared_ptr<arrow::matlab::array::proxy::Array>> wrap( + const std::shared_ptr<arrow::Array>& array); + +/// \brief Wraps an array within a proxy::Array and adds the proxy to the ProxyManager. Review Comment: ```suggestion /// \brief Wraps an array within a proxy::Array and adds the Proxy to the ProxyManager. ``` ########## matlab/src/cpp/arrow/matlab/proxy/wrap.h: ########## @@ -0,0 +1,54 @@ +// 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 "MatlabDataArray.hpp" +#include "arrow/array.h" +#include "arrow/matlab/array/proxy/array.h" +#include "arrow/matlab/type/proxy/type.h" +#include "arrow/result.h" + +namespace arrow::matlab::proxy { + +/// \brief Wraps an array within a proxy::Array. +/// +/// \return arrow::result<std::shared_ptr<arrow::matlab::array::proxy::Array>> +arrow::Result<std::shared_ptr<arrow::matlab::array::proxy::Array>> wrap( + const std::shared_ptr<arrow::Array>& array); + +/// \brief Wraps an array within a proxy::Array and adds the proxy to the ProxyManager. +/// +/// \return arrow::Result<mda::StructArray>. The mda::StructArray has two fields: ProxyID +/// (uint64) and TypeID (int32). +arrow::Result<::matlab::data::StructArray> wrap_and_manage( + const std::shared_ptr<arrow::Array>& array); + +/// \brief Wraps an DataType within a proxy::DataType. Review Comment: ```suggestion /// \brief Wraps a DataType within a proxy::DataType. ``` ########## matlab/src/cpp/arrow/matlab/proxy/wrap.cc: ########## @@ -0,0 +1,216 @@ +// 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/matlab/proxy/wrap.h" +#include "arrow/matlab/array/proxy/boolean_array.h" +#include "arrow/matlab/array/proxy/list_array.h" +#include "arrow/matlab/array/proxy/numeric_array.h" +#include "arrow/matlab/array/proxy/string_array.h" +#include "arrow/matlab/array/proxy/struct_array.h" +#include "arrow/matlab/type/proxy/date32_type.h" +#include "arrow/matlab/type/proxy/date64_type.h" +#include "arrow/matlab/type/proxy/list_type.h" +#include "arrow/matlab/type/proxy/primitive_ctype.h" +#include "arrow/matlab/type/proxy/string_type.h" +#include "arrow/matlab/type/proxy/struct_type.h" +#include "arrow/matlab/type/proxy/time32_type.h" +#include "arrow/matlab/type/proxy/time64_type.h" + +#include "libmexclass/proxy/ProxyManager.h" + +namespace arrow::matlab::proxy { + +namespace { +template <typename T> +struct ProxyTraits {}; + +#define MATLAB_PROXY_TRAITS_DEF(ArrowType_, ArrayProxyName_, TypeProxyName_) \ Review Comment: Perhaps, we could add a comment here explaining what this macro does? ########## matlab/src/cpp/arrow/matlab/proxy/wrap.h: ########## @@ -0,0 +1,54 @@ +// 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 "MatlabDataArray.hpp" +#include "arrow/array.h" +#include "arrow/matlab/array/proxy/array.h" +#include "arrow/matlab/type/proxy/type.h" +#include "arrow/result.h" + +namespace arrow::matlab::proxy { + +/// \brief Wraps an array within a proxy::Array. +/// +/// \return arrow::result<std::shared_ptr<arrow::matlab::array::proxy::Array>> +arrow::Result<std::shared_ptr<arrow::matlab::array::proxy::Array>> wrap( + const std::shared_ptr<arrow::Array>& array); + +/// \brief Wraps an array within a proxy::Array and adds the proxy to the ProxyManager. +/// +/// \return arrow::Result<mda::StructArray>. The mda::StructArray has two fields: ProxyID +/// (uint64) and TypeID (int32). +arrow::Result<::matlab::data::StructArray> wrap_and_manage( + const std::shared_ptr<arrow::Array>& array); + +/// \brief Wraps an DataType within a proxy::DataType. +/// +/// \return arrow::result<std::shared_ptr<arrow::matlab::type::proxy::Type>> +arrow::Result<std::shared_ptr<arrow::matlab::type::proxy::Type>> wrap( + const std::shared_ptr<arrow::DataType>& datatype); + +/// \brief Wraps an DataType within a proxy::DataType and adds the proxy to the Review Comment: ```suggestion /// \brief Wraps a DataType within a proxy::DataType and adds the proxy to the ``` ########## matlab/src/matlab/+arrow/+type/ListType.m: ########## @@ -42,8 +42,8 @@ methods function valueType = get.ValueType(obj) valueTypeStruct = obj.Proxy.getValueType(); Review Comment: Maybe we should rename `valueTypeStruct` to `proxyInfo` for consistency? -- 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]
