Struct argmin::solver::conjugategradient::nonlinear_cg::NonlinearConjugateGradient[][src]

pub struct NonlinearConjugateGradient<P, L, B, F> { /* fields omitted */ }

The nonlinear conjugate gradient is a generalization of the conjugate gradient method for nonlinear optimization problems.

Example

References:

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

Implementations

impl<P, L, B, F> NonlinearConjugateGradient<P, L, B, F> where
    P: Default,
    F: ArgminFloat
[src]

pub fn new(linesearch: L, beta_method: B) -> Result<Self, Error>[src]

Constructor (Polak Ribiere Conjugate Gradient (PR-CG))

pub fn restart_iters(self, iters: u64) -> Self[src]

Specifiy the number of iterations after which a restart should be performed This allows the algorithm to “forget” previous information which may not be helpful anymore.

pub fn restart_orthogonality(self, v: F) -> Self[src]

Set the value for the orthogonality measure. Setting this parameter leads to a restart of the algorithm (setting beta = 0) after two consecutive search directions are not orthogonal anymore. In other words, if this condition is met:

|\nabla f_k^T * \nabla f_{k-1}| / | \nabla f_k ||^2 >= v

A typical value for v is 0.1.

Trait Implementations

impl<P: Clone, L: Clone, B: Clone, F: Clone> Clone for NonlinearConjugateGradient<P, L, B, F>[src]

impl<'de, P, L, B, F> Deserialize<'de> for NonlinearConjugateGradient<P, L, B, F> where
    P: Deserialize<'de>,
    L: Deserialize<'de>,
    B: Deserialize<'de>,
    F: Deserialize<'de>, 
[src]

impl<P, L, B, F> Serialize for NonlinearConjugateGradient<P, L, B, F> where
    P: Serialize,
    L: Serialize,
    B: Serialize,
    F: Serialize
[src]

impl<O, P, L, B, F> Solver<O> for NonlinearConjugateGradient<P, L, B, F> where
    O: ArgminOp<Param = P, Output = F, Float = F>,
    P: Clone + Default + Serialize + DeserializeOwned + ArgminSub<O::Param, O::Param> + ArgminDot<O::Param, O::Float> + ArgminScaledAdd<O::Param, O::Float, O::Param> + ArgminAdd<O::Param, O::Param> + ArgminMul<F, O::Param> + ArgminNorm<O::Float>,
    O::Hessian: Default,
    L: Clone + ArgminLineSearch<O::Param, O::Float> + Solver<OpWrapper<O>>,
    B: ArgminNLCGBetaUpdate<O::Param, O::Float>,
    F: ArgminFloat
[src]

Auto Trait Implementations

impl<P, L, B, F> RefUnwindSafe for NonlinearConjugateGradient<P, L, B, F> where
    B: RefUnwindSafe,
    F: RefUnwindSafe,
    L: RefUnwindSafe,
    P: RefUnwindSafe

impl<P, L, B, F> Send for NonlinearConjugateGradient<P, L, B, F> where
    B: Send,
    F: Send,
    L: Send,
    P: Send

impl<P, L, B, F> Sync for NonlinearConjugateGradient<P, L, B, F> where
    B: Sync,
    F: Sync,
    L: Sync,
    P: Sync

impl<P, L, B, F> Unpin for NonlinearConjugateGradient<P, L, B, F> where
    B: Unpin,
    F: Unpin,
    L: Unpin,
    P: Unpin

impl<P, L, B, F> UnwindSafe for NonlinearConjugateGradient<P, L, B, F> where
    B: UnwindSafe,
    F: UnwindSafe,
    L: UnwindSafe,
    P: 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