kevingurney commented on code in PR #38020: URL: https://github.com/apache/arrow/pull/38020#discussion_r1348795360
########## matlab/src/cpp/arrow/matlab/buffer/proxy/buffer.cc: ########## @@ -0,0 +1,97 @@ +// 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/buffer/proxy/buffer.h" +#include "arrow/matlab/buffer/matlab_buffer.h" +#include "arrow/matlab/error/error.h" +#include "libmexclass/proxy/ProxyManager.h" + +namespace arrow::matlab::buffer::proxy { + + Buffer::Buffer(std::shared_ptr<arrow::Buffer> buffer) : buffer{std::move(buffer)} { + Review Comment: Extra newline here. ########## matlab/test/arrow/buffer/tBuffer.m: ########## @@ -0,0 +1,206 @@ +%TBUFFER Unit tests for arrow.buffer.Buffer + +% 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 tBuffer < matlab.unittest.TestCase + + methods (Test) + function Smoke(testCase) + import arrow.buffer.Buffer + + source = uint8([1 2 3]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyInstanceOf(buffer, "arrow.buffer.Buffer"); + end + + function fromMATLABUint8Scalar(testCase) Review Comment: Uint -> UInt ########## matlab/test/arrow/buffer/tBuffer.m: ########## @@ -0,0 +1,206 @@ +%TBUFFER Unit tests for arrow.buffer.Buffer + +% 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 tBuffer < matlab.unittest.TestCase + + methods (Test) + function Smoke(testCase) + import arrow.buffer.Buffer + + source = uint8([1 2 3]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyInstanceOf(buffer, "arrow.buffer.Buffer"); + end + + function fromMATLABUint8Scalar(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % instance when given a scalar uint8 value. + + import arrow.buffer.Buffer + + source = uint8(20); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(1)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, source); + end + + function fromMATLABFromEmptyUint8(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an empty uint8 array. + + import arrow.buffer.Buffer + + % Create buffer from 0x0 uint8 array + source = uint8.empty(0, 0); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 0x1 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 1x0 uint8 array + source = uint8.empty(0, 1); Review Comment: uint8.empty(0, 1) -> uint8.empty(1, 0) ########## matlab/test/arrow/buffer/tBuffer.m: ########## @@ -0,0 +1,206 @@ +%TBUFFER Unit tests for arrow.buffer.Buffer + +% 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 tBuffer < matlab.unittest.TestCase + + methods (Test) + function Smoke(testCase) + import arrow.buffer.Buffer + + source = uint8([1 2 3]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyInstanceOf(buffer, "arrow.buffer.Buffer"); + end + + function fromMATLABUint8Scalar(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % instance when given a scalar uint8 value. + + import arrow.buffer.Buffer + + source = uint8(20); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(1)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, source); + end + + function fromMATLABFromEmptyUint8(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an empty uint8 array. + + import arrow.buffer.Buffer + + % Create buffer from 0x0 uint8 array + source = uint8.empty(0, 0); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 0x1 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 1x0 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + end + + function fromMATLABUint8Vector(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an uint8 vector. + + import arrow.buffer.Buffer + + % Create buffer from 1x3 uint8 array + source = uint8([3 9 27]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(3)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8([3 9 27]')); + + % Create buffer from 3x1 uint8 array + source = uint8([3 9 27]'); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(3)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8([3 9 27]')); + end + + function fromMATLABDoubleVector(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an double vector. + + import arrow.buffer.Buffer + + % Create buffer from 1x3 double array + source = [3 9 27]; + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(24)); + values = toMATLAB(buffer); + expected = typecast(source', "uint8"); + testCase.verifyEqual(values, expected); + testCase.verifyEqual(typecast(values, "double"), source'); + + % Create buffer from 3x1 double array + source = [3 9 27]'; + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(24)); + values = toMATLAB(buffer); + expected = typecast(source, "uint8"); + testCase.verifyEqual(values, expected); + testCase.verifyEqual(typecast(values, "double"), source); + end + + function fromMATLABNonNumericError(testCase) + % Verify fromMATLAB throws an error if given a non-numeric + % array as input. + import arrow.buffer.Buffer + + fcn = @() Buffer.fromMATLAB(true); + testCase.verifyError(fcn, "MATLAB:validators:mustBeNumeric"); + + fcn = @() Buffer.fromMATLAB("A"); + testCase.verifyError(fcn, "MATLAB:validators:mustBeNumeric"); + + fcn = @() Buffer.fromMATLAB(datetime(2023, 1, 1)); + testCase.verifyError(fcn, "MATLAB:validators:mustBeNumeric"); + end + + function fromMATLABNonRealError(testCase) + % Verify fromMATLAB throws an error if given a complex + % numeric array as input. + import arrow.buffer.Buffer + + fcn = @() Buffer.fromMATLAB(10 + 3i); + testCase.verifyError(fcn, "MATLAB:validators:mustBeReal"); + end + + function fromMATLABNonSparseError(testCase) + % Verify fromMATLAB throws an error if given a sparse + % numeric array as input. + import arrow.buffer.Buffer + + fcn = @() Buffer.fromMATLAB(sparse(ones([5 1]))); + testCase.verifyError(fcn, "MATLAB:validators:mustBeNonsparse"); + end + + function NumBytesNoSetter(testCase) + % Verifies the NumBytes property is not settable. + + import arrow.buffer.Buffer + + buffer = Buffer.fromMATLAB([1 2 3]); + fcn = @() setfield(buffer, "NumBytes", int64(1)); + testCase.verifyError(fcn, "MATLAB:class:SetProhibited"); + end + + function IsEqualTrue(testCase) + % Verifies two buffers are considered equal if + % 1. They have the same size (NumBytes) + % 2. They contain the same bytes + + import arrow.buffer.Buffer + + % Compare two non-empty buffers + buffer1 = Buffer.fromMATLAB([1 2 3]); + buffer2 = Buffer.fromMATLAB([1 2 3]); + testCase.verifyTrue(isequal(buffer1, buffer2)); + + % Compare two buffers, one of which was created from a double + % array and the other created from a uint8 array. However, both + % arrays have the same bit pattern. + data = zeros([1 24], "uint8"); + data([7 8 16 23 24]) = [240 63 64 8 64]; + buffer3 = Buffer.fromMATLAB(data); + testCase.verifyTrue(isequal(buffer1, buffer3)); + + % Compare two empty buffers + buffer4 = Buffer.fromMATLAB([]); + buffer5 = Buffer.fromMATLAB([]); + testCase.verifyTrue(isequal(buffer4, buffer5)); + + % Compare more than two buffers + testCase.verifyTrue(isequal(buffer1, buffer2, buffer3)); + end + + function IsEqualFalse(testCase) + % Verifies two buffers are considered equal if Review Comment: I think it would be good to modify this comment to discuss when two Buffers are *not* considered equal. ########## matlab/src/cpp/arrow/matlab/buffer/proxy/buffer.h: ########## @@ -0,0 +1,48 @@ +// 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 "arrow/buffer.h" + +#include "libmexclass/proxy/Proxy.h" + +namespace arrow::matlab::buffer::proxy { + +class Buffer : public libmexclass::proxy::Proxy { + public: + Buffer(std::shared_ptr<arrow::Buffer> buffer); + + ~Buffer() {} + + std::shared_ptr<arrow::Buffer> unwrap(); + + static libmexclass::proxy::MakeResult make(const libmexclass::proxy::FunctionArguments& constructor_arguments); + + + protected: + + void getNumBytes(libmexclass::proxy::method::Context& context); + Review Comment: There is a lot of extra newlines here. Might look a little bit better if we removed some of them. ########## matlab/test/arrow/buffer/tBuffer.m: ########## @@ -0,0 +1,206 @@ +%TBUFFER Unit tests for arrow.buffer.Buffer + +% 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 tBuffer < matlab.unittest.TestCase + + methods (Test) + function Smoke(testCase) + import arrow.buffer.Buffer + + source = uint8([1 2 3]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyInstanceOf(buffer, "arrow.buffer.Buffer"); + end + + function fromMATLABUint8Scalar(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % instance when given a scalar uint8 value. + + import arrow.buffer.Buffer + + source = uint8(20); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(1)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, source); + end + + function fromMATLABFromEmptyUint8(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an empty uint8 array. + + import arrow.buffer.Buffer + + % Create buffer from 0x0 uint8 array + source = uint8.empty(0, 0); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 0x1 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 1x0 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + end + + function fromMATLABUint8Vector(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an uint8 vector. + + import arrow.buffer.Buffer + + % Create buffer from 1x3 uint8 array + source = uint8([3 9 27]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(3)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8([3 9 27]')); + + % Create buffer from 3x1 uint8 array + source = uint8([3 9 27]'); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(3)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8([3 9 27]')); + end + + function fromMATLABDoubleVector(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an double vector. + + import arrow.buffer.Buffer + + % Create buffer from 1x3 double array + source = [3 9 27]; + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(24)); Review Comment: Might be helpful to add a comment here like: ```matlab % Since the input vector is a 1x3 double (i.e. 64-bit floating point value) array - each of the 3 elements takes up 8 bytes (3 elements * 8 bytes per element = 24 bytes). ``` ########## matlab/test/arrow/buffer/tBuffer.m: ########## @@ -0,0 +1,206 @@ +%TBUFFER Unit tests for arrow.buffer.Buffer + +% 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 tBuffer < matlab.unittest.TestCase + + methods (Test) + function Smoke(testCase) + import arrow.buffer.Buffer + + source = uint8([1 2 3]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyInstanceOf(buffer, "arrow.buffer.Buffer"); + end + + function fromMATLABUint8Scalar(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % instance when given a scalar uint8 value. + + import arrow.buffer.Buffer + + source = uint8(20); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(1)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, source); + end + + function fromMATLABFromEmptyUint8(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an empty uint8 array. + + import arrow.buffer.Buffer + + % Create buffer from 0x0 uint8 array + source = uint8.empty(0, 0); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 0x1 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 1x0 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + end + + function fromMATLABUint8Vector(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an uint8 vector. + + import arrow.buffer.Buffer + + % Create buffer from 1x3 uint8 array + source = uint8([3 9 27]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(3)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8([3 9 27]')); + + % Create buffer from 3x1 uint8 array + source = uint8([3 9 27]'); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(3)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8([3 9 27]')); + end + + function fromMATLABDoubleVector(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an double vector. Review Comment: an -> a ########## matlab/test/arrow/buffer/tBuffer.m: ########## @@ -0,0 +1,206 @@ +%TBUFFER Unit tests for arrow.buffer.Buffer + +% 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 tBuffer < matlab.unittest.TestCase + + methods (Test) + function Smoke(testCase) + import arrow.buffer.Buffer + + source = uint8([1 2 3]); + buffer = Buffer.fromMATLAB(source); + testCase.verifyInstanceOf(buffer, "arrow.buffer.Buffer"); + end + + function fromMATLABUint8Scalar(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % instance when given a scalar uint8 value. + + import arrow.buffer.Buffer + + source = uint8(20); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(1)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, source); + end + + function fromMATLABFromEmptyUint8(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an empty uint8 array. + + import arrow.buffer.Buffer + + % Create buffer from 0x0 uint8 array + source = uint8.empty(0, 0); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 0x1 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + + % Create buffer from 1x0 uint8 array + source = uint8.empty(0, 1); + buffer = Buffer.fromMATLAB(source); + testCase.verifyEqual(buffer.NumBytes, int64(0)); + values = toMATLAB(buffer); + testCase.verifyEqual(values, uint8.empty(0, 1)); + end + + function fromMATLABUint8Vector(testCase) + % Verifies fromMATLAB returns the expected arrow.buffer.Buffer + % value when given an uint8 vector. Review Comment: an -> a ########## matlab/src/cpp/arrow/matlab/buffer/proxy/buffer.cc: ########## @@ -0,0 +1,97 @@ +// 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/buffer/proxy/buffer.h" +#include "arrow/matlab/buffer/matlab_buffer.h" +#include "arrow/matlab/error/error.h" +#include "libmexclass/proxy/ProxyManager.h" + +namespace arrow::matlab::buffer::proxy { + + Buffer::Buffer(std::shared_ptr<arrow::Buffer> buffer) : buffer{std::move(buffer)} { + + REGISTER_METHOD(Buffer, getNumBytes); + REGISTER_METHOD(Buffer, isEqual); + REGISTER_METHOD(Buffer, toMATLAB); + } + + libmexclass::proxy::MakeResult Buffer::make(const libmexclass::proxy::FunctionArguments& constructor_arguments) { + namespace mda = ::matlab::data; + using BufferProxy = proxy::Buffer; + using MatlabBuffer = arrow::matlab::buffer::MatlabBuffer; + + mda::StructArray opts = constructor_arguments[0]; + const mda::TypedArray<uint8_t> values_mda = opts[0]["Values"]; + auto buffer = std::make_shared<MatlabBuffer>(values_mda); + return std::make_shared<BufferProxy>(std::move(buffer)); + } + + std::shared_ptr<arrow::Buffer> Buffer::unwrap() { + return buffer; + } + + void Buffer::getNumBytes(libmexclass::proxy::method::Context& context) { + namespace mda = ::matlab::data; + mda::ArrayFactory factory; + auto num_bytes_mda = factory.createScalar(buffer->size()); + context.outputs[0] = num_bytes_mda; + } + + void Buffer::isEqual(libmexclass::proxy::method::Context& context) { + namespace mda = ::matlab::data; + + bool is_equal = true; + const mda::TypedArray<uint64_t> buffer_proxy_ids = context.inputs[0]; + for (const auto& buffer_proxy_id : buffer_proxy_ids) { + // Retrieve the Buffer proxy from the ProxyManager + auto proxy = libmexclass::proxy::ProxyManager::getProxy(buffer_proxy_id); + auto buffer_proxy = std::static_pointer_cast<proxy::Buffer>(proxy); + auto buffer_to_compare = buffer_proxy->unwrap(); + + if (!buffer->Equals(*buffer_to_compare)) { + is_equal = false; + break; + } + } + mda::ArrayFactory factory; + context.outputs[0] = factory.createScalar(is_equal); + } + + void Buffer::toMATLAB(libmexclass::proxy::method::Context& context) { + namespace mda = ::matlab::data; + + // If buffer->is_cpu() returns false, invoking buffer->data() may cause a crash. + // Avoid this potential crash by first invoking ViewOrCopy(buffer, memory_manager_device). + // This function tries to create a no-copy view of the buffer on the given memory + // manager device. If not possible, then ViewOrCopy copies the buffer's contents. + MATLAB_ASSIGN_OR_ERROR_WITH_CONTEXT( + auto cpu_buffer, + arrow::Buffer::ViewOrCopy(buffer, arrow::default_cpu_memory_manager()), + context, error::BUFFER_VIEW_OR_COPY_FAILED + ); + + const auto* data_begin = cpu_buffer->data(); + const auto num_bytes = cpu_buffer->size(); + // data_begin is a uint8_t*, so num_bytes is equal to the number of elements Review Comment: Ah, OK, that makes sense. I think I misinterpreted this the first time I read it. My apologies. ########## matlab/src/cpp/arrow/matlab/buffer/proxy/buffer.cc: ########## @@ -0,0 +1,97 @@ +// 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/buffer/proxy/buffer.h" +#include "arrow/matlab/buffer/matlab_buffer.h" +#include "arrow/matlab/error/error.h" +#include "libmexclass/proxy/ProxyManager.h" + +namespace arrow::matlab::buffer::proxy { + + Buffer::Buffer(std::shared_ptr<arrow::Buffer> buffer) : buffer{std::move(buffer)} { + + REGISTER_METHOD(Buffer, getNumBytes); + REGISTER_METHOD(Buffer, isEqual); + REGISTER_METHOD(Buffer, toMATLAB); + } + + libmexclass::proxy::MakeResult Buffer::make(const libmexclass::proxy::FunctionArguments& constructor_arguments) { + namespace mda = ::matlab::data; + using BufferProxy = proxy::Buffer; + using MatlabBuffer = arrow::matlab::buffer::MatlabBuffer; + + mda::StructArray opts = constructor_arguments[0]; + const mda::TypedArray<uint8_t> values_mda = opts[0]["Values"]; + auto buffer = std::make_shared<MatlabBuffer>(values_mda); + return std::make_shared<BufferProxy>(std::move(buffer)); + } + + std::shared_ptr<arrow::Buffer> Buffer::unwrap() { + return buffer; + } + + void Buffer::getNumBytes(libmexclass::proxy::method::Context& context) { + namespace mda = ::matlab::data; + mda::ArrayFactory factory; + auto num_bytes_mda = factory.createScalar(buffer->size()); + context.outputs[0] = num_bytes_mda; + } + + void Buffer::isEqual(libmexclass::proxy::method::Context& context) { + namespace mda = ::matlab::data; + + bool is_equal = true; + const mda::TypedArray<uint64_t> buffer_proxy_ids = context.inputs[0]; + for (const auto& buffer_proxy_id : buffer_proxy_ids) { + // Retrieve the Buffer proxy from the ProxyManager + auto proxy = libmexclass::proxy::ProxyManager::getProxy(buffer_proxy_id); + auto buffer_proxy = std::static_pointer_cast<proxy::Buffer>(proxy); + auto buffer_to_compare = buffer_proxy->unwrap(); + + if (!buffer->Equals(*buffer_to_compare)) { + is_equal = false; + break; + } + } + mda::ArrayFactory factory; + context.outputs[0] = factory.createScalar(is_equal); + } + + void Buffer::toMATLAB(libmexclass::proxy::method::Context& context) { + namespace mda = ::matlab::data; + + // If buffer->is_cpu() returns false, invoking buffer->data() may cause a crash. + // Avoid this potential crash by first invoking ViewOrCopy(buffer, memory_manager_device). + // This function tries to create a no-copy view of the buffer on the given memory + // manager device. If not possible, then ViewOrCopy copies the buffer's contents. + MATLAB_ASSIGN_OR_ERROR_WITH_CONTEXT( + auto cpu_buffer, + arrow::Buffer::ViewOrCopy(buffer, arrow::default_cpu_memory_manager()), + context, error::BUFFER_VIEW_OR_COPY_FAILED + ); + + const auto* data_begin = cpu_buffer->data(); + const auto num_bytes = cpu_buffer->size(); + // data_begin is a uint8_t*, so num_bytes is equal to the number of elements Review Comment: Marking this as resolved. -- 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]
