Struct HalsOpts

Source

pub struct HalsOpts<F: BixverseFloat> {
    pub max_iter: usize,
    pub tol: F,
    pub eps: F,
    pub check_every: usize,
    pub init: NmfInit,
}

Expand description

HALS solver options.

Fields§

§max_iter: usize

Maximum number of outer iterations.

§tol: F

Relative objective decrease below which the solver stops.

§eps: F

Floor applied to W and H entries on every sweep.

§check_every: usize

Cadence (in iterations) for evaluating the Frobenius objective.

§init: NmfInit

How W and H are initialised.

Implementations§

Source §

impl<F: BixverseFloat> HalsOpts<F>

Source

pub fn new( max_iter: usize, tol: F, eps: F, check_every: usize, init: NmfInit, ) -> Self

Generate a new instance of HalsOpts

§Params

max_iter - Maximum iterations to run the algorithm for
tol - Tolerance for early stopping
eps - Floor applied to W and H entries on every sweep.
check_every - Cadence (in iters) for evaluating the Frobenius objective.
init - How the W and H matrices are initialised, see NmfInit.

§Returns

The initialised HalsOpts.

Trait Implementations§

Source §

impl<F: Clone + BixverseFloat> Clone for HalsOpts<F>

Source §

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<F: Debug + BixverseFloat> Debug for HalsOpts<F>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<T> Default for HalsOpts<T>
where T: BixverseFloat,

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<F> UnwindSafe for HalsOpts<F>
where F: 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> ByRef<T> for T

Source §

fn by_ref(&self) -> &T

Source §

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

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

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

Source §

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

Source §

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §