@thi.ng/math 5.3.7 → 5.3.9

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-08-01T14:54:00Z
+- **Last updated**: 2022-09-27T16:23:13Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,6 +1,6 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![math](https://media.thi.ng/umbrella/banners/thing-math.svg?4738af0a)
+# ![math](https://media.thi.ng/umbrella/banners-20220914/thing-math.svg?6c020320)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/math.svg)](https://www.npmjs.com/package/@thi.ng/math)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/math.svg)
@@ -12,7 +12,7 @@ This project is part of the
 For the Clojure version, please visit: [thi.ng/math-clj](https://thi.ng/math-clj)
 
 - [About](#about)
-  - [Status](#status)
+- [Status](#status)
   - [Breaking changes in v4.0.0](#breaking-changes-in-v400)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
@@ -32,7 +32,7 @@ Partially ported from Clojure version
 [c.thi.ng](https://github.com/thi-ng/c-thing) and
 [thi.ng/vexed-generation](https://github.com/thi-ng/vexed-generation).
 
-### Status
+## Status
 
 **STABLE** - used in production
 
@@ -95,6 +95,7 @@ A selection:
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/scenegraph.png" width="240"/>            | 2D scenegraph & shape picking                                          | [Demo](https://demo.thi.ng/umbrella/scenegraph/)            | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/scenegraph)            |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/scenegraph-image.png" width="240"/>      | 2D scenegraph & image map based geometry manipulation                  | [Demo](https://demo.thi.ng/umbrella/scenegraph-image/)      | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/scenegraph-image)      |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/svg-barchart.png" width="240"/>          | Simplistic SVG bar chart component                                     | [Demo](https://demo.thi.ng/umbrella/svg-barchart/)          | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/svg-barchart)          |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/svg-resample.png" width="240"/>          | SVG path parsing & dynamic resampling                                  | [Demo](https://demo.thi.ng/umbrella/svg-resample/)          | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/svg-resample)          |
 
 ## API
 

package/fit.d.ts

@@ -8,9 +8,52 @@ import type { FnN3, FnN5 } from "@thi.ng/api";
  * @param b -
  */
 export declare const norm: FnN3;
+/**
+ * Returns a number in the `[c,d]` interval which is relative to `x` in the
+ * `[a,b]` interval. **No** clamping will be performed if `x` lies outside the
+ * original range (for that use {@link fitClamped} instead).
+ *
+ * @param x
+ * @param a
+ * @param b
+ * @param c
+ * @param d
+ */
 export declare const fit: FnN5;
+/**
+ * Clamped version of {@link fit}, i.e. before mapping `x` into the target
+ * interval `[c,d]`, it will be clamped to the source interval `[a,b]`.
+ *
+ * @param x
+ * @param a
+ * @param b
+ * @param c
+ * @param d
+ */
 export declare const fitClamped: FnN5;
+/**
+ * Similar to {@link fitClamped}, assuming [0,1] as source interval.
+ *
+ * @param x
+ * @param a
+ * @param b
+ */
 export declare const fit01: FnN3;
+/**
+ * Similar to {@link fitClamped}, assuming the reverse ordered [1,0] as source
+ * interval.
+ *
+ * @param x
+ * @param a
+ * @param b
+ */
 export declare const fit10: FnN3;
+/**
+ * Similar to {@link fitClamped}, assuming [-1,1] as source interval.
+ *
+ * @param x
+ * @param a
+ * @param b
+ */
 export declare const fit11: FnN3;
 //# sourceMappingURL=fit.d.ts.map

package/fit.js

@@ -8,8 +8,51 @@ import { clamp01, clamp11 } from "./interval.js";
  * @param b -
  */
 export const norm = (x, a, b) => (b !== a ? (x - a) / (b - a) : 0);
+/**
+ * Returns a number in the `[c,d]` interval which is relative to `x` in the
+ * `[a,b]` interval. **No** clamping will be performed if `x` lies outside the
+ * original range (for that use {@link fitClamped} instead).
+ *
+ * @param x
+ * @param a
+ * @param b
+ * @param c
+ * @param d
+ */
 export const fit = (x, a, b, c, d) => c + (d - c) * norm(x, a, b);
+/**
+ * Clamped version of {@link fit}, i.e. before mapping `x` into the target
+ * interval `[c,d]`, it will be clamped to the source interval `[a,b]`.
+ *
+ * @param x
+ * @param a
+ * @param b
+ * @param c
+ * @param d
+ */
 export const fitClamped = (x, a, b, c, d) => c + (d - c) * clamp01(norm(x, a, b));
+/**
+ * Similar to {@link fitClamped}, assuming [0,1] as source interval.
+ *
+ * @param x
+ * @param a
+ * @param b
+ */
 export const fit01 = (x, a, b) => a + (b - a) * clamp01(x);
+/**
+ * Similar to {@link fitClamped}, assuming the reverse ordered [1,0] as source
+ * interval.
+ *
+ * @param x
+ * @param a
+ * @param b
+ */
 export const fit10 = (x, a, b) => b + (a - b) * clamp01(x);
+/**
+ * Similar to {@link fitClamped}, assuming [-1,1] as source interval.
+ *
+ * @param x
+ * @param a
+ * @param b
+ */
 export const fit11 = (x, a, b) => a + (b - a) * (0.5 + 0.5 * clamp11(x));

package/mix.d.ts

@@ -27,7 +27,24 @@ export declare const mix: FnN3;
  * @param v - 2nd interpolation factor
  */
 export declare const mixBilinear: FnN6;
+/**
+ * Computes quadratic bezier interpolation for normalized value `t`.
+ *
+ * @param a
+ * @param b
+ * @param c
+ * @param t
+ */
 export declare const mixQuadratic: FnN4;
+/**
+ * Computes cubic bezier interpolation for normalized value `t`.
+ *
+ * @param a
+ * @param b
+ * @param c
+ * @param d
+ * @param t
+ */
 export declare const mixCubic: FnN5;
 /**
  * Returns hermite interpolation of `a, b, c, d` at normalized position

package/mix.js

@@ -31,10 +31,27 @@ export const mixBilinear = (a, b, c, d, u, v) => {
     const iv = 1 - v;
     return a * iu * iv + b * u * iv + c * iu * v + d * u * v;
 };
+/**
+ * Computes quadratic bezier interpolation for normalized value `t`.
+ *
+ * @param a
+ * @param b
+ * @param c
+ * @param t
+ */
 export const mixQuadratic = (a, b, c, t) => {
     const s = 1 - t;
     return a * s * s + b * 2 * s * t + c * t * t;
 };
+/**
+ * Computes cubic bezier interpolation for normalized value `t`.
+ *
+ * @param a
+ * @param b
+ * @param c
+ * @param d
+ * @param t
+ */
 export const mixCubic = (a, b, c, d, t) => {
     const t2 = t * t;
     const s = 1 - t;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.3.7",
+  "version": "5.3.9",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -34,15 +34,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.4.1"
+    "@thi.ng/api": "^8.4.2"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.25.0",
-    "@thi.ng/testament": "^0.2.12",
+    "@microsoft/api-extractor": "^7.31.1",
+    "@thi.ng/testament": "^0.3.0",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.22.17",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.3"
   },
   "keywords": [
     "animation",
@@ -132,5 +132,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "be8423e2019e95c14a096260a93b9762dde0c768\n"
+  "gitHead": "f4c59114f2d2dfafa9014626038a9ec5242b0606\n"
 }