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

Cauchy point method

The Cauchy point is the minimum of the quadratic approximation of the cost function within the trust region along the direction given by the first derivative.

Requirements on the optimization problem

The optimization problem is required to implement Gradient and Hessian.

Reference

Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.

Implementations§

source§

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

source

pub fn new() -> Self

Construct a new instance of CauchyPoint

Example
let cp: CauchyPoint<f64> = CauchyPoint::new();

Trait Implementations§

source§

impl<F: Clone> Clone for CauchyPoint<F>

source§

fn clone(&self) -> CauchyPoint<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<F: Debug> Debug for CauchyPoint<F>

source§

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

Formats the value using the given formatter. Read more
source§

impl<F: Default> Default for CauchyPoint<F>

source§

fn default() -> CauchyPoint<F>

Returns the “default value” for a type. Read more
source§

impl<'de, F> Deserialize<'de> for CauchyPoint<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: PartialEq> PartialEq<CauchyPoint<F>> for CauchyPoint<F>

source§

fn eq(&self, other: &CauchyPoint<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<F: PartialOrd> PartialOrd<CauchyPoint<F>> for CauchyPoint<F>

source§

fn partial_cmp(&self, other: &CauchyPoint<F>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<F> Serialize for CauchyPoint<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, P, G, H> Solver<O, IterState<P, G, (), H, F>> for CauchyPoint<F>where O: Gradient<Param = P, Gradient = G> + Hessian<Param = P, Hessian = H>, P: Clone + ArgminMul<F, P> + ArgminWeightedDot<P, F, H>, G: ArgminMul<F, P> + ArgminWeightedDot<G, F, H> + ArgminL2Norm<F>, F: ArgminFloat,

source§

const NAME: &'static str = "Cauchy Point"

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

fn next_iter( &mut self, problem: &mut Problem<O>, state: IterState<P, G, (), H, F> ) -> Result<(IterState<P, G, (), H, 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(&mut self, state: &IterState<P, G, (), H, F>) -> TerminationStatus

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

fn init( &mut self, _problem: &mut Problem<O>, state: I ) -> Result<(I, Option<KV>), Error>

Initializes the algorithm. Read more
source§

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

Checks whether basic termination reasons apply. Read more
source§

impl<F> TrustRegionRadius<F> for CauchyPoint<F>where F: ArgminFloat,

source§

fn set_radius(&mut self, radius: F)

Set current radius.

Needed by TrustRegion.

Example
use argmin::solver::trustregion::{CauchyPoint, TrustRegionRadius};
let mut cp: CauchyPoint<f64> = CauchyPoint::new();
cp.set_radius(0.8);
source§

impl<F: Copy> Copy for CauchyPoint<F>

source§

impl<F: Eq> Eq for CauchyPoint<F>

source§

impl<F> StructuralEq for CauchyPoint<F>

source§

impl<F> StructuralPartialEq for CauchyPoint<F>

Auto Trait Implementations§

§

impl<F> RefUnwindSafe for CauchyPoint<F>where F: RefUnwindSafe,

§

impl<F> Send for CauchyPoint<F>where F: Send,

§

impl<F> Sync for CauchyPoint<F>where F: Sync,

§

impl<F> Unpin for CauchyPoint<F>where F: Unpin,

§

impl<F> UnwindSafe for CauchyPoint<F>where F: UnwindSafe,

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.
§

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

§

fn vzip(self) -> V

source§

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

source§

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