Struct kodama::LinkageState
[−]
[src]
pub struct LinkageState<T> { /* fields omitted */ }
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.
Methods
impl<T: Float> LinkageState<T>
[src]
pub fn new() -> LinkageState<T>
[src]
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>
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<T: Default> Default for LinkageState<T>
[src]
fn default() -> LinkageState<T>
[src]
Returns the "default value" for a type. Read more
Auto Trait Implementations
impl<T> Send for LinkageState<T> where
T: Send,
T: Send,
impl<T> Sync for LinkageState<T> where
T: Sync,
T: Sync,