distillate 0.1.1 → 0.2.0

package/dist/bloom/index.d.cts

@@ -1,24 +1,83 @@
 import { t as BytesLike } from "../bytes-DCuYtUVS.cjs";
+import { t as ParamError } from "../params-DnqJBqLS.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
-export { BloomFilter, BloomParamMismatchError, type BloomParams };
+export { BloomFilter, BloomParamMismatchError, type BloomParams, ParamError };

package/dist/bloom/index.d.ts

@@ -1,24 +1,83 @@
 import { t as BytesLike } from "../bytes-DCuYtUVS.js";
+import { t as ParamError } from "../params-DnqJBqLS.js";
 //#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
-export { BloomFilter, BloomParamMismatchError, type BloomParams };
+export { BloomFilter, BloomParamMismatchError, type BloomParams, ParamError };

package/dist/bloom/index.js

@@ -1,4 +1,5 @@
 import { a as probeInto, n as readHeader, r as writeHeader } from "../serialize-5XQ5y_R-.js";
+import { a as assertUint32, i as assertProbability, r as assertPositiveInt, t as ParamError } from "../params-ChTRNxM9.js";
 //#region src/core/bitset.ts
 var BitSetRangeError = class extends RangeError {
 	name = "BitSetRangeError";
@@ -47,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;
@@ -57,11 +72,26 @@ 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) {
+		assertPositiveInt(n, "n");
+		assertProbability(epsilon, "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 } = readHeader(bytes);
 		const dv = new DataView(body.buffer, body.byteOffset, body.byteLength);
@@ -76,7 +106,14 @@ 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 }) {
+		assertPositiveInt(m, "m");
+		assertPositiveInt(k, "k");
+		assertUint32(seed, "seed");
 		this.#bits = new BitSet(m);
 		this.#m = m;
 		this.#k = k;
@@ -88,6 +125,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);
@@ -102,6 +144,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;
@@ -116,10 +165,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) {
 		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) {
 		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;
@@ -127,4 +187,4 @@ var BloomFilter = class BloomFilter {
 	}
 };
 //#endregion
-export { BloomFilter, BloomParamMismatchError };
+export { BloomFilter, BloomParamMismatchError, ParamError };

package/dist/fuse/index.cjs

@@ -4,7 +4,9 @@ const require_serialize = require("../serialize-CHHDM4TQ.cjs");
 const ARITY = 3;
 const TYPE_FUSE8 = 3;
 const TYPE_FUSE16 = 4;
+/** Thrown when binary fuse construction fails to converge on the key set. */
 var BinaryFuseBuildError = class extends Error {
+	/** Discriminates this error from other `Error`s. */
 	name = "BinaryFuseBuildError";
 };
 let RLO = 0;
@@ -231,6 +233,10 @@ function fuseStateFromBytes(bytes, expectedType) {
 		size
 	};
 }
