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] Implement rank() for blockfile #3331

Merged
merged 3 commits into from
Dec 20, 2024

Conversation

Sicheng-Pan
Copy link
Contributor

@Sicheng-Pan Sicheng-Pan commented Dec 18, 2024

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • N/A
  • New functionality
    • Implement rank(prefix, key) method for blockfile, which calculates the number of elements in the blockfile that is strictly less than the given prefix-key pair. In otherword, the given prefix-key pair can be inserted at its rank without breaking the order of the blockfile.
    • Use the rank(prefix, key) method to replace get_at_index(index) in LimitOperator and RecordSegmentReader.

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

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)

Copy link
Contributor Author

Sicheng-Pan commented Dec 18, 2024

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

@Sicheng-Pan Sicheng-Pan marked this pull request as ready for review December 18, 2024 23:50
@@ -657,6 +657,54 @@ impl<'me, K: ArrowReadableKey<'me> + Into<KeyWrapper>, V: ArrowReadableValue<'me
self.root.id
}

pub(crate) async fn rank(
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a comment here as to what this function does

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added comments

Err(e)
}
}
pub(crate) fn get_offset_stream<'me>(
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a comment on the contract of this method. It's not clear from the names

Copy link
Contributor Author

@Sicheng-Pan Sicheng-Pan Dec 20, 2024

Choose a reason for hiding this comment

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

Added comments

Copy link
Contributor Author

Sicheng-Pan commented Dec 20, 2024

Merge activity

  • Dec 20, 1:45 PM EST: A user started a stack merge that includes this pull request via Graphite.
  • Dec 20, 1:46 PM EST: Graphite rebased this pull request as part of a merge.
  • Dec 20, 1:46 PM EST: A user merged this pull request with Graphite.

@Sicheng-Pan Sicheng-Pan force-pushed the 12-18-_enh_implement_rank_for_blockfile branch from c6192f7 to 5c09493 Compare December 20, 2024 18:45
@Sicheng-Pan Sicheng-Pan merged commit b8f823f into main Dec 20, 2024
76 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