Giter Club home page Giter Club logo

hierarchical-clustering's Introduction

hierarchical-clustering

NPM version Build status Test coverage Dependency Status License Downloads Gittip

Agglomerative Hierarchical clustering based on How to Explain Hierarchical Clustering.

Example

From clusterfck:

var cluster = require('hierarchical-clustering');
var colors = [
  [20, 20, 80],
  [22, 22, 90],
  [250, 255, 253],
  [100, 54, 255]
];

// Euclidean distance
function distance(a, b) {
  var d = 0;
  for (var i = 0; i < a.length; i++) {
    d += Math.pow(a[i] - b[i], 2);
  }
  return Math.sqrt(d);
}

// Single-linkage clustering
function linkage(distances) {
  return Math.min.apply(null, distances);
}

var levels = cluster({
  input: colors,
  distance: distance,
  linkage: linkage,
  minClusters: 2, // only want two clusters
});

var clusters = levels[levels.length - 1].clusters;
console.log(clusters);
// => [ [ 2 ], [ 3, 1, 0 ] ]
clusters = clusters.map(function (cluster) {
  return cluster.map(function (index) {
    return colors[index];
  });
});
console.log(clusters);
// => [ [ [ 250, 255, 253 ] ],
// => [ [ 100, 54, 255 ], [ 22, 22, 90 ], [ 20, 20, 80 ] ] ]

API

var cluster = require('hierarchical-clustering')

var levels = cluster(options)

Options:

  • .input <Array> (required) - input array
  • .distance <Function> (required) - distance function
  • .linkage <Function> (required) - linkage function or string of 'single', 'complete or 'average'
  • .minClusters <Integer> (1) - number of clusters you want to iterate to
  • .maxLinkage <Integer> (Infinity) - maximum linkage until you stop iteration

Function definitions:

function distance(a, b) {
  // the smaller, the closer
  return <Number>
}

function linkage(distances) {
  // the smaller, the more similar
  return <Number>
}

The output is an array of levels, each which have the property:

  • .linkage <Number> - the linkage of this level
  • .cluster <Array> - the clusters at this level
  • .from <Integer> - index of the last cluster which got merged and deleted
  • .to <Integer> - index of the last cluster which got merged and appended

hierarchical-clustering's People

Contributors

finnp avatar jonathanong avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.