Struct optimize::NelderMeadBuilder

pub struct NelderMeadBuilder { /* fields omitted */ }

Builder for NelderMead.

Methods

impl NelderMeadBuilder

pub fn ulps(&mut self, value: i64) -> &mut Self

The required number of floating point representations that separate two numbers to consider them equal. See crate float_cmp for more information.

pub fn maxiter<VALUE: Into<Option<usize>>>(&mut self, value: VALUE) -> &mut Self

The maximum number of iterations to optimize. If neither maxiter nor maxfun are given, both default to n*200 where n is the number of parameters to optimize.

pub fn maxfun<VALUE: Into<Option<usize>>>(&mut self, value: VALUE) -> &mut Self

The maximum number of function calls used to optimize. If neither maxiter nor maxfun are given, both default to n*200 where n is the number of parameters to optimize.

pub fn adaptive(&mut self, value: bool) -> &mut Self

Adapt algorithm parameters to dimensionality of the problem. Useful for high-dimensional minimization.

pub fn xtol(&mut self, value: f64) -> &mut Self

Absolute error in function parameters between iterations that is acceptable for convergence.

pub fn ftol(&mut self, value: f64) -> &mut Self

Absolute error in function values between iterations that is acceptable for convergence.

pub fn build(&self) -> Result<NelderMead, String>

Builds a new NelderMead.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for NelderMeadBuilder

fn default() -> NelderMeadBuilder

Returns the "default value" for a type.

impl Clone for NelderMeadBuilder

fn clone(&self) -> NelderMeadBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.