[][src]Enum kmeans::AbortStrategy

pub enum AbortStrategy<T: Primitive> {
    NoImprovement {
        threshold: T,
    },
    NoImprovementForXIterations {
        x: usize,
        threshold: T,
        abort_on_negative: bool,
    },
}

Enum with possible abort strategies. These strategies specify when a running iteration (with the k-means calculation) is aborted.

Variants

NoImprovement

This strategy aborts the calculation directly after an iteration produced no improvement where improvement > threshold for the first time.

Fields:

  • threshold: Threshold, used to detect an improvement (improvement > threshold)

Fields of NoImprovement

threshold: T
NoImprovementForXIterations

This strategy aborts the calculation, when there have not been any improvements after x iterations, where improvement > threshold.

Fields:

  • x: The amount of consecutive without improvement, after which the calculation is aborted
  • threshold: Threshold, used to detect an improvement (improvement > threshold)
  • abort_on_negative: Specifies whether the strategy instantly aborts when a negative improvement occured (true), or if negative improvements are handled as "no improvements" (false).

Fields of NoImprovementForXIterations

x: usizethreshold: Tabort_on_negative: bool

Auto Trait Implementations

impl<T> RefUnwindSafe for AbortStrategy<T> where
    T: RefUnwindSafe

impl<T> Send for AbortStrategy<T>

impl<T> Sync for AbortStrategy<T>

impl<T> Unpin for AbortStrategy<T> where
    T: Unpin

impl<T> UnwindSafe for AbortStrategy<T> where
    T: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T, U> Cast<U> for T where
    U: FromCast<T>, 
[src]

impl<T> From<T> for T[src]

impl<T> FromCast<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,