Repository navigation
docs: align cross-language hashing guidance - #340
Merged
Merged
Conversation
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.
Document recommended cross-language input conventions consistently for Count-Min, HLL, CPC, Theta, Tuple, Bloom, and XOR:
canonical_floatfor floating-point values andraw_bytesfor UTF-8 strings and byte slices.falsefor membership queries, without querying the sketch or filter.Keep encoding recommendations in each sketch's module documentation and describe the four encoding strategies in
hash::value. Use consistent module documentation links from the public types and remove duplicate method-level encoding guidance.Organize the Count-Min examples around configuration, updates, and frequency queries, followed by explicit caller-side handling of empty inputs. Keep legacy format compatibility details with the serialization methods. Cross-language interchange uses
i64counters, following the format discussion.Differences in current implementations' empty-byte and signed-zero handling remain tracked in TCK discussion #20. This PR documents the recommended conventions without changing runtime behavior.
Validation:
cargo x check,cargo x test(763 tests, including 147 doctests), andcargo x lintpassed, including rustdoc link checks.