Skip to main content

QuadratureStatus

Enum QuadratureStatus 

Source
pub enum QuadratureStatus {
    Evaluated,
    ToleranceNotMet,
    NotFinite,
    InvalidInterval,
}
Expand description

How one lane of a quadrature batch ended.

Variantlast_valueMeaning
Evaluatedthe integralthe rule ran to completion
ToleranceNotMetbest estimate — not to toleranceadaptive lane ran out of subdivisions
NotFiniteNaNthe accumulated value was NaN or infinite
InvalidIntervalNaNa limit is not finite

§What Evaluated does and does not claim

For adaptive_quadrature_batch it means the requested tolerance was met. For a fixed QuadratureRule it means only that every node evaluated to a finite number and the sum is finite — it makes no accuracy claim at all, because a fixed rule has no way to know. Choosing enough panels for the integrand is the caller’s responsibility, and QuadratureSolution::error_estimate is NaN on that path for exactly this reason.

§Units

Dimensionless — a status tag.

Variants§

§

Evaluated

The rule ran to completion with a finite result.

§

ToleranceNotMet

Adaptive only: the subdivision budget or MAX_ADAPTIVE_DEPTH was reached before the tolerance. The reported value is the best estimate available and is not claimed to meet the tolerance.

§

NotFinite

The accumulated value is NaN or infinite — either the integrand returned a non-finite sample, or the sum overflowed.

§

InvalidInterval

A limit of the interval was infinite or NaN, so there is nothing to integrate over.

Implementations§

Source§

impl QuadratureStatus

Source

pub fn is_evaluated(self) -> bool

Whether this status means the lane produced a usable value.

§Example
use outram_foam_basic_lib::ode::parallel::QuadratureStatus;

assert!(QuadratureStatus::Evaluated.is_evaluated());
assert!(!QuadratureStatus::ToleranceNotMet.is_evaluated());
Source

pub fn label(self) -> &'static str

A short human-readable label, for log lines and failure reports.

Trait Implementations§

Source§

impl Clone for QuadratureStatus

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 Copy for QuadratureStatus

Source§

impl Debug for QuadratureStatus

Source§

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

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

impl Eq for QuadratureStatus

Source§

impl Hash for QuadratureStatus

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for QuadratureStatus

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 QuadratureStatus

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> Same for T

Source§

type Output = T

Should always be Self
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.