std::num::FpCategory - Rust
Description: API documentation for the Rust `FpCategory` enum in crate `std`.
Keywords: rust, rustlang, rust-lang, FpCategory

# Enum std::num::FpCategory 1.0.0 [−] [src]

    pub enum FpCategory {
        Nan,
        Infinite,
        Zero,
        Subnormal,
        Normal,
    }

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);Run

## Variants

`Nan`

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

`Infinite`

Positive or negative infinity.

`Zero`

Positive or negative zero.

`Subnormal`

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

`Normal`

A regular floating point number.

## Trait Implementations

### `impl Clone for FpCategory`
[src]

#### `fn clone(&self) -> FpCategory`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
[src]

Performs copy-assignment from `source`. Read more

### `impl Eq for FpCategory`
[src]

### `impl Copy for FpCategory`
[src]

### `impl PartialEq<FpCategory> for FpCategory`
[src]

#### `fn eq(&self, __arg_0: &FpCategory) -> bool`
[src]

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

#### `fn ne(&self, other: &Rhs) -> bool`
[src]

This method tests for `!=`.

### `impl Debug for FpCategory`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>`
[src]

Formats the value using the given formatter. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)