Struct LBFGSConfig 

pub struct LBFGSConfig {
    pub max_iter: usize,
    pub history_size: usize,
    pub tolerance_grad: f64,
    pub tolerance_change: f64,
    pub max_eval: Option<usize>,
    pub line_search_fn: LineSearchFn,
}

LBFGS Configuration.

Fields

max_iter: usize

Maximal number of iterations per optimization step (default: 20)

history_size: usize

Update history size (default: 100).

tolerance_grad: f64

Termination tolerance on first order optimality (default: 1e-7).

tolerance_change: f64

Termination tolerance on function value/parameter changes (default: 1e-9).

max_eval: Option<usize>

Maximal number of function evaluations per optimization step (default: max_iter * 1.25).

line_search_fn: LineSearchFn

Either ‘strong_wolfe’ or None (default: None).

Implementations

impl LBFGSConfig

pub fn new() -> LBFGSConfig

Create a new instance of the config.

Arguments

Default Arguments

max_iter

Maximal number of iterations per optimization step (default: 20)

• Defaults to 20

history_size

Update history size (default: 100).

• Defaults to 100

tolerance_grad

Termination tolerance on first order optimality (default: 1e-7).

• Defaults to 1e-7

tolerance_change

Termination tolerance on function value/parameter changes (default: 1e-9).

• Defaults to 1e-9

max_eval

Maximal number of function evaluations per optimization step (default: max_iter * 1.25).

• Defaults to "None"

line_search_fn

Either ‘strong_wolfe’ or None (default: None).

• Defaults to "LineSearchFn::None"

impl LBFGSConfig

pub fn with_max_iter(self, max_iter: usize) -> LBFGSConfig

Sets the value for the field max_iter.

Maximal number of iterations per optimization step (default: 20)

• Defaults to 20

pub fn with_history_size(self, history_size: usize) -> LBFGSConfig

Sets the value for the field history_size.

Update history size (default: 100).

• Defaults to 100

pub fn with_tolerance_grad(self, tolerance_grad: f64) -> LBFGSConfig

Sets the value for the field tolerance_grad.

Termination tolerance on first order optimality (default: 1e-7).

• Defaults to 1e-7

pub fn with_tolerance_change(self, tolerance_change: f64) -> LBFGSConfig

Sets the value for the field tolerance_change.

Termination tolerance on function value/parameter changes (default: 1e-9).

• Defaults to 1e-9

pub fn with_max_eval(self, max_eval: Option<usize>) -> LBFGSConfig

Sets the value for the field max_eval.

Maximal number of function evaluations per optimization step (default: max_iter * 1.25).

• Defaults to "None"

pub fn with_line_search_fn(self, line_search_fn: LineSearchFn) -> LBFGSConfig

Sets the value for the field line_search_fn.

Either ‘strong_wolfe’ or None (default: None).

• Defaults to "LineSearchFn::None"

impl LBFGSConfig

pub fn init(&self) -> LBFGS

Initialize LBFGS optimizer.

Returns

Returns an optimizer that can be used to optimize a module

Trait Implementations

impl Clone for LBFGSConfig

fn clone(&self) -> LBFGSConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for LBFGSConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for LBFGSConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LBFGSConfig

fn deserialize<D>( deserializer: D, ) -> Result<LBFGSConfig, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LBFGSConfig

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

Formats the value using the given formatter.

impl Serialize for LBFGSConfig

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.