Struct Options 

pub struct Options<'a, F> {
    pub method: Option<Method>,
    pub bounds: Option<Bounds<'a, F>>,
    pub tolerance: Option<F>,
    pub evaluations: Option<usize>,
    pub population: Option<usize>,
    pub seed: u64,
}

What a front runs and when it stops. Options::default() lets Method::choose pick the method and leaves every variable unbounded.

Fields

method: Option<Method>

The method, or None for the one Method::choose picks.

bounds: Option<Bounds<'a, F>>

Limits on the variables. L-BFGS, Levenberg–Marquardt and the Krylov methods take none, and differential evolution needs finite ones. For Brent’s method solving an equation, finite limits are the bracket.

tolerance: Option<F>

The relative change at which a method stops, or None for √ε of F. A Krylov method stops when its residual’s norm falls to tolerance times its right-hand side’s.

evaluations: Option<usize>

The most evaluations of the function, or None for 1000 for each variable, plus 1000, and for differential evolution another 1000 for each member of its population. For solve_linear, the most products with the matrix and its transpose, or None for 20 for each unknown, plus 20.

population: Option<usize>

Differential evolution’s population, or None for 15 for each variable, and at least 5.

seed: u64

The seed of differential evolution’s generator.

Implementations

impl<F> Options<'_, F>

where F: Native,

pub fn method_for(&self, task: Task, variables: usize) -> Method

The method a front runs for task on variables variables: method, or the one Method::choose picks.

pub fn check(&self, task: Task, variables: usize) -> Result<(), Error>

Why a front would reject these options for task on variables variables: a Domain error with the reason. A binding calls it first and reports the error.

Trait Implementations

impl<'a, F> Clone for Options<'a, F>

where F: Clone,

fn clone(&self) -> Options<'a, F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, F> Copy for Options<'a, F>

where F: Copy,

impl<'a, F> Debug for Options<'a, F>

where F: Debug,

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

Formats the value using the given formatter.

impl<F> Default for Options<'_, F>

fn default() -> Options<'_, F>

Returns the “default value” for a type.