@thi.ng/math 5.11.18 → 5.11.20

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-01-23T13:39:11Z
+- **Last updated**: 2025-02-13T16:03:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 200 standalone projects, maintained as part
+> This is one of 201 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/abs.d.ts

@@ -8,7 +8,7 @@ import type { FnN2 } from "@thi.ng/api";
 export declare const absDiff: FnN2;
 /**
  * Similar to `Math.sign()`, but uses `eps` to determine the zero value (i.e. if
- * `x` is in [-eps,eps] interval).
+ * `x` is in `[-eps,eps]` interval).
  *
  * @param x
  * @param eps

package/angle.d.ts

@@ -14,22 +14,22 @@ export declare const sincos: (theta: number, n?: number) => [number, number];
  */
 export declare const cossin: (theta: number, n?: number) => [number, number];
 /**
- * Projects `theta` into [0 .. 2π] interval.
+ * Projects `theta` into `[0,2π]` interval.
  *
  * @param theta -
  */
 export declare const absTheta: FnN;
 export declare const absInnerAngle: FnN;
 /**
- * Returns smallest absolute angle difference between `a` and `b`.
- * Result will be in [0 .. π] interval.
+ * Returns smallest absolute angle difference between `a` and `b`. Result will
+ * be in `[0,π]` interval.
  *
  * @param a -
  * @param b -
  */
 export declare const angleDist: FnN2;
 /**
- * Like `Math.atan2`, but always returns angle in [0 .. TAU) interval.
+ * Like `Math.atan2`, but always returns angle in `[0,TAU)` interval.
  *
  * @param y -
  * @param x -
@@ -72,8 +72,8 @@ export declare const sec: FnN;
  */
 export declare const cot: FnN;
 /**
- * Law of Cosines. Takes length of two sides of a triangle and the inner
- * angle (in radians) between them. Returns length of third side.
+ * Law of Cosines. Takes length of two sides of a triangle and the inner angle
+ * (in radians) between them. Returns length of third side.
  *
  * @param a -
  * @param b -
@@ -81,7 +81,7 @@ export declare const cot: FnN;
  */
 export declare const loc: FnN3;
 /**
- * Approximates cos(xπ) for x in [-1,1]
+ * Approximates cos(xπ) for x in `[-1,1]`
  *
  * @param x -
  */
@@ -90,7 +90,7 @@ export declare const normCos: FnN;
  * Fast cosine approximation using {@link normCos} (polynomial). Max. error
  * ~0.00059693
  *
- * In [0 .. 2π] interval, approx. 18-20% faster than `Math.cos` on V8.
+ * In `[0,2π]` interval, approx. 18-20% faster than `Math.cos` on V8.
  *
  * @param theta - in radians
  */

package/extrema.d.ts

