# Struct argmin::solver::brent::BrentOpt

``pub struct BrentOpt<F> { /* private fields */ }``
Expand description

## Brent’s method

A minimization algorithm combining parabolic interpolation and the golden-section method. It has the reliability of the golden-section method, but can be faster thanks to the parabolic interpolation steps.

### Requirements on the optimization problem

The optimization problem is required to implement `CostFunction`.

### Reference

“An algorithm with guaranteed convergence for finding a minimum of a function of one variable”, Algorithms for minimization without derivatives, Richard P. Brent, 1973, Prentice-Hall.

## Implementations§

source§

### impl<F: ArgminFloat> BrentOpt<F>

source

#### pub fn new(min: F, max: F) -> Self

Constructor

The values `min` and `max` must bracket the minimum of the function.

source

#### pub fn set_tolerance(self, eps: F, t: F) -> Self

Set the tolerance to the value required.

The algorithm will return an approximation `x` of a local minimum of the function, with an accuracy smaller than `3 tol`, where `tol = eps*abs(x) + t`. It is useless to set `eps` to less than the square root of the machine precision (`F::epsilon().sqrt()`), which is its default value. The default value of `t` is `1e-5`.

## Trait Implementations§

source§

### impl<F: Clone> Clone for BrentOpt<F>

source§

#### fn clone(&self) -> BrentOpt<F>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl<'de, F> Deserialize<'de> for BrentOpt<F>where F: Deserialize<'de>,

source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

### impl<F> Serialize for BrentOpt<F>where F: Serialize,

source§

#### fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

### impl<O, F> Solver<O, IterState<F, (), (), (), F>> for BrentOpt<F>where O: CostFunction<Param = F, Output = F>, F: ArgminFloat,

source§

#### const NAME: &'static str = "BrentOpt"

Name of the solver. Mainly used in Observers.
source§

source§

#### fn next_iter( &mut self, problem: &mut Problem<O>, state: IterState<F, (), (), (), F> ) -> Result<(IterState<F, (), (), (), F>, Option<KV>), Error>

Computes a single iteration of the algorithm and has access to the optimization problem definition and the internal state of the solver. Returns an updated `state` and optionally a `KV` which holds key-value pairs used in Observers.
source§

#### fn terminate_internal(&mut self, state: &I) -> TerminationStatus

Checks whether basic termination reasons apply. Read more
source§

#### fn terminate(&mut self, _state: &I) -> TerminationStatus

Used to implement stopping criteria, in particular criteria which are not covered by (`terminate_internal`. Read more

§

§

§

§

§

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere 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<U> for Twhere 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> ToOwned for Twhere T: Clone,

§

#### 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 Twhere 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<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

§

source§

source§