Struct cpclib_asm::preamble::ordered_float::NotNan

#[repr(transparent)]
pub struct NotNan<T>(_);

Expand description

A wrapper around floats providing an implementation of Eq, Ord and Hash.

A NaN value cannot be stored in this type.

use ordered_float::NotNan;

let mut v = [
    NotNan::new(2.0).unwrap(),
    NotNan::new(1.0).unwrap(),
];
v.sort();
assert_eq!(v, [1.0, 2.0]);

Because NotNan implements Ord and Eq, it can be used as a key in a HashSet, HashMap, BTreeMap, or BTreeSet (unlike the primitive f32 or f64 types):


let mut s: HashSet<NotNan<f32>> = HashSet::new();
let key = NotNan::new(1.0).unwrap();
s.insert(key);
assert!(s.contains(&key));

Arithmetic on NotNan values will panic if it produces a NaN value:

let a = NotNan::new(std::f32::INFINITY).unwrap();
let b = NotNan::new(std::f32::NEG_INFINITY).unwrap();

// This will panic:
let c = a + b;

Implementations§

§

impl<T> NotNan<T>where T: Float,

pub fn new(val: T) -> Result<NotNan<T>, FloatIsNan>

Create a NotNan value.

Returns Err if val is NaN

§

impl<T> NotNan<T>

pub fn into_inner(self) -> T

Get the value out.

pub const unsafe fn new_unchecked(val: T) -> NotNan<T>

Create a NotNan value from a value that is guaranteed to not be NaN

pub const unsafe fn unchecked_new(val: T) -> NotNan<T>

👎Deprecated since 2.5.0: Please use the new_unchecked function instead.

Create a NotNan value from a value that is guaranteed to not be NaN

impl NotNan<f64>

pub fn as_f32(self) -> NotNan<f32>

Converts this NotNan<f64> to a NotNan<f32> while giving up on precision, using roundTiesToEven as rounding mode, yielding Infinity on overflow.

Trait Implementations§

§

impl<T> Add<&NotNan<T>> for &NotNan<T>where T: Float,

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: &NotNan<T>) -> <&NotNan<T> as Add<&NotNan<T>>>::Output

Performs the + operation. Read more

§

impl<T> Add<&NotNan<T>> for NotNan<T>where T: Float,

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: &NotNan<T>) -> <NotNan<T> as Add<&NotNan<T>>>::Output

Performs the + operation. Read more

§

impl<T> Add<&T> for &NotNan<T>where T: Float,

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: &T) -> <&NotNan<T> as Add<&T>>::Output

Performs the + operation. Read more

§

impl<T> Add<&T> for NotNan<T>where T: Float,

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: &T) -> <NotNan<T> as Add<&T>>::Output

Performs the + operation. Read more

§

impl<T> Add<NotNan<T>> for &NotNan<T>where T: Float,

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: NotNan<T>) -> <&NotNan<T> as Add<NotNan<T>>>::Output

Performs the + operation. Read more

§

impl<T> Add<NotNan<T>> for NotNan<T>where T: Float,

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: NotNan<T>) -> NotNan<T>

Performs the + operation. Read more

§

impl<T> Add<T> for &NotNan<T>where T: Float,

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: T) -> <&NotNan<T> as Add<T>>::Output

Performs the + operation. Read more

§

impl<T> Add<T> for NotNan<T>where T: Float,

Adds a float directly.

Panics if the provided value is NaN or the computation results in NaN

§

type Output = NotNan<T>

The resulting type after applying the + operator.

§

fn add(self, other: T) -> NotNan<T>

Performs the + operation. Read more

§

impl<T> AddAssign<&NotNan<T>> for NotNan<T>where T: Float + AddAssign<T>,

§

fn add_assign(&mut self, other: &NotNan<T>)

Performs the += operation. Read more

§

impl<T> AddAssign<&T> for NotNan<T>where T: Float + AddAssign<T>,

§

fn add_assign(&mut self, other: &T)

Performs the += operation. Read more

§

impl<T> AddAssign<NotNan<T>> for NotNan<T>where T: Float + AddAssign<T>,

§

fn add_assign(&mut self, other: NotNan<T>)

Performs the += operation. Read more

§

impl<T> AddAssign<T> for NotNan<T>where T: Float + AddAssign<T>,

§

fn add_assign(&mut self, other: T)

Performs the += operation. Read more

§