Struct kodama::LinkageState

pub struct LinkageState<T> { /* private fields */ }

Mutable scratch space used by the linkage algorithms.

LinkageState is an opaque representation of mutable scratch space used by the linkage algorithms. It is provided only for callers who wish to amortize allocation using the with variants of the clustering functions. This may be useful when your requirements call for rapidly running hierarchical clustering on small dissimilarity matrices.

The memory used by LinkageState is proportional to the number of observations being clustered.

The T type parameter refers to the type of dissimilarity used in the pairwise matrix. In practice, T is a floating point type.

Implementations

impl<T: Float> LinkageState<T>

pub fn new() -> LinkageState<T>

Create a new mutable scratch space for use in the with variants of the clustering functions.

The clustering functions will automatically resize the scratch space as needed based on the number of observations being clustered.

Trait Implementations

impl<T: Debug> Debug for LinkageState<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for LinkageState<T>

fn default() -> LinkageState<T>

Returns the “default value” for a type.