This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new 122a5f498b doc: Clarify take kernel semantics (#6632)
122a5f498b is described below
commit 122a5f498bf57746d16899b892e8ca239490e162
Author: Liang-Chi Hsieh <vii...@gmail.com>
AuthorDate: Tue Oct 29 01:49:06 2024 -0700
doc: Clarify take kernel semantics (#6632)
* doc: Clarify take kernel behavior
* fix
* Update arrow-select/src/take.rs
Co-authored-by: Raphael Taylor-Davies
<1781103+tustv...@users.noreply.github.com>
---------
Co-authored-by: Raphael Taylor-Davies
<1781103+tustv...@users.noreply.github.com>
---
arrow-select/src/take.rs | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/arrow-select/src/take.rs b/arrow-select/src/take.rs
index 7e17e61e1d..07630a49fa 100644
--- a/arrow-select/src/take.rs
+++ b/arrow-select/src/take.rs
@@ -50,6 +50,10 @@ use num::{One, Zero};
///
/// For selecting values by index from multiple arrays see
[`crate::interleave`]
///
+/// Note that this kernel, similar to other kernels in this crate,
+/// will avoid allocating where not necessary. Consequently
+/// the returned array may share buffers with the inputs
+///
/// # Errors
/// This function errors whenever:
/// * An index cannot be casted to `usize` (typically 32 bit architectures)
