Skip to main content

LineSearch

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_merit( &self, merit: impl FnMut(Scalar) -> Result<Scalar, String>, value: Scalar, slope: Scalar, step_size: Scalar, ) -> Result<Scalar, LineSearchError>

Backtrack on a merit function of the step size alone.

The exact penalty function is not differentiable, its norm having a kink wherever a constraint is satisfied, so its slope along the step is supplied rather than recovered from a gradient.

pub fn backtrack<X, J, D, W, E>( &self, function: impl FnMut(&X, Scalar) -> Result<Scalar, String>, jacobian: impl FnMut(&X) -> Result<J, String>, argument: &X, jacobian0: &J, decrement: &D, step_size: Scalar, ) -> Result<Scalar, LineSearchError>
where J: Erase<Erased = E> + Jacobian, D: Erase<Erased = E>, E: Tensor, X: Solution, for<'a> &'a D: Mul<Quantity<W>, Output = X>,

Trait Implementations§

impl Clone for LineSearch

fn clone(&self) -> LineSearch

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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 UnsafeUnpin 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> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. 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> Is<T> for T

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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.