@saehrimnir/druidjs / HierarchicalClustering

Class: HierarchicalClustering

Defined in: clustering/Hierarchical_Clustering.js:18

Hierarchical Clustering

A bottom-up approach (agglomerative) to clustering that builds a tree of clusters (dendrogram). Supports different linkage criteria: single, complete, and average.

Extends

• Clustering

Constructors

Constructor

new HierarchicalClustering(points: InputType, parameters?: Partial<ParametersHierarchicalClustering>): HierarchicalClustering;

Defined in: clustering/Hierarchical_Clustering.js:26

Parameters

Parameter	Type	Description
points	InputType	Data or distance matrix if metric is 'precomputed'
parameters	Partial<ParametersHierarchicalClustering>	-

Returns

HierarchicalClustering

Overrides

Clustering.constructor

Properties

Property	Type	Default value	Inherited from	Defined in
_c_size	Uint16Array<ArrayBuffer>	undefined	-	clustering/Hierarchical_Clustering.js:85
_clusters	any[]	undefined	-	clustering/Hierarchical_Clustering.js:83
_D	number	undefined	Clustering._D	clustering/Clustering.js:19
_d_min	Float64Array<ArrayBuffer>	undefined	-	clustering/Hierarchical_Clustering.js:41
_distance_matrix	Matrix	undefined	-	clustering/Hierarchical_Clustering.js:82
_id	number	undefined	-	clustering/Hierarchical_Clustering.js:33
_matrix	Matrix	undefined	Clustering._matrix	clustering/Clustering.js:15
_N	number	undefined	Clustering._N	clustering/Clustering.js:17
_parameters	ParametersHierarchicalClustering	undefined	Clustering._parameters	clustering/Clustering.js:13
_points	InputType	undefined	Clustering._points	clustering/Clustering.js:11
root	Cluster | null	null	-	clustering/Hierarchical_Clustering.js:20

Methods

get_cluster_list()

get_cluster_list(value: number, type?: "distance" | "depth"): number[];

Defined in: clustering/Hierarchical_Clustering.js:228

Parameters

Parameter	Type	Default value	Description
value	number	undefined	Value where to cut the tree.
type?	"distance" | "depth"	"distance"	Type of value. Default is "distance"

Returns

number[]

• Array of clusters with the indices of the rows in given points.

Overrides

Clustering.get_cluster_list

---

get_clusters()

get_clusters(value: number, type?: "distance" | "depth"): number[][];

Defined in: clustering/Hierarchical_Clustering.js:204

Parameters

Parameter	Type	Default value	Description
value	number	undefined	Value where to cut the tree.
type?	"distance" | "depth"	"distance"	Type of value. Default is "distance"

Returns

number[][]

• Array of clusters with the indices of the rows in given points.

Overrides

Clustering.get_clusters

---

get_clusters_raw()

get_clusters_raw(value: number, type?: "distance" | "depth"): Cluster[][];

Defined in: clustering/Hierarchical_Clustering.js:180

Parameters

Parameter	Type	Default value	Description
value	number	undefined	Value where to cut the tree.
type?	"distance" | "depth"	"distance"	Type of value. Default is "distance"

Returns

Cluster[][]

• Array of clusters with the indices of the rows in given points.