@thi.ng/distance 2.4.120 → 3.0.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-05-28T12:02:39Z
+- **Last updated**: 2025-06-14T20:56:27Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -11,6 +11,20 @@ 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.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/distance@3.0.0) (2025-06-14)
+
+#### 🛑 Breaking changes
+
+- rename class Eucledian => Untransformed ([5ace461](https://github.com/thi-ng/umbrella/commit/5ace461))
+- BREAKING CHANGE: rename class `Eucledian` => `Untransformed`
+  - migrate to own src file
+  - update references
+  - update doc strings
+
+#### 🚀 Features
+
+- add JACCARD n-D distance metric ([ea48648](https://github.com/thi-ng/umbrella/commit/ea48648))
+
 ### [2.4.70](https://github.com/thi-ng/umbrella/tree/@thi.ng/distance@2.4.70) (2024-04-20)
 
 #### ♻️ Refactoring

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 208 standalone projects, maintained as part
+> This is one of 209 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -140,7 +140,7 @@ For Node.js REPL:
 const dist = await import("@thi.ng/distance");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.37 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.41 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -16,13 +16,14 @@ export interface IDistance<T> {
      */
     readonly metric: Metric<T>;
     /**
-     * Converts Eucledian distance `x` into the metric of this instance.
+     * Converts "untransformed" raw distance `x` into the metric of this instance.
      *
      * @param x -
      */
     to(x: number): number;
     /**
-     * Converts `x` from the metric of this instance into an Eucledian value.
+     * Converts `x` from the metric of this instance into an "untransformed" raw
+     * value.
      *
      * @param x -
      */
@@ -43,14 +44,15 @@ export interface INeighborhood<P, T> extends IReset {
     readonly radius: number;
     /**
      * Returns true, if distance `d` is <= current radius of this neighborhood.
-     * If `eucledian` is true (default: true), then `d` will first be converted
-     * into the metric used by this neighborhood using {@link IDistance.to},
-     * otherwise it is expected to be already in that metric space.
+     * If `untransformed` is true (default: true), then `d` will first be
+     * converted into the metric used by this neighborhood using
+     * {@link IDistance.to}, otherwise it is expected to be already in that
+     * metric's space.
      *
      * @param d -
-     * @param eucledian -
+     * @param untransformed -
      */
-    includesDistance(d: number, eucledian?: boolean): boolean;
+    includesDistance(d: number, untransformed?: boolean): boolean;
     /**
      * Computes distance metric between `pos` and this neighborhood's target
      * pos. Returns true if result is <= current radius.

package/eucledian.d.ts

@@ -1,25 +1,19 @@
 import type { ReadonlyVec } from "@thi.ng/vectors";
-import type { IDistance, Metric } from "./api.js";
-export declare class Eucledian<T> implements IDistance<T> {
-    readonly metric: Metric<T>;
-    constructor(metric: Metric<T>);
-    to(x: number): number;
-    from(x: number): number;
-}
+import { Untransformed } from "./untransformed.js";
 /**
  * Eucledian distance metric for n-D vectors.
  */
-export declare const EUCLEDIAN: Eucledian<ReadonlyVec>;
+export declare const EUCLEDIAN: Untransformed<ReadonlyVec>;
 /**
  * Eucledian distance metric for numbers.
  */
-export declare const EUCLEDIAN1: Eucledian<number>;
+export declare const EUCLEDIAN1: Untransformed<number>;
 /**
  * Eucledian distance metric for 2d vectors.
  */
-export declare const EUCLEDIAN2: Eucledian<ReadonlyVec>;
+export declare const EUCLEDIAN2: Untransformed<ReadonlyVec>;
 /**
  * Eucledian distance metric for 3d vectors.
  */
-export declare const EUCLEDIAN3: Eucledian<ReadonlyVec>;
+export declare const EUCLEDIAN3: Untransformed<ReadonlyVec>;
 //# sourceMappingURL=eucledian.d.ts.map

package/eucledian.js

@@ -1,23 +1,12 @@
 import { dist, dist2, dist3 } from "@thi.ng/vectors/dist";
-class Eucledian {
-  constructor(metric) {
-    this.metric = metric;
-  }
-  to(x) {
-    return x;
-  }
-  from(x) {
-    return x;
-  }
-}
-const EUCLEDIAN = new Eucledian(dist);
-const EUCLEDIAN1 = new Eucledian((a, b) => Math.abs(a - b));
-const EUCLEDIAN2 = new Eucledian(dist2);
-const EUCLEDIAN3 = new Eucledian(dist3);
+import { Untransformed } from "./untransformed.js";
+const EUCLEDIAN = new Untransformed(dist);
+const EUCLEDIAN1 = new Untransformed((a, b) => Math.abs(a - b));
+const EUCLEDIAN2 = new Untransformed(dist2);
+const EUCLEDIAN3 = new Untransformed(dist3);
 export {
   EUCLEDIAN,
   EUCLEDIAN1,
   EUCLEDIAN2,
-  EUCLEDIAN3,
-  Eucledian
+  EUCLEDIAN3
 };

package/haversine.d.ts

@@ -1,11 +1,11 @@
 import type { ReadonlyVec } from "@thi.ng/vectors";
-import { Eucledian } from "./eucledian.js";
+import { Untransformed } from "./untransformed.js";
 /**
  * Distance metric for geo locations given as `[lat,lon]` vectors.
  */
-export declare const HAVERSINE_LATLON: Eucledian<ReadonlyVec>;
+export declare const HAVERSINE_LATLON: Untransformed<ReadonlyVec>;
 /**
  * Distance metric for geo locations given as `[lon,lat]` vectors.
  */
-export declare const HAVERSINE_LONLAT: Eucledian<ReadonlyVec>;
+export declare const HAVERSINE_LONLAT: Untransformed<ReadonlyVec>;
 //# sourceMappingURL=haversine.d.ts.map

package/haversine.js

@@ -2,9 +2,13 @@ import {
   distHaversineLatLon,
   distHaversineLonLat
 } from "@thi.ng/vectors/dist-haversine";
-import { Eucledian } from "./eucledian.js";
-const HAVERSINE_LATLON = new Eucledian(distHaversineLatLon);
-const HAVERSINE_LONLAT = new Eucledian(distHaversineLonLat);
+import { Untransformed } from "./untransformed.js";
+const HAVERSINE_LATLON = new Untransformed(
+  distHaversineLatLon
+);
+const HAVERSINE_LONLAT = new Untransformed(
+  distHaversineLonLat
+);
 export {
   HAVERSINE_LATLON,
   HAVERSINE_LONLAT

package/index.d.ts

@@ -2,9 +2,11 @@ export * from "./api.js";
 export * from "./argmin.js";
 export * from "./eucledian.js";
 export * from "./haversine.js";
+export * from "./jaccard.js";
 export * from "./knearest.js";
 export * from "./manhattan.js";
 export * from "./nearest.js";
 export * from "./radial.js";
 export * from "./squared.js";
+export * from "./untransformed.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -2,8 +2,10 @@ export * from "./api.js";
 export * from "./argmin.js";
 export * from "./eucledian.js";
 export * from "./haversine.js";
+export * from "./jaccard.js";
 export * from "./knearest.js";
 export * from "./manhattan.js";
 export * from "./nearest.js";
 export * from "./radial.js";
 export * from "./squared.js";
+export * from "./untransformed.js";

package/jaccard.d.ts

@@ -0,0 +1,10 @@
+import type { ReadonlyVec } from "@thi.ng/vectors";
+import { Untransformed } from "./untransformed.js";
+/**
+ * Jaccard distance metric for n-D vectors. Returns the inverse Jaccard
+ * similarity, i.e. as distance metric rather than similarity. Returns a value
+ * in `[0,1]` interval: 0.0 if `a` and `b` are equal, or 1.0 if none of the
+ * components match.
+ */
+export declare const JACCARD: Untransformed<ReadonlyVec>;
+//# sourceMappingURL=jaccard.d.ts.map

package/jaccard.js

@@ -0,0 +1,6 @@
+import { distJaccard } from "@thi.ng/vectors/dist-jaccard";
+import { Untransformed } from "./untransformed.js";
+const JACCARD = new Untransformed(distJaccard);
+export {
+  JACCARD
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/distance",
-  "version": "2.4.120",
+  "version": "3.0.0",
   "description": "N-dimensional distance metrics & K-nearest neighborhoods for point queries",
   "type": "module",
   "module": "./index.js",
@@ -39,12 +39,12 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.28",
-    "@thi.ng/checks": "^3.7.8",
-    "@thi.ng/errors": "^2.5.34",
-    "@thi.ng/heaps": "^2.1.100",
-    "@thi.ng/math": "^5.11.28",
-    "@thi.ng/vectors": "^8.2.1"
+    "@thi.ng/api": "^8.11.29",
+    "@thi.ng/checks": "^3.7.9",
+    "@thi.ng/errors": "^2.5.35",
+    "@thi.ng/heaps": "^2.1.101",
+    "@thi.ng/math": "^5.11.29",
+    "@thi.ng/vectors": "^8.3.0"
   },
   "devDependencies": {
     "esbuild": "^0.25.5",
@@ -52,8 +52,15 @@
     "typescript": "^5.8.3"
   },
   "keywords": [
+    "2d",
+    "3d",
+    "4d",
     "distance",
+    "eucledian",
+    "haversine",
+    "jaccard",
     "k-nearest",
+    "manhattan",
     "metric",
     "nd",
     "neighborhood",
@@ -90,6 +97,9 @@
     "./haversine": {
       "default": "./haversine.js"
     },
+    "./jaccard": {
+      "default": "./jaccard.js"
+    },
     "./knearest": {
       "default": "./knearest.js"
     },
@@ -104,6 +114,9 @@
     },
     "./squared": {
       "default": "./squared.js"
+    },
+    "./untransformed": {
+      "default": "./untransformed.js"
     }
   },
   "thi.ng": {
@@ -115,5 +128,5 @@
     ],
     "year": 2021
   },
-  "gitHead": "61c3833b7ef7d044621454b5ea4af885d39f065e\n"
+  "gitHead": "14e994e531d32053e948768998324d443436a542\n"
 }

package/untransformed.d.ts

@@ -0,0 +1,8 @@
+import type { IDistance, Metric } from "./api.js";
+export declare class Untransformed<T> implements IDistance<T> {
+    readonly metric: Metric<T>;
+    constructor(metric: Metric<T>);
+    to(x: number): number;
+    from(x: number): number;
+}
+//# sourceMappingURL=untransformed.d.ts.map

package/untransformed.js

@@ -0,0 +1,14 @@
+class Untransformed {
+  constructor(metric) {
+    this.metric = metric;
+  }
+  to(x) {
+    return x;
+  }
+  from(x) {
+    return x;
+  }
+}
+export {
+  Untransformed
+};