Add iterators to BooleanBuffer and NullBuffer #3901
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
alamb
approved these changes
Mar 22, 2023
| @@ -164,6 +165,21 @@ impl BooleanBuffer { | |||
| pub fn into_inner(self) -> Buffer { | |||
| self.buffer | |||
| } | |||
|
|
|||
| /// Returns an iterator over the bits in this [`BooleanBuffer`] | |||
| pub fn iter(&self) -> BitIterator<'_> { | |||
| } | ||
|
|
||
| /// Returns a [`BitIndexIterator`] over the valid indices in this [`NullBuffer`] | ||
| pub fn valid_indices(&self) -> BitIndexIterator<'_> { |
There was a problem hiding this comment.
Is the reason this is called valid_indices but the equivalent is called set_indices in BooleanBuffer is to highlight that a "Null buffer" in arrow is really a validity buffer (1 means non null)?
There was a problem hiding this comment.
Yeah, I figured that it might avoid some confusion perhaps
| self.buffer.iter() | ||
| } | ||
|
|
||
| /// Returns a [`BitIndexIterator`] over the valid indices in this [`NullBuffer`] |
There was a problem hiding this comment.
Suggested change
| /// Returns a [`BitIndexIterator`] over the valid indices in this [`NullBuffer`] | |
| /// Returns a [`BitIndexIterator`] over the valid indices in this [`NullBuffer`]. | |
| /// | |
| /// Valid indices indicate that the corresponding value is non null |
| @@ -114,6 +114,23 @@ impl NullBuffer { | |||
| Self::new(self.buffer.slice(offset, len)) | |||
| } | |||
|
|
|||
| /// Returns an iterator over the bits in this [`NullBuffer`] | |||
There was a problem hiding this comment.
Suggested change
| /// Returns an iterator over the bits in this [`NullBuffer`] | |
| /// Returns an iterator over the bits in this [`NullBuffer`] | |
| /// | |
| /// * values of `1` indicate valid indices (the corresponding value is non null) | |
| /// * values of `0` indicate invalid indices (the corresponding value is null) |
| self.buffer.set_indices() | ||
| } | ||
|
|
||
| /// Returns a [`BitSliceIterator`] yielding contiguous ranges of valid indices |
There was a problem hiding this comment.
Suggested change
| /// Returns a [`BitSliceIterator`] yielding contiguous ranges of valid indices | |
| /// Returns a [`BitSliceIterator`] yielding contiguous ranges of valid indices | |
| /// | |
| /// Valid indices indicate that the corresponding value is non null |
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.
Which issue does this PR close?
Part of #3880
Rationale for this change
Continues to flesh out the buffer abstractions
What changes are included in this PR?
Are there any user-facing changes?