Struct swim_core::num::f16::f16

#[repr(C)]
pub struct f16(_);

The 16-bit floating point type.

Methods

impl f16

pub const DIGITS: u32

Approximate number of significant digits in base 10.

pub const EPSILON: f16

Difference between 1.0 and the next largest representable number.

pub const INFINITY: f16

Infinity (∞).

pub const MANTISSA_DIGITS: u32

Number of significant digits in base 2.

pub const MAX: f16

Largest finite f16 value.

pub const MAX_10_EXP: i32

Maximum possible power of 10 exponent.

pub const MAX_EXP: i32

Maximum possible power of 2 exponent.

pub const MIN: f16

Smallest finite f16 value.

pub const MIN_10_EXP: i32

Minimum possible normal power of 10 exponent.

pub const MIN_EXP: i32

One greater than the minimum possible normal power of 2 exponent.

pub const MIN_POSITIVE: f16

Smallest positive normal f16 value.

pub const NAN: f16

Not a Number (NaN).

pub const NEG_INFINITY: f16

Negative infinity (-∞).

pub const RADIX: u32

The radix or base of the internal representation of f16

pub const fn from_bits(v: u16) -> f16

Raw transmutation from u16.

pub const fn to_bits(self) -> u16

Raw transmutation to u16.

pub fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

use swim_core::f16;

let nan = f16::NAN;
let f = f16::from(7.0_f32);

assert!(nan.is_nan());
assert!(!f.is_nan());

pub fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

use swim_core::f16;

let f = f16::from(7.0f32);
let inf = f16::INFINITY;
let neg_inf = f16::NEG_INFINITY;
let nan = f16::NAN;

assert!(!f.is_infinite());
assert!(!nan.is_infinite());

assert!(inf.is_infinite());
assert!(neg_inf.is_infinite());

pub fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

use swim_core::f16;

let f = f16::from(7.0f32);
let inf = f16::INFINITY;
let neg_inf = f16::NEG_INFINITY;
let nan = f16::NAN;

assert!(f.is_finite());

assert!(!nan.is_finite());
assert!(!inf.is_finite());
assert!(!neg_inf.is_finite());

pub fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

use swim_core::f16;

let min = f16::MIN_POSITIVE;
let max = f16::MAX;
let lower_than_min = f16::from(1.0e-10_f32);
let zero = f16::from(0.0_f32);

assert!(min.is_normal());
assert!(max.is_normal());

assert!(!zero.is_normal());
assert!(!f16::NAN.is_normal());
assert!(!f16::INFINITY.is_normal());
// Values between `0` and `min` are Subnormal.
assert!(!lower_than_min.is_normal());

pub fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

use std::num::FpCategory;
use swim_core::f16;

let num = f16::from(12.4_f32);
let inf = f16::INFINITY;

assert_eq!(num.classify(), FpCategory::Normal);
assert_eq!(inf.classify(), FpCategory::Infinite);

pub fn signum(self) -> f16

Returns a number that represents the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY
• NAN if the number is NAN

use swim_core::f16;

let f = f16::from(3.5_f32);

assert_eq!(f.signum(), f16::from(1.0));
assert_eq!(f16::NEG_INFINITY.signum(), f16::from(-1.0));

assert!(f16::NAN.signum().is_nan());

pub fn is_sign_positive(self) -> bool

Returns true if and only if self has a positive sign, including +0.0, NaNs with positive sign bit and positive infinity.

use swim_core::f16;

let f = f16::from(7.0_f32);
let g = f16::from(-7.0_f32);

assert!(f.is_sign_positive());
assert!(!g.is_sign_positive());

pub fn is_sign_negative(self) -> bool

Returns true if and only if self has a negative sign, including -0.0, NaNs with negative sign bit and negative infinity.

use swim_core::f16;

let f = f16::from(7.0f32);
let g = f16::from(-7.0f32);

assert!(!f.is_sign_negative());
assert!(g.is_sign_negative());

Trait Implementations

impl PartialEq<f16> for f16

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<f16> for f16

fn partial_cmp(&self, other: &f16) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &f16) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &f16) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &f16) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &f16) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl From<f16> for f32

fn from(x: f16) -> f32

Performs the conversion.

impl From<f16> for f64

fn from(x: f16) -> f64

Performs the conversion.

impl From<f32> for f16

fn from(x: f32) -> f16

Performs the conversion.

impl From<f64> for f16

fn from(x: f64) -> f16

Performs the conversion.

impl From<i8> for f16

fn from(x: i8) -> f16

Performs the conversion.

impl From<u8> for f16

fn from(x: u8) -> f16

Performs the conversion.

impl Display for f16

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

Formats the value using the given formatter.

impl Debug for f16

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

Formats the value using the given formatter.

impl UpperExp for f16

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

Formats the value using the given formatter.

impl LowerExp for f16

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

Formats the value using the given formatter.

impl Copy for f16

impl FromStr for f16

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<f16, ParseFloatError>

Parses a string s to return a value of this type.

impl Clone for f16

fn clone(&self) -> f16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for f16

fn default() -> f16

Returns the "default value" for a type.