Class Cluster

constructor

• new Cluster(): Cluster

  Returns Cluster

children

height

index

isLeaf

size

cut

• cut(threshold: number): Cluster[]

  Creates an array of clusters where the maximum height is smaller than the threshold.

  Parameters

  • threshold: number

  Returns Cluster[]

  The cut clusters.

group

• group(groups: number): Cluster

  Merge the leaves in the minimum way to have groups number of clusters.

  Parameters

  • groups: number

    Them number of children the first level of the tree should have.

  Returns Cluster

indices

• indices(): number[]

  Returns a list of indices for all the leaves of this cluster. The list is ordered in such a way that a dendrogram could be drawn without crossing branches.

  Returns number[]

traverse

• traverse(cb: (cluster: Cluster) => void): void

  Traverses the tree depth-first and calls the provided callback with each individual node

  Parameters

  • cb: (cluster: Cluster) => void

    The callback to be called on each node encounter

  Returns void