Struct argmin::solver::linesearch::condition::StrongWolfeCondition

pub struct StrongWolfeCondition<F> { /* private fields */ }

Strong Wolfe conditions

Assures that a step length satisfies a “sufficient decrease” in cost function value (see ArmijoCondition as well as that the absolute value of the slope has been reduced sufficiently (thus making it more likely to be close to a critical point).

Implementations

impl<F> StrongWolfeCondition<F>

where F: ArgminFloat,

pub fn new(c1: F, c2: F) -> Result<Self, Error>

Construct a new instance of StrongWolfeCondition.

Example

let strongwolfe = StrongWolfeCondition::new(0.0001f64, 0.1f64);

Trait Implementations

impl<F: Clone> Clone for StrongWolfeCondition<F>

fn clone(&self) -> StrongWolfeCondition<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for StrongWolfeCondition<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F: Default> Default for StrongWolfeCondition<F>

fn default() -> StrongWolfeCondition<F>

Returns the “default value” for a type.

impl<'de, F> Deserialize<'de> for StrongWolfeCondition<F>

where 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<T, G, F> LineSearchCondition<T, G, F> for StrongWolfeCondition<F>

where G: ArgminDot<T, F>, F: ArgminFloat,

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

fn requires_current_gradient(&self) -> bool

Indicates whether this condition requires the computation of the gradient at the new point

impl<F: PartialEq> PartialEq for StrongWolfeCondition<F>

fn eq(&self, other: &StrongWolfeCondition<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F> Serialize for StrongWolfeCondition<F>

where 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<F: Copy> Copy for StrongWolfeCondition<F>

impl<F: Eq> Eq for StrongWolfeCondition<F>

impl<F> StructuralPartialEq for StrongWolfeCondition<F>