+/**
+* Shared behavior for the static binary fuse filters: an immutable,
+* space-efficient membership filter built once from a fixed key set.
+*/
 var BinaryFuse = class {
 	#fp;
 	#seed;
@@ -247,12 +253,19 @@ var BinaryFuse = class {
 		this.#segCountLen = state.params.segCountLen;
 		this.#size = state.size;
 	}
+	/** Number of distinct keys the filter was built from. */
 	get size() {
 		return this.#size;
 	}
+	/** Actual bits stored per key (`0` for an empty filter). */
 	get bitsPerKey() {
 		return this.#size === 0 ? 0 : this.#fp.byteLength * 8 / this.#size;
 	}
+	/**
+	* Serializes the filter to a portable little-endian byte layout.
+	*
+	* @returns The serialized filter, readable by the matching `fromBytes`.
+	*/
 	toBytes() {
 		const laneBytes = new Uint8Array(this.#fp.buffer, this.#fp.byteOffset, this.#fp.byteLength);
 		const body = new Uint8Array(16 + laneBytes.length);
@@ -268,6 +281,12 @@ var BinaryFuse = class {
 			flags: 0
 		}, body);
 	}
+	/**
+	* 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) {
 		if (this.#fp.length === 0) return false;
 		require_serialize.hash128KeyInto(key, 0, scratchHash);
@@ -282,18 +301,65 @@ var BinaryFuse = class {
 		return ((mlo ^ mhi) & mask) === (((this.#fp[p0] ?? 0) ^ (this.#fp[p1] ?? 0) ^ (this.#fp[p2] ?? 0)) & mask);
 	}
 };
+/**
+* A static 8-bit binary fuse filter: built once from a key set, then immutable.
+* The most space-efficient option (~9 bits/key at ~0.39% false-positive rate).
+*
+* @example
+* ```ts
+* const filter = BinaryFuse8.from(["alice", "bob", "carol"]);
+* filter.has("alice"); // true
+* filter.size; // 3
+* ```
+*/
 var BinaryFuse8 = class BinaryFuse8 extends BinaryFuse {
+	/**
+	* Builds a filter from the given keys; duplicates are ignored.
+	*
+	* @param keys - The complete set of keys to store.
+	* @returns A new immutable filter.
+	* @throws {@link BinaryFuseBuildError} if construction fails to converge.
+	*/
 	static from(keys) {
 		return new BinaryFuse8(buildState(keys, (n) => new Uint8Array(n)));
 	}
+	/**
+	* Restores a filter from its {@link BinaryFuse8.toBytes} serialization.
+	*
+	* @param bytes - The serialized filter.
+	* @returns The reconstructed filter.
+	*/
 	static fromBytes(bytes) {
 		return new BinaryFuse8(fuseStateFromBytes(bytes, TYPE_FUSE8));
 	}
 };
+/**
+* A static 16-bit binary fuse filter: like {@link BinaryFuse8} but twice the
+* space (~18 bits/key) for a far lower false-positive rate (~1/65536).
+*
+* @example
+* ```ts
+* const filter = BinaryFuse16.from(["alice", "bob", "carol"]);
+* filter.has("alice"); // true
+* ```
+*/
 var BinaryFuse16 = class BinaryFuse16 extends BinaryFuse {
+	/**
+	* Builds a filter from the given keys; duplicates are ignored.
+	*
+	* @param keys - The complete set of keys to store.
+	* @returns A new immutable filter.
+	* @throws {@link BinaryFuseBuildError} if construction fails to converge.
+	*/
 	static from(keys) {
 		return new BinaryFuse16(buildState(keys, (n) => new Uint16Array(n)));
 	}
+	/**
+	* Restores a filter from its {@link BinaryFuse16.toBytes} serialization.
+	*
+	* @param bytes - The serialized filter.
+	* @returns The reconstructed filter.
+	*/
 	static fromBytes(bytes) {
 		return new BinaryFuse16(fuseStateFromBytes(bytes, TYPE_FUSE16));
 	}

package/dist/fuse/index.d.cts

@@ -1,6 +1,8 @@
 import { t as BytesLike } from "../bytes-DCuYtUVS.cjs";
 //#region src/fuse/fuse.d.ts
+/** Thrown when binary fuse construction fails to converge on the key set. */
 declare class BinaryFuseBuildError extends Error {
+  /** Discriminates this error from other `Error`s. */
   override readonly name = "BinaryFuseBuildError";
 }
 interface FuseParams {
@@ -15,20 +17,84 @@ interface FuseState {
   params: FuseParams;
   size: number;
 }
+/**
+ * Shared behavior for the static binary fuse filters: an immutable,
+ * space-efficient membership filter built once from a fixed key set.
+ */
 declare abstract class BinaryFuse {
   #private;
   protected constructor(state: FuseState);
+  /** Number of distinct keys the filter was built from. */
   get size(): number;
+  /** Actual bits stored per key (`0` for an empty filter). */
   get bitsPerKey(): number;
+  /**
+   * Serializes the filter to a portable little-endian byte layout.
+   *
+   * @returns The serialized filter, readable by the matching `fromBytes`.
+   */
   toBytes(): Uint8Array;
+  /**
+   * 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;
 }
+/**
+ * A static 8-bit binary fuse filter: built once from a key set, then immutable.
+ * The most space-efficient option (~9 bits/key at ~0.39% false-positive rate).
+ *
+ * @example
+ * ```ts
+ * const filter = BinaryFuse8.from(["alice", "bob", "carol"]);
+ * filter.has("alice"); // true
+ * filter.size; // 3
+ * ```
+ */
 declare class BinaryFuse8 extends BinaryFuse {
+  /**
+   * Builds a filter from the given keys; duplicates are ignored.
+   *
+   * @param keys - The complete set of keys to store.
+   * @returns A new immutable filter.
+   * @throws {@link BinaryFuseBuildError} if construction fails to converge.
+   */
   static from(keys: Iterable<BytesLike>): BinaryFuse8;
+  /**
+   * Restores a filter from its {@link BinaryFuse8.toBytes} serialization.
+   *
+   * @param bytes - The serialized filter.
+   * @returns The reconstructed filter.
+   */
   static fromBytes(bytes: Uint8Array): BinaryFuse8;
 }
+/**
+ * A static 16-bit binary fuse filter: like {@link BinaryFuse8} but twice the
+ * space (~18 bits/key) for a far lower false-positive rate (~1/65536).
+ *
+ * @example
+ * ```ts
+ * const filter = BinaryFuse16.from(["alice", "bob", "carol"]);
+ * filter.has("alice"); // true
+ * ```
+ */
 declare class BinaryFuse16 extends BinaryFuse {
+  /**
+   * Builds a filter from the given keys; duplicates are ignored.
+   *
+   * @param keys - The complete set of keys to store.
+   * @returns A new immutable filter.
+   * @throws {@link BinaryFuseBuildError} if construction fails to converge.
+   */
   static from(keys: Iterable<BytesLike>): BinaryFuse16;
+  /**
+   * Restores a filter from its {@link BinaryFuse16.toBytes} serialization.
+   *
+   * @param bytes - The serialized filter.
+   * @returns The reconstructed filter.
+   */
   static fromBytes(bytes: Uint8Array): BinaryFuse16;
 }
 //#endregion

package/dist/fuse/index.d.ts

@@ -1,6 +1,8 @@
 import { t as BytesLike } from "../bytes-DCuYtUVS.js";
 //#region src/fuse/fuse.d.ts
+/** Thrown when binary fuse construction fails to converge on the key set. */
 declare class BinaryFuseBuildError extends Error {
+  /** Discriminates this error from other `Error`s. */
   override readonly name = "BinaryFuseBuildError";
 }
 interface FuseParams {
@@ -15,20 +17,84 @@ interface FuseState {
   params: FuseParams;
   size: number;
 }
+/**
+ * Shared behavior for the static binary fuse filters: an immutable,
+ * space-efficient membership filter built once from a fixed key set.
+ */
 declare abstract class BinaryFuse {
   #private;
   protected constructor(state: FuseState);
+  /** Number of distinct keys the filter was built from. */
   get size(): number;
+  /** Actual bits stored per key (`0` for an empty filter). */
   get bitsPerKey(): number;
+  /**
+   * Serializes the filter to a portable little-endian byte layout.
+   *
+   * @returns The serialized filter, readable by the matching `fromBytes`.
+   */
   toBytes(): Uint8Array;
+  /**
+   * 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;
 }
+/**
+ * A static 8-bit binary fuse filter: built once from a key set, then immutable.
+ * The most space-efficient option (~9 bits/key at ~0.39% false-positive rate).
+ *
+ * @example
+ * ```ts
+ * const filter = BinaryFuse8.from(["alice", "bob", "carol"]);
+ * filter.has("alice"); // true
+ * filter.size; // 3
+ * ```
+ */
 declare class BinaryFuse8 extends BinaryFuse {
+  /**
+   * Builds a filter from the given keys; duplicates are ignored.
+   *
+   * @param keys - The complete set of keys to store.
+   * @returns A new immutable filter.
+   * @throws {@link BinaryFuseBuildError} if construction fails to converge.
+   */
   static from(keys: Iterable<BytesLike>): BinaryFuse8;
+  /**
+   * Restores a filter from its {@link BinaryFuse8.toBytes} serialization.
+   *
+   * @param bytes - The serialized filter.
+   * @returns The reconstructed filter.
+   */
   static fromBytes(bytes: Uint8Array): BinaryFuse8;
 }
+/**
+ * A static 16-bit binary fuse filter: like {@link BinaryFuse8} but twice the
+ * space (~18 bits/key) for a far lower false-positive rate (~1/65536).
+ *
+ * @example
+ * ```ts
+ * const filter = BinaryFuse16.from(["alice", "bob", "carol"]);
+ * filter.has("alice"); // true
+ * ```
+ */
 declare class BinaryFuse16 extends BinaryFuse {
+  /**
+   * Builds a filter from the given keys; duplicates are ignored.
+   *
+   * @param keys - The complete set of keys to store.
+   * @returns A new immutable filter.
+   * @throws {@link BinaryFuseBuildError} if construction fails to converge.
+   */
   static from(keys: Iterable<BytesLike>): BinaryFuse16;
+  /**
+   * Restores a filter from its {@link BinaryFuse16.toBytes} serialization.
+   *
+   * @param bytes - The serialized filter.
+   * @returns The reconstructed filter.
+   */
   static fromBytes(bytes: Uint8Array): BinaryFuse16;
 }
 //#endregion