@thi.ng/timestep 0.4.22 → 0.5.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-10-23T07:37:37Z
+- **Last updated**: 2023-10-30T14:31:56Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ 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.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/timestep@0.5.0) (2023-10-27)
+
+#### 🚀 Features
+
+- update VectorState, add VecAPI support ([f0aeb7e](https://github.com/thi-ng/umbrella/commit/f0aeb7e))
+  - update VectorState ctor & defVector() args
+
 ### [0.4.2](https://github.com/thi-ng/umbrella/tree/@thi.ng/timestep@0.4.2) (2023-08-04)
 
 #### ♻️ Refactoring

package/README.md

@@ -13,8 +13,10 @@ This project is part of the
 - [About](#about)
   - [Managing fixed timestep updates](#managing-fixed-timestep-updates)
 - [Status](#status)
+- [Related packages](#related-packages)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
 - [API](#api)
 - [Authors](#authors)
 - [License](#license)
@@ -132,6 +134,10 @@ after 1 second (25 frames)...
 
 [Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Btimestep%5D+in%3Atitle)
 
+## Related packages
+
+- [@thi.ng/boids](https://github.com/thi-ng/umbrella/tree/develop/packages/boids) - n-dimensional boids simulation with highly configurable behaviors
+
 ## Installation
 
 ```bash
@@ -152,7 +158,7 @@ For Node.js REPL:
 const timestep = await import("@thi.ng/timestep");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 816 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 821 bytes
 
 ## Dependencies
 
@@ -160,6 +166,16 @@ Package sizes (brotli'd, pre-treeshake): ESM: 816 bytes
 - [@thi.ng/math](https://github.com/thi-ng/umbrella/tree/develop/packages/math)
 - [@thi.ng/vectors](https://github.com/thi-ng/umbrella/tree/develop/packages/vectors)
 
+## Usage examples
+
+One project in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
+directory is using this package:
+
+| Screenshot                                                                                                         | Description                                                    | Live demo                                         | Source                                                                         |
+|:-------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:--------------------------------------------------|:-------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/boid-basics.png" width="240"/> | Basic 2D boid simulation and spatial indexing neighbor lookups | [Demo](https://demo.thi.ng/umbrella/boid-basics/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/boid-basics) |
+
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/timestep/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/timestep",
-  "version": "0.4.22",
+  "version": "0.5.1",
   "description": "Deterministic fixed timestep simulation updates with state interpolation",
   "type": "module",
   "module": "./index.js",
@@ -35,8 +35,8 @@
   },
   "dependencies": {
     "@thi.ng/api": "^8.9.6",
-    "@thi.ng/math": "^5.6.3",
-    "@thi.ng/vectors": "^7.7.22"
+    "@thi.ng/math": "^5.7.1",
+    "@thi.ng/vectors": "^7.8.1"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.38.0",
@@ -85,8 +85,11 @@
     }
   },
   "thi.ng": {
+    "related": [
+      "boids"
+    ],
     "status": "alpha",
     "year": 2023
   },
-  "gitHead": "fc6e14052ed24bf9196896980ceb9f398b6ea6c1\n"
+  "gitHead": "bfa16829786146bd24df3cdbd44649a45a603e44\n"
 }

package/state.d.ts

@@ -1,5 +1,5 @@
 import type { IDeref } from "@thi.ng/api";
-import type { ReadonlyVec, Vec, VecOpV, VecOpVVN } from "@thi.ng/vectors";
+import type { ReadonlyVec, Vec, VecAPI, VecOpV, VecOpVVN } from "@thi.ng/vectors";
 import type { ITimeStep, ReadonlyTimeStep, StateUpdate } from "./api.js";
 export declare class NumericState implements IDeref<number>, ITimeStep {
     value: number;
@@ -20,12 +20,12 @@ export declare class NumericState implements IDeref<number>, ITimeStep {
 }
 export declare class VectorState implements IDeref<ReadonlyVec>, ITimeStep {
     value: Vec;
-    setFn: VecOpV;
-    mixFn: VecOpVVN;
     update: StateUpdate<ReadonlyVec>;
     prev: Vec;
     curr: Vec;
-    constructor(value: Vec, setFn: VecOpV, mixFn: VecOpVVN, update: StateUpdate<ReadonlyVec>);
+    setFn: VecOpV;
+    mixFn: VecOpVVN;
+    constructor(api: Pick<VecAPI, "set" | "mixN">, value: Vec, update: StateUpdate<ReadonlyVec>);
     deref(): ReadonlyVec;
     /**
      * Copies given vector to {@link VectorState.prev}, {@link VectorState.curr}
@@ -47,18 +47,21 @@ export declare class VectorState implements IDeref<ReadonlyVec>, ITimeStep {
 export declare const defNumeric: (x: number, update: StateUpdate<number>) => NumericState;
 /**
  * Returns a new {@link VectorState} wrapper for given vector `v` (arbitrary
- * length) and its update function for use with {@link TimeStep.update}.
+ * length) and its update function for use with {@link TimeStep.update}. The
+ * `api` object is used to provide dedicated vector ops used internally.
  *
  * @remarks
- * **IMPORTANT:** The `update` function MUST manipulate the vector received as
- * 1st arg (which is {@link VectorState.curr}).
+ * **IMPORTANT:** The `update` function MUST update the vector received as 1st
+ * arg (which is {@link VectorState.curr}).
  *
- * Also see {@link defVector2}, {@link defVector3}, {@link defVector4}.
+ * Also see {@link defVector2}, {@link defVector3}, {@link defVector4} for
+ * pre-configured versions.
  *
- * @param x
+ * @param api
+ * @param v
  * @param update
  */
-export declare const defVector: (v: ReadonlyVec, update: StateUpdate<ReadonlyVec>) => VectorState;
+export declare const defVector: (api: Pick<VecAPI, "set" | "mixN">, v: ReadonlyVec, update: StateUpdate<ReadonlyVec>) => VectorState;
 /**
  * 2D optimized version of {@link defVector}.
  *

package/state.js

@@ -1,6 +1,6 @@
 import { mix } from "@thi.ng/math/mix";
-import { mixN, mixN2, mixN3, mixN4 } from "@thi.ng/vectors/mixn";
-import { set, set2, set3, set4 } from "@thi.ng/vectors/set";
+import { mixN2, mixN3, mixN4 } from "@thi.ng/vectors/mixn";
+import { set2, set3, set4 } from "@thi.ng/vectors/set";
 export class NumericState {
     constructor(value, update) {
         this.value = value;
@@ -28,13 +28,13 @@ export class NumericState {
     }
 }
 export class VectorState {
-    constructor(value, setFn, mixFn, update) {
+    constructor(api, value, update) {
         this.value = value;
-        this.setFn = setFn;
-        this.mixFn = mixFn;
         this.update = update;
-        this.prev = [...value];
-        this.curr = [...value];
+        this.setFn = api.set;
+        this.mixFn = api.mixN;
+        this.prev = this.setFn([], value);
+        this.curr = this.setFn([], value);
     }
     deref() {
         return this.value;
@@ -69,36 +69,39 @@ export class VectorState {
 export const defNumeric = (x, update) => new NumericState(x, update);
 /**
  * Returns a new {@link VectorState} wrapper for given vector `v` (arbitrary
- * length) and its update function for use with {@link TimeStep.update}.
+ * length) and its update function for use with {@link TimeStep.update}. The
+ * `api` object is used to provide dedicated vector ops used internally.
  *
  * @remarks
- * **IMPORTANT:** The `update` function MUST manipulate the vector received as
- * 1st arg (which is {@link VectorState.curr}).
+ * **IMPORTANT:** The `update` function MUST update the vector received as 1st
+ * arg (which is {@link VectorState.curr}).
  *
- * Also see {@link defVector2}, {@link defVector3}, {@link defVector4}.
+ * Also see {@link defVector2}, {@link defVector3}, {@link defVector4} for
+ * pre-configured versions.
  *
- * @param x
+ * @param api
+ * @param v
  * @param update
  */
-export const defVector = (v, update) => new VectorState(v, set, mixN, update);
+export const defVector = (api, v, update) => new VectorState(api, v, update);
 /**
  * 2D optimized version of {@link defVector}.
  *
  * @param v
  * @param update
  */
-export const defVector2 = (v, update) => new VectorState(v, set2, mixN2, update);
+export const defVector2 = (v, update) => new VectorState({ set: set2, mixN: mixN2 }, v, update);
 /**
  * 3D optimized version of {@link defVector}.
  *
  * @param v
  * @param update
  */
-export const defVector3 = (v, update) => new VectorState(v, set3, mixN3, update);
+export const defVector3 = (v, update) => new VectorState({ set: set3, mixN: mixN3 }, v, update);
 /**
  * 4D optimized version of {@link defVector}.
  *
  * @param v
  * @param update
  */
-export const defVector4 = (v, update) => new VectorState(v, set4, mixN4, update);
+export const defVector4 = (v, update) => new VectorState({ set: set4, mixN: mixN4 }, v, update);