Struct ConjugateGradientSolution

pub struct ConjugateGradientSolution {
    pub x: Vec<f64>,
    pub relative_residual: f64,
    pub iterations: usize,
    pub status: Status,
}

The result of conjugate_gradient.

Fields

x: Vec<f64>

The final iterate.

relative_residual: f64

||b - A x||_2 / ||b||_2, recomputed from the matrix at the final iterate (zero when b is zero). A computed value, not an estimate.

iterations: usize

Iterations taken.

status: Status

Status::Converged when the relative residual met the tolerance, Status::BudgetExhausted when the iteration budget ran out first.

Implementations

impl ConjugateGradientSolution

pub fn converged(self) -> NumericResult<Self>

The solution when its tolerance was met.

Errors

NumericError::NotConverged with the relative residual reached.

Trait Implementations

impl Clone for ConjugateGradientSolution

fn clone(&self) -> ConjugateGradientSolution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConjugateGradientSolution

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ConjugateGradientSolution

fn eq(&self, other: &ConjugateGradientSolution) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConjugateGradientSolution