Skip to content

givehug/k-means-ts

Repository files navigation

K-Means implementation in TypeScript

type Input = {
	data: Point[];		// data sample
	k: number;		// number of clusters
	limit?: number;		// max times to run kMeans iteration until convergence, defaults to Infinity
	centroids?: Point[],	// predefined centroids
	// precision?: number,	// TODO add float point precision option
};

type Result = {
	clusters: Point[][],	// data separated into clusters
	centroids: Point[],	// final centroids
	iterations: number,	// number of times kMeans did reclusterization
	totalDistance: number,	// sum of distances from examples to each cluster center
};

type Point = number[];

/**
 * @throws error if invalid data provided 
 */
function clusterize({k, data, centroids, limit = Infinity}: Input): Result

Releases

No releases published

Packages

No packages published