feat: add xor filter - #208
Open
tisonkun wants to merge 5 commits into
Open
Conversation
tisonkun
marked this pull request as draft
August 23, 2026 20:06
# Conflicts: # CHANGELOG.md # README.md # datasketches/Cargo.toml # tests-integration/tests/serde_tests/xor.rs
tisonkun
marked this pull request as ready for review
September 3, 2026 01:18
Member
Author
|
FYI @leerho @freakyzoidberg I'm trying to implement XorFilter in Rust as well |
Images with 32-bit fingerprints are a Rust-specific extension: the portable family 22 format only defines 8- and 16-bit fingerprints, and other DataSketches implementations reject 32-bit images.
This file contains hidden or 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
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.
Summary
XorFilterconstruction and lookup with 8- and 16-bit fingerprints behind thexorfeatureHashvalues and precomputed 64-bit hashes, with duplicate removal and bounded seeded construction retriesxorfcrate as a reference implementation for comparisonDesign
The implementation follows the three-partite peeling construction from Graf and Lemire's xor-filter paper directly, without adding a third-party runtime dependency.
XorFilterBuilder::buildreturnsResultbecause construction is deliberately bounded at 100 seed attempts instead of risking an unbounded loop. The default base construction seed is deterministic, and callers can provide another seed when needed.Serialization follows the 3-long family 22 layout proposed in apache/datasketches-java#740. Tests use images generated by that Java implementation and verify that Rust produces byte-for-byte identical images for the same values and explicit seed. The initial API intentionally exposes only the 8- and 16-bit variants defined by that portable format.
Deserialization validates the family, version, fingerprint width, hash count, signed lengths, indexable capacity, item count, and payload length before constructing a filter.
Testing
cargo x checkcargo x testcargo x lintcargo bench --package benchmarks -- xor(comparative baseline againstxorf)