@thi.ng/k-means 0.6.94 → 0.7.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-07-22T13:15:57Z
+- **Last updated**: 2024-07-25T11:43:52Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,15 @@ 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.
 
+## [0.7.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/k-means@0.7.0) (2024-07-25)
+
+#### 🚀 Features
+
+- update `KMeansOpts.initial` ([f70073d](https://github.com/thi-ng/umbrella/commit/f70073d))
+  - support custom init functions
+  - add KMeansInit type alias
+  - update handling in `kmeans()`
+
 ### [0.6.89](https://github.com/thi-ng/umbrella/tree/@thi.ng/k-means@0.6.89) (2024-06-21)
 
 #### ♻️ Refactoring

package/README.md

@@ -59,7 +59,7 @@ For Node.js REPL:
 const kmeans = await import("@thi.ng/k-means");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 870 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 884 bytes
 
 ## Dependencies
 

package/api.d.ts

@@ -5,9 +5,10 @@ import type { ReadonlyVec, Vec } from "@thi.ng/vectors";
 export interface KMeansOpts {
     /**
      * Array of initial centroids (i.e. indices of selected points in `samples`
-     * array given to {@link kmeans}).
+     * array given to {@link kmeans}) or a function producing such. If omitted,
+     * {@link initKmeanspp} is used as default.
      */
-    initial: number[];
+    initial: number[] | KMeansInit<ReadonlyVec>;
     /**
      * Distance function/metric to use for finding nearest centroid.
      */
@@ -25,6 +26,10 @@ export interface KMeansOpts {
      */
     strategy: CentroidStrategy;
 }
+/**
+ * k-means initialization function, e.g. {@link initKmeanspp}.
+ */
+export type KMeansInit<T extends ReadonlyVec> = (k: number, samples: T[], dist?: IDistance<ReadonlyVec>, rnd?: IRandom) => number[];
 export type CentroidStrategy = Fn<number, {
     update: Fn<ReadonlyVec, void>;
     finish: Fn0<Maybe<Vec>>;

package/kmeans.js

@@ -16,7 +16,7 @@ const kmeans = (k, samples, opts) => {
   };
   const num = samples.length;
   const dim = samples[0].length;
-  const centroidIDs = initial || initKmeanspp(k, samples, dist, rnd);
+  const centroidIDs = Array.isArray(initial) ? initial : initial ? initial(k, samples, dist, rnd) : initKmeanspp(k, samples, dist, rnd);
   assert(centroidIDs.length > 0, `missing initial centroids`);
   k = centroidIDs.length;
   const centroids = centroidIDs.map((i) => samples[i]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/k-means",
-  "version": "0.6.94",
+  "version": "0.7.0",
   "description": "Configurable k-means & k-medians (with k-means++ initialization) for n-D vectors",
   "type": "module",
   "module": "./index.js",
@@ -37,10 +37,10 @@
   },
   "dependencies": {
     "@thi.ng/api": "^8.11.7",
-    "@thi.ng/distance": "^2.4.79",
+    "@thi.ng/distance": "^2.4.80",
     "@thi.ng/errors": "^2.5.13",
-    "@thi.ng/random": "^4.0.0",
-    "@thi.ng/vectors": "^7.11.5"
+    "@thi.ng/random": "^4.0.1",
+    "@thi.ng/vectors": "^7.11.6"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.0",
@@ -83,5 +83,5 @@
     "status": "beta",
     "year": 2021
   },
-  "gitHead": "324d6b7dbf31558329e9fb6452e29b2f7db9c61a\n"
+  "gitHead": "ec052b25dff4db6c4d1748e946c38fb5cf403dbf\n"
 }