argmin::solver::goldensectionsearch

Struct GoldenSectionSearch

Source
pub struct GoldenSectionSearch<F> { /* private fields */ }
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.

§References:

Wikipedia

Implementations§

Source§

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

Source

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

Constructor

Source

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

Set tolerance

Trait Implementations§

Source§

impl<F: Clone> Clone for GoldenSectionSearch<F>

Source§

fn clone(&self) -> GoldenSectionSearch<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 GoldenSectionSearch<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 GoldenSectionSearch<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> for GoldenSectionSearch<F>
where O: ArgminOp<Output = F, Param = F, Float = F>, F: ArgminFloat,

Source§

const NAME: &'static str = "Golden-section search"

Name of the solver
Source§

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

Initializes the algorithm Read more
Source§

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

Computes one iteration of the algorithm.
Source§

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

Checks whether basic termination reasons apply. Read more
Source§

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

Checks whether the algorithm must be terminated

Auto Trait Implementations§

§

impl<F> Freeze for GoldenSectionSearch<F>
where F: Freeze,

§

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§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

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

Source§

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