@thi.ng/math 5.4.11 → 5.5.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-06-14T07:58:51Z
+- **Last updated**: 2023-08-04T10:58:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.5.0) (2023-07-14)
+
+#### 🚀 Features
+
+- add smoothStep01/smootherStep01() ([152f93c](https://github.com/thi-ng/umbrella/commit/152f93c))
+
 ### [5.4.4](https://github.com/thi-ng/umbrella/tree/@thi.ng/math@5.4.4) (2023-03-02)
 
 #### ♻️ Refactoring

package/README.md

@@ -66,7 +66,7 @@ For Node.js REPL:
 const math = await import("@thi.ng/math");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.03 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.04 KB
 
 ## Dependencies
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/math",
-  "version": "5.4.11",
+  "version": "5.5.1",
   "description": "Assorted common math functions & utilities",
   "type": "module",
   "module": "./index.js",
@@ -37,15 +37,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.8.2"
+    "@thi.ng/api": "^8.9.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.35.3",
-    "@thi.ng/testament": "^0.3.17",
+    "@microsoft/api-extractor": "^7.36.3",
+    "@thi.ng/testament": "^0.3.18",
     "rimraf": "^5.0.1",
     "tools": "^0.0.1",
     "typedoc": "^0.24.8",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.6"
   },
   "keywords": [
     "animation",
@@ -138,5 +138,5 @@
   "thi.ng": {
     "year": 2013
   },
-  "gitHead": "54e825a976c72067a244cff8725ca98f5416d26d\n"
+  "gitHead": "9fa3f7f8169efa30e3c71b43c82f77393581c3b5\n"
 }

package/step.d.ts

@@ -1,4 +1,4 @@
-import type { FnN2, FnN3 } from "@thi.ng/api";
+import type { FnN, FnN2, FnN3 } from "@thi.ng/api";
 /**
  * Step/threshold function.
  *
@@ -10,20 +10,40 @@ export declare const step: FnN2;
 /**
  * GLSL-style smoothStep threshold function.
  *
+ * @remarks
+ * Also see {@link smoothStep01}, {@link smootherStep}.
+ *
  * @param edge - lower threshold
  * @param edge2 - upper threshold
  * @param x - test value
  * @returns 0, if `x < edge1`, 1 if `x > edge2`, else S-curve polynomial interpolation
  */
 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.
+ *
+ * @param x
+ */
+export declare const smoothStep01: FnN;
 /**
  * Similar to {@link smoothStep} but using different, higher degree polynomial.
  *
+ * @remarks
+ * Also see {@link smootherStep01}.
+ *
  * @param edge -
  * @param edge2 -
  * @param x -
  */
 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.
+ *
+ * @param x
+ */
+export declare const smootherStep01: FnN;
 /**
  * Exponential ramp with variable shape
  *

package/step.js

@@ -10,26 +10,40 @@ export const step = (edge, x) => (x < edge ? 0 : 1);
 /**
  * GLSL-style smoothStep threshold function.
  *
+ * @remarks
+ * Also see {@link smoothStep01}, {@link smootherStep}.
+ *
  * @param edge - lower threshold
  * @param edge2 - upper threshold
  * @param x - test value
  * @returns 0, if `x < edge1`, 1 if `x > edge2`, else S-curve polynomial interpolation
  */
-export const smoothStep = (edge, edge2, x) => {
-    x = clamp01((x - edge) / (edge2 - edge));
-    return (3 - 2 * x) * x * x;
-};
+export const smoothStep = (edge, edge2, x) => smoothStep01(clamp01((x - edge) / (edge2 - edge)));
+/**
+ * Specialized version of {@link smoothStep}, assuming edges are 0/1
+ * respectively and `x` is in [0..1]. No clamping performed.
+ *
+ * @param x
+ */
+export const smoothStep01 = (x) => x * x * (3 - 2 * x);
 /**
  * Similar to {@link smoothStep} but using different, higher degree polynomial.
  *
+ * @remarks
+ * Also see {@link smootherStep01}.
+ *
  * @param edge -
  * @param edge2 -
  * @param x -
  */
-export const smootherStep = (edge, edge2, x) => {
-    x = clamp01((x - edge) / (edge2 - edge));
-    return x * x * x * (x * (x * 6 - 15) + 10);
-};
+export const smootherStep = (edge, edge2, x) => smootherStep01(clamp01((x - edge) / (edge2 - edge)));
+/**
+ * Specialized version of {@link smootherStep}, assuming edges are 0/1
+ * respectively and `x` is in [0..1]. No clamping performed.
+ *
+ * @param x
+ */
+export const smootherStep01 = (x) => x * x * x * (x * (x * 6 - 15) + 10);
 /**
  * Exponential ramp with variable shape
  *