@thi.ng/distance 2.1.34 → 2.1.36

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-11-30T22:27:37Z
+- **Last updated**: 2022-12-20T16:33:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,10 +1,10 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![distance](https://media.thi.ng/umbrella/banners-20220914/thing-distance.svg?1deaa6f1)
+# ![@thi.ng/distance](https://media.thi.ng/umbrella/banners-20220914/thing-distance.svg?1deaa6f1)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/distance.svg)](https://www.npmjs.com/package/@thi.ng/distance)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/distance.svg)
-[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -25,7 +25,7 @@ This project is part of the
 
 ## About
 
-N-dimensional distance metrics & K-nearest neighborhoods for point queries.
+N-dimensional distance metrics & K-nearest neighborhoods for point queries
 
 ### Distance metrics
 
@@ -117,11 +117,8 @@ ES module import:
 
 For Node.js REPL:
 
-```text
-# with flag only for < v16
-node --experimental-repl-await
-
-> const distance = await import("@thi.ng/distance");
+```js
+const distance = await import("@thi.ng/distance");
 ```
 
 Package sizes (brotli'd, pre-treeshake): ESM: 1.11 KB
@@ -169,7 +166,7 @@ k2.deref()
 
 ## Authors
 
-Karsten Schmidt
+- [Karsten Schmidt](https://thi.ng)
 
 If this project contributes to an academic publication, please cite it as:
 
@@ -184,4 +181,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-&copy; 2021 - 2022 Karsten Schmidt // Apache Software License 2.0
+&copy; 2021 - 2022 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -2,11 +2,11 @@ import type { FnU2, IReset, Pair } from "@thi.ng/api";
 /**
  * Distance metric function
  */
-export declare type Metric<T> = FnU2<T, number>;
+export type Metric<T> = FnU2<T, number>;
 /**
  * Tuple of `[distance, T]`
  */
-export declare type Neighbor<T> = Pair<number, T>;
+export type Neighbor<T> = Pair<number, T>;
 /**
  * Distance metric implementation & conversions from/to raw distances.
  */

package/knearest.d.ts

@@ -9,10 +9,10 @@ import type { IDistance, INeighborhood, Neighbor } from "./api.js";
  *
  * @remarks
  * The K-nearest neighbors will be accumulated via an internal
- * {@link @thi.ng/heaps#Heap} and results can be optionally returned in order of
- * proximity (via {@link KNearest.deref} or {@link KNearest.values}). For K=1 it
- * will be more efficient to use {@link Nearest} to avoid the additional
- * overhead.
+ * [`Heap`](https://docs.thi.ng/umbrella/heaps/classes/Heap.html) and results
+ * can be optionally returned in order of proximity (via {@link KNearest.deref}
+ * or {@link KNearest.values}). For K=1 it will be more efficient to use
+ * {@link Nearest} to avoid the additional overhead.
  *
  * @typeParam D - spatial position for distance metric
  * @typeParam T - indexed value

package/knearest.js

@@ -9,10 +9,10 @@ import { DIST_SQ, DIST_SQ1, DIST_SQ2, DIST_SQ3 } from "./squared.js";
  *
  * @remarks
  * The K-nearest neighbors will be accumulated via an internal
- * {@link @thi.ng/heaps#Heap} and results can be optionally returned in order of
- * proximity (via {@link KNearest.deref} or {@link KNearest.values}). For K=1 it
- * will be more efficient to use {@link Nearest} to avoid the additional
- * overhead.
+ * [`Heap`](https://docs.thi.ng/umbrella/heaps/classes/Heap.html) and results
+ * can be optionally returned in order of proximity (via {@link KNearest.deref}
+ * or {@link KNearest.values}). For K=1 it will be more efficient to use
+ * {@link Nearest} to avoid the additional overhead.
  *
  * @typeParam D - spatial position for distance metric
  * @typeParam T - indexed value

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/distance",
-  "version": "2.1.34",
+  "version": "2.1.36",
   "description": "N-dimensional distance metrics & K-nearest neighborhoods for point queries",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/distance#readme",
+  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/distance#readme",
   "funding": [
     {
       "type": "github",
@@ -21,7 +21,7 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
@@ -34,20 +34,20 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/checks": "^3.3.4",
-    "@thi.ng/errors": "^2.2.5",
-    "@thi.ng/heaps": "^2.1.18",
-    "@thi.ng/math": "^5.3.15",
-    "@thi.ng/vectors": "^7.5.26"
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/checks": "^3.3.5",
+    "@thi.ng/errors": "^2.2.6",
+    "@thi.ng/heaps": "^2.1.20",
+    "@thi.ng/math": "^5.3.17",
+    "@thi.ng/vectors": "^7.5.28"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "distance",
@@ -109,5 +109,5 @@
     ],
     "year": 2021
   },
-  "gitHead": "1fe40da507070653f420156d91e6b27cf682004f\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }