@thi.ng/distance 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-05-28T09:56:37Z
+- **Last updated**: 2023-06-09T12:24:57Z
 - **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.
 
+## [2.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/distance@2.4.0) (2023-06-09)
+
+#### 🚀 Features
+
+- add INeighborhood.includesPosition() ([2018e41](https://github.com/thi-ng/umbrella/commit/2018e41))
+  - update all impls: Nearest/KNearest/Radial
+
 ## [2.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/distance@2.3.0) (2023-05-28)
 
 #### 🚀 Features

package/api.d.ts

@@ -51,6 +51,13 @@ export interface INeighborhood<P, T> extends IReset {
      * @param eucledian -
      */
     includesDistance(d: number, eucledian?: boolean): boolean;
+    /**
+     * Computes distance metric between `pos` and this neighborhood's target
+     * pos. Returns true if result is <= current radius.
+     *
+     * @param pos
+     */
+    includesPosition(pos: P): boolean;
     /**
      * Computes distance metric between `pos` and this neighborhood's target
      * pos. If result distance is <= current radius, adds `val` to neighborhood

package/knearest.d.ts

@@ -62,6 +62,7 @@ export declare class KNearest<D, T> implements INeighborhood<D, T>, IDeref<Neigh
      */
     values(): T[];
     includesDistance(d: number, eucledian?: boolean): boolean;
+    includesPosition(pos: D): boolean;
     consider(pos: D, val: T): number;
 }
 /**

package/knearest.js

@@ -85,6 +85,9 @@ export class KNearest {
     includesDistance(d, eucledian = true) {
         return (eucledian ? this.dist.to(d) : d) <= this._currR;
     }
+    includesPosition(pos) {
+        return this.dist.metric(this.target, pos) < this._currR;
+    }
     consider(pos, val) {
         const d = this.dist.metric(this.target, pos);
         if (d <= this._currR) {

package/nearest.d.ts

@@ -23,6 +23,7 @@ export declare class Nearest<D, T> implements INeighborhood<D, T>, IDeref<Neighb
      */
     deref(): Neighbor<T> | undefined;
     includesDistance(d: number, eucledian?: boolean): boolean;
+    includesPosition(pos: D): boolean;
     consider(pos: D, val: T): number;
 }
 /**

package/nearest.js

@@ -32,6 +32,9 @@ export class Nearest {
     includesDistance(d, eucledian = true) {
         return (eucledian ? this.dist.to(d) : d) <= this._currR;
     }
+    includesPosition(pos) {
+        return this.dist.metric(this.target, pos) < this._currR;
+    }
     consider(pos, val) {
         const d = this.dist.metric(this.target, pos);
         if (d <= this._currR) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/distance",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "N-dimensional distance metrics & K-nearest neighborhoods for point queries",
   "type": "module",
   "module": "./index.js",
@@ -112,5 +112,5 @@
     ],
     "year": 2021
   },
-  "gitHead": "065e40c90123541fcb126b825a07f84975431fb6\n"
+  "gitHead": "31076ef846f8ddd076c7968aca8d6d5f5b9b9465\n"
 }

package/radial.d.ts

@@ -51,6 +51,7 @@ export declare class Radial<D, T> implements INeighborhood<D, T>, IDeref<Neighbo
      */
     values(): T[];
     includesDistance(d: number, eucledian?: boolean): boolean;
+    includesPosition(pos: D): boolean;
     consider(pos: D, val: T): number;
 }
 /**
@@ -82,7 +83,7 @@ export declare const radial2: <T>(p: ReadonlyVec, r?: number, dist?: import("./s
  */
 export declare const radial3: <T>(p: ReadonlyVec, r?: number, dist?: import("./squared.js").Squared<ReadonlyVec>) => Radial<ReadonlyVec, T>;
 /**
- * Defines a {@link KNearest} instance for numeric positions and, by default,
+ * Defines a {@link Radial} instance for numeric positions and, by default,
  * using an infinite region radius and {@link DIST_SQ1} distance metric.
  *
  * @param p -

package/radial.js

@@ -66,6 +66,9 @@ export class Radial {
     includesDistance(d, eucledian = true) {
         return (eucledian ? this.dist.to(d) : d) <= this._r;
     }
+    includesPosition(pos) {
+        return this.dist.metric(this.target, pos) < this._r;
+    }
     consider(pos, val) {
         const d = this.dist.metric(this.target, pos);
         if (d <= this._r) {
@@ -103,7 +106,7 @@ export const radial2 = (p, r, dist = DIST_SQ2) => new Radial(dist, p, r);
  */
 export const radial3 = (p, r, dist = DIST_SQ3) => new Radial(dist, p, r);
 /**
- * Defines a {@link KNearest} instance for numeric positions and, by default,
+ * Defines a {@link Radial} instance for numeric positions and, by default,
  * using an infinite region radius and {@link DIST_SQ1} distance metric.
  *
  * @param p -