Struct linfa_hierarchical::HierarchicalCluster

pub struct HierarchicalCluster<T> { /* fields omitted */ }

Agglomerative hierarchical clustering

In this clustering algorithm, each point is first considered as a separate cluster. During each step, two points are merged into new clusters, until a stopping criterion is reached. The distance between the points is computed as the negative-log transform of the similarity kernel.

Implementations

impl<F: Float> HierarchicalCluster<F>

pub fn with_method(self, method: Method) -> HierarchicalCluster<F>

Select a merging method

pub fn num_clusters(self, num_clusters: usize) -> HierarchicalCluster<F>

Stop merging when a certain number of clusters are reached

In the fitting process points are merged until a certain criterion is reached. With this option the merging process will stop, when the number of clusters drops below this value.

pub fn max_distance(self, max_distance: F) -> HierarchicalCluster<F>

Stop merging when a certain distance is reached

In the fitting process points are merged until a certain criterion is reached. With this option the merging process will stop, then the distance exceeds this value.

Trait Implementations

impl<T> Default for HierarchicalCluster<T>

Initialize hierarchical clustering, which averages in-cluster points and stops when two clusters are reached.

fn default() -> HierarchicalCluster<T>

Returns the “default value” for a type.

impl<F: Float, T> Transformer<DatasetBase<KernelBase<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CsMatBase<F, usize, Vec<usize, Global>, Vec<usize, Global>, Vec<F, Global>, usize>>, T>, DatasetBase<KernelBase<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CsMatBase<F, usize, Vec<usize, Global>, Vec<usize, Global>, Vec<F, Global>, usize>>, Vec<usize, Global>>> for HierarchicalCluster<F>

fn transform(
    &self,
    dataset: DatasetBase<Kernel<F>, T>
) -> DatasetBase<Kernel<F>, Vec<usize>>

Perform hierarchical clustering of a similarity matrix

Returns the class id for each data point

impl<F: Float> Transformer<KernelBase<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CsMatBase<F, usize, Vec<usize, Global>, Vec<usize, Global>, Vec<F, Global>, usize>>, DatasetBase<KernelBase<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, CsMatBase<F, usize, Vec<usize, Global>, Vec<usize, Global>, Vec<F, Global>, usize>>, Vec<usize, Global>>> for HierarchicalCluster<F>

fn transform(&self, kernel: Kernel<F>) -> DatasetBase<Kernel<F>, Vec<usize>>

Perform hierarchical clustering of a similarity matrix

Returns the class id for each data point