Struct linfa_hierarchical::HierarchicalCluster

pub struct HierarchicalCluster<T: Float>(_);

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: Clone + Float> Clone for HierarchicalCluster<T>

fn clone(&self) -> HierarchicalCluster<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Float> Debug for HierarchicalCluster<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default + Float> Default for HierarchicalCluster<T>

fn default() -> HierarchicalCluster<T>

Returns the “default value” for a type.

impl<F: Float> ParamGuard for HierarchicalCluster<F>

type Checked = ValidHierarchicalCluster<F>

The checked hyperparameters

type Error = HierarchicalError<F>

Error type resulting from failed hyperparameter checking

fn check_ref(&self) -> Result<&Self::Checked, Self::Error>

Checks the hyperparameters and returns a reference to the checked hyperparameters if successful

fn check(self) -> Result<Self::Checked, Self::Error>

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checkedwhere
    Self: Sized,

Calls check() and unwraps the result

impl<T: PartialEq + Float> PartialEq<HierarchicalCluster<T>> for HierarchicalCluster<T>

fn eq(&self, other: &HierarchicalCluster<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Float> StructuralPartialEq for HierarchicalCluster<T>

impl<F: Float> TransformGuard for HierarchicalCluster<F>