argmin::solver::gradientdescent::steepestdescent

Struct SteepestDescent

Source
pub struct SteepestDescent<L> { /* private fields */ }
Expand description

Steepest descent iteratively takes steps in the direction of the strongest negative gradient. In each iteration, a line search is employed to obtain an appropriate step length.

Example

§References:

[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.

Implementations§

Source§

impl<L> SteepestDescent<L>

Source

pub fn new(linesearch: L) -> Self

Constructor

Trait Implementations§

Source§

impl<L: Clone> Clone for SteepestDescent<L>

Source§

fn clone(&self) -> SteepestDescent<L>

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<'de, L> Deserialize<'de> for SteepestDescent<L>
where L: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<L> Serialize for SteepestDescent<L>
where L: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<O, L, F> Solver<O> for SteepestDescent<L>
where O: ArgminOp<Output = F, Float = F>, O::Param: Clone + Default + Serialize + ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, O::Float> + ArgminScaledAdd<O::Param, O::Float, O::Param> + ArgminMul<O::Float, O::Param> + ArgminNorm<O::Float>, O::Hessian: Default, L: Clone + ArgminLineSearch<O::Param, O::Float> + Solver<OpWrapper<O>>, F: ArgminFloat,

Source§

const NAME: &'static str = "Steepest Descent"

Name of the solver
Source§

fn next_iter( &mut self, op: &mut OpWrapper<O>, state: &IterState<O>, ) -> Result<ArgminIterData<O>, Error>

Computes one iteration of the algorithm.
Source§

fn init( &mut self, _op: &mut OpWrapper<O>, _state: &IterState<O>, ) -> Result<Option<ArgminIterData<O>>, Error>

Initializes the algorithm Read more
Source§

fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether basic termination reasons apply. Read more
Source§

fn terminate(&mut self, _state: &IterState<O>) -> TerminationReason

Checks whether the algorithm must be terminated

Auto Trait Implementations§

§

impl<L> Freeze for SteepestDescent<L>
where L: Freeze,

§

impl<L> RefUnwindSafe for SteepestDescent<L>
where L: RefUnwindSafe,

§

impl<L> Send for SteepestDescent<L>
where L: Send,

§

impl<L> Sync for SteepestDescent<L>
where L: Sync,

§

impl<L> Unpin for SteepestDescent<L>
where L: Unpin,

§

impl<L> UnwindSafe for SteepestDescent<L>
where L: 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> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,