@weasel-js/geom 1.13.0 → 1.14.0

package/dist/nd/index.d.ts

@@ -131,4 +131,31 @@ interface Bvh<K> {
  *  given. Entries with an invalid box are skipped. */
 declare function createBvh<K>(dim: number, entries?: Iterable<readonly [K, BoxN]>): Bvh<K>;
 
-export { type BoxN, type Bvh, type Flat, type HalfSpace, type ProbeRole, type SnapCandidate, type SnapProbe, type SnapProblem, type SnapResolution, type SnapTier, type Vec, closestBetweenFlats, closestOnFlat, createBvh, flatDim, intersectFlats, resolveSnap, stepLine };
+/**
+ * A value built from a source only once the source has held still. Each read
+ * passes the source's key, a tuple of whatever its value is a function of
+ * (versions, generations, the identity of an input). A read at a key that
+ * differs from the last one records it and answers null, so the caller works
+ * without the value; the `reads`-th read in a row at one key builds it, and
+ * later reads at that key return the same value. A source whose key changes
+ * before every read never pays for a build.
+ *
+ * Keys match element by element under `Object.is`.
+ */
+interface SettledCache<T> {
+    /** The value for `key`, built by `build` on the read that settles it; null before that. */
+    read(key: readonly unknown[], build: () => T): T | null;
+    /** Forget the recorded key and any value, as if never read. */
+    clear(): void;
+}
+/** Options for {@link createSettledCache}. */
+interface SettledCacheOptions {
+    /** Which read in a row at one key builds the value. Default 2: a source must
+     *  be read once unchanged before it is worth building over. 1 builds on the
+     *  first read, which makes the cache a plain memo keyed the same way. */
+    reads?: number;
+}
+/** A {@link SettledCache} that builds on the `reads`-th read in a row at one key. */
+declare function createSettledCache<T>({ reads }?: SettledCacheOptions): SettledCache<T>;
+
+export { type BoxN, type Bvh, type Flat, type HalfSpace, type ProbeRole, type SettledCache, type SettledCacheOptions, type SnapCandidate, type SnapProbe, type SnapProblem, type SnapResolution, type SnapTier, type Vec, closestBetweenFlats, closestOnFlat, createBvh, createSettledCache, flatDim, intersectFlats, resolveSnap, stepLine };