@thi.ng/ramp 3.0.2 → 3.1.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-12T16:28:41Z
+- **Last updated**: 2024-02-19T16:07:07Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ 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.
 
+## [3.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/ramp@3.1.0) (2024-02-19)
+
+#### 🚀 Features
+
+- add minimal API presets for vector interpolations ([6dcb4b6](https://github.com/thi-ng/umbrella/commit/6dcb4b6))
+  - add VEC, VEC2/3/4 API presets
+  - add VecAPI interface
+  - update docs
+  - update pkg exports
+
 # [3.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/ramp@3.0.0) (2024-02-12)
 
 #### 🛑 Breaking changes

package/README.md

@@ -75,7 +75,7 @@ For Node.js REPL:
 const ramp = await import("@thi.ng/ramp");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.67 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.84 KB
 
 ## Dependencies
 
@@ -131,8 +131,8 @@ for(let i = 0; i <= 10; i++) {
 ### nD vectors
 
 ```ts tangle:export/readme-vector.ts
-import { HERMITE_V, ramp } from "@thi.ng/ramp";
-import { FORMATTER, VEC3 } from "@thi.ng/vectors";
+import { HERMITE_V, VEC3, ramp } from "@thi.ng/ramp";
+import { FORMATTER } from "@thi.ng/vectors";
 
 // use the generic `ramp()` factory function with a custom implementation
 // see: https://docs.thi.ng/umbrella/ramp/interfaces/RampImpl.html
@@ -178,8 +178,7 @@ for (let i = 0; i <= 20; i++) {
 ### Nested objects
 
 ```ts tangle:export/readme-nested.ts
-import { HERMITE_V, LINEAR_N, nested, ramp } from "@thi.ng/ramp";
-import { VEC2 } from "@thi.ng/vectors";
+import { HERMITE_V, LINEAR_N, VEC2, nested, ramp } from "@thi.ng/ramp";
 
 const r = ramp(
     nested({

package/api.d.ts

@@ -1,4 +1,5 @@
-import type { Fn2 } from "@thi.ng/api";
+import type { Fn, Fn2 } from "@thi.ng/api";
+import type { Vec, VecOpN, VecOpVV, VecOpVVN } from "@thi.ng/vectors";
 export type Frame<T> = [number, T];
 export interface RampImpl<T> {
     min: Fn2<T | null, T, T>;
@@ -70,4 +71,14 @@ export interface RampBounds<T> {
     maxT: number;
 }
 export type RampDomain = (t: number, min: number, max: number) => number;
+/**
+ * Operations required for vector interpolations.
+ */
+export interface VecAPI {
+    min: VecOpVV;
+    max: VecOpVV;
+    mixN: VecOpVVN;
+    setN: VecOpN;
+    vecOf: Fn<number, Vec>;
+}
 //# sourceMappingURL=api.d.ts.map

package/hermite.d.ts

@@ -1,5 +1,5 @@
-import type { Vec, VecAPI } from "@thi.ng/vectors";
-import type { Frame, RampImpl, RampOpts } from "./api.js";
+import type { Vec } from "@thi.ng/vectors";
+import type { Frame, RampImpl, RampOpts, VecAPI } from "./api.js";
 import { Ramp } from "./ramp.js";
 /**
  * Syntax sugar for creating a numeric {@link Ramp} using the {@link HERMITE_N}
@@ -21,5 +21,11 @@ import { Ramp } from "./ramp.js";
  */
 export declare const hermite: (stops: Frame<number>[], opts?: Partial<RampOpts>) => Ramp<number>;
 export declare const HERMITE_N: RampImpl<number>;
+/**
+ * Vector version of {@link HERMITE_N}. Use with any of the supplied vector APIs:
+ * {@link VEC} (arbitrary size), {@link VEC2}, {@link VEC3} or {@link VEC4}.
+ *
+ * @param vec
+ */
 export declare const HERMITE_V: <T extends Vec>(vec: VecAPI) => RampImpl<T>;
 //# sourceMappingURL=hermite.d.ts.map

package/hermite.js

@@ -18,8 +18,8 @@ const HERMITE_N = {
   }
 };
 const HERMITE_V = (vec) => ({
-  min: (acc, x) => vec.min(acc, acc || vec.setN([], Infinity), x),
-  max: (acc, x) => vec.max(acc, acc || vec.setN([], -Infinity), x),
+  min: (acc, x) => vec.min(acc, acc || vec.vecOf(Infinity), x),
+  max: (acc, x) => vec.max(acc, acc || vec.vecOf(-Infinity), x),
   at: (stops, i, t) => {
     const n = stops.length - 1;
     const [, a] = stops[Math.max(i - 1, 0)];

package/index.d.ts

@@ -5,4 +5,5 @@ export * from "./hermite.js";
 export * from "./linear.js";
 export * from "./nested.js";
 export * from "./ramp.js";
+export * from "./vector.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -5,3 +5,4 @@ export * from "./hermite.js";
 export * from "./linear.js";
 export * from "./nested.js";
 export * from "./ramp.js";
+export * from "./vector.js";

package/linear.d.ts

@@ -1,5 +1,5 @@
-import type { Vec, VecAPI } from "@thi.ng/vectors";
-import type { Frame, RampImpl, RampOpts } from "./api.js";
+import type { Vec } from "@thi.ng/vectors";
+import type { Frame, RampImpl, RampOpts, VecAPI } from "./api.js";
 import { Ramp } from "./ramp.js";
 /**
  * Syntax sugar for creating a numeric {@link Ramp} using the {@link LINEAR_N}
@@ -14,5 +14,11 @@ import { Ramp } from "./ramp.js";
  */
 export declare const linear: (stops: Frame<number>[], opts?: Partial<RampOpts>) => Ramp<number>;
 export declare const LINEAR_N: RampImpl<number>;
+/**
+ * Vector version of {@link LINEAR_N}. Use with any of the supplied vector APIs:
+ * {@link VEC} (arbitrary size), {@link VEC2}, {@link VEC3} or {@link VEC4}.
+ *
+ * @param vec
+ */
 export declare const LINEAR_V: <T extends Vec>(vec: VecAPI) => RampImpl<T>;
 //# sourceMappingURL=linear.d.ts.map

package/linear.js

@@ -11,8 +11,8 @@ const LINEAR_N = {
   }
 };
 const LINEAR_V = (vec) => ({
-  min: (acc, x) => vec.min(acc, acc || vec.setN([], Infinity), x),
-  max: (acc, x) => vec.max(acc, acc || vec.setN([], -Infinity), x),
+  min: (acc, x) => vec.min(acc, acc || vec.vecOf(Infinity), x),
+  max: (acc, x) => vec.max(acc, acc || vec.vecOf(-Infinity), x),
   at: (stops, i, t) => {
     const a = stops[i];
     const b = stops[i + 1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/ramp",
-  "version": "3.0.2",
+  "version": "3.1.1",
   "description": "Extensible keyframe interpolation/tweening of arbitrary, nested types",
   "type": "module",
   "module": "./index.js",
@@ -35,13 +35,13 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.23",
-    "@thi.ng/arrays": "^2.7.20",
-    "@thi.ng/compare": "^2.2.19",
-    "@thi.ng/errors": "^2.4.16",
-    "@thi.ng/math": "^5.10.0",
-    "@thi.ng/transducers": "^8.9.2",
-    "@thi.ng/vectors": "^7.10.7"
+    "@thi.ng/api": "^8.9.24",
+    "@thi.ng/arrays": "^2.8.1",
+    "@thi.ng/compare": "^2.2.20",
+    "@thi.ng/errors": "^2.4.17",
+    "@thi.ng/math": "^5.10.1",
+    "@thi.ng/transducers": "^8.9.4",
+    "@thi.ng/vectors": "^7.10.9"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -109,10 +109,13 @@
     },
     "./ramp": {
       "default": "./ramp.js"
+    },
+    "./vector": {
+      "default": "./vector.js"
     }
   },
   "thi.ng": {
     "year": 2019
   },
-  "gitHead": "25ee18f7db6d03f0b76787267ab071d16df94888\n"
+  "gitHead": "2724c87ca41810f2112f9d8c3d6b90dfaeea876b\n"
 }

package/vector.d.ts

@@ -0,0 +1,6 @@
+import type { VecAPI } from "./api.js";
+export declare const VEC: (size: number) => VecAPI;
+export declare const VEC2: VecAPI;
+export declare const VEC3: VecAPI;
+export declare const VEC4: VecAPI;
+//# sourceMappingURL=vector.d.ts.map

package/vector.js

@@ -0,0 +1,39 @@
+import { max, max2, max3, max4 } from "@thi.ng/vectors/max";
+import { min, min2, min3, min4 } from "@thi.ng/vectors/min";
+import { mixN, mixN2, mixN3, mixN4 } from "@thi.ng/vectors/mixn";
+import { setN, setN2, setN3, setN4 } from "@thi.ng/vectors/setn";
+import { vecOf } from "@thi.ng/vectors/vec-of";
+const VEC = (size) => ({
+  min,
+  max,
+  mixN,
+  vecOf: (n) => vecOf(size, n),
+  setN
+});
+const VEC2 = {
+  min: min2,
+  max: max2,
+  mixN: mixN2,
+  setN: setN2,
+  vecOf: (x) => vecOf(2, x)
+};
+const VEC3 = {
+  min: min3,
+  max: max3,
+  mixN: mixN3,
+  setN: setN3,
+  vecOf: (x) => vecOf(3, x)
+};
+const VEC4 = {
+  min: min4,
+  max: max4,
+  mixN: mixN4,
+  setN: setN4,
+  vecOf: (x) => vecOf(4, x)
+};
+export {
+  VEC,
+  VEC2,
+  VEC3,
+  VEC4
+};