Struct LineSearch

Source

pub struct LineSearch {
    pub method: LineSearchMethod,
    pub c1: f64,
    pub c2: f64,
    pub max_iterations: usize,
    pub initial_step: f64,
    pub step_decay: f64,
}

Expand description

Line search methods for optimization algorithms

Fields§

§method: LineSearchMethod§c1: f64§c2: f64§max_iterations: usize§initial_step: f64§step_decay: f64

Implementations§

Source §

impl LineSearch

Source

pub fn armijo(c1: f64) -> Self

Create Armijo line search with default parameters

Source

pub fn wolfe(c1: f64, c2: f64) -> Self

Create Wolfe line search with default parameters

Source

pub fn strong_wolfe(c1: f64, c2: f64) -> Self

Create strong Wolfe line search

Source

pub fn backtracking(c1: f64) -> Self

Create backtracking line search

Source

pub fn search<F, G>( &self, f: F, grad_f: G, x: &ArrayView1<'_, f64>, direction: &ArrayView1<'_, f64>, f_x: f64, grad_x: &ArrayView1<'_, f64>, ) -> UtilsResult<f64>
where F: Fn(&ArrayView1<'_, f64>) -> f64, G: Fn(&ArrayView1<'_, f64>) -> Array1<f64>,

Perform line search to find appropriate step size

Trait Implementations§

Source §

impl Clone for LineSearch

Source §

fn clone(&self) -> LineSearch

Returns a duplicate 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 Debug for LineSearch

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for LineSearch

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, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §