Struct linfa_ica::hyperparams::FastIcaParams

pub struct FastIcaParams<F: Float>(_);

Implementations

impl<F: Float> FastIcaParams<F>

pub fn new() -> Self

Create new FastICA algorithm with default values for its parameters

pub fn ncomponents(self, ncomponents: usize) -> Self

Set the number of components to use, if not set all are used

pub fn gfunc(self, gfunc: GFunc) -> Self

G function used in the approximation to neg-entropy, refer GFunc

pub fn max_iter(self, max_iter: usize) -> Self

Set maximum number of iterations during fit

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

Set tolerance on upate at each iteration

pub fn random_state(self, random_state: usize) -> Self

Set seed for random number generator for reproducible results.

Trait Implementations

impl<F: Clone + Float> Clone for FastIcaParams<F>

fn clone(&self) -> FastIcaParams<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float> Debug for FastIcaParams<F>

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

Formats the value using the given formatter.

impl<F: Float> Default for FastIcaParams<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float> ParamGuard for FastIcaParams<F>

type Checked = FastIcaValidParams<F>

The checked hyperparameters

type Error = FastIcaError

Error type resulting from failed hyperparameter checking

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

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

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

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checked

Calls check() and unwraps the result

impl<F: PartialEq + Float> PartialEq<FastIcaParams<F>> for FastIcaParams<F>

fn eq(&self, other: &FastIcaParams<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FastIcaParams<F>) -> bool

This method tests for !=.

impl<F: Float> StructuralPartialEq for FastIcaParams<F>