Enum std::num::FpCategory

[+] Show declaration

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;
use std::f32;

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!(nan.classify(), FpCategory::Nan);
assert_eq!(sub.classify(), FpCategory::Subnormal);

Variants

Nan

[−] Expand description

"Not a Number", often obtained by dividing by zero.

Infinite

[−] Expand description

Positive or negative infinity.

Zero

[−] Expand description

Positive or negative zero.

Subnormal

[−] Expand description

De-normalized floating point representation (less precise than Normal).

Normal

[−] Expand description

A regular floating point number.

Trait Implementations

impl Debug for FpCategory

[+]

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

[−]

Formats the value using the given formatter.

impl Copy for FpCategory

impl Clone for FpCategory

[+]

fn clone(&self) -> FpCategory

[−]

Returns a copy of the value.

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

[−]

Performs copy-assignment from source.

impl Eq for FpCategory

impl PartialEq<FpCategory> for FpCategory

[+]

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

[−]

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

[+] Expand attributes #[must_use] fn ne(&self, other: &Rhs) -> bool

[−]

This method tests for !=.