Struct argmin::solver::trustregion::cauchypoint::CauchyPoint

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

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.

References:

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

Implementations

impl<F: ArgminFloat> CauchyPoint<F>

pub fn new() -> Self

Constructor

Trait Implementations

impl<F: ArgminFloat> ArgminTrustRegion<F> for CauchyPoint<F>

fn set_radius(&mut self, radius: F)

Set the initial step length

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for CauchyPoint<F>

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

Formats the value using the given formatter.

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

fn default() -> CauchyPoint<F>

Returns the “default value” for a type.

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

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

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

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

This method tests for !=.

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<F> Serialize for CauchyPoint<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 CauchyPoint<F> where
    O: ArgminOp<Output = F, Float = F>,
    O::Param: Debug + Clone + Serialize + ArgminMul<O::Float, O::Param> + ArgminWeightedDot<O::Param, F, O::Hessian> + ArgminNorm<O::Float>,
    O::Hessian: Clone + Serialize,
    F: ArgminFloat, 

const NAME: &'static str

Name of the solver

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

Computes one iteration of the algorithm.

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

Checks whether the algorithm must be terminated

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

Initializes the algorithm

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

Checks whether basic termination reasons apply.

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

impl<F> StructuralPartialEq for CauchyPoint<F>