You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "tustvold (via GitHub)" <gi...@apache.org> on 2023/03/01 17:27:33 UTC

[GitHub] [arrow-rs] tustvold opened a new pull request, #3783: Return Buffers from ArrayData::buffers instead of slice (#1799)

tustvold opened a new pull request, #3783:
URL: https://github.com/apache/arrow-rs/pull/3783

   # Which issue does this PR close?
   
   <!--
   We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
   -->
   
   Part of #1799
   Relates to #1176 
   
   # Rationale for this change
    
   <!--
   Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
   Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
   -->
   
   Currently ArrayData stores a `Vec<Buffer>` and this allows it to return `&[Buffer]`. As we move to structured array data (#1799) implementations will no longer store a contiguous array of `Buffer` instead storing a selection of `ScalarBuffer`. This PR adds a new `Buffers` struct to smooth over this transition, and allow code to be slowly migrated.
   
   # What changes are included in this PR?
   
   <!--
   There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
   -->
   
   # Are there any user-facing changes?
   
   
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!---
   If there are any breaking changes to public APIs, please add the `breaking change` label.
   -->
   


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-rs] alamb commented on a diff in pull request #3783: Return Buffers from ArrayData::buffers instead of slice (#1799)

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #3783:
URL: https://github.com/apache/arrow-rs/pull/3783#discussion_r1123232616


##########
arrow-data/src/data/buffers.rs:
##########
@@ -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.
+
+use arrow_buffer::Buffer;
+use std::iter::Chain;
+use std::ops::Index;
+
+/// A collection of [`Buffer`]
+#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
+pub struct Buffers<'a>([Option<&'a Buffer>; 2]);
+
+impl<'a> Buffers<'a> {
+    /// Temporary will be removed once ArrayData does not store `Vec<Buffer>` directly (#3769)

Review Comment:
   Will this whole struct be temporary or just this method?



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-rs] tustvold commented on a diff in pull request #3783: Return Buffers from ArrayData::buffers instead of slice (#1799)

Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #3783:
URL: https://github.com/apache/arrow-rs/pull/3783#discussion_r1123246737


##########
arrow-data/src/data/buffers.rs:
##########
@@ -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.
+
+use arrow_buffer::Buffer;
+use std::iter::Chain;
+use std::ops::Index;
+
+/// A collection of [`Buffer`]
+#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
+pub struct Buffers<'a>([Option<&'a Buffer>; 2]);
+
+impl<'a> Buffers<'a> {
+    /// Temporary will be removed once ArrayData does not store `Vec<Buffer>` directly (#3769)

Review Comment:
   Just this method



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-rs] tustvold merged pull request #3783: Return Buffers from ArrayData::buffers instead of slice (#1799)

Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold merged PR #3783:
URL: https://github.com/apache/arrow-rs/pull/3783


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-rs] ursabot commented on pull request #3783: Return Buffers from ArrayData::buffers instead of slice (#1799)

Posted by "ursabot (via GitHub)" <gi...@apache.org>.
ursabot commented on PR #3783:
URL: https://github.com/apache/arrow-rs/pull/3783#issuecomment-1452133176

   Benchmark runs are scheduled for baseline = eff058fc7a156d1b22569bd60a747d98960d97e7 and contender = 231ae9b31769b62da368b9f1eb355a840540cb06. 231ae9b31769b62da368b9f1eb355a840540cb06 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
   Conbench compare runs links:
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ec2-t3-xlarge-us-east-2] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/ec218d7437b145148bf65f2275a8bd1c...a3bd2e5667644805aeb3b02dcc7b6faa/)
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on test-mac-arm] [test-mac-arm](https://conbench.ursa.dev/compare/runs/5222383eb87640c3a403ccfaff3e8f83...5c75a4126a604df18f1a954fe5f18917/)
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ursa-i9-9960x] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/1284f9d4f6a34b5a9dda1072043ed057...889edfb66f894432af6da6bd49397e1d/)
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ursa-thinkcentre-m75q] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/6406a83468a64f5cbe2d1eed1ad65fef...9056d2bb8cf74b84abb9ef207b41eba3/)
   Buildkite builds:
   Supported benchmarks:
   ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
   test-mac-arm: Supported benchmark langs: C++, Python, R
   ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
   ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
   


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-rs] waynexia commented on a diff in pull request #3783: Return Buffers from ArrayData::buffers instead of slice (#1799)

