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,

source

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

Construct a new ArmijoCondition instance.

§Example
let armijo = ArmijoCondition::new(0.0001f64);

Trait Implementations§

source§

impl<F: Clone> Clone for ArmijoCondition<F>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<F: Debug> Debug for ArmijoCondition<F>

source§

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

Formats the value using the given formatter. Read more
source§

impl<F: Default> Default for ArmijoCondition<F>

source§

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>,

source§

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,

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

Evaluate the condition Read more
source§

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>

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<F> Serialize for ArmijoCondition<F>
where F: Serialize,

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<F: Copy> Copy for ArmijoCondition<F>

source§

impl<F: Eq> Eq for ArmijoCondition<F>

source§

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

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

Checks if self is actually part of its subset T (and can be converted to it).
§

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

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

source§

impl<T> SendAlias for T

source§

impl<T> SyncAlias for T