-
-
Notifications
You must be signed in to change notification settings - Fork 10
feat: introduce golomb-rice encoding package #564
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
Conversation
This adds a new package 'pkg/golomb' containing generic Golomb-Rice encoding and decoding logic. The package includes a BitWriter and BitReader for bit-level I/O, as well as an Encoder and Decoder for numerical values (both uint64 and big.Int). This logic was previously embedded within 'pkg/nixcacheindex' but is now extracted into its own package to improve reusability and maintain a cleaner separation of concerns.
Summary of ChangesHello @kalbasit, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request establishes a new Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request successfully extracts Golomb-Rice encoding logic into a new, reusable package pkg/golomb. The implementation is clean and includes support for both uint64 and big.Int values, along with comprehensive tests. My review focuses on improving the performance of the big.Int handling, which can be significantly slow for large numbers in its current form. I've also suggested a minor improvement in the test suite to ensure all potential errors are caught. Overall, this is a great addition that improves modularity.
This commit addresses performance concerns raised in PR 564. Changes: - Optimizes `EncodeBig` and `DecodeBig` in `pkg/golomb` to use `uint64` arithmetic for quotient operations when possible, avoiding expensive `big.Int` allocations and operations for common cases. - Updates `pkg/golomb/golomb_test.go` to properly handle errors from `Flush()`. This significantly reduces the overhead of Golomb coding for standard integer sizes while maintaining correctness for arbitrarily large numbers. Follow-up on #564 that I merged prematurely by accident.

This adds a new package 'pkg/golomb' containing generic Golomb-Rice encoding and decoding logic. The package includes a BitWriter and BitReader for bit-level I/O, as well as an Encoder and Decoder for numerical values (both uint64 and big.Int).
This logic was previously embedded within 'pkg/nixcacheindex' but is now extracted into its own package to improve reusability and maintain a cleaner separation of concerns.