@thi.ng/dual-algebra 0.4.3 → 0.4.4

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-12-13T10:26:00Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -237,4 +237,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2020 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2020 - 2022 Karsten Schmidt // Apache Software License 2.0

package/ops.d.ts

@@ -10,29 +10,29 @@ export declare const dual: (real: number, n?: number, i?: number) => Dual;
 /**
  * Creates a 1-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export declare const $: (r: number, i?: number) => number[];
 /**
  * Creates a 2-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export declare const $2: (r: number, i?: number) => import("@thi.ng/api").NumericArray;
 /**
  * Creates a 3-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export declare const $3: (r: number, i?: number) => import("@thi.ng/api").NumericArray;
 /**
  * Creates a 4-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export declare const $4: (r: number, i?: number) => import("@thi.ng/api").NumericArray;
 export declare const defOp: <T extends Function>(single: T, multi: T, dispatch?: number) => T;
@@ -53,9 +53,9 @@ export declare const atan: Op1;
 /**
  * Linear interpolation for dual numbers: `a + (b - a) * t`
  *
- * @param a
- * @param b
- * @param t
+ * @param a -
+ * @param b -
+ * @param t -
  */
 export declare const mix: (a: Dual, b: Dual, t: Dual) => import("@thi.ng/api").NumericArray;
 /**
@@ -71,19 +71,19 @@ export declare const mix: (a: Dual, b: Dual, t: Dual) => import("@thi.ng/api").N
  * - index 1 - derivative of first var at `x`
  * - index 2 - derivative of second var at `y`
  *
- * @param fn
+ * @param fn -
  */
 export declare const evalFn2: (fn: Op2) => (x: number, y: number) => import("@thi.ng/api").NumericArray;
 /**
  * Same as {@link evalFn2}, but 3-multivariate functions.
  *
- * @param fn
+ * @param fn -
  */
 export declare const evalFn3: (fn: Op3) => (x: number, y: number, z: number) => import("@thi.ng/api").NumericArray;
 /**
  * Same as {@link evalFn4}, but 4-multivariate functions.
  *
- * @param fn
+ * @param fn -
  */
 export declare const evalFn4: (fn: Op4) => (x: number, y: number, z: number, w: number) => import("@thi.ng/api").NumericArray;
 //# sourceMappingURL=ops.d.ts.map

package/ops.js

