Struct ordered_float::NotNan

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

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: Float> NotNan<T>

pub fn new(val: T) -> Result<Self, 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) -> Self

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

Safety

Behaviour is undefined if val is NaN

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

👎 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

Safety

Behaviour is undefined if val is NaN

Trait Implementations

impl<T: Float> Add<&'_ NotNan<T>> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the + operator.

fn add(self, other: &Self) -> Self::Output

Performs the + operation.

impl<T: Float> Add<&'_ NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<T: Float> Add<&'_ T> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the + operator.

fn add(self, other: &T) -> Self::Output

Performs the + operation.

impl<T: Float> Add<&'_ T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the + operator.

fn add(self, other: &T) -> Self::Output

Performs the + operation.

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

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

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

type Output = NotNan<T>

The resulting type after applying the + operator.

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

Performs the + operation.

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

Adds a float directly.

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

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: T) -> Self

Performs the + operation.

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

type Output = NotNan<T>

The resulting type after applying the + operator.

fn add(self, other: T) -> Self::Output

Performs the + operation.

impl<T: Float + AddAssign> AddAssign<&'_ NotNan<T>> for NotNan<T>

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

Performs the += operation.

impl<T: Float + AddAssign> AddAssign<&'_ T> for NotNan<T>

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

Performs the += operation.

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

fn add_assign(&mut self, other: Self)

Performs the += operation.

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

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T: Float> AsRef<T> for NotNan<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: Float> Bounded for NotNan<T>

fn min_value() -> Self

returns the smallest finite number this type can represent

fn max_value() -> Self

returns the largest finite number this type can represent

impl<T: Clone> Clone for NotNan<T>

fn clone(&self) -> NotNan<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for NotNan<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for NotNan<T>

fn default() -> NotNan<T>

Returns the “default value” for a type.

impl<T: Float> Deref for NotNan<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Float + Display> Display for NotNan<T>

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

Formats the value using the given formatter.

impl<T: Float> Div<&'_ NotNan<T>> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the / operator.

fn div(self, other: &Self) -> Self::Output

Performs the / operation.

impl<T: Float> Div<&'_ NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl<T: Float> Div<&'_ T> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the / operator.

fn div(self, other: &T) -> Self::Output

Performs the / operation.

impl<T: Float> Div<&'_ T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the / operator.

fn div(self, other: &T) -> Self::Output

Performs the / operation.

impl<T: Float> Div<NotNan<T>> for NotNan<T>

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl<T: Float> Div<NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the / operator.

fn div(self, other: NotNan<T>) -> Self::Output

Performs the / operation.

impl<T: Float> Div<T> for NotNan<T>

Divides a float directly.

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

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: T) -> Self

Performs the / operation.

impl<T: Float> Div<T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the / operator.

fn div(self, other: T) -> Self::Output

Performs the / operation.

impl<T: Float + DivAssign> DivAssign<&'_ NotNan<T>> for NotNan<T>

fn div_assign(&mut self, other: &Self)

Performs the /= operation.

impl<T: Float + DivAssign> DivAssign<&'_ T> for NotNan<T>

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

Performs the /= operation.

impl<T: Float + DivAssign> DivAssign<NotNan<T>> for NotNan<T>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T: Float + DivAssign> DivAssign<T> for NotNan<T>

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl From<NotNan<f32>> for NotNan<f64>

fn from(v: NotNan<f32>) -> NotNan<f64>

Performs the conversion.

impl<T: Float + FromPrimitive> FromPrimitive for NotNan<T>

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<T: Float + FromStr> FromStr for NotNan<T>

fn from_str(src: &str) -> Result<Self, Self::Err>

Convert a &str to NotNan. Returns an error if the string fails to parse, or if the resulting value is NaN

use ordered_float::NotNan;

assert!("-10".parse::<NotNan<f32>>().is_ok());
assert!("abc".parse::<NotNan<f32>>().is_err());
assert!("NaN".parse::<NotNan<f32>>().is_err());

type Err = ParseNotNanError<T::Err>

The associated error which can be returned from parsing.

impl<T: Float> Hash for NotNan<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Float> Mul<&'_ NotNan<T>> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the * operator.

fn mul(self, other: &Self) -> Self::Output

Performs the * operation.

impl<T: Float> Mul<&'_ NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<T: Float> Mul<&'_ T> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the * operator.

fn mul(self, other: &T) -> Self::Output

Performs the * operation.

impl<T: Float> Mul<&'_ T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the * operator.

fn mul(self, other: &T) -> Self::Output

Performs the * operation.

impl<T: Float> Mul<NotNan<T>> for NotNan<T>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl<T: Float> Mul<NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the * operator.

fn mul(self, other: NotNan<T>) -> Self::Output

Performs the * operation.

impl<T: Float> Mul<T> for NotNan<T>

Multiplies a float directly.

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

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self

Performs the * operation.

impl<T: Float> Mul<T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self::Output

Performs the * operation.

impl<T: Float + MulAssign> MulAssign<&'_ NotNan<T>> for NotNan<T>

fn mul_assign(&mut self, other: &Self)

Performs the *= operation.

impl<T: Float + MulAssign> MulAssign<&'_ T> for NotNan<T>

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

Performs the *= operation.

