Enum FpError 

pub enum FpError {
    InfiniteInput,
    OutOfDomain,
    Indeterminate,
    Overflow(Sign),
    Underflow(Sign),
}

Error returned by floating-point operations that cannot produce a usable result.

Errors vs. special values

Infinite outputs (e.g. 1/0 → +inf, ln(0) → -inf) are not errors — they are legitimate Exact values produced by operations whose mathematical result is genuinely infinite. Overflow and underflow are distinct: the mathematical result is finite, but its magnitude exceeds the representable exponent range. These are reported as Overflow / Underflow, and converted to signed infinity / signed zero at the convenience layer via Context::unwrap_fp (or the Repr-level counterpart Context::unwrap_fp_repr). Because the true result was finite, the converted value is always Inexact with Rounding::NoOp.

The remaining variants (InfiniteInput, OutOfDomain, Indeterminate) signal that an operation could not proceed, and always panic at the convenience layer.

Variants

InfiniteInput

An operand was infinite. Infinities are terminal values: they can be produced and compared, but not fed back into arithmetic.

OutOfDomain

The mathematical result is not a real number (domain error), e.g. sqrt(-x) for x > 0, ln(-x), asin(|x| > 1), pow(negative, non-integer), an even root of a negative value.

Indeterminate

An indeterminate form, e.g. 0 / 0. Only a zero divided by zero is indeterminate — a non-zero value divided by zero yields ±infinity, which is a legitimate Exact value rather than an error.

Overflow(Sign)

The result magnitude is too large to represent as a finite number.

At the FBig convenience layer this is converted to a signed infinity via Context::unwrap_fp (or to a signed Repr via Context::unwrap_fp_repr). The converted result is always Inexact: the true result was a very large finite number, and infinity is an approximation.

Underflow(Sign)

The result magnitude is too small to represent as a finite non-zero number.

At the FBig convenience layer this is converted to a signed zero via Context::unwrap_fp (or to a signed Repr via Context::unwrap_fp_repr). The converted result is always Inexact: the true result was a very small non-zero number, and zero is an approximation.

Trait Implementations

impl Clone for FpError

fn clone(&self) -> FpError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FpError

impl Debug for FpError

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

Formats the value using the given formatter.

impl Display for FpError

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

Formats the value using the given formatter.

impl Eq for FpError

impl Error for FpError

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for FpError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FpError