Struct argmin::solver::linesearch::condition::WolfeCondition

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

Wolfe conditions

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

Implementations

impl<F> WolfeCondition<F>

where F: ArgminFloat,

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

Construct a new instance of WolfeCondition.

Example

let wolfe = WolfeCondition::new(0.0001f64, 0.1f64);

Trait Implementations

impl<F: Clone> Clone for WolfeCondition<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for WolfeCondition<F>

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

Formats the value using the given formatter.

impl<F: Default> Default for WolfeCondition<F>

fn default() -> WolfeCondition<F>

Returns the “default value” for a type.

impl<'de, F> Deserialize<'de> for WolfeCondition<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 WolfeCondition<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 WolfeCondition<F>

fn eq(&self, other: &WolfeCondition<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 WolfeCondition<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 WolfeCondition<F>

impl<F: Eq> Eq for WolfeCondition<F>

impl<F> StructuralPartialEq for WolfeCondition<F>