Renkai opened a new pull request, #202: URL: https://github.com/apache/datasketches-rust/pull/202
## Summary Documentation-only clarification of the BloomFilter contract around `invert()`, addressing #194: - qualify the module- and type-level guarantees (no false negatives, false-positive rate) as holding before `invert()` only - state in `invert()`'s documentation that after inversion both guarantees lapse, and that `is_empty()`/`bits_used()`/`load_factor()` then describe the raw bit state rather than insertion history - document `is_empty()` in terms of bit state (`num_bits_set == 0`), which is what the implementation actually observes - remove the unreachable `BloomFilterBuilder::build` panic documentation: the builder has no public default constructor, and both public entry points always produce a valid configuration This takes the "document the altered guarantee" direction from #194 rather than moving `invert()` off the public API: the bit-level behavior matches the C++/Java implementations exactly, and `invert()` remains useful as an intermediate in boolean composition with `union()`/`intersect()`. The API-placement question in #194 can still be discussed separately; this patch only makes the current semantics honest. ## Validation - cargo x check - cargo x test - cargo x lint -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
