Enhance ListViewArray related docs #7007
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jefffrey
commented
Jan 22, 2025
| /// | ||
| /// [Variable-size List Layout: ListView Layout]: https://arrow.apache.org/docs/format/Columnar.html#listview-layout | ||
| /// This allows the offsets (and subsequently child data) to be out of order. It also | ||
| /// allows take / filter operations to be implemented without copying the underlying data. |
There was a problem hiding this comment.
Would be nice to elaborate on this statement about take / filter operations efficiency; I just kept it verbatim as it was already there before.
tustvold
reviewed
Jan 22, 2025
| /// ├─────────────┤ ├───────┤ │ ├───┤ ├───┤ ├───┤ ├───┤ ├───┤ | ||
| /// │ NULL │ │ (?,?) │ │ 0 │ │ ? │ │ ? │ │ │ 1 │ │ C │ │ 2 │ | ||
| /// ├─────────────┤ ├───────┤ │ ├───┤ ├───┤ ├───┤ ├───┤ ├───┤ | ||
| /// │ [D] │ │ (4,1) │ │ 1 │ │ 4 │ │ 1 │ │ │ ? │ │ ? │ │ 3 │ |
There was a problem hiding this comment.
Technically you don't need a value at index 3, list view even allows for overlapping ranges
There was a problem hiding this comment.
I've added another example which shows this in use 👍
tustvold
approved these changes
Jan 22, 2025
alamb
reviewed
Jan 22, 2025
| /// This allows the offsets (and subsequently child data) to be out of order. It also | ||
| /// allows take / filter operations to be implemented without copying the underlying data. | ||
| /// | ||
| /// # Representation |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Whilst reviewing #6969 I noticed the docs for GenericListViewArray weren't as detailed compared to GenericListArray. Just enhancing the docs a bit, borrowing the example from GenericListArray to give a visual representation of how view differs from regular list layout.
Also update the datatype docs to remove the reference to internal buffers as that would belong with the GenericListViewArray doc instead of at datatype level.