@saehrimnir/druidjs / KMeans

Class: KMeans

Defined in: clustering/KMeans.js:31

K-Means Clustering

A popular clustering algorithm that partitions data into K clusters where each point belongs to the cluster with the nearest mean (centroid).

See

KMedoids for a more robust alternative

Example

import * as druid from "@saehrimnir/druidjs";

const points = [[1, 1], [1.5, 1.5], [5, 5], [5.5, 5.5]];
const kmeans = new druid.KMeans(points, { K: 2 });

const clusters = kmeans.get_cluster_list(); // [0, 0, 1, 1]
const centroids = kmeans.centroids; // center points

Extends

• Clustering

Constructors

Constructor

new KMeans(points: InputType, parameters?: Partial<ParametersKMeans>): KMeans;

Defined in: clustering/KMeans.js:36

Parameters

Parameter	Type	Description
points	InputType	-
parameters	Partial<ParametersKMeans>	-

Returns

KMeans

Overrides

Clustering.constructor

Properties

Property	Type	Inherited from	Defined in
_cluster_centroids	Float64Array<ArrayBufferLike>[]	-	clustering/KMeans.js:62
_clusters	number[]	-	clustering/KMeans.js:60
_D	number	Clustering._D	clustering/KMeans.js:54
_K	number	-	clustering/KMeans.js:56
_matrix	Matrix	Clustering._matrix	clustering/KMeans.js:47
_N	number	Clustering._N	clustering/KMeans.js:53
_parameters	ParametersKMeans	Clustering._parameters	clustering/Clustering.js:13
_points	InputType	Clustering._points	clustering/Clustering.js:11
_randomizer	Randomizer	-	clustering/KMeans.js:57

Accessors

centroids

Get Signature

get centroids(): Float64Array<ArrayBufferLike>[];

Defined in: clustering/KMeans.js:86

Returns

Float64Array<ArrayBufferLike>[]

The cluster centroids

---

k

Get Signature

get k(): number;

Defined in: clustering/KMeans.js:81

Returns

number

The number of clusters

Methods

get_cluster_list()

get_cluster_list(): number[];

Defined in: clustering/KMeans.js:91

Returns

number[]

The cluster list

Overrides

Clustering.get_cluster_list

---

get_clusters()

get_clusters(): number[][];

Defined in: clustering/KMeans.js:96

Returns

number[][]

An Array of clusters with the indices of the points.

Overrides

Clustering.get_clusters