Struct argmin::solver::linesearch::condition::ArmijoCondition
source · pub struct ArmijoCondition<F> { /* private fields */ }
Expand description
Armijo Condition
Ensures that the step length “sufficiently” decreases the cost function value.
Implementations§
source§impl<F> ArmijoCondition<F>where
F: ArgminFloat,
impl<F> ArmijoCondition<F>where F: ArgminFloat,
Trait Implementations§
source§impl<F: Clone> Clone for ArmijoCondition<F>
impl<F: Clone> Clone for ArmijoCondition<F>
source§fn clone(&self) -> ArmijoCondition<F>
fn clone(&self) -> ArmijoCondition<F>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<F: Debug> Debug for ArmijoCondition<F>
impl<F: Debug> Debug for ArmijoCondition<F>
source§impl<F: Default> Default for ArmijoCondition<F>
impl<F: Default> Default for ArmijoCondition<F>
source§fn default() -> ArmijoCondition<F>
fn default() -> ArmijoCondition<F>
Returns the “default value” for a type. Read more
source§impl<'de, F> Deserialize<'de> for ArmijoCondition<F>where
F: Deserialize<'de>,
impl<'de, F> Deserialize<'de> for ArmijoCondition<F>where F: Deserialize<'de>,
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl<T, G, F> LineSearchCondition<T, G, F> for ArmijoCondition<F>where
G: ArgminDot<T, F>,
F: ArgminFloat,
impl<T, G, F> LineSearchCondition<T, G, F> for ArmijoCondition<F>where G: ArgminDot<T, F>, F: ArgminFloat,
source§fn evaluate_condition(
&self,
current_cost: F,
_current_gradient: Option<&G>,
initial_cost: F,
initial_gradient: &G,
search_direction: &T,
step_length: F
) -> bool
fn evaluate_condition( &self, current_cost: F, _current_gradient: Option<&G>, initial_cost: F, initial_gradient: &G, search_direction: &T, step_length: F ) -> bool
Evaluate the condition Read more
source§fn requires_current_gradient(&self) -> bool
fn requires_current_gradient(&self) -> bool
Indicates whether this condition requires the computation of the gradient at the new point Read more
source§impl<F: PartialEq> PartialEq<ArmijoCondition<F>> for ArmijoCondition<F>
impl<F: PartialEq> PartialEq<ArmijoCondition<F>> for ArmijoCondition<F>
source§fn eq(&self, other: &ArmijoCondition<F>) -> bool
fn eq(&self, other: &ArmijoCondition<F>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.