pub struct ConjugateGradient<P, F> { /* private fields */ }
Expand description

A solver for systems of linear equations with a symmetric and positive-definite matrix.

Solves systems of the form A * x = b where x and b are vectors and A is a symmetric and positive-definite matrix.

Requires an initial parameter vector.

### Requirements on the optimization problem

The optimization problem is required to implement Operator.

### Reference

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

## Implementations§

source§

### impl<P, F> ConjugateGradient<P, F>where F: ArgminFloat,

source

#### pub fn new(b: P) -> Self

Takes b, the right hand side of A * x = b as input.

source

#### pub fn get_prev_p(&self) -> Result<&P, Error>

Return the previous search direction (Needed by NewtonCG)

Returns an error if the field p_prev is not initialized.

##### Example
let p_prev: Result<_, _> = cg.get_prev_p();

## Trait Implementations§

source§

### impl<P: Clone, F: Clone> Clone for ConjugateGradient<P, F>

source§

#### fn clone(&self) -> ConjugateGradient<P, F>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

### impl<'de, P, F> Deserialize<'de> for ConjugateGradient<P, F>where P: Deserialize<'de>, F: Deserialize<'de>,

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

### impl<P, F> Serialize for ConjugateGradient<P, F>where P: Serialize, F: Serialize,

source§

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

Serialize this value into the given Serde serializer. Read more
source§

### impl<P, O, F> Solver<O, IterState<P, (), (), (), F>> for ConjugateGradient<P, F>where O: Operator<Param = P, Output = P>, P: Clone + SerializeAlias + ArgminDot<P, F> + ArgminSub<P, P> + ArgminScaledAdd<P, F, P> + ArgminConj + ArgminMul<F, P>, F: ArgminFloat + ArgminL2Norm<F>,

source§

#### fn next_iter( &mut self, problem: &mut Problem<O>, state: IterState<P, (), (), (), F> ) -> Result<(IterState<P, (), (), (), F>, Option<KV>), Error>

Perform one iteration of CG algorithm

source§

#### const NAME: &'static str = "Conjugate Gradient"

Name of the solver. Mainly used in Observers.
source§

source§

#### fn terminate_internal(&mut self, state: &I) -> TerminationStatus

Checks whether basic termination reasons apply. Read more
source§

#### fn terminate(&mut self, _state: &I) -> TerminationStatus

Used to implement stopping criteria, in particular criteria which are not covered by (terminate_internal. Read more

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

const: unstable · source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

#### fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

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

#### fn clone_into(&self, target: &mut T)

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

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

§

source§

source§