Struct argmin::solver::gradientdescent::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 used to obtain an appropriate step length.
Requirements on the optimization problem
The optimization problem is required to implement CostFunction
and Gradient
.
Reference
Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.
Implementations
sourceimpl<L> SteepestDescent<L>
impl<L> SteepestDescent<L>
sourcepub fn new(linesearch: L) -> Self
pub fn new(linesearch: L) -> Self
Construct a new instance of SteepestDescent
Requires a line search.
Example
let sd = SteepestDescent::new(linesearch);
Trait Implementations
sourceimpl<L: Clone> Clone for SteepestDescent<L>
impl<L: Clone> Clone for SteepestDescent<L>
sourcefn clone(&self) -> SteepestDescent<L>
fn clone(&self) -> SteepestDescent<L>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'de, L> Deserialize<'de> for SteepestDescent<L> where
L: Deserialize<'de>,
impl<'de, L> Deserialize<'de> for SteepestDescent<L> where
L: Deserialize<'de>,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<L> Serialize for SteepestDescent<L> where
L: Serialize,
impl<L> Serialize for SteepestDescent<L> where
L: Serialize,
sourceimpl<O, L, P, G, F> Solver<O, IterState<P, G, (), (), F>> for SteepestDescent<L> where
O: CostFunction<Param = P, Output = F> + Gradient<Param = P, Gradient = G>,
P: Clone + SerializeAlias + DeserializeOwnedAlias,
G: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminMul<F, P>,
L: Clone + LineSearch<P, F> + Solver<O, IterState<P, G, (), (), F>>,
F: ArgminFloat,
impl<O, L, P, G, F> Solver<O, IterState<P, G, (), (), F>> for SteepestDescent<L> where
O: CostFunction<Param = P, Output = F> + Gradient<Param = P, Gradient = G>,
P: Clone + SerializeAlias + DeserializeOwnedAlias,
G: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminMul<F, P>,
L: Clone + LineSearch<P, F> + Solver<O, IterState<P, G, (), (), F>>,
F: ArgminFloat,
sourcefn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), (), F>
) -> Result<(IterState<P, G, (), (), F>, Option<KV>), Error>
fn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), (), F>
) -> Result<(IterState<P, G, (), (), F>, Option<KV>), Error>
sourcefn init(
&mut self,
_problem: &mut Problem<O>,
state: I
) -> Result<(I, Option<KV>), Error>
fn init(
&mut self,
_problem: &mut Problem<O>,
state: I
) -> Result<(I, Option<KV>), Error>
Initializes the algorithm. Read more
sourcefn terminate_internal(&mut self, state: &I) -> TerminationReason
fn terminate_internal(&mut self, state: &I) -> TerminationReason
Checks whether basic termination reasons apply. Read more
sourcefn terminate(&mut self, _state: &I) -> TerminationReason
fn terminate(&mut self, _state: &I) -> TerminationReason
Used to implement stopping criteria, in particular criteria which are not covered by
(terminate_internal
. Read more
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more