[−][src]Struct argmin::solver::linesearch::hagerzhang::HagerZhangLineSearch
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
Methods
impl<P: Default, F: ArgminFloat> HagerZhangLineSearch<P, F>
[src]
impl<P, F> HagerZhangLineSearch<P, F> where
P: Clone + Default + Serialize + DeserializeOwned + ArgminScaledAdd<P, F, P> + ArgminDot<P, F>,
F: ArgminFloat,
[src]
P: Clone + Default + Serialize + DeserializeOwned + ArgminScaledAdd<P, F, P> + ArgminDot<P, F>,
F: ArgminFloat,
pub fn delta(self, delta: F) -> Result<Self, Error>
[src]
set delta
pub fn sigma(self, sigma: F) -> Result<Self, Error>
[src]
set sigma
pub fn epsilon(self, epsilon: F) -> Result<Self, Error>
[src]
set epsilon
pub fn theta(self, theta: F) -> Result<Self, Error>
[src]
set theta
pub fn gamma(self, gamma: F) -> Result<Self, Error>
[src]
set gamma
pub fn eta(self, eta: F) -> Result<Self, Error>
[src]
set eta
pub fn alpha(self, alpha_min: F, alpha_max: F) -> Result<Self, Error>
[src]
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,
[src]
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)
[src]
Set search direction
fn set_init_alpha(&mut self, alpha: F) -> Result<(), Error>
[src]
Set initial alpha value
impl<P: Clone, F: Clone> Clone for HagerZhangLineSearch<P, F>
[src]
fn clone(&self) -> HagerZhangLineSearch<P, F>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<P: Default, F: ArgminFloat> Default for HagerZhangLineSearch<P, F>
[src]
impl<'de, P, F> Deserialize<'de> for HagerZhangLineSearch<P, F> where
P: Deserialize<'de>,
F: Deserialize<'de>,
[src]
P: Deserialize<'de>,
F: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl<P, F> Serialize for HagerZhangLineSearch<P, F> where
P: Serialize,
F: Serialize,
[src]
P: Serialize,
F: Serialize,
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: 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,
[src]
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
[src]
fn init(
&mut self,
op: &mut OpWrapper<O>,
state: &IterState<O>
) -> Result<Option<ArgminIterData<O>>, Error>
[src]
&mut self,
op: &mut OpWrapper<O>,
state: &IterState<O>
) -> Result<Option<ArgminIterData<O>>, Error>
fn next_iter(
&mut self,
op: &mut OpWrapper<O>,
_state: &IterState<O>
) -> Result<ArgminIterData<O>, Error>
[src]
&mut self,
op: &mut OpWrapper<O>,
_state: &IterState<O>
) -> Result<ArgminIterData<O>, Error>
fn terminate(&mut self, _state: &IterState<O>) -> TerminationReason
[src]
fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason
[src]
Auto Trait Implementations
impl<P, F> RefUnwindSafe for HagerZhangLineSearch<P, F> where
F: RefUnwindSafe,
P: RefUnwindSafe,
F: RefUnwindSafe,
P: RefUnwindSafe,
impl<P, F> Send for HagerZhangLineSearch<P, F> where
F: Send,
P: Send,
F: Send,
P: Send,
impl<P, F> Sync for HagerZhangLineSearch<P, F> where
F: Sync,
P: Sync,
F: Sync,
P: Sync,
impl<P, F> Unpin for HagerZhangLineSearch<P, F> where
F: Unpin,
P: Unpin,
F: Unpin,
P: Unpin,
impl<P, F> UnwindSafe for HagerZhangLineSearch<P, F> where
F: UnwindSafe,
P: UnwindSafe,
F: UnwindSafe,
P: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SendSyncUnwindSafe for T where
T: Send + Sync + UnwindSafe + ?Sized,
[src]
T: Send + Sync + UnwindSafe + ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,