[−][src]Struct argmin::solver::conjugategradient::cg::ConjugateGradient
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> ConjugateGradient<P> where
P: Clone + Default,
[src]
P: Clone + Default,
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> Clone for ConjugateGradient<P>
[src]
fn clone(&self) -> ConjugateGradient<P>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<P> Serialize for ConjugateGradient<P> where
P: Serialize,
[src]
P: Serialize,
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<P, O> Solver<O> for ConjugateGradient<P> where
O: ArgminOp<Param = P, Output = P>,
P: Clone + Serialize + DeserializeOwned + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P> + ArgminAdd<P, P> + ArgminMul<f64, P> + ArgminDot<P, f64>,
[src]
O: ArgminOp<Param = P, Output = P>,
P: Clone + Serialize + DeserializeOwned + ArgminSub<P, P> + ArgminDot<P, f64> + ArgminScaledAdd<P, f64, P> + ArgminAdd<P, P> + ArgminMul<f64, P> + ArgminDot<P, f64>,
const NAME: &'static str
[src]
fn init(
&mut self,
op: &mut OpWrapper<O>,
state: &IterState<O>
) -> Result<Option<ArgminIterData<O>>, Error>
[src]
&mut self,
op: &mut OpWrapper<O>,
state: &IterState<O>
) -> Result<Option<ArgminIterData<O>>, Error>
fn next_iter(
&mut self,
op: &mut OpWrapper<O>,
state: &IterState<O>
) -> Result<ArgminIterData<O>, Error>
[src]
&mut self,
op: &mut OpWrapper<O>,
state: &IterState<O>
) -> Result<ArgminIterData<O>, Error>
Perform one iteration of SA algorithm
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
impl<'de, P> Deserialize<'de> for ConjugateGradient<P> where
P: Deserialize<'de>,
[src]
P: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl<P> Send for ConjugateGradient<P> where
P: Send,
P: Send,
impl<P> Sync for ConjugateGradient<P> where
P: Sync,
P: Sync,
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> SendSyncUnwindSafe for T where
T: Send + Sync + UnwindSafe + ?Sized,
T: Send + Sync + UnwindSafe + ?Sized,