Enum core::num::FpCategory

1.0.0 · source ·
pub enum FpCategory {
    Nan,
    Infinite,
    Zero,
    Subnormal,
    Normal,
}
Expand description

A classification of floating point numbers.

This enum is used as the return type for f32::classify and f64::classify. See their documentation for more.

§Examples

use std::num::FpCategory;

let num = 12.4_f32;
let inf = f32::INFINITY;
let zero = 0f32;
let sub: f32 = 1.1754942e-38;
let nan = f32::NAN;

assert_eq!(num.classify(), FpCategory::Normal);
assert_eq!(inf.classify(), FpCategory::Infinite);
assert_eq!(zero.classify(), FpCategory::Zero);
assert_eq!(sub.classify(), FpCategory::Subnormal);
assert_eq!(nan.classify(), FpCategory::Nan);
Run

Variants§

§1.0.0

Nan

NaN (not a number): this value results from calculations like (-1.0).sqrt().

See the documentation for f32 for more information on the unusual properties of NaN.

§1.0.0

Infinite

Positive or negative infinity, which often results from dividing a nonzero number by zero.

§1.0.0

Zero

Positive or negative zero.

See the documentation for f32 for more information on the signedness of zeroes.

§1.0.0

Subnormal

“Subnormal” or “denormal” floating point representation (less precise, relative to their magnitude, than Normal).

Subnormal numbers are larger in magnitude than Zero but smaller in magnitude than all Normal numbers.

§1.0.0

Normal

A regular floating point number, not any of the exceptional categories.

The smallest positive normal numbers are f32::MIN_POSITIVE and f64::MIN_POSITIVE, and the largest positive normal numbers are f32::MAX and f64::MAX. (Unlike signed integers, floating point numbers are symmetric in their range, so negating any of these constants will produce their negative counterpart.)

Trait Implementations§

1.0.0 · source§

impl Clone for FpCategory

source§

fn clone(&self) -> FpCategory

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
1.0.0 · source§

impl Debug for FpCategory

source§

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

Formats the value using the given formatter. Read more
1.0.0 · source§

impl PartialEq for FpCategory

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.0.0 · source§

impl Copy for FpCategory

1.0.0 · source§

impl Eq for FpCategory

1.0.0 · source§

impl StructuralPartialEq for FpCategory

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.