distillate 0.1.0 → 0.1.2

package/README.md

@@ -92,6 +92,19 @@ const precise = BinaryFuse16.from(["alice", "bob", "carol"]);
 
 Also: `toBytes` / `fromBytes`. No `add` / `delete`; rebuild `from` the new set to change membership.
 
+## Performance
+
+Classic Bloom head-to-head at a **matched 1% false-positive rate** over the same 100k keys, measured by identical code (Node, Apple M5):
+
+| Classic Bloom  | bits/key | measured FPR | `has` throughput |
+| -------------- | -------- | ------------ | ---------------- |
+| **distillate** | 9.59     | 1.03%        | ~7.0 M ops/s     |
+| bloom-filters  | 9.59     | 0.99%        | ~0.29 M ops/s    |
+
+Same space, same accuracy, **~24x the lookup throughput** of [`bloom-filters`](https://www.npmjs.com/package/bloom-filters) (the package distillate replaces), while hashing UTF-8 bytes with MurmurHash3 so filters stay portable and cross-language readable.
+
+These are a point-in-time snapshot on one machine. The full report (blocked/fuse, 1M capacity, the `bloomfilter` micro-package) and exactly how it is measured live in the [distillate-bench](https://github.com/akshay-xp/distillate-bench) repo: [RESULTS.md](https://github.com/akshay-xp/distillate-bench/blob/main/RESULTS.md), [METHODOLOGY.md](https://github.com/akshay-xp/distillate-bench/blob/main/METHODOLOGY.md).
+
 ## Docs
 
 Design notes, the structure decision matrix, hashing, and the binary format live in [`docs/`](./docs):
@@ -99,6 +112,8 @@ Design notes, the structure decision matrix, hashing, and the binary format live
 - [overview](./docs/overview.md): what and why
 - [structures](./docs/structures.md): decision matrix and the full lineup
 - [architecture](./docs/architecture.md), [hashing](./docs/hashing.md), [serialization](./docs/serialization.md)
+- [versioning](./docs/versioning.md): SemVer policy and supported-runtime baseline
+- [API reference](./docs/api): generated from TSDoc (per entry point)
 
 ## License
 

package/dist/blocked/index.cjs

@@ -1,17 +1,30 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_serialize = require("../serialize-C5rwVPvv.cjs");
+const require_serialize = require("../serialize-CHHDM4TQ.cjs");
 //#region src/blocked/blocked.ts
 const TYPE = 2;
 const SALT = Uint32Array.of(1203114875, 1150766481, 2284105051, 2729912477, 1884591559, 770785867, 2667333959, 1550580529);
-/**
-* Split-block probe: derive one block index and 8 single-bit lane masks for
-* `key`. Writes lane word indices into `outWords` and their masks into
-* `outBits` (both length 8, caller-owned so no per-call allocation). A block is
-* 256 bits = 8 contiguous 32-bit lanes; word `block*8 + i` gets one bit set.
-*/
+const scratchHash = {
+	h1lo: 0,
+	h1hi: 0,
+	h2lo: 0,
+	h2hi: 0
+};
+/** Thrown when an operation requires two filters built with identical parameters. */
 var BlockedBloomParamMismatchError = class extends Error {
+	/** Discriminates this error from other `Error`s. */
 	name = "BlockedBloomParamMismatchError";
 };
+/**
+* A blocked (split-block) Bloom filter: confines every lookup to a single cache
+* line, trading ~20-30% more space for cache-friendly throughput.
+*
+* @example
+* ```ts
+* const filter = BlockedBloomFilter.create(100_000, 0.01);
+* filter.add("alice");
+* filter.has("alice"); // true
+* ```
+*/
 var BlockedBloomFilter = class BlockedBloomFilter {
 	#lanes;
 	#numBlocks;
@@ -24,6 +37,13 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 		[3, 16.9],
 		[4, 26.4]
 	];
+	/**
+	* Creates a filter sized for `n` expected keys at a target false-positive rate.
+	*
+	* @param n - Expected number of keys.
+	* @param epsilon - Target false-positive rate, e.g. `0.01` for 1%.
+	* @returns A new, empty filter.
+	*/
 	static create(n, epsilon) {
 		const t = Math.log10(1 / epsilon);
 		const a = BlockedBloomFilter.#ANCHORS;
@@ -37,15 +57,26 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 			capacity: n
 		});
 	}
