Struct argmin::solver::newton::newton_cg::NewtonCG[][src]

pub struct NewtonCG<L, F> { /* fields omitted */ }

The Newton-CG method (also called truncated Newton method) uses a modified CG to solve the Newton equations approximately. After a search direction is found, a line search is performed.

Example

References:

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

Implementations

impl<L, F: ArgminFloat> NewtonCG<L, F>[src]

pub fn new(linesearch: L) -> Self[src]

Constructor

pub fn curvature_threshold(self, threshold: F) -> Self[src]

Set curvature threshold

pub fn with_tol(self, tol: F) -> Result<Self, Error>[src]

Set tolerance for the stopping criterion based on cost difference

Trait Implementations

impl<L: Clone, F: Clone> Clone for NewtonCG<L, F>[src]

impl<'de, L, F> Deserialize<'de> for NewtonCG<L, F> where
    L: Deserialize<'de>,
    F: Deserialize<'de>, 
[src]

impl<L, F> Serialize for NewtonCG<L, F> where
    L: Serialize,
    F: Serialize
[src]

impl<O, L, F> Solver<O> for NewtonCG<L, F> where
    O: ArgminOp<Output = F, Float = F>,
    O::Param: Send + Sync + Clone + Serialize + Default + ArgminSub<O::Param, O::Param> + ArgminAdd<O::Param, O::Param> + ArgminDot<O::Param, O::Float> + ArgminScaledAdd<O::Param, O::Float, O::Param> + ArgminMul<F, O::Param> + ArgminConj + ArgminZeroLike + ArgminNorm<O::Float>,
    O::Hessian: Send + Sync + Default + Clone + Serialize + ArgminInv<O::Hessian> + ArgminDot<O::Param, O::Param>,
    L: Clone + ArgminLineSearch<O::Param, O::Float> + Solver<OpWrapper<O>>,
    F: ArgminFloat + Default + ArgminDiv<O::Float, O::Float> + ArgminNorm<O::Float> + ArgminConj
[src]

Auto Trait Implementations

impl<L, F> RefUnwindSafe for NewtonCG<L, F> where
    F: RefUnwindSafe,
    L: RefUnwindSafe

impl<L, F> Send for NewtonCG<L, F> where
    F: Send,
    L: Send

impl<L, F> Sync for NewtonCG<L, F> where
    F: Sync,
    L: Sync

impl<L, F> Unpin for NewtonCG<L, F> where
    F: Unpin,
    L: Unpin

impl<L, F> UnwindSafe for NewtonCG<L, F> where
    F: UnwindSafe,
    L: UnwindSafe

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

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

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