@thi.ng/boids 0.1.2 → 0.1.5

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-10-30T14:31:56Z
+- **Last updated**: 2023-11-09T10:28:18Z
 - **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.1.3](https://github.com/thi-ng/umbrella/tree/@thi.ng/boids@0.1.3) (2023-11-09)
+
+#### ♻️ Refactoring
+
+- update all tests (packages A-S) ([e3085e4](https://github.com/thi-ng/umbrella/commit/e3085e4))
+
 ## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/boids@0.1.0) (2023-10-27)
 
 #### 🚀 Features

package/README.md

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

package/boid.d.ts

@@ -17,8 +17,35 @@ export declare class Boid implements ITimeStep {
     protected tmpAlign: Vec;
     protected tmpCoh: Vec;
     constructor(accel: AHashGrid<Boid>, api: VecAPI, distance: IDistance<ReadonlyVec>, pos: Vec, vel: Vec, opts: Partial<BoidOpts>);
+    /**
+     * Integration step of the thi.ng/timestep update cycle. See
+     * [`ITimeStep`](https://docs.thi.ng/umbrella/timestep/interfaces/ITimeStep.html)
+     *
+     * @param dt
+     * @param ctx
+     */
     integrate(dt: number, ctx: ReadonlyTimeStep): void;
+    /**
+     * Interplation step of the thi.ng/timestep update cycle. See
+     * [`ITimeStep`](https://docs.thi.ng/umbrella/timestep/interfaces/ITimeStep.html)
+     *
+     * @param dt
+     * @param ctx
+     */
     interpolate(alpha: number, ctx: ReadonlyTimeStep): void;
+    /**
+     * Queries the spatial index for other boids in the current region, or if
+     * `pos` is given also moves the search region to new position before
+     * querying.
+     *
+     * @remarks
+     * IMPORTANT: The returned array will always contain the current boid itself
+     * too. Filtering has been left out here for performance reasons and is left
+     * to downstream code.
+     *
+     * @param r
+     * @param pos
+     */
     neighbors(r: number, pos?: Vec): Boid[];
     protected separate(): Vec;
     protected align(): Vec;
@@ -27,6 +54,24 @@ export declare class Boid implements ITimeStep {
     protected computeSteer(steer: Vec, num: number): Vec;
     protected limitSteer(steer: Vec): Vec;
 }
+/**
+ * Returns a new {@link Boid} instance configured to use optimized 2D vector
+ * operations.
+ *
+ * @param accel
+ * @param pos
+ * @param vel
+ * @param opts
+ */
 export declare const defBoid2: (accel: HashGrid2<Boid>, pos: Vec, vel: Vec, opts: Partial<BoidOpts>) => Boid;
+/**
+ * Returns a new {@link Boid} instance configured to use optimized 3D vector
+ * operations.
+ *
+ * @param accel
+ * @param pos
+ * @param vel
+ * @param opts
+ */
 export declare const defBoid3: (accel: HashGrid3<Boid>, pos: Vec, vel: Vec, opts: Partial<BoidOpts>) => Boid;
 //# sourceMappingURL=boid.d.ts.map

package/boid.js

@@ -7,12 +7,19 @@ import { VEC2 } from "@thi.ng/vectors/vec2-api";
 import { VEC3 } from "@thi.ng/vectors/vec3-api";
 import { Radial } from "./region.js";
 export class Boid {
+    accel;
+    api;
+    pos;
+    vel;
+    opts;
+    region;
+    cachedNeighbors;
+    tmpSep = [];
+    tmpAlign = [];
+    tmpCoh = [];
     constructor(accel, api, distance, pos, vel, opts) {
         this.accel = accel;
         this.api = api;
-        this.tmpSep = [];
-        this.tmpAlign = [];
-        this.tmpCoh = [];
         this.opts = {
             constrain: identity,
             maxSpeed: 10,
@@ -28,13 +35,40 @@ export class Boid {
         this.pos = defVector(api, pos, (pos, dt) => this.opts.constrain(api.maddN(pos, this.vel.curr, dt, pos)));
         this.region = new Radial(distance, pos, 1);
     }
+    /**
+     * Integration step of the thi.ng/timestep update cycle. See
+     * [`ITimeStep`](https://docs.thi.ng/umbrella/timestep/interfaces/ITimeStep.html)
+     *
+     * @param dt
+     * @param ctx
+     */
     integrate(dt, ctx) {
         this.cachedNeighbors = this.neighbors(this.opts.maxDist, this.pos.value);
         integrateAll(dt, ctx, this.vel, this.pos);
     }
+    /**
+     * Interplation step of the thi.ng/timestep update cycle. See
+     * [`ITimeStep`](https://docs.thi.ng/umbrella/timestep/interfaces/ITimeStep.html)
+     *
+     * @param dt
+     * @param ctx
+     */
     interpolate(alpha, ctx) {
         interpolateAll(alpha, ctx, this.vel, this.pos);
     }
+    /**
+     * Queries the spatial index for other boids in the current region, or if
+     * `pos` is given also moves the search region to new position before
+     * querying.
+     *
+     * @remarks
+     * IMPORTANT: The returned array will always contain the current boid itself
+     * too. Filtering has been left out here for performance reasons and is left
+     * to downstream code.
+     *
+     * @param r
+     * @param pos
+     */
     neighbors(r, pos) {
         const region = this.region;
         if (pos)
@@ -99,5 +133,23 @@ export class Boid {
             : steer;
     }
 }
+/**
+ * Returns a new {@link Boid} instance configured to use optimized 2D vector
+ * operations.
+ *
+ * @param accel
+ * @param pos
+ * @param vel
+ * @param opts
+ */
 export const defBoid2 = (accel, pos, vel, opts) => new Boid(accel, VEC2, DIST_SQ2, pos, vel, opts);
+/**
+ * Returns a new {@link Boid} instance configured to use optimized 3D vector
+ * operations.
+ *
+ * @param accel
+ * @param pos
+ * @param vel
+ * @param opts
+ */
 export const defBoid3 = (accel, pos, vel, opts) => new Boid(accel, VEC3, DIST_SQ3, pos, vel, opts);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/boids",
-  "version": "0.1.2",
+  "version": "0.1.5",
   "description": "n-dimensional boids simulation with highly configurable behaviors",
   "type": "module",
   "module": "./index.js",
@@ -28,24 +28,23 @@
     "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
-    "doc:readme": "yarn doc:stats && tools:readme",
-    "doc:stats": "tools:module-stats",
+    "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
-    "test": "testament test"
+    "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.6",
-    "@thi.ng/distance": "^2.4.27",
-    "@thi.ng/geom-accel": "^3.5.27",
-    "@thi.ng/timestep": "^0.5.2",
-    "@thi.ng/vectors": "^7.8.2"
+    "@thi.ng/api": "^8.9.8",
+    "@thi.ng/distance": "^2.4.30",
+    "@thi.ng/geom-accel": "^3.5.30",
+    "@thi.ng/timestep": "^0.5.5",
+    "@thi.ng/vectors": "^7.8.5"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.38.0",
-    "@thi.ng/testament": "^0.3.24",
+    "@microsoft/api-extractor": "^7.38.2",
+    "@thi.ng/testament": "^0.4.1",
     "rimraf": "^5.0.5",
     "tools": "^0.0.1",
-    "typedoc": "^0.25.2",
+    "typedoc": "^0.25.3",
     "typescript": "^5.2.2"
   },
   "keywords": [
@@ -91,5 +90,5 @@
     "status": "alpha",
     "year": 2023
   },
-  "gitHead": "336bd1bf95825b3c318a3ab49c54451c94aaa883\n"
+  "gitHead": "2be4c38c9680da929339bd164acfb69ebb1fd3d0\n"
 }

package/region.js

@@ -7,11 +7,15 @@ import {} from "@thi.ng/api";
  * @internal
  */
 export class Radial {
+    dist;
+    target;
+    radius;
+    _r;
+    _items = [];
     constructor(dist, target, radius = Infinity) {
         this.dist = dist;
         this.target = target;
         this.radius = radius;
-        this._items = [];
         this.setRadius(radius);
     }
     deref() {