Struct argmin::solver::linesearch::hagerzhang::HagerZhangLineSearch

pub struct HagerZhangLineSearch<P, F> { /* private fields */ }

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

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

Implementations

impl<P: Default, F: ArgminFloat> HagerZhangLineSearch<P, F>

pub fn new() -> Self

Constructor

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

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

set delta

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

set sigma

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

set epsilon

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

set theta

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

set gamma

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

set eta

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

set alpha limits

Trait Implementations

impl<P, F> ArgminLineSearch<P, F> for HagerZhangLineSearch<P, F> where
    P: Clone + Default + Serialize + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P>,
    F: ArgminFloat, 

fn set_search_direction(&mut self, search_direction: P)

Set search direction

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

Set initial alpha value

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Default, F: ArgminFloat> Default for HagerZhangLineSearch<P, F>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, P, F> Deserialize<'de> for HagerZhangLineSearch<P, F> where
    P: Deserialize<'de>,
    F: 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, F> Serialize for HagerZhangLineSearch<P, F> where
    P: Serialize,
    F: 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, F> Solver<O> for HagerZhangLineSearch<P, F> where
    O: ArgminOp<Param = P, Output = F, Float = F>,
    P: Clone + Default + Serialize + DeserializeOwned + ArgminSub<P, P> + ArgminDot<P, F> + ArgminScaledAdd<P, F, P>,
    F: ArgminFloat, 

const NAME: &'static str

Name of the solver

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.