[][src]Struct argmin::solver::conjugategradient::cg::ConjugateGradient

pub struct ConjugateGradient<P, S> { /* fields omitted */ }

The conjugate gradient method is a solver for systems of linear equations with a symmetric and positive-definite matrix.

Example

References:

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

Methods

impl<P, S> ConjugateGradient<P, S> where
    P: Clone + Default,
    S: Default
[src]

pub fn new(b: P) -> Result<Self, Error>[src]

Constructor

Parameters:

b: right hand side of A * x = b

pub fn p(&self) -> P[src]

Return the current search direction (This is needed by NewtonCG for instance)

pub fn p_prev(&self) -> P[src]

Return the previous search direction (This is needed by NewtonCG for instance)

pub fn residual(&self) -> P[src]

Return the current residual (This is needed by NewtonCG for instance)

Trait Implementations

impl<P: Clone, S: Clone> Clone for ConjugateGradient<P, S>[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<P, S> Serialize for ConjugateGradient<P, S> where
    P: Serialize
[src]

impl<'de, P, S> Deserialize<'de> for ConjugateGradient<P, S> where
    P: Deserialize<'de>,
    S: Default
[src]

impl<P, O, S> Solver<O> for ConjugateGradient<P, S> where
    O: ArgminOp<Param = P, Output = P>,
    P: Clone + Serialize + DeserializeOwned + ArgminDot<P, S> + ArgminSub<P, P> + ArgminScaledAdd<P, S, P> + ArgminAdd<P, P> + ArgminConj + ArgminMul<f64, P>,
    S: Debug + ArgminDiv<S, S> + ArgminNorm<f64> + ArgminConj
[src]

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

Perform one iteration of CG algorithm

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

Checks whether basic termination reasons apply. Read more

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

Checks whether the algorithm must be terminated

Auto Trait Implementations

impl<P, S> Send for ConjugateGradient<P, S> where
    P: Send,
    S: Send

impl<P, S> Sync for ConjugateGradient<P, S> where
    P: Sync,
    S: Sync

Blanket Implementations

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

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

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<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

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

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

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