Struct argmin::solver::goldensectionsearch::GoldenSectionSearch[][src]

pub struct GoldenSectionSearch<F> { /* fields omitted */ }
Expand description

Golden-section search

The golden-section search is a technique for finding an extremum (minimum or maximum) of a function inside a specified interval.

The method operates by successively narrowing the range of values on the specified interval, which makes it relatively slow, but very robust. The technique derives its name from the fact that the algorithm maintains the function values for four points whose three interval widths are in the ratio 2-φ:2φ-3:2-φ where φ is the golden ratio. These ratios are maintained for each iteration and are maximally efficient.

The min_bound and max_bound arguments define values that bracket the expected minimum. The init_estimate argument is the initial estimate of the minimum that is required to be larger than min_bound and smaller than max_bound.




impl<F> GoldenSectionSearch<F> where
    F: ArgminFloat

pub fn new(min_bound: F, max_bound: F) -> Self[src]


pub fn tolerance(self, tol: F) -> Self[src]

Set tolerance

Trait Implementations

impl<F: Clone> Clone for GoldenSectionSearch<F>[src]

fn clone(&self) -> GoldenSectionSearch<F>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'de, F> Deserialize<'de> for GoldenSectionSearch<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. Read more

impl<F> Serialize for GoldenSectionSearch<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. Read more

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

const NAME: &'static str[src]

Name of the solver

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

Initializes the algorithm Read more

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[src]

Checks whether basic termination reasons apply. Read more

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

Checks whether the algorithm must be terminated

Auto Trait Implementations

impl<F> RefUnwindSafe for GoldenSectionSearch<F> where
    F: RefUnwindSafe

impl<F> Send for GoldenSectionSearch<F> where
    F: Send

impl<F> Sync for GoldenSectionSearch<F> where
    F: Sync

impl<F> Unpin for GoldenSectionSearch<F> where
    F: Unpin

impl<F> UnwindSafe for GoldenSectionSearch<F> where
    F: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

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

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 

impl<T> SendSyncUnwindSafe for T where
    T: Send + Sync + UnwindSafe + ?Sized