Skip to content
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

[ENH] Use binary search for gt/gte/lt/lte #2894

Merged

Conversation

Sicheng-Pan
Copy link
Contributor

@Sicheng-Pan Sicheng-Pan commented Oct 3, 2024

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • Updates the binary search algorithm for arrow block to match the latest std impl
    • The binary search now identifies the partition point instead of returning the value at the location
    • New utility function to scan a range of values for the same prefix
    • Now methods that yields a vector of records like get_by_prefix and get_gt returns Vec<(K, V)> instead of Option<Vec<&str, K, V>>. The empty vector is sufficient to indicate the absence of the specified (prefix, key)
  • New functionality
    • With all the refactoring above, now get_gt/gte/lt/lte finds the starting point of the scan using binary search. Previously, we scan the entire block.

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @Sicheng-Pan and the rest of your teammates on Graphite Graphite

Copy link

github-actions bot commented Oct 3, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@Sicheng-Pan Sicheng-Pan marked this pull request as ready for review October 3, 2024 17:04
/// The code is a result of inlining this predicate in [`std::slice::partition_point`].
/// If the key is unspecified (i.e. [`None`]), we find the first index of the prefix.
#[inline]
fn binary_search_index<'me, K: ArrowReadableKey<'me>>(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: The coupling of key=None and key=Some cases together in the same api seems forced to me

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In our case None is equivalent to K::MIN, but we do not have a Min trait so an Option<K> is the best alternative I can think of.

@Sicheng-Pan Sicheng-Pan force-pushed the 10-02-_enh_binary_search_arrow_block_for_gt_gte_lt_lte branch from 0a15a86 to 7567d17 Compare October 9, 2024 19:30
Copy link
Contributor Author

Sicheng-Pan commented Oct 9, 2024

Merge activity

  • Oct 9, 3:59 PM EDT: A user started a stack merge that includes this pull request via Graphite.
  • Oct 9, 3:59 PM EDT: A user merged this pull request with Graphite.

@Sicheng-Pan Sicheng-Pan merged commit 2923324 into main Oct 9, 2024
68 of 70 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants