@thi.ng/distance 2.1.7 → 2.1.8

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-12-13T10:26:00Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -15,6 +15,7 @@ This project is part of the
     - [Nearest](#nearest)
     - [KNearest](#knearest)
   - [Status](#status)
+  - [Support packages](#support-packages)
   - [Related packages](#related-packages)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
@@ -90,6 +91,10 @@ structures provided by the
 [@thi.ng/geom-accel](https://github.com/thi-ng/umbrella/tree/develop/packages/geom-accel)
 package.
 
+### Support packages
+
+- [@thi.ng/distance-transform](https://github.com/thi-ng/umbrella/tree/develop/packages/distance-transform) - Binary image to Distance Field transformation
+
 ### Related packages
 
 - [@thi.ng/geom-accel](https://github.com/thi-ng/umbrella/tree/develop/packages/geom-accel) - n-D spatial indexing data structures with a shared ES6 Map/Set-like API
@@ -179,4 +184,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2021 Karsten Schmidt // Apache Software License 2.0
+© 2021 - 2022 Karsten Schmidt // Apache Software License 2.0

package/api.d.ts

@@ -18,13 +18,13 @@ export interface IDistance<T> {
     /**
      * Converts Eucledian distance `x` into the metric of this instance.
      *
-     * @param x
+     * @param x -
      */
     to(x: number): number;
     /**
      * Converts `x` from the metric of this instance into an Eucledian value.
      *
-     * @param x
+     * @param x -
      */
     from(x: number): number;
 }
@@ -47,8 +47,8 @@ export interface INeighborhood<P, T> extends IReset {
      * into the metric used by this neighborhood using {@link IDistance.to},
      * otherwise it is expected to be already in that metric space.
      *
-     * @param d
-     * @param eucledian
+     * @param d -
+     * @param eucledian -
      */
     includesDistance(d: number, eucledian?: boolean): boolean;
     /**
@@ -56,8 +56,8 @@ export interface INeighborhood<P, T> extends IReset {
      * pos. If result distance is <= current radius, adds `val` to neighborhood
      * and shrinks neighborhood radius to new distance. Returns distance metric.
      *
-     * @param pos
-     * @param val
+     * @param pos -
+     * @param val -
      */
     consider(pos: P, val: T): number;
 }

package/argmin.d.ts

@@ -11,9 +11,9 @@ import type { IDistance, Metric } from "./api.js";
  *
  * https://en.wikipedia.org/wiki/Arg_max#Arg_min
  *
- * @param p
- * @param samples
- * @param dist
+ * @param p -
+ * @param samples -
+ * @param dist -
  */
 export declare const argmin: (p: ReadonlyVec, samples: ReadonlyVec[], dist?: Metric<ReadonlyVec> | IDistance<ReadonlyVec>) => number;
 export declare const argminN: (p: number, samples: NumericArray, dist?: Metric<number> | IDistance<number>) => number;
@@ -26,28 +26,28 @@ export declare const argminN: (p: number, samples: NumericArray, dist?: Metric<n
  * @reference
  * Use {@link argmin} if all items are vectors already.
  *
- * @param p
- * @param samples
- * @param key
- * @param dist
+ * @param p -
+ * @param samples -
+ * @param key -
+ * @param dist -
  */
 export declare const argminT: <T>(p: T, samples: T[], key: Fn<T, ReadonlyVec>, dist?: Metric<ReadonlyVec> | IDistance<ReadonlyVec> | undefined) => number;
 /**
  * Similar to {@link argmin}, but for k-nearest queries.
  *
- * @param k
- * @param p
- * @param samples
- * @param dist
+ * @param k -
+ * @param p -
+ * @param samples -
+ * @param dist -
  */
 export declare const argminK: (k: number, p: ReadonlyVec, samples: ReadonlyVec[], dist?: IDistance<ReadonlyVec>) => number[];
 /**
  * Similar to {@link argminT}, but for k-nearest queries.
  *
- * @param k
- * @param p
- * @param samples
- * @param dist
+ * @param k -
+ * @param p -
+ * @param samples -
+ * @param dist -
  */
 export declare const argminKT: <T>(k: number, p: T, samples: T[], key: Fn<T, ReadonlyVec>, dist?: IDistance<ReadonlyVec> | undefined) => number[];
 //# sourceMappingURL=argmin.d.ts.map

package/argmin.js

@@ -11,9 +11,9 @@ import { DIST_SQ, DIST_SQ1 } from "./squared.js";
  *
  * https://en.wikipedia.org/wiki/Arg_max#Arg_min
  *
- * @param p
- * @param samples
- * @param dist
+ * @param p -
+ * @param samples -
+ * @param dist -
  */
 export const argmin = (p, samples, dist = DIST_SQ) => {
     const distFn = isFunction(dist) ? dist : dist.metric;
@@ -50,19 +50,19 @@ export const argminN = (p, samples, dist = DIST_SQ1) => {
  * @reference
  * Use {@link argmin} if all items are vectors already.
  *
- * @param p
- * @param samples
- * @param key
- * @param dist
+ * @param p -
+ * @param samples -
+ * @param key -
+ * @param dist -
  */
 export const argminT = (p, samples, key, dist) => argmin(key(p), samples.map(key), dist);
 /**
  * Similar to {@link argmin}, but for k-nearest queries.
  *
- * @param k
- * @param p
- * @param samples
- * @param dist
+ * @param k -
+ * @param p -
+ * @param samples -
+ * @param dist -
  */
 export const argminK = (k, p, samples, dist = DIST_SQ) => {
     const neighborhood = knearest(p, k, Infinity, dist);
@@ -74,9 +74,9 @@ export const argminK = (k, p, samples, dist = DIST_SQ) => {
 /**
  * Similar to {@link argminT}, but for k-nearest queries.
  *
- * @param k
- * @param p
- * @param samples
- * @param dist
+ * @param k -
+ * @param p -
+ * @param samples -
+ * @param dist -
  */
 export const argminKT = (k, p, samples, key, dist) => argminK(k, key(p), samples.map(key), dist);

package/knearest.d.ts

@@ -50,44 +50,44 @@ export declare class KNearest<D, T> implements INeighborhood<D, T>, IDeref<Neigh
  * and, by default, using an infinite region radius and {@link DIST_SQ} distance
  * metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export declare const knearest: <T>(p: ReadonlyVec, k: number, r?: number | undefined, dist?: import("./squared.js").Squared<ReadonlyVec>, sorted?: boolean | undefined) => KNearest<ReadonlyVec, T>;
 /**
  * Defines a {@link KNearest} instance for 2D vector positions and, by default,
  * using an infinite region radius and {@link DIST_SQ2} distance metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export declare const knearest2: <T>(p: ReadonlyVec, k: number, r?: number | undefined, dist?: import("./squared.js").Squared<ReadonlyVec>, sorted?: boolean | undefined) => KNearest<ReadonlyVec, T>;
 /**
  * Defines a {@link KNearest} instance for 3D vector positions, by default,
  * using an infinite region radius and {@link DIST_SQ3} distance metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export declare const knearest3: <T>(p: ReadonlyVec, k: number, r?: number | undefined, dist?: import("./squared.js").Squared<ReadonlyVec>, sorted?: boolean | undefined) => KNearest<ReadonlyVec, T>;
 /**
  * Defines a {@link KNearest} instance for numeric positions and, by default,
  * using an infinite region radius and {@link DIST_SQ1} distance metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export declare const knearestN: <T>(p: number, k: number, r?: number | undefined, dist?: import("./squared.js").Squared<number>, sorted?: boolean | undefined) => KNearest<number, T>;
 //# sourceMappingURL=knearest.d.ts.map

package/knearest.js

@@ -77,43 +77,43 @@ export class KNearest {
  * and, by default, using an infinite region radius and {@link DIST_SQ} distance
  * metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export const knearest = (p, k, r, dist = DIST_SQ, sorted) => new KNearest(dist, p, k, r, sorted);
 /**
  * Defines a {@link KNearest} instance for 2D vector positions and, by default,
  * using an infinite region radius and {@link DIST_SQ2} distance metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export const knearest2 = (p, k, r, dist = DIST_SQ2, sorted) => new KNearest(dist, p, k, r, sorted);
 /**
  * Defines a {@link KNearest} instance for 3D vector positions, by default,
  * using an infinite region radius and {@link DIST_SQ3} distance metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export const knearest3 = (p, k, r, dist = DIST_SQ3, sorted) => new KNearest(dist, p, k, r, sorted);
 /**
  * Defines a {@link KNearest} instance for numeric positions and, by default,
  * using an infinite region radius and {@link DIST_SQ1} distance metric.
  *
- * @param p
- * @param k
- * @param r
- * @param dist
- * @param sorted
+ * @param p -
+ * @param k -
+ * @param r -
+ * @param dist -
+ * @param sorted -
  */
 export const knearestN = (p, k, r, dist = DIST_SQ1, sorted) => new KNearest(dist, p, k, r, sorted);

package/nearest.d.ts

@@ -30,36 +30,36 @@ export declare class Nearest<D, T> implements INeighborhood<D, T>, IDeref<Neighb
  * default, using an infinite region radius and {@link DIST_SQ} distance
  * metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export declare const nearest: <T>(p: ReadonlyVec, r?: number | undefined, dist?: import("./squared.js").Squared<ReadonlyVec>) => Nearest<ReadonlyVec, T>;
 /**
  * Defines a {@link Nearest} instance for 2D vector positions, by default,
  * using an infinite region radius and {@link DIST_SQ2} distance metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export declare const nearest2: <T>(p: ReadonlyVec, r?: number | undefined, dist?: import("./squared.js").Squared<ReadonlyVec>) => Nearest<ReadonlyVec, T>;
 /**
  * Defines a {@link Nearest} instance for 3D vector positions, by default,
  * using an infinite region radius and {@link DIST_SQ3} distance metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export declare const nearest3: <T>(p: ReadonlyVec, r?: number | undefined, dist?: import("./squared.js").Squared<ReadonlyVec>) => Nearest<ReadonlyVec, T>;
 /**
  * Defines a {@link Nearest} instance for numeric positions and, by default,
  * using an infinite region radius and {@link DIST_SQ1} distance metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export declare const nearestN: <T>(p: number, r?: number | undefined, dist?: import("./squared.js").Squared<number>) => Nearest<number, T>;
 //# sourceMappingURL=nearest.d.ts.map

package/nearest.js

@@ -46,35 +46,35 @@ export class Nearest {
  * default, using an infinite region radius and {@link DIST_SQ} distance
  * metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export const nearest = (p, r, dist = DIST_SQ) => new Nearest(dist, p, r);
 /**
  * Defines a {@link Nearest} instance for 2D vector positions, by default,
  * using an infinite region radius and {@link DIST_SQ2} distance metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export const nearest2 = (p, r, dist = DIST_SQ2) => new Nearest(dist, p, r);
 /**
  * Defines a {@link Nearest} instance for 3D vector positions, by default,
  * using an infinite region radius and {@link DIST_SQ3} distance metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export const nearest3 = (p, r, dist = DIST_SQ3) => new Nearest(dist, p, r);
 /**
  * Defines a {@link Nearest} instance for numeric positions and, by default,
  * using an infinite region radius and {@link DIST_SQ1} distance metric.
  *
- * @param p
- * @param r
- * @param dist
+ * @param p -
+ * @param r -
+ * @param dist -
  */
 export const nearestN = (p, r, dist = DIST_SQ1) => new Nearest(dist, p, r);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/distance",
-  "version": "2.1.7",
+  "version": "2.1.8",
   "description": "N-dimensional distance metrics & K-nearest neighborhoods for point queries",
   "type": "module",
   "module": "./index.js",
@@ -34,20 +34,20 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.3",
-    "@thi.ng/checks": "^3.1.3",
-    "@thi.ng/errors": "^2.1.3",
-    "@thi.ng/heaps": "^2.1.3",
-    "@thi.ng/math": "^5.2.0",
-    "@thi.ng/vectors": "^7.4.3"
+    "@thi.ng/api": "^8.3.4",
+    "@thi.ng/checks": "^3.1.4",
+    "@thi.ng/errors": "^2.1.4",
+    "@thi.ng/heaps": "^2.1.4",
+    "@thi.ng/math": "^5.3.0",
+    "@thi.ng/vectors": "^7.5.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "distance",
@@ -109,5 +109,5 @@
     ],
     "year": 2021
   },
-  "gitHead": "1ba92c6b9509e74e509b4c0b875fc380a97bbbc1\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }