[][src]Struct argmin::solver::linesearch::hagerzhang::HagerZhangLineSearch

pub struct HagerZhangLineSearch<P> { /* fields omitted */ }

The Hager-Zhang line search is a method to find a step length which obeys the strong Wolfe conditions.

Example

References

[0] William W. Hager and Hongchao Zhang. "A new conjugate gradient method with guaranteed descent and an efficient line search." SIAM J. Optim. 16(1), 2006, 170-192. DOI: https://doi.org/10.1137/030601880

Methods

impl<P: Default> HagerZhangLineSearch<P>[src]

pub fn new() -> Self[src]

Constructor

impl<P> HagerZhangLineSearch<P> where
    P: Clone + Default + Serialize + DeserializeOwned + ArgminScaledAdd<P, f64, P> + ArgminDot<P, f64>, 
[src]

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

set delta

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

set sigma

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

set epsilon

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

set theta

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

set gamma

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

set eta

pub fn alpha(self, alpha_min: f64, alpha_max: f64) -> Result<Self, Error>[src]

set alpha limits

Trait Implementations

impl<P: Default> Default for HagerZhangLineSearch<P>[src]

impl<P: Clone> Clone for HagerZhangLineSearch<P>[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<P> Serialize for HagerZhangLineSearch<P> where
    P: Serialize
[src]

impl<'de, P> Deserialize<'de> for HagerZhangLineSearch<P> where
    P: Deserialize<'de>, 
[src]

impl<P, O> Solver<O> for HagerZhangLineSearch<P> where
    O: ArgminOp<Param = P, Output = f64>,
    P: Clone + Default + Serialize + DeserializeOwned + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P>, 
[src]

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

Checks whether basic termination reasons apply. Read more

impl<P> ArgminLineSearch<P> for HagerZhangLineSearch<P> where
    P: Clone + Default + Serialize + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P>, 
[src]

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

Set search direction

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

Set initial alpha value

Auto Trait Implementations

impl<P> Send for HagerZhangLineSearch<P> where
    P: Send

impl<P> Sync for HagerZhangLineSearch<P> where
    P: Sync

Blanket Implementations

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

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

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<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

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

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

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