# clusteringjs

> clusteringjs ============

Latest version **0.1.2** (published 2014-04-07) · 0 weekly downloads

## Install

```sh
npm install clusteringjs
pnpm add clusteringjs
yarn add clusteringjs
bun add clusteringjs
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2014-04-07 |
| First published | 2014-03-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | trasantos |

## Links

- npm: https://www.npmjs.com/package/clusteringjs
- Repository: https://github.com/Volcany/clusteringjs
- Issues: https://github.com/Volcany/clusteringjs/issues
- npm.io page: https://npm.io/package/clusteringjs

## Recent versions

- 0.1.2 (latest) — 2014-04-07
- 0.1.1 — 2014-03-30
- 0.1.0 — 2014-03-30

## README

clusteringjs
============

K-Means
-------

A Node.js K-Means implementation.

**How to use**

1. Install the module
> npm install clusteringjs

2. Create a K-Means object
> var clustering = require('clusteringjs');
> 
> var kmeans = new clustering.KMeans(k, e); // k = numer of clusters, e = max error

3. Cluster something
> kmeans.cluster(input); // input = array of points

4. Use the cluster
> var clusters = kmeans.getClusters();
> var cluster = kmeans.classify(point); // point = [x, y]

http://en.wikipedia.org/wiki/K-means_clustering

---
_Source: https://npm.io/package/clusteringjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