impl<T: Float + MulAssign> MulAssign<NotNan<T>> for NotNan<T>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T: Float + MulAssign> MulAssign<T> for NotNan<T>

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T: Float> Neg for NotNan<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Float> Neg for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Float> Num for NotNan<T>

type FromStrRadixErr = ParseNotNanError<T::FromStrRadixErr>

fn from_str_radix(src: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl<T: Float> NumCast for NotNan<T>

fn from<F: ToPrimitive>(n: F) -> Option<Self>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl<T: Float> One for NotNan<T>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<T: Float> Ord for NotNan<T>

fn cmp(&self, other: &NotNan<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<NotNan<T>> for NotNan<T>

fn eq(&self, other: &NotNan<T>) -> bool

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

fn ne(&self, other: &NotNan<T>) -> bool

This method tests for !=.

impl<T: Float> PartialEq<T> for NotNan<T>

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

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

#[must_use]

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<NotNan<T>> for NotNan<T>

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl<'a, T: Float + Product + 'a> Product<&'a NotNan<T>> for NotNan<T>

fn product<I: Iterator<Item = &'a NotNan<T>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<T: Float + Product> Product<NotNan<T>> for NotNan<T>

fn product<I: Iterator<Item = NotNan<T>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<T: Float> Rem<&'_ NotNan<T>> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the % operator.

fn rem(self, other: &Self) -> Self::Output

Performs the % operation.

impl<T: Float> Rem<&'_ NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self::Output

Performs the % operation.

impl<T: Float> Rem<&'_ T> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the % operator.

fn rem(self, other: &T) -> Self::Output

Performs the % operation.

impl<T: Float> Rem<&'_ T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the % operator.

fn rem(self, other: &T) -> Self::Output

Performs the % operation.

impl<T: Float> Rem<NotNan<T>> for NotNan<T>

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self

Performs the % operation.

impl<T: Float> Rem<NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the % operator.

fn rem(self, other: NotNan<T>) -> Self::Output

Performs the % operation.

impl<T: Float> Rem<T> for NotNan<T>

Calculates % with a float directly.

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

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: T) -> Self

Performs the % operation.

impl<T: Float> Rem<T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the % operator.

fn rem(self, other: T) -> Self::Output

Performs the % operation.

impl<T: Float + RemAssign> RemAssign<&'_ NotNan<T>> for NotNan<T>

fn rem_assign(&mut self, other: &Self)

Performs the %= operation.

impl<T: Float + RemAssign> RemAssign<&'_ T> for NotNan<T>

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

Performs the %= operation.

impl<T: Float + RemAssign> RemAssign<NotNan<T>> for NotNan<T>

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<T: Float + RemAssign> RemAssign<T> for NotNan<T>

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T: Float + Signed> Signed for NotNan<T>

fn abs(&self) -> Self

Computes the absolute value.

fn abs_sub(&self, other: &Self) -> Self

The positive difference of two numbers.

fn signum(&self) -> Self

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl<T: Float> Sub<&'_ NotNan<T>> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the - operator.

fn sub(self, other: &Self) -> Self::Output

Performs the - operation.

impl<T: Float> Sub<&'_ NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<T: Float> Sub<&'_ T> for NotNan<T>

type Output = NotNan<T>

The resulting type after applying the - operator.

fn sub(self, other: &T) -> Self::Output

Performs the - operation.

impl<T: Float> Sub<&'_ T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the - operator.

fn sub(self, other: &T) -> Self::Output

Performs the - operation.

impl<T: Float> Sub<NotNan<T>> for NotNan<T>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl<T: Float> Sub<NotNan<T>> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the - operator.

fn sub(self, other: NotNan<T>) -> Self::Output

Performs the - operation.

impl<T: Float> Sub<T> for NotNan<T>

Subtracts a float directly.

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

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: T) -> Self

Performs the - operation.

impl<T: Float> Sub<T> for &NotNan<T>

type Output = NotNan<T>

The resulting type after applying the - operator.

fn sub(self, other: T) -> Self::Output

Performs the - operation.

impl<T: Float + SubAssign> SubAssign<&'_ NotNan<T>> for NotNan<T>

fn sub_assign(&mut self, other: &Self)

Performs the -= operation.

impl<T: Float + SubAssign> SubAssign<&'_ T> for NotNan<T>

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

Performs the -= operation.

impl<T: Float + SubAssign> SubAssign<NotNan<T>> for NotNan<T>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: Float + SubAssign> SubAssign<T> for NotNan<T>

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<'a, T: Float + Sum + 'a> Sum<&'a NotNan<T>> for NotNan<T>

fn sum<I: Iterator<Item = &'a NotNan<T>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: Float + Sum> Sum<NotNan<T>> for NotNan<T>

Adds a float directly.

Panics if the provided value is NaN.

fn sum<I: Iterator<Item = NotNan<T>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: Float> ToPrimitive for NotNan<T>

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

impl TryFrom<f32> for NotNan<f32>

type Error = FloatIsNan

The type returned in the event of a conversion error.

fn try_from(v: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for NotNan<f64>

type Error = FloatIsNan

The type returned in the event of a conversion error.

fn try_from(v: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Float> Zero for NotNan<T>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: Copy> Copy for NotNan<T>

impl<T: Float + PartialEq> Eq for NotNan<T>

impl<T> StructuralPartialEq for NotNan<T>