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 for ArmijoCondition<F>
impl<F: PartialEq> PartialEq for ArmijoCondition<F>
source§impl<F> Serialize for ArmijoCondition<F>where
F: Serialize,
impl<F> Serialize for ArmijoCondition<F>where
F: Serialize,
impl<F: Copy> Copy for ArmijoCondition<F>
impl<F: Eq> Eq for ArmijoCondition<F>
impl<F> StructuralPartialEq for ArmijoCondition<F>
Auto Trait Implementations§
impl<F> Freeze for ArmijoCondition<F>where
F: Freeze,
impl<F> RefUnwindSafe for ArmijoCondition<F>where
F: RefUnwindSafe,
impl<F> Send for ArmijoCondition<F>where
F: Send,
impl<F> Sync for ArmijoCondition<F>where
F: Sync,
impl<F> Unpin for ArmijoCondition<F>where
F: Unpin,
impl<F> UnwindSafe for ArmijoCondition<F>where
F: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.