Struct argmin::solver::linesearch::backtracking::BacktrackingLineSearch

pub struct BacktrackingLineSearch<P, L> { /* fields omitted */ }

The Backtracking line search is a simple method to find a step length which obeys the Armijo (sufficient decrease) condition.

Example

References:

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

[1] Wikipedia: https://en.wikipedia.org/wiki/Backtracking_line_search

Methods

impl<P: Default, L> BacktrackingLineSearch<P, L>

pub fn new(condition: L) -> Self

Constructor

pub fn rho(self, rho: f64) -> Result<Self, Error>

Set rho

Trait Implementations

impl<P: Clone, L: Clone> Clone for BacktrackingLineSearch<P, L>

fn clone(&self) -> BacktrackingLineSearch<P, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O, P, L> Solver<O> for BacktrackingLineSearch<P, L> where
    P: Clone + Default + Serialize + DeserializeOwned + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P>,
    O: ArgminOp<Param = P, Output = f64>,
    L: LineSearchCondition<P>, 

const NAME: &'static str

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

Initializes the algorithm

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

Computes one iteration of the algorithm.

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

Checks whether the algorithm must be terminated

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

Checks whether basic termination reasons apply.

impl<'de, P, L> Deserialize<'de> for BacktrackingLineSearch<P, L> where
    P: Deserialize<'de>,
    L: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<P, L> Serialize for BacktrackingLineSearch<P, L> where
    P: Serialize,
    L: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<P, L> ArgminLineSearch<P> for BacktrackingLineSearch<P, L> where
    P: Clone + Serialize + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P>,
    L: LineSearchCondition<P>, 

fn set_search_direction(&mut self, search_direction: P)

Set search direction

fn set_init_alpha(&mut self, alpha: f64) -> Result<(), Error>

Set initial alpha value