Tweak Private Sbbf::new_with_ndv_fpp Documentation #5718
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
github-actions
bot
added
parquet
alamb
reviewed
May 4, 2024
There was a problem hiding this comment.
Thanks for this contribution @YichiZhang0613 🙏
I think the asserts in this PR are unecessary as Rust automatically checks bounds on array accesses (and panic's if it is out of bounds)
arrow-array/src/array/byte_array.rs
Outdated
| @@ -232,6 +232,7 @@ impl<T: ByteArrayType> GenericByteArray<T> { | |||
| #[inline] | |||
| pub fn value_length(&self, i: usize) -> T::Offset { | |||
| let offsets = self.value_offsets(); | |||
| assert!(i + 1 < offsets.len()); | |||
There was a problem hiding this comment.
I think this check is unecessary as offsets[i + 1] will panic if the access is out of bounds
tustvold
reviewed
May 4, 2024
arrow-data/src/transform/mod.rs
Outdated
| @@ -645,6 +645,8 @@ impl<'a> MutableArrayData<'a> { | |||
| /// or `end` > the length of the `index`th array | |||
| pub fn extend(&mut self, index: usize, start: usize, end: usize) { | |||
| let len = end - start; | |||
| assert!(index < self.extend_null_bits.len()); | |||
There was a problem hiding this comment.
These are also unnecessary
There was a problem hiding this comment.
ok, I will modify my PR accordingly.
|
ok, I will modify my PR accordingly. |
tustvold
added
documentation
tustvold
changed the title
tustvold
reviewed
May 4, 2024
parquet/src/bloom_filter/mod.rs
Outdated
| @@ -179,7 +179,7 @@ fn num_of_bits_from_ndv_fpp(ndv: u64, fpp: f64) -> usize { | |||
|
|
|||
| impl Sbbf { | |||
| /// Create a new [Sbbf] with given number of distinct values and false positive probability. | |||
| /// Will panic if `fpp` is greater than 1.0 or less than 0.0. | |||
| /// Will panic if `fpp` is greater than or equal to 1.0 or less than 0.0. | |||
There was a problem hiding this comment.
Suggested change
| /// Will panic if `fpp` is greater than or equal to 1.0 or less than 0.0. | |
| /// Will return an error if `fpp` is greater than or equal to 1.0 or less than 0.0. |
There was a problem hiding this comment.
ok, I will modify my PR accordingly.
tustvold
changed the title
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.
Closes #5708.
I solve some inconsistency between code and comment and add some checks for boundary constraints mentioned in comment.