Enum std::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!(nan.classify(), FpCategory::Nan);
assert_eq!(sub.classify(), FpCategory::Subnormal);
RunVariants
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.
Infinite
Positive or negative infinity, which often results from dividing a nonzero number by zero.
Zero
Positive or negative zero.
See the documentation for f32
for more information on the signedness of zeroes.
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.
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
sourceimpl Clone for FpCategory
impl Clone for FpCategory
sourcefn clone(&self) -> FpCategory
fn clone(&self) -> FpCategory
Returns a copy of the value. Read more
sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for FpCategory
impl Debug for FpCategory
sourceimpl PartialEq<FpCategory> for FpCategory
impl PartialEq<FpCategory> for FpCategory
impl Copy for FpCategory
impl Eq for FpCategory
impl StructuralEq for FpCategory
impl StructuralPartialEq for FpCategory
Auto Trait Implementations
impl RefUnwindSafe for FpCategory
impl Send for FpCategory
impl Sync for FpCategory
impl Unpin for FpCategory
impl UnwindSafe for FpCategory
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more