Struct gosh_lbfgs::LbfgsState

source · [−]

pub struct LbfgsState<'a, E> where
    E: FnMut(&[f64], &mut [f64]) -> Result<f64>,  { /* private fields */ }

Expand description

LBFGS optimization state allowing iterative propagation

Implementations

source

impl<'a, E> LbfgsState<'a, E> where
E: FnMut(&[f64 ], &mut [f64 ]) -> Result<f64>,

source

pub fn is_converged(&mut self) -> bool

Check if stopping critera met. Panics if not initialized.

source

pub fn report(&self) -> Report

Report minimization progress. Panics if not initialized yet.

source

pub fn propagate(&mut self) -> Result<Progress<'_>>

Propagate in next LBFGS step. Return optimization progress on success. Panics if not initialized.

Auto Trait Implementations

impl<'a, E> RefUnwindSafe for LbfgsState<'a, E> where
E: RefUnwindSafe,

impl<'a, E> Send for LbfgsState<'a, E> where
E: Send,

impl<'a, E> Sync for LbfgsState<'a, E> where
E: Sync,

impl<'a, E> Unpin for LbfgsState<'a, E> where
E: Unpin,

impl<'a, E> !UnwindSafe for LbfgsState<'a, E>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct gosh_lbfgs::LbfgsState

Implementations

impl<'a, E> LbfgsState<'a, E> where
E: FnMut(&[f64 ], &mut [f64 ]) -> Result<f64>,

pub fn is_converged(&mut self) -> bool

pub fn report(&self) -> Report

pub fn propagate(&mut self) -> Result<Progress<'_>>

Auto Trait Implementations

impl<'a, E> RefUnwindSafe for LbfgsState<'a, E> where
E: RefUnwindSafe,

impl<'a, E> Send for LbfgsState<'a, E> where
E: Send,

impl<'a, E> Sync for LbfgsState<'a, E> where
E: Sync,

impl<'a, E> Unpin for LbfgsState<'a, E> where
E: Unpin,

impl<'a, E> !UnwindSafe for LbfgsState<'a, E>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct gosh_lbfgs::LbfgsState

Implementations

impl<'a, E> LbfgsState<'a, E> where E: FnMut(&[f64], &mut [f64]) -> Result<f64>,

pub fn is_converged(&mut self) -> bool

pub fn report(&self) -> Report

pub fn propagate(&mut self) -> Result<Progress<'_>>

Auto Trait Implementations

impl<'a, E> RefUnwindSafe for LbfgsState<'a, E> where E: RefUnwindSafe,

impl<'a, E> Send for LbfgsState<'a, E> where E: Send,

impl<'a, E> Sync for LbfgsState<'a, E> where E: Sync,

impl<'a, E> Unpin for LbfgsState<'a, E> where E: Unpin,

impl<'a, E> !UnwindSafe for LbfgsState<'a, E>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<'a, E> LbfgsState<'a, E> where
E: FnMut(&[f64 ], &mut [f64 ]) -> Result<f64>,

impl<'a, E> RefUnwindSafe for LbfgsState<'a, E> where
E: RefUnwindSafe,

impl<'a, E> Send for LbfgsState<'a, E> where
E: Send,

impl<'a, E> Sync for LbfgsState<'a, E> where
E: Sync,

impl<'a, E> Unpin for LbfgsState<'a, E> where
E: Unpin,

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

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

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

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

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

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