Struct Config

Source
pub struct Config<V: Value> { /* private fields */ }
Expand description

Algorithm configuration parameters, passed to rkm::kmeans_lloyd to specify:

  • Random number generator seed
  • The maximum number of iterations to terminate the algorithm at
  • The minimum delta for all means from iteration to iteration The algorithm will terminate if the maximum number of iterations is exceeded, or none of the means change by at least the minimum delta distance, or the algorithm converges.

Implementations§

Source§

impl<V: Value> Config<V>

Source

pub fn from( random_seed: Option<RandomSeed>, max_iterations: Option<u64>, min_delta: Option<V>, ) -> Config<V>

Create a new config struct from a partial or complete set of parameters

Source

pub fn empty() -> Config<V>

Create an empty config struct

Trait Implementations§

Source§

impl<V: Debug + Value> Debug for Config<V>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V> Freeze for Config<V>
where V: Freeze,

§

impl<V> RefUnwindSafe for Config<V>
where V: RefUnwindSafe,

§

impl<V> Send for Config<V>

§

impl<V> Sync for Config<V>

§

impl<V> Unpin for Config<V>
where V: Unpin,

§

impl<V> UnwindSafe for Config<V>
where V: 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<U> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.