Enum linfa_clustering::IncrKMeansError

source · [−]

pub enum IncrKMeansError<M: Debug> {
    InvalidParams(KMeansParamsError),
    NotConverged(M),
    LinfaError(Error),
}

Variants

`InvalidParams(KMeansParamsError)`

When any of the hyperparameters are set the wrong value

`NotConverged(M)`

When the distance between the old and new centroids exceeds the tolerance parameter. Not an actual error, just there to signal that the algorithm should keep running.

`LinfaError(Error)`

Trait Implementations

source

impl<M: Debug + Debug> Debug for IncrKMeansError<M>

source

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

Formats the value using the given formatter. Read more

source

impl<M: Debug> Display for IncrKMeansError<M>

source

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

Formats the value using the given formatter. Read more

source

impl<M: Debug> Error for IncrKMeansError<M> where
Self: Debug + Display,

source

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more

source

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred. Read more

1.0.0 · source

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

source

impl<'a, F: Float + Debug, R: Rng + Clone, DA: Data<Elem = F>, T, D: 'a + Distance<F> + Debug> FitWith<'a, ArrayBase<DA, Dim<[usize ; 2]>>, T, IncrKMeansError<KMeans<F, D>>> for KMeansValidParams<F, R, D>

source

fn fit_with(
 &self,
 model: Self::ObjectIn,
 dataset: &'a DatasetBase<ArrayBase<DA, Ix2>, T>
) -> Result<Self::ObjectOut, IncrKMeansError<Self::ObjectOut>>

Performs a single batch update of the Mini-Batch K-means algorithm.

Given an input matrix observations, with shape (n_batch, n_features) and a previous KMeans model, the model’s centroids are updated with the input matrix. If model is None, then it’s initialized using the specified initialization algorithm. The return value consists of the updated model and a bool value that indicates whether the algorithm has converged.