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

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.

## Implementations

### `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(&self) -> ConjugateGradient<P, S>`[src]

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

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

#### `fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where    __D: Deserializer<'de>, `[src]

Deserialize this value from the given Serde deserializer. Read more

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

#### `fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where    __S: Serializer, `[src]

Serialize this value into the given Serde serializer. Read more

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

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

Perform one iteration of CG algorithm

#### `const NAME: &'static str`[src]

Name of the solver

#### `fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason`[src]

Checks whether basic termination reasons apply. Read more

#### `fn terminate(&mut self, _state: &IterState<O>) -> TerminationReason`[src]

Checks whether the algorithm must be terminated

## Blanket Implementations

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

#### `pub fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

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

#### `pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

#### `pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

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

#### `pub fn into(self) -> U`[src]

Performs the conversion.

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

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

Uses borrowed data to replace owned data, usually by cloning. Read more

### `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.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `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.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.