+	/**
+	* Constructs a filter from low-level {@link BlockedBloomParams}. Prefer
+	* {@link BlockedBloomFilter.create} unless restoring a specific configuration.
+	*/
 	constructor({ bitsPerKey, capacity, seed = 0 }) {
 		this.#numBlocks = Math.max(1, Math.ceil(bitsPerKey * capacity / 256));
 		this.#lanes = new Uint32Array(this.#numBlocks * 8);
 		this.#seed = seed;
 		this.#n = capacity;
 	}
+	/** Actual bits allocated per key (`total bits / capacity`). */
 	get bitsPerKey() {
 		return this.#numBlocks * 256 / this.#n;
 	}
+	/**
+	* Restores a filter from its {@link BlockedBloomFilter.toBytes} serialization.
+	*
+	* @param bytes - The serialized filter.
+	* @returns The reconstructed filter.
+	*/
 	static fromBytes(bytes) {
 		const { body } = require_serialize.readHeader(bytes);
 		const dv = new DataView(body.buffer, body.byteOffset, body.byteLength);
@@ -61,6 +92,11 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 		new Uint8Array(f.#lanes.buffer).set(body.subarray(12));
 		return f;
 	}
+	/**
+	* Serializes the filter to a portable little-endian byte layout.
+	*
+	* @returns The serialized filter, readable by {@link BlockedBloomFilter.fromBytes}.
+	*/
 	toBytes() {
 		const lanes = new Uint8Array(this.#lanes.buffer, this.#lanes.byteOffset, this.#lanes.byteLength);
 		const body = new Uint8Array(12 + lanes.length);
@@ -75,6 +111,13 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 			flags: 0
 		}, body);
 	}
