Struct argmin::solver::linesearch::condition::WolfeCondition[−][src]

pub struct WolfeCondition<F> { /* fields omitted */ }
Expand description

Wolfe Condition

Implementations

impl<F: ArgminFloat> WolfeCondition<F>[src]

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

Constructor

Trait Implementations

impl<F: Clone> Clone for WolfeCondition<F>[src]

fn clone(&self) -> WolfeCondition<F>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<F: Debug> Debug for WolfeCondition<F>[src]

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

Formats the value using the given formatter. Read more

impl<F: Default> Default for WolfeCondition<F>[src]

fn default() -> WolfeCondition<F>[src]

Returns the “default value” for a type. Read more

impl<'de, F> Deserialize<'de> for WolfeCondition<F> where
    F: Deserialize<'de>, [src]

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [src]

Deserialize this value from the given Serde deserializer. Read more

impl<T, F> LineSearchCondition<T, F> for WolfeCondition<F> where
    T: Clone + ArgminDot<T, F>,
    F: ArgminFloat + DeserializeOwned + Serialize, [src]

fn eval(
    &self,
    cur_cost: F,
    cur_grad: T,
    init_cost: F,
    init_grad: T,
    search_direction: T,
    alpha: F
) -> bool[src]

Evaluate the condition

fn requires_cur_grad(&self) -> bool[src]

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

impl<F> Serialize for WolfeCondition<F> where
    F: Serialize, [src]

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

Serialize this value into the given Serde serializer. Read more

impl<F: Copy> Copy for WolfeCondition<F>[src]

Auto Trait Implementations

impl<F> RefUnwindSafe for WolfeCondition<F> where
    F: RefUnwindSafe, 

impl<F> Send for WolfeCondition<F> where
    F: Send, 

impl<F> Sync for WolfeCondition<F> where
    F: Sync, 

impl<F> Unpin for WolfeCondition<F> where
    F: Unpin, 

impl<F> UnwindSafe for WolfeCondition<F> where
    F: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V

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

impl<T> SendSyncUnwindSafe for T where
    T: Send + Sync + UnwindSafe + ?Sized, [src]