@@ -16,9 +16,9 @@ export declare const isMinima: FnU3<number, boolean>;
  */
 export declare const isMaxima: FnU3<number, boolean>;
 /**
- * Returns index of the first local & internal minima found in given
- * `values` array, or -1 if no such minima exists. The search range can
- * be optionally defined via semi-open [from, to) index interval.
+ * Returns index of the first local & internal minima found in given `values`
+ * array, or -1 if no such minima exists. The search range can be optionally
+ * defined via semi-open `[from,to)` index interval.
  *
  * @param values -
  * @param from -
@@ -26,9 +26,9 @@ export declare const isMaxima: FnU3<number, boolean>;
  */
 export declare const minimaIndex: (values: number[], from?: number, to?: number) => number;
 /**
- * Returns index of the first local & internal maxima found in given
- * `values` array, or -1 if no such maxima exists. The search range can
- * be optionally defined via semi-open [from, to) index interval.
+ * Returns index of the first local & internal maxima found in given `values`
+ * array, or -1 if no such maxima exists. The search range can be optionally
+ * defined via semi-open `[from,to)` index interval.
  *
  * @param values -
  * @param from -
@@ -36,9 +36,9 @@ export declare const minimaIndex: (values: number[], from?: number, to?: number)
  */
 export declare const maximaIndex: (values: number[], from?: number, to?: number) => number;
 /**
- * Returns an iterator yielding all minima indices in given `values`
- * array. The search range can be optionally defined via semi-open
- * [from, to) index interval.
+ * Returns an iterator yielding all minima indices in given `values` array. The
+ * search range can be optionally defined via semi-open `[from,to)` index
+ * interval.
  *
  * @param values -
  * @param from -
@@ -46,9 +46,9 @@ export declare const maximaIndex: (values: number[], from?: number, to?: number)
  */
 export declare const minimaIndices: (values: number[], from?: number, to?: number) => Generator<number, void, unknown>;
 /**
- * Returns an iterator yielding all maxima indices in given `values`
- * array. The search range can be optionally defined via semi-open
- * [from, to) index interval.
+ * Returns an iterator yielding all maxima indices in given `values` array. The
+ * search range can be optionally defined via semi-open `[from,to)` index
+ * interval.
  *
  * @param values -
  * @param from -

package/fit.d.ts

@@ -32,7 +32,7 @@ export declare const fit: FnN5;
  */
 export declare const fitClamped: FnN5;
 /**
- * Similar to {@link fitClamped}, assuming [0,1] as source interval.
+ * Similar to {@link fitClamped}, assuming `[0,1]` as source interval.
  *
  * @param x
  * @param a
@@ -40,7 +40,7 @@ export declare const fitClamped: FnN5;
  */
 export declare const fit01: FnN3;
 /**
- * Similar to {@link fitClamped}, assuming the reverse ordered [1,0] as source
+ * Similar to {@link fitClamped}, assuming the reverse ordered `[1,0]` as source
  * interval.
  *
  * @param x
@@ -49,7 +49,7 @@ export declare const fit01: FnN3;
  */
 export declare const fit10: FnN3;
 /**
- * Similar to {@link fitClamped}, assuming [-1,1] as source interval.
+ * Similar to {@link fitClamped}, assuming `[-1,1]` as source interval.
  *
  * @param x
  * @param a

package/interval.d.ts

@@ -8,39 +8,38 @@ import type { FnN, FnN2, FnN3, FnN4, FnU2, FnU3 } from "@thi.ng/api";
  */
 export declare const clamp: FnN3;
 /**
- * Clamps value `x` to closed [0 .. ∞] interval.
+ * Clamps value `x` to closed `[0,∞]` interval.
  *
  * @param x -
  */
 export declare const clamp0: FnN;
 /**
- * Clamps value `x` to closed [0 .. 1] interval.
+ * Clamps value `x` to closed `[0,1]` interval.
  *
  * @param x -
  */
 export declare const clamp01: FnN;
 /**
- * Clamps value `x` to closed [-1 .. 1] interval.
+ * Clamps value `x` to closed `[-1,1]` interval.
  *
  * @param x -
  */
 export declare const clamp11: FnN;
 /**
- * Clamps value `x` to closed [0 .. 0.5] interval.
+ * Clamps value `x` to closed `[0,0.5]` interval.
  *
  * @param x -
  */
 export declare const clamp05: FnN;
 /**
- * Returns 2-tuple of [min(x,y), max(x,y)].
+ * Returns 2-tuple of `[min(x,y), max(x,y)]`.
  *
  * @param x
  * @param y
  */
 export declare const minMax: FnU2<number, [number, number]>;
 /**
- * Folds `x` back inside closed [min..max] interval. Also see
- * {@link wrapOnce}.
+ * Folds `x` back inside closed `[min,max]` interval. Also see {@link wrapOnce}.
  *
  * @param x -
  * @param min -
@@ -48,9 +47,9 @@ export declare const minMax: FnU2<number, [number, number]>;
  */
 export declare const wrap: FnN3;
 /**
- * Like {@link wrap}, but optimized for cases where `x` is guaranteed to
- * be in `[min - d, max + d]` interval, where `d = max - min`. Result
- * will be in closed `[min..max]` interval.
+ * Like {@link wrap}, but optimized for cases where `x` is guaranteed to be in
+ * `[min-d,max+d]` interval, where `d = max - min`. Result will be in closed
+ * `[min,max]` interval.
  *
  * @param x -
  * @param min -
@@ -58,13 +57,13 @@ export declare const wrap: FnN3;
  */
 export declare const wrapOnce: FnN3;
 /**
- * Similar to {@link wrapOnce} for [0..1] interval.
+ * Similar to {@link wrapOnce} for `[0,1]` interval.
  *
  * @param x -
  */
 export declare const wrap01: FnN;
 /**
- * Similar to {@link wrapOnce} for [-1..1] interval.
+ * Similar to {@link wrapOnce} for `[-1,1]` interval.
  *
  * @param x -
  */
