conspire::math::optimize

Enum LineSearch

pub enum LineSearch {
    Armijo {
        control: Scalar,
        cut_back: Scalar,
        max_steps: usize,
    },
    Error {
        cut_back: Scalar,
        max_steps: usize,
    },
    Goldstein {
        control: Scalar,
        cut_back: Scalar,
        max_steps: usize,
    },
    Wolfe {
        control_1: Scalar,
        control_2: Scalar,
        cut_back: Scalar,
        max_steps: usize,
        strong: bool,
    },
    None,
}

Expand description

Available line search algorithms.

Variants§

Armijo

The Armijo condition.

Fields

§control: Scalar

§cut_back: Scalar

§max_steps: usize

Error

Backtrack for errors.

Fields

§cut_back: Scalar

§max_steps: usize

Goldstein

The Goldstein conditions.

Fields

§control: Scalar

§cut_back: Scalar

§max_steps: usize

Wolfe

The Wolfe conditions.

Fields

§control_1: Scalar

§control_2: Scalar

§cut_back: Scalar

§max_steps: usize

§strong: bool

None

No line search.

Implementations§

impl LineSearch

pub fn backtrack<X, J>( &self, function: impl Fn(&X) -> Result<Scalar, String>, jacobian: impl Fn(&X) -> Result<J, String>, argument: &X, jacobian0: &J, decrement: &X, step_size: Scalar, ) -> Result<Scalar, LineSearchError>
where J: Jacobian, for<'a> &'a J: From<&'a X>, X: Solution, for<'a> &'a X: Mul<Scalar, Output = X>,

Trait Implementations§

impl Debug for LineSearch

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

Formats the value using the given formatter. Read more

impl Default for LineSearch

fn default() -> Self

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

impl Display for LineSearch

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for LineSearch

impl RefUnwindSafe for LineSearch

impl Send for LineSearch

impl Sync for LineSearch

impl Unpin for LineSearch

impl UnwindSafe for LineSearch

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<A, Y, U> OdeSolver<Y, U> for A
where A: Debug, Y: Tensor, U: TensorVec<Item = Y>,