Struct ConjugateGradientOptions

pub struct ConjugateGradientOptions {
    pub relative_tolerance: f64,
    pub max_iterations: Option<usize>,
}

Stopping rule and budget for conjugate_gradient.

Fields

relative_tolerance: f64

Stop when ||b - A x||_2 <= relative_tolerance * ||b||_2.

max_iterations: Option<usize>

Iteration budget; None allows 10 n + 100 for an n x n system.

Trait Implementations

impl Clone for ConjugateGradientOptions

fn clone(&self) -> ConjugateGradientOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConjugateGradientOptions

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

Formats the value using the given formatter.

impl Default for ConjugateGradientOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ConjugateGradientOptions

fn eq(&self, other: &ConjugateGradientOptions) -> 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 Copy for ConjugateGradientOptions

impl StructuralPartialEq for ConjugateGradientOptions