@thi.ng/shader-ast-stdlib 0.14.18 → 0.14.20

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-08-27T11:20:59Z
+- **Last updated**: 2023-10-24T08:38:23Z
 - **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.
 
+### [0.14.20](https://github.com/thi-ng/umbrella/tree/@thi.ng/shader-ast-stdlib@0.14.20) (2023-10-24)
+
+#### ♻️ Refactoring
+
+- use hoc function to define easing functions ([2b2c451](https://github.com/thi-ng/umbrella/commit/2b2c451))
+
 ## [0.14.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/shader-ast-stdlib@0.14.0) (2023-07-14)
 
 #### 🚀 Features

package/README.md

@@ -27,6 +27,7 @@ This project is part of the
   - [Fog](#fog)
   - [Lighting](#lighting)
   - [Math](#math)
+  - [Easing functions](#easing-functions)
   - [Oscillators](#oscillators)
   - [Matrix operations](#matrix-operations)
   - [Noise / randomness](#noise--randomness)
@@ -102,7 +103,7 @@ For Node.js REPL:
 const shaderAstStdlib = await import("@thi.ng/shader-ast-stdlib");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 11.82 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 12.62 KB
 
 ## Dependencies
 
@@ -391,6 +392,21 @@ for reference.
 - `smootherStep` / `smootherStep2` / `smootherStep3` / `smootherStep4`
 - `smootherStep01` / `smootherStep01_2` / `smootherStep01_3` / `smootherStep01_4`
 
+### Easing functions
+
+[/src/math/easing.ts](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/math/easing.ts)
+
+- `easeInBack` / `easeOutBack` / `easeInOutBack`
+- `easeInBounce` / `easeOutBounce` / `easeInOutBounce`
+- `easeInCirc` / `easeOutCirc` / `easeInOutCirc`
+- `easeInCubic` / `easeOutCubic` / `easeInOutCubic`
+- `easeInElastic` / `easeOutElastic` / `easeInOutElastic`
+- `easeInExpo` / `easeOutExpo` / `easeInOutExpo`
+- `easeInQuad` / `easeOutQuad` / `easeInOutQuad`
+- `easeInQuart` / `easeOutQuart` / `easeInOutQuart`
+- `easeInQuint` / `easeOutQuint` / `easeInOutQuint`
+- `easeInSine` / `easeOutSine` / `easeInOutSine`
+
 ### Oscillators
 
 [/src/math](https://github.com/thi-ng/umbrella/tree/develop/packages/shader-ast-stdlib/src/math/osc.ts)
@@ -491,14 +507,15 @@ for reference.
 
 ## Authors
 
-- [Karsten Schmidt](https://thi.ng)
+- [Karsten Schmidt](https://thi.ng) (Main author)
+- [Yury Hantsouski](https://github.com/Hantsouski)
 
 If this project contributes to an academic publication, please cite it as:
 
 ```bibtex
 @misc{thing-shader-ast-stdlib,
   title = "@thi.ng/shader-ast-stdlib",
-  author = "Karsten Schmidt",
+  author = "Karsten Schmidt and others",
   note = "https://thi.ng/shader-ast-stdlib",
   year = 2019
 }

package/index.d.ts

@@ -27,6 +27,7 @@ export * from "./math/osc.js";
 export * from "./math/polar.js";
 export * from "./math/sincos.js";
 export * from "./math/smoother-step.js";
+export * from "./math/easing.js";
 export * from "./matrix/lookat.js";
 export * from "./matrix/mvp.js";
 export * from "./matrix/normal.js";

package/index.js

@@ -27,6 +27,7 @@ export * from "./math/osc.js";
 export * from "./math/polar.js";
 export * from "./math/sincos.js";
 export * from "./math/smoother-step.js";
+export * from "./math/easing.js";
 export * from "./matrix/lookat.js";
 export * from "./matrix/mvp.js";
 export * from "./matrix/normal.js";

package/math/easing.d.ts

@@ -0,0 +1,39 @@
+import type { FnBody1 } from "@thi.ng/shader-ast";
+/**
+ * Higher order helper function to wrap a given easing function body as proper
+ * shader-ast function.
+ *
+ * @param body
+ */
+export declare const defEasing: (body: FnBody1<"float">) => import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInSine: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutSine: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutSine: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInQuad: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutQuad: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutQuad: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInCubic: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutCubic: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutCubic: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInQuart: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutQuart: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutQuart: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInQuint: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutQuint: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutQuint: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInExpo: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutExpo: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutExpo: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInCirc: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutCirc: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutCirc: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInBack: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutBack: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutBack: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInElastic: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutElastic: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutElastic: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeOutBounce: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInBounce: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+export declare const easeInOutBounce: import("@thi.ng/shader-ast").TaggedFn1<"float", "float">;
+//# sourceMappingURL=easing.d.ts.map

package/math/easing.js

@@ -0,0 +1,117 @@
+import { F } from "@thi.ng/shader-ast/api/types";
+import { ifThen, ternary } from "@thi.ng/shader-ast/ast/controlflow";
+import { defn, ret } from "@thi.ng/shader-ast/ast/function";
+import { FLOAT0, FLOAT05, FLOAT1, FLOAT2, HALF_PI, PI, TAU, float, } from "@thi.ng/shader-ast/ast/lit";
+import { add, div, eq, gte, lt, lte, madd, mul, neg, reciprocal, sub, } from "@thi.ng/shader-ast/ast/ops";
+import { cos, exp2, pow, sin, sqrt } from "@thi.ng/shader-ast/builtin/math";
+/**
+ * Higher order helper function to wrap a given easing function body as proper
+ * shader-ast function.
+ *
+ * @param body
+ */
+export const defEasing = (body) => defn(F, null, [F], body);
+export const easeInSine = defEasing((x) => [
+    ret(sub(FLOAT1, cos(mul(x, HALF_PI)))),
+]);
+export const easeOutSine = defEasing((x) => [ret(sin(mul(x, HALF_PI)))]);
+export const easeInOutSine = defEasing((x) => [
+    ret(div(neg(sub(cos(mul(PI, x)), FLOAT1)), FLOAT2)),
+]);
+export const easeInQuad = defEasing((x) => [ret(pow(x, FLOAT2))]);
+export const easeOutQuad = defEasing((x) => [
+    ret(sub(FLOAT1, pow(sub(FLOAT1, x), FLOAT2))),
+]);
+export const easeInOutQuad = defEasing((x) => [
+    ret(ternary(lt(x, FLOAT05), mul(FLOAT2, pow(x, FLOAT2)), sub(FLOAT1, div(pow(madd(neg(FLOAT2), x, FLOAT2), FLOAT2), FLOAT2)))),
+]);
+export const easeInCubic = defEasing((x) => [ret(pow(x, float(3)))]);
+export const easeOutCubic = defEasing((x) => [
+    ret(sub(FLOAT1, pow(sub(FLOAT1, x), float(3)))),
+]);
+export const easeInOutCubic = defEasing((x) => [
+    ret(ternary(lt(x, FLOAT05), mul(float(4), pow(x, float(3))), sub(FLOAT1, div(pow(madd(neg(FLOAT2), x, FLOAT2), float(3)), FLOAT2)))),
+]);
+export const easeInQuart = defEasing((x) => [ret(pow(x, float(4)))]);
+export const easeOutQuart = defEasing((x) => [
+    ret(sub(FLOAT1, pow(sub(FLOAT1, x), float(4)))),
+]);
+export const easeInOutQuart = defEasing((x) => [
+    ret(ternary(lt(x, FLOAT05), mul(float(8), pow(x, float(4))), sub(FLOAT1, div(pow(madd(neg(FLOAT2), x, FLOAT2), float(4)), FLOAT2)))),
+]);
+export const easeInQuint = defEasing((x) => [ret(pow(x, float(5)))]);
+export const easeOutQuint = defEasing((x) => [
+    ret(sub(FLOAT1, pow(sub(FLOAT1, x), float(5)))),
+]);
+export const easeInOutQuint = defEasing((x) => [
+    ret(ternary(lt(x, FLOAT05), mul(float(16), pow(x, float(5))), sub(FLOAT1, div(pow(madd(neg(FLOAT2), x, FLOAT2), float(5)), FLOAT2)))),
+]);
+export const easeInExpo = defEasing((x) => [
+    ret(ternary(eq(x, FLOAT0), FLOAT0, exp2(sub(mul(float(10), x), float(10))))),
+]);
+export const easeOutExpo = defEasing((x) => [
+    ret(ternary(eq(x, FLOAT1), FLOAT1, sub(FLOAT1, exp2(mul(neg(float(10)), x))))),
+]);
+export const easeInOutExpo = defEasing((x) => [
+    ret(ternary(eq(x, FLOAT0), FLOAT0, ternary(eq(x, FLOAT1), FLOAT1, ternary(lt(x, FLOAT05), div(exp2(sub(mul(float(20), x), float(10))), FLOAT2), div(sub(FLOAT2, exp2(madd(neg(float(20)), x, float(10)))), FLOAT2))))),
+]);
+export const easeInCirc = defEasing((x) => [
+    ret(sub(FLOAT1, sqrt(sub(FLOAT1, pow(x, FLOAT2))))),
+]);
+export const easeOutCirc = defEasing((x) => [
+    ret(sqrt(sub(FLOAT1, pow(sub(x, FLOAT1), FLOAT2)))),
+]);
+export const easeInOutCirc = defEasing((x) => [
+    ret(ternary(lt(x, FLOAT05), div(sub(FLOAT1, sqrt(sub(FLOAT1, pow(mul(FLOAT2, x), FLOAT2)))), FLOAT2), div(add(sqrt(sub(FLOAT1, pow(madd(neg(FLOAT2), x, FLOAT2), FLOAT2))), FLOAT1), FLOAT2))),
+]);
+export const easeInBack = defEasing((x) => {
+    const c1 = 1.70158;
+    const c3 = c1 + 1;
+    return [ret(sub(mul(c3, pow(x, float(3))), mul(c1, pow(x, FLOAT2))))];
+});
+export const easeOutBack = defEasing((x) => {
+    const c1 = 1.70158;
+    const c3 = c1 + 1;
+    return [
+        ret(add(madd(float(c3), pow(sub(x, FLOAT1), float(3)), FLOAT1), mul(c1, pow(sub(x, FLOAT1), FLOAT2)))),
+    ];
+});
+export const easeInOutBack = defEasing((x) => {
+    const c1 = 1.70158;
+    const c2 = c1 * 1.525;
+    return [
+        ret(ternary(lt(x, FLOAT05), div(mul(pow(mul(FLOAT2, x), FLOAT2), sub(mul(mul(add(c2, FLOAT1), FLOAT2), x), c2)), FLOAT2), div(add(mul(pow(sub(mul(FLOAT2, x), FLOAT2), FLOAT2), add(mul(add(c2, FLOAT1), sub(mul(x, FLOAT2), FLOAT2)), c2)), FLOAT2), FLOAT2))),
+    ];
+});
+export const easeInElastic = defEasing((x) => [
+    ret(ternary(eq(x, FLOAT0), FLOAT0, ternary(eq(x, FLOAT1), FLOAT1, mul(neg(exp2(sub(mul(10, x), 10))), sin(mul(sub(mul(x, 10), 10.75), div(TAU, 3))))))),
+]);
+export const easeOutElastic = defEasing((x) => [
+    ret(ternary(lte(x, FLOAT0), FLOAT0, ternary(gte(x, FLOAT1), FLOAT1, madd(exp2(mul(-10, x)), sin(mul(sub(mul(x, 10), 0.75), div(TAU, 3))), FLOAT1)))),
+]);
+export const easeInOutElastic = defEasing((x) => {
+    const c5 = div(TAU, 4.5);
+    return [
+        ret(ternary(eq(x, FLOAT0), FLOAT0, ternary(eq(x, FLOAT1), FLOAT1, ternary(lt(x, FLOAT05), div(neg(mul(exp2(sub(mul(20, x), 10)), sin(mul(sub(mul(20, x), 11.125), c5)))), FLOAT2), add(div(mul(exp2(madd(neg(float(20)), x, float(10))), sin(mul(sub(mul(20, x), 11.125), c5))), FLOAT2), FLOAT1))))),
+    ];
+});
+export const easeOutBounce = defEasing((x) => {
+    const n1 = 7.5625;
+    const d1 = float(2.75);
+    return [
+        ifThen(lt(x, reciprocal(d1)), [ret(mul(n1, pow(x, FLOAT2)))]),
+        ifThen(lt(x, div(FLOAT2, d1)), [
+            ret(add(mul(mul(n1, sub(x, div(1.5, d1))), sub(x, div(1.5, d1))), 0.75)),
+        ]),
+        ifThen(lt(x, div(2.5, d1)), [
+            ret(add(mul(mul(n1, sub(x, div(2.25, d1))), sub(x, div(2.25, d1))), 0.9375)),
+        ]),
+        ret(add(mul(mul(n1, sub(x, div(2.625, d1))), sub(x, div(2.625, d1))), 0.984375)),
+    ];
+});
+export const easeInBounce = defEasing((x) => [
+    ret(sub(FLOAT1, easeOutBounce(sub(FLOAT1, x)))),
+]);
+export const easeInOutBounce = defEasing((x) => [
+    ret(ternary(lt(x, FLOAT05), div(sub(FLOAT1, easeOutBounce(sub(FLOAT1, mul(FLOAT2, x)))), FLOAT2), div(add(FLOAT1, easeOutBounce(sub(mul(FLOAT2, x), FLOAT1))), FLOAT2))),
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/shader-ast-stdlib",
-  "version": "0.14.18",
+  "version": "0.14.20",
   "description": "Function collection for modular GPGPU / shader programming with @thi.ng/shader-ast",
   "type": "module",
   "module": "./index.js",
@@ -22,6 +22,9 @@
     }
   ],
   "author": "Karsten Schmidt (https://thi.ng)",
+  "contributors": [
+    "Yury Hantsouski (https://github.com/Hantsouski)"
+  ],
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
@@ -34,15 +37,15 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.5",
-    "@thi.ng/shader-ast": "^0.12.72"
+    "@thi.ng/api": "^8.9.6",
+    "@thi.ng/shader-ast": "^0.12.74"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.36.4",
-    "@thi.ng/testament": "^0.3.23",
-    "rimraf": "^5.0.1",
+    "@microsoft/api-extractor": "^7.38.0",
+    "@thi.ng/testament": "^0.3.24",
+    "rimraf": "^5.0.5",
     "tools": "^0.0.1",
-    "typedoc": "^0.25.0",
+    "typedoc": "^0.25.2",
     "typescript": "^5.2.2"
   },
   "keywords": [
@@ -51,6 +54,7 @@
     "canvas",
     "codegen",
     "dsl",
+    "easing",
     "fog",
     "functional",
     "glsl",
@@ -149,6 +153,9 @@
     "./math/dist-manhattan": {
       "default": "./math/dist-manhattan.js"
     },
+    "./math/easing": {
+      "default": "./math/easing.js"
+    },
     "./math/fit": {
       "default": "./math/fit.js"
     },
@@ -333,5 +340,5 @@
     ],
     "year": 2019
   },
-  "gitHead": "46e445c09f2909d1aeaa9fdc8d8b3aa61c114db2\n"
+  "gitHead": "dc7eeaba72f3c3977f2d6cc201e595ed6d68e2ad\n"
 }