Skip to main content

WolfeLineSearch

Struct WolfeLineSearch 

Source
pub struct WolfeLineSearch { /* private fields */ }
Expand description

Wolfe line search with Armijo and curvature conditions.

Enforces both the Armijo condition (sufficient decrease) and the curvature condition (sufficient curvature):

Armijo:    f(x + α*d) ≤ f(x) + c₁*α*∇f(x)ᵀd
Curvature: |∇f(x + α*d)ᵀd| ≤ c₂*|∇f(x)ᵀd|

The curvature condition ensures the step size is not too small by requiring that the gradient has decreased sufficiently along the search direction.

§Parameters

  • c1: Armijo constant (typical: 1e-4), c₁ ∈ (0, c₂)
  • c2: Curvature constant (typical: 0.9), c₂ ∈ (c₁, 1)
  • max_iter: Maximum line search iterations

§Example

use aprender::optim::{WolfeLineSearch, LineSearch};
use aprender::primitives::Vector;

let line_search = WolfeLineSearch::new(1e-4, 0.9, 50);

let f = |x: &Vector<f32>| x[0] * x[0];
let grad = |x: &Vector<f32>| Vector::from_slice(&[2.0 * x[0]]);

let x = Vector::from_slice(&[1.0]);
let d = Vector::from_slice(&[-2.0]);

let alpha = line_search.search(&f, &grad, &x, &d);
assert!(alpha > 0.0);

Implementations§

Source§

impl WolfeLineSearch

Source

pub fn new(c1: f32, c2: f32, max_iter: usize) -> WolfeLineSearch

Creates a new Wolfe line search.

§Arguments
  • c1 - Armijo constant (typical: 1e-4)
  • c2 - Curvature constant (typical: 0.9)
  • max_iter - Maximum iterations (typical: 50)
§Panics

Panics if c1 >= c2 or values are outside (0, 1).

§Example
use aprender::optim::WolfeLineSearch;

let line_search = WolfeLineSearch::new(1e-4, 0.9, 50);

Trait Implementations§

Source§

impl Clone for WolfeLineSearch

Source§

fn clone(&self) -> WolfeLineSearch

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
Source§

impl Debug for WolfeLineSearch

Source§

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

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

impl Default for WolfeLineSearch

Source§

fn default() -> WolfeLineSearch

Creates a Wolfe line search with default parameters.

Defaults: c1=1e-4, c2=0.9, max_iter=50

Source§

impl LineSearch for WolfeLineSearch

Source§

fn search<F, G>(&self, f: &F, grad: &G, x: &Vector<f32>, d: &Vector<f32>) -> f32
where F: Fn(&Vector<f32>) -> f32, G: Fn(&Vector<f32>) -> Vector<f32>,

Finds a suitable step size along the search direction. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,