Struct linfa_clustering::GmmParams

source · [−]

pub struct GmmParams<F: Float, R: Rng>(_);

Expand description

The set of hyperparameters that can be specified for the execution of the GMM algorithm.

Implementations

source

pub fn covariance_type(self, covar_type: GmmCovarType) -> Self

Set the covariance type.

source

pub fn tolerance(self, tolerance: F) -> Self

Set the convergence threshold. EM iterations will stop when the lower bound average gain is below this threshold.

source

pub fn reg_covariance(self, reg_covar: F) -> Self

Non-negative regularization added to the diagonal of covariance. Allows to assure that the covariance matrices are all positive.

source

pub fn n_runs(self, n_runs: u64) -> Self

Set the number of initializations to perform. The best results are kept.

source

pub fn max_n_iterations(self, max_n_iter: u64) -> Self

Set the number of EM iterations to perform.

source

pub fn init_method(self, init_method: GmmInitMethod) -> Self

Set the method used to initialize the weights, the means and the precisions.

source

pub fn with_rng<R2: Rng + Clone>(self, rng: R2) -> GmmParams<F, R2>

Trait Implementations

source

impl<F: Clone + Float, R: Clone + Rng> Clone for GmmParams<F, R>

source

fn clone(&self) -> GmmParams<F, R>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<F: Debug + Float, R: Debug + Rng> Debug for GmmParams<F, R>

source

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

Formats the value using the given formatter. Read more

source

impl<F: Float, R: Rng> ParamGuard for GmmParams<F, R>

type Checked = GmmValidParams<F, R>

The checked hyperparameters

type Error = GmmError

Error type resulting from failed hyperparameter checking

source

fn check_ref(&self) -> Result<&Self::Checked, GmmError>

Checks the hyperparameters and returns a reference to the checked hyperparameters if successful Read more

source

fn check(self) -> Result<Self::Checked, GmmError>

Checks the hyperparameters and returns the checked hyperparameters if successful

source

fn check_unwrap(self) -> Self::Checked

Calls check() and unwraps the result

Auto Trait Implementations

impl<F, R> RefUnwindSafe for GmmParams<F, R> where
F: RefUnwindSafe,
R: RefUnwindSafe,

impl<F, R> Send for GmmParams<F, R> where
R: Send,

impl<F, R> Sync for GmmParams<F, R> where
R: Sync,

impl<F, R> Unpin for GmmParams<F, R> where
F: Unpin,
R: Unpin,

impl<F, R> UnwindSafe for GmmParams<F, R> where
F: UnwindSafe,
R: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct linfa_clustering::GmmParams

Implementations

impl<F: Float> GmmParams<F, Isaac64Rng>

pub fn new(n_clusters: usize) -> GmmParams<F, Isaac64Rng>

impl<F: Float, R: Rng + Clone> GmmParams<F, R>

pub fn covariance_type(self, covar_type: GmmCovarType) -> Self

pub fn tolerance(self, tolerance: F) -> Self

pub fn reg_covariance(self, reg_covar: F) -> Self

pub fn n_runs(self, n_runs: u64) -> Self

pub fn max_n_iterations(self, max_n_iter: u64) -> Self

pub fn init_method(self, init_method: GmmInitMethod) -> Self

pub fn with_rng<R2: Rng + Clone>(self, rng: R2) -> GmmParams<F, R2>

Trait Implementations

impl<F: Clone + Float, R: Clone + Rng> Clone for GmmParams<F, R>

fn clone(&self) -> GmmParams<F, R>

fn clone_from(&mut self, source: &Self)

impl<F: Debug + Float, R: Debug + Rng> Debug for GmmParams<F, R>

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

impl<F: Float, R: Rng> ParamGuard for GmmParams<F, R>

type Checked = GmmValidParams<F, R>

type Error = GmmError

fn check_ref(&self) -> Result<&Self::Checked, GmmError>

fn check(self) -> Result<Self::Checked, GmmError>

fn check_unwrap(self) -> Self::Checked

Auto Trait Implementations

impl<F, R> RefUnwindSafe for GmmParams<F, R> where F: RefUnwindSafe, R: RefUnwindSafe,

impl<F, R> Send for GmmParams<F, R> where R: Send,

impl<F, R> Sync for GmmParams<F, R> where R: Sync,

impl<F, R> Unpin for GmmParams<F, R> where F: Unpin, R: Unpin,

impl<F, R> UnwindSafe for GmmParams<F, R> where F: UnwindSafe, R: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

impl<F, R> RefUnwindSafe for GmmParams<F, R> where
F: RefUnwindSafe,
R: RefUnwindSafe,

impl<F, R> Send for GmmParams<F, R> where
R: Send,

impl<F, R> Sync for GmmParams<F, R> where
R: Sync,

impl<F, R> Unpin for GmmParams<F, R> where
F: Unpin,
R: Unpin,

impl<F, R> UnwindSafe for GmmParams<F, R> where
F: UnwindSafe,
R: UnwindSafe,

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

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