@@ -14,29 +14,29 @@ export const dual = (real, n = 1, i = 0) => {
 /**
  * Creates a 1-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export const $ = (r, i = 0) => [r, i === 1 ? 1 : 0];
 /**
  * Creates a 2-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export const $2 = (r, i = 0) => dual(r, 2, i);
 /**
  * Creates a 3-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export const $3 = (r, i = 0) => dual(r, 3, i);
 /**
  * Creates a 4-dual number of `r`. Syntax sugar for {@link dual}.
  *
- * @param r
- * @param i
+ * @param r -
+ * @param i -
  */
 export const $4 = (r, i = 0) => dual(r, 4, i);
 export const defOp = (single, multi, dispatch = 0) => (((...xs) => xs[dispatch].length < 3 ? single(...xs) : multi(...xs)));
@@ -150,9 +150,9 @@ export const atan = defOp(([ar, ad]) => [Math.atan(ar), ad / (1 + ar * ar)], (a)
 /**
  * Linear interpolation for dual numbers: `a + (b - a) * t`
  *
- * @param a
- * @param b
- * @param t
+ * @param a -
+ * @param b -
+ * @param t -
  */
 export const mix = (a, b, t) => add(a, mul(sub(b, a), t));
 /**
@@ -168,18 +168,18 @@ export const mix = (a, b, t) => add(a, mul(sub(b, a), t));
  * - index 1 - derivative of first var at `x`
  * - index 2 - derivative of second var at `y`
  *
- * @param fn
+ * @param fn -
  */
 export const evalFn2 = (fn) => (x, y) => fn([x, 1, 0], [y, 0, 1]);
 /**
  * Same as {@link evalFn2}, but 3-multivariate functions.
  *
- * @param fn
+ * @param fn -
  */
 export const evalFn3 = (fn) => (x, y, z) => fn([x, 1, 0, 0], [y, 0, 1, 0], [z, 0, 0, 1]);
 /**
  * Same as {@link evalFn4}, but 4-multivariate functions.
  *
- * @param fn
+ * @param fn -
  */
 export const evalFn4 = (fn) => (x, y, z, w) => fn([x, 1, 0, 0, 0], [y, 0, 1, 0, 0], [z, 0, 0, 1, 0], [w, 0, 0, 0, 1]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dual-algebra",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "Multivariate dual number algebra, automatic differentiation",
   "type": "module",
   "module": "./index.js",
@@ -34,15 +34,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.3"
+    "@thi.ng/api": "^8.3.4"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "algebra",
@@ -91,5 +91,5 @@
     "status": "alpha",
     "year": 2020
   },
-  "gitHead": "2db9dd34c0c2c60cbfde3dad0bca352b20292f5c\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/poly.d.ts

@@ -3,64 +3,64 @@ import type { Dual, Op4, Op5 } from "./api.js";
 /**
  * Computes: `ax^2 + bx + c`. All args must have same size/arity.
  *
- * @param x
- * @param a
- * @param b
- * @param c
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
  */
 export declare const quadratic: Op4;
 /**
  * Same as {@link quadratic}, but for real/scalar inputs. `x` is treated as
  * variable `x+1ε`, the rest as `n+0ε`.
  *
- * @param x
- * @param a
- * @param b
- * @param c
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
  */
 export declare const quadraticS: FnU4<number, Dual>;
 /**
  * Computes: `ax^3 + bx^2 + cx + d`. All args must have same size/arity.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
  */
 export declare const cubic: Op5;
 /**
  * Same as {@link cubic}, but for real/scalar inputs. `x` is treated as variable
  * `x+1ε`, the rest as `n+0ε`.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
  */
 export declare const cubicS: FnU5<number, Dual>;
 /**
  * Computes: `ax^4 + bx^3 + cx^2 + dx + e`. All args must have same size/arity.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
- * @param e
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
+ * @param e -
  */
 export declare const quartic: (x: Dual, a: Dual, b: Dual, c: Dual, d: Dual, e: Dual) => import("@thi.ng/api").NumericArray;
 /**
  * Same as {@link quartic}, but for real/scalar inputs. `x` is treated as
  * variable `x+1ε`, the rest as `n+0ε`.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
- * @param e
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
+ * @param e -
  */
 export declare const quarticS: FnU6<number, Dual>;
 //# sourceMappingURL=poly.d.ts.map

package/poly.js

@@ -2,30 +2,30 @@ import { add, mul } from "./ops.js";
 /**
  * Computes: `ax^2 + bx + c`. All args must have same size/arity.
  *
- * @param x
- * @param a
- * @param b
- * @param c
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
  */
 export const quadratic = (x, a, b, c) => add(add(mul(a, mul(x, x)), mul(b, x)), c);
 /**
  * Same as {@link quadratic}, but for real/scalar inputs. `x` is treated as
  * variable `x+1ε`, the rest as `n+0ε`.
  *
- * @param x
- * @param a
- * @param b
- * @param c
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
  */
 export const quadraticS = (x, a, b, c) => quadratic([x, 1], [a, 0], [b, 0], [c, 0]);
 /**
  * Computes: `ax^3 + bx^2 + cx + d`. All args must have same size/arity.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
  */
 export const cubic = (x, a, b, c, d) => {
     const x2 = mul(x, x);
@@ -35,22 +35,22 @@ export const cubic = (x, a, b, c, d) => {
  * Same as {@link cubic}, but for real/scalar inputs. `x` is treated as variable
  * `x+1ε`, the rest as `n+0ε`.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
  */
 export const cubicS = (x, a, b, c, d) => cubic([x, 1], [a, 0], [b, 0], [c, 0], [d, 0]);
 /**
  * Computes: `ax^4 + bx^3 + cx^2 + dx + e`. All args must have same size/arity.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
- * @param e
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
+ * @param e -
  */
 export const quartic = (x, a, b, c, d, e) => {
     const x2 = mul(x, x);
@@ -61,11 +61,11 @@ export const quartic = (x, a, b, c, d, e) => {
  * Same as {@link quartic}, but for real/scalar inputs. `x` is treated as
  * variable `x+1ε`, the rest as `n+0ε`.
  *
- * @param x
- * @param a
- * @param b
- * @param c
- * @param d
- * @param e
+ * @param x -
+ * @param a -
+ * @param b -
+ * @param c -
+ * @param d -
+ * @param e -
  */
 export const quarticS = (x, a, b, c, d, e) => quartic([x, 1], [a, 0], [b, 0], [c, 0], [d, 0], [e, 0]);

package/vector.d.ts

@@ -4,39 +4,39 @@ import type { Dual, OpV2 } from "./api.js";
  * Dual vector addition. Applies {@link add} in a component-wise manner. Returns
  * new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const vadd: OpV2;
 /**
  * Dual vector subtraction. Applies {@link sub} in a component-wise manner.
  * Returns new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const vsub: OpV2;
 /**
  * Dual vector multiplication. Applies {@link mul} in a component-wise manner.
  * Returns new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const vmul: OpV2;
 /**
  * Dual vector division. Applies {@link div} in a component-wise manner.
  * Returns new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const vdiv: OpV2;
 /**
  * Computes dot product of 2 dual vectors.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const dot: FnU2<Dual[], Dual>;
 //# sourceMappingURL=vector.d.ts.map

package/vector.js

@@ -4,38 +4,38 @@ const defVecOp2 = (op) => (a, b) => a.map((a, i) => op(a, b[i]));
  * Dual vector addition. Applies {@link add} in a component-wise manner. Returns
  * new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const vadd = defVecOp2(add);
 /**
  * Dual vector subtraction. Applies {@link sub} in a component-wise manner.
  * Returns new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const vsub = defVecOp2(sub);
 /**
  * Dual vector multiplication. Applies {@link mul} in a component-wise manner.
  * Returns new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const vmul = defVecOp2(mul);
 /**
  * Dual vector division. Applies {@link div} in a component-wise manner.
  * Returns new (dual) vector.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const vdiv = defVecOp2(div);
 /**
  * Computes dot product of 2 dual vectors.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const dot = (a, b) => a.reduce((acc, a, i) => add(acc, mul(a, b[i])), dual(0, a[0].length));