Skip to content

docs: correct public sketch semantics - #196

Merged
tisonkun merged 2 commits into
mainfrom
codex/fix-rustdoc-inconsistencies
Aug 11, 2026
Merged

docs: correct public sketch semantics#196
tisonkun merged 2 commits into
mainfrom
codex/fix-rustdoc-inconsistencies

Conversation

@tisonkun

Copy link
Copy Markdown
Member

Summary

  • correct Bloom membership examples: positive results mean possibly present, while negative results mean definitely absent in normal operation
  • document Hll4, Hll6, and Hll8 as isomorphic register representations with identical accuracy for the same lg_k
  • explain how HLL union coupon-mode replay and array-mode downsampling determine the result's effective lg_k and error distribution
  • correct the documented widths of the four 64-bit SketchSlice readers
  • clarify that core Frequencies operations require Eq + Hash, while FrequentItemValue is required only for built-in serialization
  • align Theta and Tuple Jaccard seed-error documentation with the empty-input fast paths

The broader post-invert Bloom contract remains tracked in #194.

Validation

  • cargo x check
  • cargo x test
  • cargo x lint

Comment thread datasketches/src/hll/mod.rs
Comment thread datasketches/src/frequencies/mod.rs
Comment thread datasketches/src/hll/union.rs
@tisonkun
tisonkun merged commit 1fdf964 into main Aug 11, 2026
10 checks passed
@tisonkun
tisonkun deleted the codex/fix-rustdoc-inconsistencies branch August 11, 2026 02:32
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.

1 participant