kyle/tines
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix Bloom |1 placement and doubled 'The'; PairTransport 'broadcast' wording

Browse Source
This commit is contained in:
kyle
2026-10-17 23:58:15 -07:00
parent ab9b892d94
commit 09a676c243
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tines-core/src/bloom.rs
+3 -3
View File
@@ -4,7 +4,7 @@
//! bit positions per inserted `ObservationId`. The `salt` value mixes into the //! bit positions per inserted `ObservationId`. The `salt` value mixes into the
//! hash so that the same id under different salts lands on different bit //! hash so that the same id under different salts lands on different bit
//! positions, keeping false positives between independent filters low. The //! positions, keeping false positives between independent filters low. The
//! The hashing scheme is pinned (see [`positions`]) so that `tines-core` and the //! hashing scheme is pinned (see [`positions`]) so that `tines-core` and the
//! simulation agree bit-for-bit across builds. //! simulation agree bit-for-bit across builds.
//! //!
//! This type is `core`-only: it owns a fixed `[u8; SUMMARY_BYTES]` array and //! This type is `core`-only: it owns a fixed `[u8; SUMMARY_BYTES]` array and
@@ -68,9 +68,9 @@ impl Bloom {
/// `k` in `0..BLOOM_K`: /// `k` in `0..BLOOM_K`:
/// ```text /// ```text
/// a = u64::from_le_bytes(id[0..8]) ^ (salt as u64).wrapping_mul(0x9E3779B97F4A7C15) /// a = u64::from_le_bytes(id[0..8]) ^ (salt as u64).wrapping_mul(0x9E3779B97F4A7C15)
/// b = u64::from_le_bytes(id[8..16]) ^ (salt as u64).wrapping_mul(0xC2B2AE3D27D4EB4F) | 1 /// b = u64::from_le_bytes(id[8..16]) ^ (salt as u64).wrapping_mul(0xC2B2AE3D27D4EB4F)
/// h1 = fmix64(a) /// h1 = fmix64(a)
/// h2 = fmix64(b) /// h2 = fmix64(b) | 1
/// capacity = SUMMARY_BYTES * 8 /// capacity = SUMMARY_BYTES * 8
/// bit_index = (h1 + k * h2) % capacity /// bit_index = (h1 + k * h2) % capacity
/// ``` /// ```
tines-core/tests/common/mod.rs
+2 -1
View File
@@ -1,6 +1,7 @@
//! Shared, test-only helper: two `PairTransport`s wired back-to-back as if they //! Shared, test-only helper: two `PairTransport`s wired back-to-back as if they
//! were peers on a datagram link. A `send` on one side surfaces as a `Frame` //! were peers on a datagram link. A `send` on one side surfaces as a `Frame`
//! on the other; `connect`/`disconnect` broadcast `Contact`/`Lost`. //! on the other; `connect`/`disconnect` enqueue `Contact`/`Lost` on the
//! caller's own queue only.
//! //!
//! Each side owns its own inbound queue (`inbox`) and holds a shared handle to //! Each side owns its own inbound queue (`inbox`) and holds a shared handle to
//! the other side's queue (`peer_inbox`), so outbound frames land in the peer's //! the other side's queue (`peer_inbox`), so outbound frames land in the peer's