Struct argmin::solver::brent::Brent

pub struct Brent<F> { /* fields omitted */ }

Brent’s method

A root-finding algorithm combining the bisection method, the secant method and inverse quadratic interpolation. It has the reliability of bisection but it can be as quick as some of the less-reliable methods.

References:

https://en.wikipedia.org/wiki/Brent%27s_method

Implementations

impl<F: ArgminFloat> Brent<F>

pub fn new(min: F, max: F, tol: F) -> Brent<F>

Constructor The values min and max must bracketing the root of the function. The parameter tol specifies the relative error to be targeted.

Trait Implementations

impl<F: Clone> Clone for Brent<F>

fn clone(&self) -> Brent<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, F> Deserialize<'de> for Brent<F> where
    F: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<F> Serialize for Brent<F> where
    F: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<O, F> Solver<O> for Brent<F> where
    O: ArgminOp<Param = F, Output = F, Float = F>,
    F: ArgminFloat, 

const NAME: &'static str

Name of the solver

fn init(
    &mut self,
    op: &mut OpWrapper<O>,
    _state: &IterState<O>
) -> Result<Option<ArgminIterData<O>>, Error>

Initializes the algorithm

fn next_iter(
    &mut self,
    op: &mut OpWrapper<O>,
    _state: &IterState<O>
) -> Result<ArgminIterData<O>, Error>

Computes one iteration of the algorithm.

fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether basic termination reasons apply.

fn terminate(&mut self, _state: &IterState<O>) -> TerminationReason

Checks whether the algorithm must be terminated