Posted by "waynexia (via GitHub)" <gi...@apache.org>.
waynexia commented on code in PR #3783:
URL: https://github.com/apache/arrow-rs/pull/3783#discussion_r1122572534


##########
arrow-data/src/data/buffers.rs:
##########
@@ -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.
+
+use arrow_buffer::Buffer;
+use std::iter::Chain;
+use std::ops::Index;
+
+/// A collection of [`Buffer`]
+#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
+pub struct Buffers<'a>([Option<&'a Buffer>; 2]);
+
+impl<'a> Buffers<'a> {
+    /// Temporary will be removed once ArrayData does not store `Vec<Buffer>` directly (#3769)
+    #[inline]
+    pub(crate) fn from_slice(a: &'a [Buffer]) -> Self {
+        match a.len() {
+            0 => Self([None, None]),
+            1 => Self([Some(&a[0]), None]),
+            _ => Self([Some(&a[0]), Some(&a[1])]),
+        }
+    }
+
+    /// Returns the number of [`Buffer`] in this collection
+    #[inline]
+    pub fn len(&self) -> usize {
+        self.0[0].is_some() as usize + self.0[1].is_some() as usize
+    }
+
+    /// Returns `true` if this collection is empty
+    #[inline]
+    pub fn is_empty(&self) -> bool {
+        self.0[0].is_none() && self.0[1].is_none()
+    }
+
+    #[inline]
+    pub fn iter(&self) -> IntoIter<'a> {
+        self.into_iter()
+    }
+
+    /// Converts this [`Buffers`] to a `Vec<Buffer>`
+    #[inline]
+    pub fn to_vec(&self) -> Vec<Buffer> {
+        self.iter().cloned().collect()
+    }
+}
+
+impl<'a> Index<usize> for Buffers<'a> {
+    type Output = &'a Buffer;
+
+    #[inline]
+    fn index(&self, index: usize) -> &Self::Output {

Review Comment:
   I tried changing it to `type Output = Buffer` and got tons of errors. The one you mentioned can be fixed by introducing a temp variable for `array.data().buffers()` (very verbose...). But I don't know how to fix it if something else references `buffer`...
   
   So I'm ok with `&&Buffer` here. Not sure if it's the only way but it does make other things easier (to me).



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-rs] tustvold commented on a diff in pull request #3783: Return Buffers from ArrayData::buffers instead of slice (#1799)

Posted by "tustvold (via GitHub)" <gi...@apache.org>.
tustvold commented on code in PR #3783:
URL: https://github.com/apache/arrow-rs/pull/3783#discussion_r1122093470


##########
arrow-data/src/data/buffers.rs:
##########
@@ -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.
+
+use arrow_buffer::Buffer;
+use std::iter::Chain;
+use std::ops::Index;
+
+/// A collection of [`Buffer`]
+#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
+pub struct Buffers<'a>([Option<&'a Buffer>; 2]);
+
+impl<'a> Buffers<'a> {
+    /// Temporary will be removed once ArrayData does not store `Vec<Buffer>` directly (#3769)
+    #[inline]
+    pub(crate) fn from_slice(a: &'a [Buffer]) -> Self {
+        match a.len() {
+            0 => Self([None, None]),
+            1 => Self([Some(&a[0]), None]),
+            _ => Self([Some(&a[0]), Some(&a[1])]),
+        }
+    }
+
+    /// Returns the number of [`Buffer`] in this collection
+    #[inline]
+    pub fn len(&self) -> usize {
+        self.0[0].is_some() as usize + self.0[1].is_some() as usize
+    }
+
+    /// Returns `true` if this collection is empty
+    #[inline]
+    pub fn is_empty(&self) -> bool {
+        self.0[0].is_none() && self.0[1].is_none()
+    }
+
+    #[inline]
+    pub fn iter(&self) -> IntoIter<'a> {
+        self.into_iter()
+    }
+
+    /// Converts this [`Buffers`] to a `Vec<Buffer>`
+    #[inline]
+    pub fn to_vec(&self) -> Vec<Buffer> {
+        self.iter().cloned().collect()
+    }
+}
+
+impl<'a> Index<usize> for Buffers<'a> {
+    type Output = &'a Buffer;
+
+    #[inline]
+    fn index(&self, index: usize) -> &Self::Output {

Review Comment:
   This is somewhat unfortunate, having to return `&&Buffer` but we need to return a borrow with a `'a` lifetime otherwise the following code doesn't compile.
   
   ```
   let buffer = array.data().buffers()[0];
   ```



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org