Skip to main content

ForwardErrorBound

Struct ForwardErrorBound 

Source
#[non_exhaustive]
pub struct ForwardErrorBound { pub outcome: ForwardErrorOutcome, pub norm_inf: f64, pub componentwise: Vec<f64>, pub contraction: f64, pub solves: usize, }
Expand description

The outcome of Algorithm E.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§outcome: ForwardErrorOutcome

Why it stopped.

§norm_inf: f64

ε ≥ ‖x − x*‖∞ (+∞ unless certified).

§componentwise: Vec<f64>

ε_p ≥ |x_p − x*_p|, 0 ≤ ε_p ≤ ε (all +∞ unless certified).

§contraction: f64

α ≥ ‖I − RA‖∞ over the rows examined: < 1 when certified; ≥ 1 when ForwardErrorOutcome::NotContracting; with ForwardErrorOutcome::NotFinite, the value reached when it stopped (0 if no row was examined).

§solves: usize

Calls of solve_transpose.

Implementations§

Source§

impl ForwardErrorBound

Source

pub fn is_certified(&self) -> bool

Source

fn refused( outcome: ForwardErrorOutcome, n: usize, contraction: f64, solves: usize, ) -> Self

No certificate: every bound +∞ (invariant E3).

Source

fn check_invariants(&self) -> Result<(), &'static str>

Invariant E3.

Trait Implementations§

Source§

impl Clone for ForwardErrorBound

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ForwardErrorBound

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ForwardErrorBound

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ForwardErrorBound

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.