You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2022/04/05 19:56:00 UTC
[arrow-rs] branch master updated: Add a diagram to `take` kernel documentation (#1524)
This is an automated email from the ASF dual-hosted git repository.
alamb 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 e27a26421 Add a diagram to `take` kernel documentation (#1524)
e27a26421 is described below
commit e27a264218f4632dd71e05e7df6d5bcfeda92e85
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Tue Apr 5 15:55:56 2022 -0400
Add a diagram to `take` kernel documentation (#1524)
---
arrow/src/compute/kernels/take.rs | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/arrow/src/compute/kernels/take.rs b/arrow/src/compute/kernels/take.rs
index 9d2ece456..55c3987f3 100644
--- a/arrow/src/compute/kernels/take.rs
+++ b/arrow/src/compute/kernels/take.rs
@@ -53,6 +53,21 @@ macro_rules! downcast_dict_take {
/// Take elements by index from [Array], creating a new [Array] from those indexes.
///
+/// ```text
+/// ┌─────────────────┐ ┌─────────┐ ┌─────────────────┐
+/// │ A │ │ 0 │ │ A │
+/// ├─────────────────┤ ├─────────┤ ├─────────────────┤
+/// │ D │ │ 2 │ │ B │
+/// ├─────────────────┤ ├─────────┤ take(values, indicies) ├─────────────────┤
+/// │ B │ │ 3 │ ─────────────────────────▶ │ C │
+/// ├─────────────────┤ ├─────────┤ ├─────────────────┤
+/// │ C │ │ 1 │ │ D │
+/// ├─────────────────┤ └─────────┘ └─────────────────┘
+/// │ E │
+/// └─────────────────┘
+/// values array indicies array result
+/// ```
+///
/// # Errors
/// This function errors whenever:
/// * An index cannot be casted to `usize` (typically 32 bit architectures)