@thi.ng/math 5.10.1 → 5.10.3

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-19T16:07:07Z
+- **Last updated**: 2024-02-25T14:07:53Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -18,7 +18,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 189 standalone projects, maintained as part
+> This is one of 190 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/crossing.d.ts

@@ -4,7 +4,7 @@ import { type Crossing } from "./api.js";
  * Returns true if line A rises up over B.
  *
  * @example
- * ```ts
+ * ```text
  * b1  a2
  *   \/
  *   /\
@@ -21,7 +21,7 @@ export declare const isCrossOver: FnU4<number, boolean>;
  * Returns true if line A rises up over B.
  *
  * @example
- * ```ts
+ * ```text
  * a1  b2
  *   \/
  *   /\

package/mix.d.ts

@@ -11,7 +11,7 @@ export declare const mix: FnN3;
  * Bilinear interpolation of given values (`a`,`b`,`c`,`d`).
  *
  * @example
- * ```ts
+ * ```text
  * c    d
  * +----+
  * |    |
@@ -171,6 +171,27 @@ export declare const tangentDiff3: (prev: number, curr: number, next: number, ta
  * Returns function which takes normalized time (in [0,1] range) as single arg
  * and returns interpolated value.
  *
+ * @example
+ * ```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));
+ * // 100
+ * // 102
+ * // 108
+ * // 118
+ * // 132
+ * // 150
+ * // 168
+ * // 182
+ * // 192
+ * // 198
+ * // 200
+ * ```
+ *
  * @param f -
  * @param from -
  * @param to -
@@ -204,14 +225,18 @@ export declare const invCircular: FnN;
  * positive the lens has dilating characteristics and will spread values near
  * `pos` towards the edges.
  *
- * Also see {@link schlick} for an alternative approach.
+ * Also see {@link schlick} for an alternative approach and {@link tween} for
+ * reference to below example.
  *
  * @example
  * ```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));
  *
- * // or build tween function via `tween()`
+ * // or compose tween function via `tween()` & `partial()`
  * f = tween(partial(lens, 0.5, 1), 100, 400);
  *
  * f(t)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.10.1",
+  "version": "5.10.3",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -38,7 +38,7 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.24"
+    "@thi.ng/api": "^8.9.26"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -142,5 +142,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "2724c87ca41810f2112f9d8c3d6b90dfaeea876b\n"
+  "gitHead": "6e20f80dd9df1c8055ffa3c1e4d6f7598add0c0b\n"
 }