@@ -91,7 +90,7 @@ export declare const minNonZero2: FnN2;
  */
 export declare const minNonZero3: FnN3;
 /**
- * See `smax()`.
+ * Smooth minimum. See {@link smax} for details.
  *
  * @param a -
  * @param b -
@@ -100,7 +99,7 @@ export declare const minNonZero3: FnN3;
 export declare const smin: FnN3;
 /**
  * Smooth maximum. Note: Result values will be slightly larger than max value
- * near max(a,b) + eps due to exponential decay. Higher `k` values reduce the
+ * near `max(a, b) + eps` due to exponential decay. Higher `k` values reduce the
  * error, but also reduce the smoothing. Recommended k=16.
  *
  * https://en.wikipedia.org/wiki/Smooth_maximum
@@ -122,12 +121,13 @@ export declare const sclamp: FnN4;
 export declare const absMin: FnN2;
 export declare const absMax: FnN2;
 /**
- * If `abs(x) > abs(e)`, recursively mirrors `x` back into `[-e .. +e]`
- * interval at respective positive/negative boundary.
+ * If `abs(x) > abs(e)`, recursively mirrors `x` back into `[-e,e]` interval at
+ * respective positive/negative boundary.
  *
  * @remarks
  * References:
- * - https://www.desmos.com/calculator/lkyf2ag3ta
+ *
+ * - [Interactive graph](https://www.desmos.com/calculator/lkyf2ag3ta)
  * - https://www.musicdsp.org/en/latest/Effects/203-fold-back-distortion.html
  *
  * @param e - threshold (> 0)
@@ -136,14 +136,14 @@ export declare const absMax: FnN2;
 export declare const foldback: FnN2;
 /**
  * Similar to {@link foldback}, but with fixed target range: Folds `x` into the
- * closed [0..1] interval, using infinite internal reflection on either side of
+ * closed `[0,1]` interval, using infinite internal reflection on either side of
  * the interval.
  *
  * @param x
  */
 export declare const foldback01: FnN;
 /**
- * Returns true iff `x` is in closed interval `[min .. max]`
+ * Returns true iff `x` is in closed interval `[min,max]`
  *
  * @param x -
  * @param min -
@@ -151,7 +151,7 @@ export declare const foldback01: FnN;
  */
 export declare const inRange: FnU3<number, boolean>;
 /**
- * Returns true iff `x` is in open interval `(min .. max)`
+ * Returns true iff `x` is in open interval `(min,max)`
  *
  * @param x -
  * @param min -

package/libc.d.ts

@@ -53,6 +53,7 @@ export declare const fmod: FnN2;
  * tuple of `[sig, exp]`.
  *
  * @remarks
+ *
  * - If `x` is zero, both parts (significand and exponent) are zero.
  * - If `x` is negative, the significand returned by this function is negative.
  *

package/min-error.d.ts

@@ -1,17 +1,16 @@
 /**
- * Recursively evaluates function `fn` for `res` uniformly spaced values
- * `t` in the closed parametric interval `[start,end]` and computes
- * corresponding sample values `p`. For each `p` then calls `error`
- * function to compute the error to query target value `q` and
- * eventually returns the `t` producing the overall minimum error. At
- * each level of recursion the search interval is increasingly narrowed
- * / centered around the best `t` of the current iteration.
+ * Recursively evaluates function `fn` for `res` uniformly spaced values `t` in
+ * the closed parametric interval `[start,end]` and computes corresponding
+ * sample values `p`. For each `p` then calls `error` function to compute the
+ * error to query target value `q` and eventually returns the `t` producing the
+ * overall minimum error. At each level of recursion the search interval is
+ * increasingly narrowed / centered around the best `t` of the current
+ * iteration.
  *
- * The search is terminated early if the best error value is less than
- * `eps`.
+ * The search is terminated early if the best error value is less than `eps`.
  *
- * The interval end points `start` and `end` MUST be normalized values
- * in the closed [0,1] interval.
+ * The interval end points `start` and `end` MUST be normalized values in the
+ * closed `[0,1]` interval.
  *
  * @param fn - function to evaluate
  * @param error - error function

package/mix.d.ts

@@ -4,7 +4,7 @@ import type { FnN, FnN2, FnN3, FnN4, FnN5, FnN6 } from "@thi.ng/api";
  *
  * @param a - start value
  * @param b - end value
- * @param t - interpolation factor [0..1]
+ * @param t - interpolation factor `[0,1]`
  */
 export declare const mix: FnN3;
 /**
@@ -56,7 +56,7 @@ export declare const mixCubic: FnN5;
  * {@link mixCubicHermite} with one of the tangent generators supporting
  * non-uniform spacing of points.
  *
- * See: https://www.desmos.com/calculator/j4gf8g9vkr
+ * [Interactive graph](https://www.desmos.com/calculator/j4gf8g9vkr)
  *
  * Source:
  * https://www.musicdsp.org/en/latest/Other/93-hermite-interpollation.html
@@ -168,7 +168,7 @@ export declare const tangentCardinal: (prev: number, next: number, scale?: numbe
 export declare const tangentDiff3: (prev: number, curr: number, next: number, ta?: number, tb?: number, tc?: number) => number;
 /**
  * HOF interpolator. Takes a timing function `f` and interval `[from,to]`.
- * Returns function which takes normalized time (in [0,1] range) as single arg
+ * Returns function which takes normalized time (in `[0,1]` range) as single arg
  * and returns interpolated value.
  *
  * @example
@@ -201,18 +201,18 @@ export declare const tween: (f: (t: number) => number, from: number, to: number)
  * Circular interpolation (ease out): `sqrt(1 - (1 - t)^2)`
  *
  * @remarks
- * Reference: https://www.desmos.com/calculator/tisoiazdrw
+ * [Interactive graph](https://www.desmos.com/calculator/tisoiazdrw)
  *
- * @param t - interpolation factor [0..1]
+ * @param t - interpolation factor `[0,1]`
  */
 export declare const circular: FnN;
 /**
  * Inverse/flipped version of {@link circular} (ease in).
  *
  * @remarks
- * Reference: https://www.desmos.com/calculator/tisoiazdrw
+ * [Interactive graph](https://www.desmos.com/calculator/tisoiazdrw)
  *
- * @param t - interpolation factor [0..1]
+ * @param t - interpolation factor `[0,1]`
  */
 export declare const invCircular: FnN;
 /**
@@ -220,8 +220,8 @@ export declare const invCircular: FnN;
  * strength.
  *
  * @remarks
- * Lens position must be given in (0..1) interval. Lens strength must be in
- * [-1,1] range. If negative, the lens will be bundling values near `pos`, if
+ * Lens position must be given in `(0,1)` interval. Lens strength must be in
+ * `[-1,1]` range. If negative, the lens will be bundling values near `pos`, if
  * positive the lens has dilating characteristics and will spread values near
  * `pos` towards the edges.
  *
@@ -255,7 +255,7 @@ export declare const invCircular: FnN;
  *
  * @param pos - lens pos
  * @param strength - lens strength
- * @param t - interpolation factor [0..1]
+ * @param t - interpolation factor `[0,1]`
  */
 export declare const lens: FnN3;
 export declare const cosine: FnN;
@@ -264,8 +264,7 @@ export declare const decimated: FnN2;
  * Spring oscillator with damping.
  *
  * @remarks
- * Interactive graph:
- * https://www.desmos.com/calculator/tywbpw8pck
+ * [Interactive graph](https://www.desmos.com/calculator/tywbpw8pck)
  *
  * @param k
  * @param amp
@@ -308,7 +307,7 @@ export declare const sinc: FnN;
  * @remarks
  * https://en.wikipedia.org/wiki/Sinc_function
  *
- * @see {@link sinc}
+ * See {@link sinc}
  *
  * @param k -
  * @param t -
@@ -319,7 +318,7 @@ export declare const sincNormalized: FnN2;
  * returns 0.
  *
  * @remarks
- * Interactive graph: https://www.desmos.com/calculator/pmypqgefle
+ * [Interactive graph](https://www.desmos.com/calculator/pmypqgefle)
  *
  * @param a -
  * @param t -
@@ -338,14 +337,14 @@ export declare const lanczos: FnN2;
  */
 export declare const sigmoid: FnN3;
 /**
- * Sigmoid function for inputs in [0..1] interval. Center bias = 0.5.
+ * Sigmoid function for inputs in `[0,1]` interval. Center bias = 0.5.
  *
  * @param k - steepness
  * @param t - input value
  */
 export declare const sigmoid01: FnN2;
 /**
- * Sigmoid function for inputs in [-1..+1] interval. Center bias = 0
+ * Sigmoid function for inputs in `[-1,1]` interval. Center bias = 0
  *
  * @param k -
  * @param t -
@@ -356,18 +355,17 @@ export declare const sigmoid11: FnN2;
  * https://arxiv.org/abs/2010.09714
  *
  * @remarks
- * Interactive graph:
- * https://www.desmos.com/calculator/u6bkm5rb7t
+ * [Interactive graph](https://www.desmos.com/calculator/u6bkm5rb7t)
  *
- * @param a - curve strength. recommended (0..64]
- * @param b - pivot position [0..1]
- * @param t - input val [0..1]
+ * @param a - curve strength. recommended `(0,64]`
+ * @param b - pivot position `[0,1]`
+ * @param t - input val `[0,1]`
  */
 export declare const schlick: FnN3;
 /**
- * Computes exponential factor to interpolate from `a` to `b` over
- * `num` steps. I.e. multiplying `a` with the returned factor will yield
- * `b` after `num` steps. All args must be > 0.
+ * Computes exponential factor to interpolate from `a` to `b` over `num` steps.
+ * I.e. multiplying `a` with the returned factor will yield `b` after `num`
+ * steps. All args must be > 0.
  *
  * @param a -
  * @param b -
@@ -378,7 +376,7 @@ export declare const expFactor: FnN3;
  * Computes gaussian bell curve for given center `bias` and `sigma` (spread).
  *
  * @remarks
- * Interactive graph: https://www.desmos.com/calculator/aq6hdzxprv
+ * [Interactive graph](https://www.desmos.com/calculator/aq6hdzxprv)
  *
  * @param bias -
  * @param sigma -

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.11.18",
+  "version": "5.11.20",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -36,18 +36,17 @@
     "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "bun ../../tools/src/clean-package.ts",
     "doc": "typedoc --options ../../typedoc.json --out doc src/index.ts",
-    "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
     "test": "bun test",
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.18"
+    "@thi.ng/api": "^8.11.20"
   },
   "devDependencies": {
-    "esbuild": "^0.24.2",
-    "typedoc": "^0.27.6",
+    "esbuild": "^0.25.0",
+    "typedoc": "^0.27.7",
     "typescript": "^5.7.3"
   },
   "keywords": [
@@ -145,5 +144,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "b92b48abda9941d608be8a2e1c83447e679a6f79\n"
+  "gitHead": "9a0b33253fef092aaf301decf6ecd54317874d4c\n"
 }

package/solve.d.ts

@@ -59,13 +59,15 @@ export declare const solveQuadratic: (a: number, b: number, c: number, eps?: num
  */
 export declare const solveCubic: (a: number, b: number, c: number, d: number, eps?: number) => number[];
 /**
- * Solves a system of linear equations for N unknowns: `a[i]*x[i−1] + b[i]*x[i]
- * + c[i]*x[i+1] = d[i]`, where a[0]=0 and c[N-1]=0. Writes solutions `x[i]` back into
- * array of input coefficients `d` and returns it. The other arrays are not modified.
+ * Solves a system of linear equations for N unknowns:
+ *
+ * `a[i]*x[i−1] + b[i]*x[i] + c[i]*x[i+1] = d[i]`,
+ *
+ * where `a[0]=0` and `c[N-1]=0`. Writes solutions `x[i]` back into array of
+ * input coefficients `d` and returns it. The other arrays are not modified.
  *
  * @remarks
- * Reference:
- * https://en.wikipedia.org/wiki/Tridiagonal_matrix_algorithm
+ * Reference: https://en.wikipedia.org/wiki/Tridiagonal_matrix_algorithm
  *
  * @param a - subdiagonal [1,N-1], a[0] is lower left corner
  * @param b - main diagonal [0,N-1]

package/step.d.ts

@@ -21,7 +21,7 @@ export declare const step: FnN2;
 export declare const smoothStep: FnN3;
 /**
  * Specialized version of {@link smoothStep}, assuming edges are 0/1
- * respectively and `x` is in [0..1]. No clamping performed.
+ * respectively and `x` is in `[0,1]`. No clamping performed.
  *
  * @param x
  */
@@ -39,7 +39,7 @@ export declare const smoothStep01: FnN;
 export declare const smootherStep: FnN3;
 /**
  * Specialized version of {@link smootherStep}, assuming edges are 0/1
- * respectively and `x` is in [0..1]. No clamping performed.
+ * respectively and `x` is in `[0,1]`. No clamping performed.
  *
  * @param x
  */
@@ -55,7 +55,7 @@ export declare const smootherStep01: FnN;
  * - Pulse: k=0.005, n=-10
  * - Ease-in: k=0.5, n=0.25
  *
- * Interactive graph: https://www.desmos.com/calculator/gcnuyppycz
+ * [Interactive graph](https://www.desmos.com/calculator/gcnuyppycz)
  *
  * @param k -
  * @param n -