#[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: ForwardErrorOutcomeWhy 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: usizeCalls of solve_transpose.
Implementations§
Source§impl ForwardErrorBound
impl ForwardErrorBound
Sourcepub fn is_certified(&self) -> bool
pub fn is_certified(&self) -> bool
The outcome is ForwardErrorOutcome::Certified.
Sourcefn refused(
outcome: ForwardErrorOutcome,
n: usize,
contraction: f64,
solves: usize,
) -> Self
fn refused( outcome: ForwardErrorOutcome, n: usize, contraction: f64, solves: usize, ) -> Self
No certificate: every bound +∞ (invariant E3).
Sourcefn check_invariants(&self) -> Result<(), &'static str>
fn check_invariants(&self) -> Result<(), &'static str>
Invariant E3.
Trait Implementations§
Source§impl Clone for ForwardErrorBound
impl Clone for ForwardErrorBound
Source§impl Debug for ForwardErrorBound
impl Debug for ForwardErrorBound
Source§impl PartialEq for ForwardErrorBound
impl PartialEq for ForwardErrorBound
impl StructuralPartialEq for ForwardErrorBound
Auto Trait Implementations§
impl Freeze for ForwardErrorBound
impl RefUnwindSafe for ForwardErrorBound
impl Send for ForwardErrorBound
impl Sync for ForwardErrorBound
impl Unpin for ForwardErrorBound
impl UnsafeUnpin for ForwardErrorBound
impl UnwindSafe for ForwardErrorBound
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more