Struct argmin::solver::linesearch::backtracking::BacktrackingLineSearch[][src]

pub struct BacktrackingLineSearch<P, L, F> { /* 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

Implementations

impl<P: Default, L, F: ArgminFloat> BacktrackingLineSearch<P, L, F>[src]

pub fn new(condition: L) -> Self[src]

Constructor

pub fn rho(self, rho: F) -> Result<Self, Error>[src]

Set rho

Trait Implementations

impl<P, L, F> ArgminLineSearch<P, F> for BacktrackingLineSearch<P, L, F> where
    P: Clone + Serialize + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P>,
    L: LineSearchCondition<P, F>,
    F: ArgminFloat + Serialize + DeserializeOwned
[src]

fn set_search_direction(&mut self, search_direction: P)[src]

Set search direction

fn set_init_alpha(&mut self, alpha: F) -> Result<(), Error>[src]

Set initial alpha value

impl<P: Clone, L: Clone, F: Clone> Clone for BacktrackingLineSearch<P, L, F>[src]

impl<'de, P, L, F> Deserialize<'de> for BacktrackingLineSearch<P, L, F> where
    P: Deserialize<'de>,
    L: Deserialize<'de>,
    F: Deserialize<'de>, 
[src]

impl<P, L, F> Serialize for BacktrackingLineSearch<P, L, F> where
    P: Serialize,
    L: Serialize,
    F: Serialize
[src]

impl<O, P, L, F> Solver<O> for BacktrackingLineSearch<P, L, F> where
    P: Clone + Default + Serialize + DeserializeOwned + ArgminSub<P, P> + ArgminDot<P, F> + ArgminScaledAdd<P, F, P>,
    O: ArgminOp<Param = P, Output = F, Float = F>,
    L: LineSearchCondition<P, F>,
    F: ArgminFloat
[src]

Auto Trait Implementations

impl<P, L, F> RefUnwindSafe for BacktrackingLineSearch<P, L, F> where
    F: RefUnwindSafe,
    L: RefUnwindSafe,
    P: RefUnwindSafe

impl<P, L, F> Send for BacktrackingLineSearch<P, L, F> where
    F: Send,
    L: Send,
    P: Send

impl<P, L, F> Sync for BacktrackingLineSearch<P, L, F> where
    F: Sync,
    L: Sync,
    P: Sync

impl<P, L, F> Unpin for BacktrackingLineSearch<P, L, F> where
    F: Unpin,
    P: Unpin

impl<P, L, F> UnwindSafe for BacktrackingLineSearch<P, L, F> where
    F: UnwindSafe,
    L: UnwindSafe,
    P: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

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

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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

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

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