+	/**
+	* Returns a new filter containing the union of this filter and `other`.
+	*
+	* @param other - A filter built with identical parameters.
+	* @returns A new filter reporting membership for keys in either input.
+	* @throws {@link BlockedBloomParamMismatchError} if the parameters differ.
+	*/
 	union(other) {
 		if (this.#numBlocks !== other.#numBlocks || this.#seed !== other.#seed) throw new BlockedBloomParamMismatchError("cannot union blocked Bloom filters whose parameters do not match");
 		const r = new BlockedBloomFilter({
@@ -85,6 +128,11 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 		for (let i = 0; i < this.#lanes.length; i++) r.#lanes[i] = (this.#lanes[i] ?? 0) | (other.#lanes[i] ?? 0);
 		return r;
 	}
+	/**
+	* Adds a key to the set.
+	*
+	* @param key - The key to insert, as a string or bytes.
+	*/
 	add(key) {
 		fillBlock(key, this.#numBlocks, this.#seed, this.#words, this.#bits);
 		for (let i = 0; i < 8; i++) {
@@ -92,6 +140,12 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 			this.#lanes[w] = (this.#lanes[w] ?? 0) | (this.#bits[i] ?? 0);
 		}
 	}
+	/**
+	* Tests whether a key is in the set.
+	*
+	* @param key - The key to test.
+	* @returns `true` if present (possibly a false positive); `false` guarantees absence.
+	*/
 	has(key) {
 		fillBlock(key, this.#numBlocks, this.#seed, this.#words, this.#bits);
 		for (let i = 0; i < 8; i++) {
@@ -102,9 +156,9 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 	}
 };
 function fillBlock(key, numBlocks, seed, outWords, outBits) {
-	const { h1lo, h1hi, h2lo, h2hi } = require_serialize.hash128(require_serialize.normalize(key), seed);
-	const block = require_serialize.reduce((h1lo ^ h1hi) >>> 0, numBlocks);
-	const x = (h2lo ^ h2hi) >>> 0;
+	require_serialize.hash128KeyInto(key, seed, scratchHash);
+	const block = require_serialize.reduce((scratchHash.h1lo ^ scratchHash.h1hi) >>> 0, numBlocks);
+	const x = (scratchHash.h2lo ^ scratchHash.h2hi) >>> 0;
 	const base = block * 8;
 	for (let i = 0; i < 8; i++) {
 		outWords[i] = base + i;

package/dist/blocked/index.d.cts

@@ -1,28 +1,80 @@
 import { t as BytesLike } from "../bytes-DCuYtUVS.cjs";
 //#region src/blocked/blocked.d.ts
-/**
- * Split-block probe: derive one block index and 8 single-bit lane masks for
- * `key`. Writes lane word indices into `outWords` and their masks into
- * `outBits` (both length 8, caller-owned so no per-call allocation). A block is
- * 256 bits = 8 contiguous 32-bit lanes; word `block*8 + i` gets one bit set.
- */
+/** Thrown when an operation requires two filters built with identical parameters. */
 declare class BlockedBloomParamMismatchError extends Error {
+  /** Discriminates this error from other `Error`s. */
   override readonly name = "BlockedBloomParamMismatchError";
 }
+/** Low-level blocked Bloom filter parameters. */
 interface BlockedBloomParams {
+  /** Bits allocated per key; higher lowers the false-positive rate. */
   bitsPerKey: number;
+  /** Expected number of keys. */
   capacity: number;
+  /** Hash seed; defaults to `0`. */
   seed?: number;
 }
+/**
+ * A blocked (split-block) Bloom filter: confines every lookup to a single cache
+ * line, trading ~20-30% more space for cache-friendly throughput.
+ *
+ * @example
+ * ```ts
+ * const filter = BlockedBloomFilter.create(100_000, 0.01);
+ * filter.add("alice");
+ * filter.has("alice"); // true
+ * ```
+ */
 declare class BlockedBloomFilter {
   #private;
+  /**
+   * Creates a filter sized for `n` expected keys at a target false-positive rate.
+   *
+   * @param n - Expected number of keys.
+   * @param epsilon - Target false-positive rate, e.g. `0.01` for 1%.
+   * @returns A new, empty filter.
+   */
   static create(n: number, epsilon: number): BlockedBloomFilter;
+  /**
+   * Constructs a filter from low-level {@link BlockedBloomParams}. Prefer
+   * {@link BlockedBloomFilter.create} unless restoring a specific configuration.
+   */
   constructor({ bitsPerKey, capacity, seed }: BlockedBloomParams);
+  /** Actual bits allocated per key (`total bits / capacity`). */
   get bitsPerKey(): number;
+  /**
+   * Restores a filter from its {@link BlockedBloomFilter.toBytes} serialization.
+   *
+   * @param bytes - The serialized filter.
+   * @returns The reconstructed filter.
+   */
   static fromBytes(bytes: Uint8Array): BlockedBloomFilter;
+  /**
+   * Serializes the filter to a portable little-endian byte layout.
+   *
+   * @returns The serialized filter, readable by {@link BlockedBloomFilter.fromBytes}.
+   */
   toBytes(): Uint8Array;
+  /**
+   * Returns a new filter containing the union of this filter and `other`.
+   *
+   * @param other - A filter built with identical parameters.
+   * @returns A new filter reporting membership for keys in either input.
+   * @throws {@link BlockedBloomParamMismatchError} if the parameters differ.
+   */
   union(other: BlockedBloomFilter): BlockedBloomFilter;
+  /**
+   * Adds a key to the set.
+   *
+   * @param key - The key to insert, as a string or bytes.
+   */
   add(key: BytesLike): void;
+  /**
+   * Tests whether a key is in the set.
+   *
+   * @param key - The key to test.
+   * @returns `true` if present (possibly a false positive); `false` guarantees absence.
+   */
   has(key: BytesLike): boolean;
 }
 //#endregion

package/dist/blocked/index.d.ts

@@ -1,28 +1,80 @@
 import { t as BytesLike } from "../bytes-DCuYtUVS.js";
 //#region src/blocked/blocked.d.ts
-/**
- * Split-block probe: derive one block index and 8 single-bit lane masks for
- * `key`. Writes lane word indices into `outWords` and their masks into
- * `outBits` (both length 8, caller-owned so no per-call allocation). A block is
- * 256 bits = 8 contiguous 32-bit lanes; word `block*8 + i` gets one bit set.
- */
+/** Thrown when an operation requires two filters built with identical parameters. */
 declare class BlockedBloomParamMismatchError extends Error {
+  /** Discriminates this error from other `Error`s. */
   override readonly name = "BlockedBloomParamMismatchError";
 }
+/** Low-level blocked Bloom filter parameters. */
 interface BlockedBloomParams {
+  /** Bits allocated per key; higher lowers the false-positive rate. */
   bitsPerKey: number;
+  /** Expected number of keys. */
   capacity: number;
+  /** Hash seed; defaults to `0`. */
   seed?: number;
 }
+/**
+ * A blocked (split-block) Bloom filter: confines every lookup to a single cache
+ * line, trading ~20-30% more space for cache-friendly throughput.
+ *
+ * @example
+ * ```ts
+ * const filter = BlockedBloomFilter.create(100_000, 0.01);
+ * filter.add("alice");
+ * filter.has("alice"); // true
+ * ```
+ */
 declare class BlockedBloomFilter {
   #private;
+  /**
+   * Creates a filter sized for `n` expected keys at a target false-positive rate.
+   *
+   * @param n - Expected number of keys.
+   * @param epsilon - Target false-positive rate, e.g. `0.01` for 1%.
+   * @returns A new, empty filter.
+   */
   static create(n: number, epsilon: number): BlockedBloomFilter;
+  /**
+   * Constructs a filter from low-level {@link BlockedBloomParams}. Prefer
+   * {@link BlockedBloomFilter.create} unless restoring a specific configuration.
+   */
   constructor({ bitsPerKey, capacity, seed }: BlockedBloomParams);
+  /** Actual bits allocated per key (`total bits / capacity`). */
   get bitsPerKey(): number;
+  /**
+   * Restores a filter from its {@link BlockedBloomFilter.toBytes} serialization.
+   *
+   * @param bytes - The serialized filter.
+   * @returns The reconstructed filter.
+   */
   static fromBytes(bytes: Uint8Array): BlockedBloomFilter;
+  /**
+   * Serializes the filter to a portable little-endian byte layout.
+   *
+   * @returns The serialized filter, readable by {@link BlockedBloomFilter.fromBytes}.
+   */
   toBytes(): Uint8Array;
+  /**
+   * Returns a new filter containing the union of this filter and `other`.
+   *
+   * @param other - A filter built with identical parameters.
+   * @returns A new filter reporting membership for keys in either input.
+   * @throws {@link BlockedBloomParamMismatchError} if the parameters differ.
+   */
   union(other: BlockedBloomFilter): BlockedBloomFilter;
+  /**
+   * Adds a key to the set.
+   *
+   * @param key - The key to insert, as a string or bytes.
+   */
   add(key: BytesLike): void;
+  /**
+   * Tests whether a key is in the set.
+   *
+   * @param key - The key to test.
+   * @returns `true` if present (possibly a false positive); `false` guarantees absence.
+   */
   has(key: BytesLike): boolean;
 }
 //#endregion

package/dist/blocked/index.js

@@ -1,16 +1,29 @@
-import { i as hash128, n as readHeader, o as reduce, r as writeHeader, s as normalize } from "../serialize-E_4WyueA.js";
+import { i as hash128KeyInto, n as readHeader, o as reduce, r as writeHeader } from "../serialize-5XQ5y_R-.js";
 //#region src/blocked/blocked.ts
 const TYPE = 2;
 const SALT = Uint32Array.of(1203114875, 1150766481, 2284105051, 2729912477, 1884591559, 770785867, 2667333959, 1550580529);
-/**
-* Split-block probe: derive one block index and 8 single-bit lane masks for
-* `key`. Writes lane word indices into `outWords` and their masks into
-* `outBits` (both length 8, caller-owned so no per-call allocation). A block is
-* 256 bits = 8 contiguous 32-bit lanes; word `block*8 + i` gets one bit set.
-*/
+const scratchHash = {
+	h1lo: 0,
+	h1hi: 0,
+	h2lo: 0,
+	h2hi: 0
+};
+/** Thrown when an operation requires two filters built with identical parameters. */
 var BlockedBloomParamMismatchError = class extends Error {
+	/** Discriminates this error from other `Error`s. */
 	name = "BlockedBloomParamMismatchError";
 };
+/**
+* A blocked (split-block) Bloom filter: confines every lookup to a single cache
+* line, trading ~20-30% more space for cache-friendly throughput.
+*
+* @example
+* ```ts
+* const filter = BlockedBloomFilter.create(100_000, 0.01);
+* filter.add("alice");
+* filter.has("alice"); // true
+* ```
+*/
 var BlockedBloomFilter = class BlockedBloomFilter {
 	#lanes;
 	#numBlocks;
@@ -23,6 +36,13 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 		[3, 16.9],
 		[4, 26.4]
 	];
+	/**
+	* Creates a filter sized for `n` expected keys at a target false-positive rate.
+	*
+	* @param n - Expected number of keys.
+	* @param epsilon - Target false-positive rate, e.g. `0.01` for 1%.
+	* @returns A new, empty filter.
+	*/
 	static create(n, epsilon) {
 		const t = Math.log10(1 / epsilon);
 		const a = BlockedBloomFilter.#ANCHORS;
@@ -36,15 +56,26 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 			capacity: n
 		});
 	}
+	/**
+	* Constructs a filter from low-level {@link BlockedBloomParams}. Prefer
+	* {@link BlockedBloomFilter.create} unless restoring a specific configuration.
+	*/
 	constructor({ bitsPerKey, capacity, seed = 0 }) {
 		this.#numBlocks = Math.max(1, Math.ceil(bitsPerKey * capacity / 256));
 		this.#lanes = new Uint32Array(this.#numBlocks * 8);
 		this.#seed = seed;
 		this.#n = capacity;
 	}
+	/** Actual bits allocated per key (`total bits / capacity`). */
 	get bitsPerKey() {
 		return this.#numBlocks * 256 / this.#n;
 	}
+	/**
+	* Restores a filter from its {@link BlockedBloomFilter.toBytes} serialization.
+	*
+	* @param bytes - The serialized filter.
+	* @returns The reconstructed filter.
+	*/
 	static fromBytes(bytes) {
 		const { body } = readHeader(bytes);
 		const dv = new DataView(body.buffer, body.byteOffset, body.byteLength);
@@ -60,6 +91,11 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 		new Uint8Array(f.#lanes.buffer).set(body.subarray(12));
 		return f;
 	}
+	/**
+	* Serializes the filter to a portable little-endian byte layout.
+	*
+	* @returns The serialized filter, readable by {@link BlockedBloomFilter.fromBytes}.
+	*/
 	toBytes() {
 		const lanes = new Uint8Array(this.#lanes.buffer, this.#lanes.byteOffset, this.#lanes.byteLength);
 		const body = new Uint8Array(12 + lanes.length);
@@ -74,6 +110,13 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 			flags: 0
 		}, body);
 	}
+	/**
+	* Returns a new filter containing the union of this filter and `other`.
+	*
+	* @param other - A filter built with identical parameters.
+	* @returns A new filter reporting membership for keys in either input.
+	* @throws {@link BlockedBloomParamMismatchError} if the parameters differ.
+	*/
 	union(other) {
 		if (this.#numBlocks !== other.#numBlocks || this.#seed !== other.#seed) throw new BlockedBloomParamMismatchError("cannot union blocked Bloom filters whose parameters do not match");
 		const r = new BlockedBloomFilter({
@@ -84,6 +127,11 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 		for (let i = 0; i < this.#lanes.length; i++) r.#lanes[i] = (this.#lanes[i] ?? 0) | (other.#lanes[i] ?? 0);
 		return r;
 	}
+	/**
+	* Adds a key to the set.
+	*
+	* @param key - The key to insert, as a string or bytes.
+	*/
 	add(key) {
 		fillBlock(key, this.#numBlocks, this.#seed, this.#words, this.#bits);
 		for (let i = 0; i < 8; i++) {
@@ -91,6 +139,12 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 			this.#lanes[w] = (this.#lanes[w] ?? 0) | (this.#bits[i] ?? 0);
 		}
 	}
+	/**
+	* Tests whether a key is in the set.
+	*
+	* @param key - The key to test.
+	* @returns `true` if present (possibly a false positive); `false` guarantees absence.
+	*/
 	has(key) {
 		fillBlock(key, this.#numBlocks, this.#seed, this.#words, this.#bits);
 		for (let i = 0; i < 8; i++) {
@@ -101,9 +155,9 @@ var BlockedBloomFilter = class BlockedBloomFilter {
 	}
 };
 function fillBlock(key, numBlocks, seed, outWords, outBits) {
-	const { h1lo, h1hi, h2lo, h2hi } = hash128(normalize(key), seed);
-	const block = reduce((h1lo ^ h1hi) >>> 0, numBlocks);
-	const x = (h2lo ^ h2hi) >>> 0;
+	hash128KeyInto(key, seed, scratchHash);
+	const block = reduce((scratchHash.h1lo ^ scratchHash.h1hi) >>> 0, numBlocks);
+	const x = (scratchHash.h2lo ^ scratchHash.h2hi) >>> 0;
 	const base = block * 8;
 	for (let i = 0; i < 8; i++) {
 		outWords[i] = base + i;

package/dist/bloom/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_serialize = require("../serialize-C5rwVPvv.cjs");
+const require_serialize = require("../serialize-CHHDM4TQ.cjs");
 //#region src/core/bitset.ts
 var BitSetRangeError = class extends RangeError {
 	name = "BitSetRangeError";
@@ -48,9 +48,23 @@ function optimal(n, epsilon) {
 //#endregion
 //#region src/bloom/bloom.ts
 const TYPE = 1;
+/** Thrown when an operation requires two filters built with identical parameters. */
 var BloomParamMismatchError = class extends Error {
+	/** Discriminates this error from other `Error`s. */
 	name = "BloomParamMismatchError";
 };
+/**
+* A classic Bloom filter: a space-efficient set with a tunable false-positive
+* rate and zero false negatives.
+*
+* @example
+* ```ts
+* const filter = BloomFilter.create(100_000, 0.01);
+* filter.add("alice");
+* filter.has("alice"); // true
+* filter.has("bob"); // false (or a ~1% false positive)
+* ```
+*/
 var BloomFilter = class BloomFilter {
 	#bits;
 	#m;
@@ -58,11 +72,24 @@ var BloomFilter = class BloomFilter {
 	#seed;
 	#scratch;
 	#n;
+	/**
+	* Creates a filter sized for `n` expected keys at a target false-positive rate.
+	*
+	* @param n - Expected number of keys.
+	* @param epsilon - Target false-positive rate, e.g. `0.01` for 1%.
+	* @returns A new, empty filter.
+	*/
 	static create(n, epsilon) {
 		const f = new BloomFilter(optimal(n, epsilon));
 		f.#n = n;
 		return f;
 	}
+	/**
+	* Restores a filter from its {@link BloomFilter.toBytes} serialization.
+	*
+	* @param bytes - The serialized filter.
+	* @returns The reconstructed filter.
+	*/
 	static fromBytes(bytes) {
 		const { body } = require_serialize.readHeader(bytes);
 		const dv = new DataView(body.buffer, body.byteOffset, body.byteLength);
@@ -77,6 +104,10 @@ var BloomFilter = class BloomFilter {
 		f.#bits.bytes.set(body.subarray(9));
 		return f;
 	}
+	/**
+	* Constructs a filter from low-level {@link BloomParams}. Prefer
+	* {@link BloomFilter.create} unless restoring a specific configuration.
+	*/
 	constructor({ m, k, seed = 0 }) {
 		this.#bits = new BitSet(m);
 		this.#m = m;
@@ -89,6 +120,11 @@ var BloomFilter = class BloomFilter {
 	get bitsPerKey() {
 		return this.#m / this.#n;
 	}
+	/**
+	* Serializes the filter to a portable little-endian byte layout.
+	*
+	* @returns The serialized filter, readable by {@link BloomFilter.fromBytes}.
+	*/
 	toBytes() {
 		const payload = this.#bits.bytes;
 		const body = new Uint8Array(9 + payload.length);
@@ -103,6 +139,13 @@ var BloomFilter = class BloomFilter {
 			flags: 0
 		}, body);
 	}
+	/**
+	* Returns a new filter containing the union of this filter and `other`.
+	*
+	* @param other - A filter built with identical parameters.
+	* @returns A new filter reporting membership for keys in either input.
+	* @throws {@link BloomParamMismatchError} if the parameters differ.
+	*/
 	union(other) {
 		if (this.#m !== other.#m || this.#k !== other.#k || this.#seed !== other.#seed) throw new BloomParamMismatchError("cannot union Bloom filters whose parameters do not match");
 		const a = this.#bits.bytes;
@@ -117,10 +160,21 @@ var BloomFilter = class BloomFilter {
 		r.#bits.bytes.set(merged);
 		return r;
 	}
+	/**
+	* Adds a key to the set.
+	*
+	* @param key - The key to insert, as a string or bytes.
+	*/
 	add(key) {
 		require_serialize.probeInto(key, this.#k, this.#m, this.#seed, this.#scratch);
 		for (let i = 0; i < this.#k; i++) this.#bits.set(this.#scratch[i] ?? 0);
 	}
+	/**
+	* Tests whether a key is in the set.
+	*
+	* @param key - The key to test.
+	* @returns `true` if present (possibly a false positive); `false` guarantees absence.
+	*/
 	has(key) {
 		require_serialize.probeInto(key, this.#k, this.#m, this.#seed, this.#scratch);
 		for (let i = 0; i < this.#k; i++) if (!this.#bits.get(this.#scratch[i] ?? 0)) return false;

package/dist/bloom/index.d.cts

@@ -1,23 +1,81 @@
 import { t as BytesLike } from "../bytes-DCuYtUVS.cjs";
 //#region src/bloom/bloom.d.ts
+/** Thrown when an operation requires two filters built with identical parameters. */
 declare class BloomParamMismatchError extends Error {
+  /** Discriminates this error from other `Error`s. */
   override readonly name = "BloomParamMismatchError";
 }
+/** Low-level Bloom filter parameters. */
 interface BloomParams {
+  /** Number of bits in the filter. */
   m: number;
+  /** Number of hash probes per key. */
   k: number;
+  /** Hash seed; defaults to `0`. */
   seed?: number;
 }
+/**
+ * A classic Bloom filter: a space-efficient set with a tunable false-positive
+ * rate and zero false negatives.
+ *
+ * @example
+ * ```ts
+ * const filter = BloomFilter.create(100_000, 0.01);
+ * filter.add("alice");
+ * filter.has("alice"); // true
+ * filter.has("bob"); // false (or a ~1% false positive)
+ * ```
+ */
 declare class BloomFilter {
   #private;
+  /**
+   * Creates a filter sized for `n` expected keys at a target false-positive rate.
+   *
+   * @param n - Expected number of keys.
+   * @param epsilon - Target false-positive rate, e.g. `0.01` for 1%.
+   * @returns A new, empty filter.
+   */
   static create(n: number, epsilon: number): BloomFilter;
+  /**
+   * Restores a filter from its {@link BloomFilter.toBytes} serialization.
+   *
+   * @param bytes - The serialized filter.
+   * @returns The reconstructed filter.
+   */
   static fromBytes(bytes: Uint8Array): BloomFilter;
+  /**
+   * Constructs a filter from low-level {@link BloomParams}. Prefer
+   * {@link BloomFilter.create} unless restoring a specific configuration.
+   */
   constructor({ m, k, seed }: BloomParams);
   /** Analytic design bits-per-key `m / n`. */
   get bitsPerKey(): number;
+  /**
+   * Serializes the filter to a portable little-endian byte layout.
+   *
+   * @returns The serialized filter, readable by {@link BloomFilter.fromBytes}.
+   */
   toBytes(): Uint8Array;
+  /**
+   * Returns a new filter containing the union of this filter and `other`.
+   *
+   * @param other - A filter built with identical parameters.
+   * @returns A new filter reporting membership for keys in either input.
+   * @throws {@link BloomParamMismatchError} if the parameters differ.
+   */
   union(other: BloomFilter): BloomFilter;
+  /**
+   * Adds a key to the set.
+   *
+   * @param key - The key to insert, as a string or bytes.
+   */
   add(key: BytesLike): void;
+  /**
+   * Tests whether a key is in the set.
+   *
+   * @param key - The key to test.
+   * @returns `true` if present (possibly a false positive); `false` guarantees absence.
+   */
   has(key: BytesLike): boolean;
 }
 //#endregion