Struct ClusteringHelper

Source

pub struct ClusteringHelper<S>where
    S: Sized,
{ /* private fields */ }

Implementations§

Source §

impl ClusteringHelper<EntryPoint>

Functions available for all states

Source

pub fn new( samples: AnalysisArray, k_max: usize, optimizer: KOptimal, clustering_method: ClusteringMethod, projection_method: ProjectionMethod, ) -> Result<ClusteringHelper<NotInitialized>, ClusteringError>

Create a new KMeansHelper object

§Errors

Will return an error if there was an error projecting the data into a lower-dimensional space

Source §

impl ClusteringHelper<NotInitialized>

Functions available for NotInitialized state

Source

pub fn initialize( self, ) -> Result<ClusteringHelper<Initialized>, ClusteringError>

Initialize the KMeansHelper object

§Errors

Will return an error if there was an error calculating the optimal number of clusters

Source §

impl ClusteringHelper<Initialized>

Functions available for Initialized state

Source

pub fn cluster(self) -> ClusteringHelper<Finished>

Cluster the data into k clusters

§Errors

Will return an error if the clustering fails

Source §

impl ClusteringHelper<Finished>

Functions available for Finished state

Source

pub fn extract_analysis_clusters<T: Clone>( &self, samples: Vec<T>, ) -> Vec<Vec<T>>

use the labels to reorganize the provided samples into clusters

Auto Trait Implementations§

§

impl<S> UnwindSafe for ClusteringHelper<S>
where S: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §