@thi.ng/k-means 0.5.34 → 0.5.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/README.md +7 -10
  3. package/api.d.ts +1 -1
  4. package/kmeans.d.ts +2 -2
  5. package/kmeans.js +2 -2
  6. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Change Log
2
2
 
3
- - **Last updated**: 2022-11-30T22:27:37Z
3
+ - **Last updated**: 2022-12-20T16:33:11Z
4
4
  - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
5
5
 
6
6
  All notable changes to this project will be documented in this file.
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  <!-- This file is generated - DO NOT EDIT! -->
2
2
 
3
- # ![k-means](https://media.thi.ng/umbrella/banners-20220914/thing-k-means.svg?974198f6)
3
+ # ![@thi.ng/k-means](https://media.thi.ng/umbrella/banners-20220914/thing-k-means.svg?974198f6)
4
4
 
5
5
  [![npm version](https://img.shields.io/npm/v/@thi.ng/k-means.svg)](https://www.npmjs.com/package/@thi.ng/k-means)
6
6
  ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/k-means.svg)
7
- [![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
7
+ [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
8
8
 
9
9
  This project is part of the
10
10
  [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -20,7 +20,7 @@ This project is part of the
20
20
 
21
21
  ## About
22
22
 
23
- Configurable k-means & k-medians (with k-means++ initialization) for n-D vectors.
23
+ Configurable k-means & k-medians (with k-means++ initialization) for n-D vectors
24
24
 
25
25
  ## Status
26
26
 
@@ -44,11 +44,8 @@ ES module import:
44
44
 
45
45
  For Node.js REPL:
46
46
 
47
- ```text
48
- # with flag only for < v16
49
- node --experimental-repl-await
50
-
51
- > const kMeans = await import("@thi.ng/k-means");
47
+ ```js
48
+ const kMeans = await import("@thi.ng/k-means");
52
49
  ```
53
50
 
54
51
  Package sizes (brotli'd, pre-treeshake): ESM: 906 bytes
@@ -124,7 +121,7 @@ for (let c of clusters) {
124
121
 
125
122
  ## Authors
126
123
 
127
- Karsten Schmidt
124
+ - [Karsten Schmidt](https://thi.ng)
128
125
 
129
126
  If this project contributes to an academic publication, please cite it as:
130
127
 
@@ -139,4 +136,4 @@ If this project contributes to an academic publication, please cite it as:
139
136
 
140
137
  ## License
141
138
 
142
- &copy; 2021 - 2022 Karsten Schmidt // Apache Software License 2.0
139
+ &copy; 2021 - 2022 Karsten Schmidt // Apache License 2.0
package/api.d.ts CHANGED
@@ -25,7 +25,7 @@ export interface KMeansOpts {
25
25
  */
26
26
  strategy: CentroidStrategy;
27
27
  }
28
- export declare type CentroidStrategy = Fn<number, {
28
+ export type CentroidStrategy = Fn<number, {
29
29
  update: Fn<ReadonlyVec, void>;
30
30
  finish: Fn0<Vec | undefined>;
31
31
  }>;
package/kmeans.d.ts CHANGED
@@ -56,8 +56,8 @@ export declare const medians: CentroidStrategy;
56
56
  *
57
57
  * @remarks
58
58
  * When using this strategy, you should also use the
59
- * {@link @thi.ng/distance#HAVERSINE_LATLON} distance metric for
60
- * {@link KMeansOpts.distance}.
59
+ * [`HAVERSINE_LATLON`](https://docs.thi.ng/umbrella/distance/variables/HAVERSINE_LATLON.html)
60
+ * distance metric for {@link KMeansOpts.distance}.
61
61
  *
62
62
  * @example
63
63
  * ```ts
package/kmeans.js CHANGED
@@ -162,8 +162,8 @@ export const medians = () => {
162
162
  *
163
163
  * @remarks
164
164
  * When using this strategy, you should also use the
165
- * {@link @thi.ng/distance#HAVERSINE_LATLON} distance metric for
166
- * {@link KMeansOpts.distance}.
165
+ * [`HAVERSINE_LATLON`](https://docs.thi.ng/umbrella/distance/variables/HAVERSINE_LATLON.html)
166
+ * distance metric for {@link KMeansOpts.distance}.
167
167
  *
168
168
  * @example
169
169
  * ```ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thi.ng/k-means",
3
- "version": "0.5.34",
3
+ "version": "0.5.36",
4
4
  "description": "Configurable k-means & k-medians (with k-means++ initialization) for n-D vectors",
5
5
  "type": "module",
6
6
  "module": "./index.js",
@@ -10,7 +10,7 @@
10
10
  "type": "git",
11
11
  "url": "https://github.com/thi-ng/umbrella.git"
12
12
  },
13
- "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/k-means#readme",
13
+ "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/k-means#readme",
14
14
  "funding": [
15
15
  {
16
16
  "type": "github",
@@ -21,7 +21,7 @@
21
21
  "url": "https://patreon.com/thing_umbrella"
22
22
  }
23
23
  ],
24
- "author": "Karsten Schmidt <k+npm@thi.ng>",
24
+ "author": "Karsten Schmidt (https://thi.ng)",
25
25
  "license": "Apache-2.0",
26
26
  "scripts": {
27
27
  "build": "yarn clean && tsc --declaration",
@@ -34,19 +34,19 @@
34
34
  "test": "testament test"
35
35
  },
36
36
  "dependencies": {
37
- "@thi.ng/api": "^8.5.1",
38
- "@thi.ng/distance": "^2.1.34",
39
- "@thi.ng/errors": "^2.2.5",
40
- "@thi.ng/random": "^3.3.17",
41
- "@thi.ng/vectors": "^7.5.26"
37
+ "@thi.ng/api": "^8.6.1",
38
+ "@thi.ng/distance": "^2.1.36",
39
+ "@thi.ng/errors": "^2.2.6",
40
+ "@thi.ng/random": "^3.3.19",
41
+ "@thi.ng/vectors": "^7.5.28"
42
42
  },
43
43
  "devDependencies": {
44
- "@microsoft/api-extractor": "^7.33.5",
45
- "@thi.ng/testament": "^0.3.6",
44
+ "@microsoft/api-extractor": "^7.33.7",
45
+ "@thi.ng/testament": "^0.3.7",
46
46
  "rimraf": "^3.0.2",
47
47
  "tools": "^0.0.1",
48
- "typedoc": "^0.23.20",
49
- "typescript": "^4.8.4"
48
+ "typedoc": "^0.23.22",
49
+ "typescript": "^4.9.4"
50
50
  },
51
51
  "keywords": [
52
52
  "cluster",
@@ -82,5 +82,5 @@
82
82
  "status": "beta",
83
83
  "year": 2021
84
84
  },
85
- "gitHead": "1fe40da507070653f420156d91e6b27cf682004f\n"
85
+ "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
86
86
  }