@thi.ng/math 5.10.13 → 5.11.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:32Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [5.11.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.11.0) (2024-06-21)
+
+#### 🚀 Features
+
+- add solveTridiagonal() ([1277a0a](https://github.com/thi-ng/umbrella/commit/1277a0a))
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ## [5.10.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.10.0) (2024-02-16)
 
 #### 🚀 Features

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 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -77,7 +77,7 @@ For Node.js REPL:
 const math = await import("@thi.ng/math");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.70 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.80 KB
 
 ## Dependencies
 

package/extrema.js

@@ -1,6 +1,6 @@
 const isMinima = (a, b, c) => a > b && b < c;
 const isMaxima = (a, b, c) => a < b && b > c;
-const index = (pred, values, from = 0, to = values.length) => {
+const __index = (pred, values, from = 0, to = values.length) => {
   to--;
   for (let i = from + 1; i < to; i++) {
     if (pred(values[i - 1], values[i], values[i + 1])) {
@@ -9,8 +9,8 @@ const index = (pred, values, from = 0, to = values.length) => {
   }
   return -1;
 };
-const minimaIndex = (values, from = 0, to = values.length) => index(isMinima, values, from, to);
-const maximaIndex = (values, from = 0, to = values.length) => index(isMaxima, values, from, to);
+const minimaIndex = (values, from = 0, to = values.length) => __index(isMinima, values, from, to);
+const maximaIndex = (values, from = 0, to = values.length) => __index(isMaxima, values, from, to);
 function* indices(fn, vals, from = 0, to = vals.length) {
   while (from < to) {
     const i = fn(vals, from, to);

package/mix.d.ts

@@ -172,13 +172,13 @@ export declare const tangentDiff3: (prev: number, curr: number, next: number, ta
  * and returns interpolated value.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/tween.ts
  * import { easeInOut2, tween } from "@thi.ng/math";
  *
  * // create tweening function
  * const anim = tween(easeInOut2, 100, 200);
  *
- * for(let i=0; i<=10; i++) console.log(anim(i/10));
+ * for(let i=0; i<=10; i++) console.log(anim(i / 10));
  * // 100
  * // 102
  * // 108
@@ -229,17 +229,28 @@ export declare const invCircular: FnN;
  * reference to below example.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/lens.ts
  * import { mix, lens, tween } from "@thi.ng/math";
  * import { partial } from "@thi.ng/compose";
  *
  * // interpolated position in [100..400] interval for given `t`
- * y = mix(100, 400, lens(0.5, 1, t));
+ * // const y = mix(100, 400, lens(0.5, 1, t));
  *
  * // or compose tween function via `tween()` & `partial()`
- * f = tween(partial(lens, 0.5, 1), 100, 400);
- *
- * f(t)
+ * const f = tween(partial(lens, 0.75, 1), 100, 400);
+ *
+ * for(let i=0; i<=10; i++) console.log(f(i / 10));
+ * // 100.0
+ * // 102.0
+ * // 108.1
+ * // 118.7
+ * // 134.6
+ * // 157.2
+ * // 190.0
+ * // 244.2
+ * // 370.0
+ * // 393.7
+ * // 400.0
  * ```
  *
  * @param pos - lens pos

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.10.13",
+  "version": "5.11.0",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/math#readme",
+  "homepage": "https://thi.ng/math",
   "funding": [
     {
       "type": "github",
@@ -39,13 +39,13 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.2"
+    "@thi.ng/api": "^8.11.3"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.2",
-    "esbuild": "^0.21.1",
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "animation",
@@ -142,5 +142,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/solve.d.ts

@@ -1,4 +1,4 @@
-import type { FnN2 } from "@thi.ng/api";
+import type { FnN2, NumericArray } from "@thi.ng/api";
 /**
  * Produces a new function which computes derivative of the given single-arg
  * function. The extra optional arg `eps` is used to define the step width for
@@ -54,4 +54,19 @@ export declare const solveQuadratic: (a: number, b: number, c: number, eps?: num
  * @param eps - tolerance to determine multiple roots
  */
 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.
+ *
+ * @remarks
+ * 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]
+ * @param c - superdiagonal [0,N-2], c[N-1] is upper right corner
+ * @param d - input coefficients & output solutions [0,N-1]
+ */
+export declare const solveTridiagonal: (a: NumericArray, b: NumericArray, c: NumericArray, d: NumericArray) => NumericArray;
 //# sourceMappingURL=solve.d.ts.map

package/solve.js

@@ -34,9 +34,27 @@ const solveCubic = (a, b, c, d, eps = 1e-9) => {
     }
   }
 };
+const solveTridiagonal = (a, b, c, d) => {
+  const n = d.length - 1;
+  const tmp = new Array(n + 1);
+  tmp[0] = c[0] / b[0];
+  d[0] = d[0] / b[0];
+  for (let i = 1; i <= n; i++) {
+    const ai = a[i];
+    const bi = b[i];
+    const denom = 1 / (bi - ai * tmp[i - 1]);
+    tmp[i] = c[i] * denom;
+    d[i] = (d[i] - ai * d[i - 1]) * denom;
+  }
+  for (let i = n; i-- > 0; ) {
+    d[i] -= tmp[i] * d[i + 1];
+  }
+  return d;
+};
 export {
   derivative,
   solveCubic,
   solveLinear,
-  solveQuadratic
+  solveQuadratic,
+  solveTridiagonal
 };