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>

pub fn new() -> Self

Constructor

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

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

set delta

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

set sigma

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

set epsilon

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

set theta

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

set gamma

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

set eta

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

set alpha limits

Trait Implementations

impl<P: Default> Default for HagerZhangLineSearch<P>

fn default() -> Self

Returns the "default value" for a type.

impl<P: Clone> Clone for HagerZhangLineSearch<P>

fn clone(&self) -> HagerZhangLineSearch<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Serialize for HagerZhangLineSearch<P> where
    P: 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, 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>, 

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> Deserialize<'de> for HagerZhangLineSearch<P> where
    P: 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> ArgminLineSearch<P> for HagerZhangLineSearch<P> where
    P: Clone + Default + Serialize + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, 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