MinimizationSettings

Enum MinimizationSettings 

Source
pub enum MinimizationSettings<P> {
    LBFGSB {
        config: LBFGSBConfig,
        callbacks: Callbacks<LBFGSB, P, GradientStatus, MaybeThreadPool, LadduError, LBFGSBConfig>,
        num_threads: usize,
    },
    Adam {
        config: AdamConfig,
        callbacks: Callbacks<Adam, P, GradientStatus, MaybeThreadPool, LadduError, AdamConfig>,
        num_threads: usize,
    },
    NelderMead {
        config: NelderMeadConfig,
        callbacks: Callbacks<NelderMead, P, GradientFreeStatus, MaybeThreadPool, LadduError, NelderMeadConfig>,
        num_threads: usize,
    },
    PSO {
        config: PSOConfig,
        callbacks: Callbacks<PSO, P, SwarmStatus, MaybeThreadPool, LadduError, PSOConfig>,
        num_threads: usize,
    },
}
Expand description

A settings wrapper for minimization algorithms

Variants§

§

LBFGSB

Settings for the L-BFGS-B algorithm

Fields

§config: LBFGSBConfig

The configuration struct

§callbacks: Callbacks<LBFGSB, P, GradientStatus, MaybeThreadPool, LadduError, LBFGSBConfig>

Callbacks to apply to the algorithm

§num_threads: usize

The number of threads to use (0 will run in single-threaded mode)

§

Adam

Settings for the Adam algorithm

Fields

§config: AdamConfig

The configuration struct

§callbacks: Callbacks<Adam, P, GradientStatus, MaybeThreadPool, LadduError, AdamConfig>

Callbacks to apply to the algorithm

§num_threads: usize

The number of threads to use (0 will run in single-threaded mode)

§

NelderMead

Settings for the Nelder-Mead algorithm

Fields

§config: NelderMeadConfig

The configuration struct

§callbacks: Callbacks<NelderMead, P, GradientFreeStatus, MaybeThreadPool, LadduError, NelderMeadConfig>

Callbacks to apply to the algorithm

§num_threads: usize

The number of threads to use (0 will run in single-threaded mode)

§

PSO

Settings for the Particle Swarm Optimimization algorithm

Fields

§config: PSOConfig

The configuration struct

§callbacks: Callbacks<PSO, P, SwarmStatus, MaybeThreadPool, LadduError, PSOConfig>

Callbacks to apply to the algorithm

§num_threads: usize

The number of threads to use (0 will run in single-threaded mode)

Trait Implementations§

Source§

impl<P> Threadable for MinimizationSettings<P>

Source§

fn get_pool(&self) -> Result<MaybeThreadPool, LadduError>

Returns a MaybeThreadPool associated with the object. Read more

Auto Trait Implementations§

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> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> TransformExt for T

Source§

fn compose<T2>(self, t2: T2) -> Compose<Self, T2>

Compose a transform with another. Read more
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.