-
Notifications
You must be signed in to change notification settings - Fork 810
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Minor: Add documentation about memory use for ArrayData #3529
Conversation
arrow-data/src/data.rs
Outdated
/// [ArrayData] pointing at the same underlying [`Buffer`]s with a | ||
/// different offset, len and a shifted null bitmap. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// [ArrayData] pointing at the same underlying [`Buffer`]s with a | |
/// different offset, len and a shifted null bitmap. | |
/// [`ArrayData`] pointing at the same underlying [`Buffer`]s with a | |
/// different offset, len and a shifted null bitmap. |
@@ -245,18 +245,58 @@ pub(crate) fn into_buffers( | |||
/// An generic representation of Arrow array data which encapsulates common attributes and | |||
/// operations for Arrow array. Specific operations for different arrays types (e.g., | |||
/// primitive, list, struct) are implemented in `Array`. | |||
/// | |||
/// # Memory Layout |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Co-authored-by: Liang-Chi Hsieh <[email protected]>
Co-authored-by: Liang-Chi Hsieh <[email protected]> Co-authored-by: Raphael Taylor-Davies <[email protected]>
Co-authored-by: Raphael Taylor-Davies <[email protected]>
Co-authored-by: Raphael Taylor-Davies <[email protected]>
Benchmark runs are scheduled for baseline = c906fbf and contender = 14545a4. 14545a4 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Which issue does this PR close?
re #3407
Rationale for this change
Rationale is that I am always confused / have to remind myself what the various memory functions track. #3501 from @askoa (❤️ ) added a third so I felt it was time to document what was going on here better (with a diagram!)
What changes are included in this PR?
Add documentation about various memory functions on ArrayData
Are there any user-facing changes?
docstrings