#[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
sourceimpl<T> NotNan<T> where
T: Float,
impl<T> NotNan<T> where
T: Float,
sourcepub fn new(val: T) -> Result<NotNan<T>, FloatIsNan>
pub fn new(val: T) -> Result<NotNan<T>, FloatIsNan>
Create a NotNan
value.
Returns Err
if val
is NaN
sourceimpl<T> NotNan<T>
impl<T> NotNan<T>
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Get the value out.
sourcepub const unsafe fn new_unchecked(val: T) -> NotNan<T>
pub const unsafe fn new_unchecked(val: T) -> NotNan<T>
Create a NotNan
value from a value that is guaranteed to not be NaN
Safety
Behaviour is undefined if val
is NaN
sourcepub const unsafe fn unchecked_new(val: T) -> NotNan<T>
👎 Deprecated since 2.5.0: Please use the new_unchecked function instead.
pub const unsafe fn unchecked_new(val: T) -> NotNan<T>
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
sourceimpl<T> Add<T> for NotNan<T> where
T: Float,
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
sourceimpl<'_, T> AddAssign<&NotNan<T>> for NotNan<T> where
T: Float + AddAssign<T>,
impl<'_, T> AddAssign<&NotNan<T>> for NotNan<T> where
T: Float + AddAssign<T>,
sourcefn add_assign(&mut self, other: &NotNan<T>)
fn add_assign(&mut self, other: &NotNan<T>)
Performs the +=
operation. Read more
sourceimpl<'_, T> AddAssign<&T> for NotNan<T> where
T: Float + AddAssign<T>,
impl<'_, T> AddAssign<&T> for NotNan<T> where
T: Float + AddAssign<T>,
sourcefn add_assign(&mut self, other: &T)
fn add_assign(&mut self, other: &T)
Performs the +=
operation. Read more
sourceimpl<T> AddAssign<NotNan<T>> for NotNan<T> where
T: Float + AddAssign<T>,
impl<T> AddAssign<NotNan<T>> for NotNan<T> where
T: Float + AddAssign<T>,
sourcefn add_assign(&mut self, other: NotNan<T>)
fn add_assign(&mut self, other: NotNan<T>)
Performs the +=
operation. Read more
sourceimpl<T> AddAssign<T> for NotNan<T> where
T: Float + AddAssign<T>,
impl<T> AddAssign<T> for NotNan<T> where
T: Float + AddAssign<T>,
sourcefn add_assign(&mut self, other: T)
fn add_assign(&mut self, other: T)
Performs the +=
operation. Read more
sourceimpl<T> Div<T> for NotNan<T> where
T: Float,
impl<T> Div<T> for NotNan<T> where
T: Float,
Divides a float directly.
Panics if the provided value is NaN or the computation results in NaN
sourceimpl<'_, T> DivAssign<&NotNan<T>> for NotNan<T> where
T: Float + DivAssign<T>,
impl<'_, T> DivAssign<&NotNan<T>> for NotNan<T> where
T: Float + DivAssign<T>,
sourcefn div_assign(&mut self, other: &NotNan<T>)
fn div_assign(&mut self, other: &NotNan<T>)
Performs the /=
operation. Read more
sourceimpl<'_, T> DivAssign<&T> for NotNan<T> where
T: Float + DivAssign<T>,
impl<'_, T> DivAssign<&T> for NotNan<T> where
T: Float + DivAssign<T>,
sourcefn div_assign(&mut self, other: &T)
fn div_assign(&mut self, other: &T)
Performs the /=
operation. Read more
sourceimpl<T> DivAssign<NotNan<T>> for NotNan<T> where
T: Float + DivAssign<T>,
impl<T> DivAssign<NotNan<T>> for NotNan<T> where
T: Float + DivAssign<T>,
sourcefn div_assign(&mut self, other: NotNan<T>)
fn div_assign(&mut self, other: NotNan<T>)
Performs the /=
operation. Read more
sourceimpl<T> DivAssign<T> for NotNan<T> where
T: Float + DivAssign<T>,
impl<T> DivAssign<T> for NotNan<T> where
T: Float + DivAssign<T>,
sourcefn div_assign(&mut self, other: T)
fn div_assign(&mut self, other: T)
Performs the /=
operation. Read more
sourceimpl<T> FromPrimitive for NotNan<T> where
T: Float + FromPrimitive,
impl<T> FromPrimitive for NotNan<T> where
T: Float + FromPrimitive,
sourcefn from_i64(n: i64) -> Option<NotNan<T>>
fn from_i64(n: i64) -> Option<NotNan<T>>
Converts an i64
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_u64(n: u64) -> Option<NotNan<T>>
fn from_u64(n: u64) -> Option<NotNan<T>>
Converts an u64
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_isize(n: isize) -> Option<NotNan<T>>
fn from_isize(n: isize) -> Option<NotNan<T>>
Converts an isize
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_i8(n: i8) -> Option<NotNan<T>>
fn from_i8(n: i8) -> Option<NotNan<T>>
Converts an i8
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_i16(n: i16) -> Option<NotNan<T>>
fn from_i16(n: i16) -> Option<NotNan<T>>
Converts an i16
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_i32(n: i32) -> Option<NotNan<T>>
fn from_i32(n: i32) -> Option<NotNan<T>>
Converts an i32
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_usize(n: usize) -> Option<NotNan<T>>
fn from_usize(n: usize) -> Option<NotNan<T>>
Converts a usize
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_u8(n: u8) -> Option<NotNan<T>>
fn from_u8(n: u8) -> Option<NotNan<T>>
Converts an u8
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_u16(n: u16) -> Option<NotNan<T>>
fn from_u16(n: u16) -> Option<NotNan<T>>
Converts an u16
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_u32(n: u32) -> Option<NotNan<T>>
fn from_u32(n: u32) -> Option<NotNan<T>>
Converts an u32
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_f32(n: f32) -> Option<NotNan<T>>
fn from_f32(n: f32) -> Option<NotNan<T>>
Converts a f32
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourcefn from_f64(n: f64) -> Option<NotNan<T>>
fn from_f64(n: f64) -> Option<NotNan<T>>
Converts a f64
to return an optional value of this type. If the
value cannot be represented by this type, then None
is returned. Read more
sourceimpl<T> FromStr for NotNan<T> where
T: Float + FromStr,
impl<T> FromStr for NotNan<T> where
T: Float + FromStr,
sourcefn from_str(src: &str) -> Result<NotNan<T>, <NotNan<T> as FromStr>::Err>
fn from_str(src: &str) -> Result<NotNan<T>, <NotNan<T> as FromStr>::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 as FromStr>::Err>
type Err = ParseNotNanError<<T as FromStr>::Err>
The associated error which can be returned from parsing.
sourceimpl<T> Mul<T> for NotNan<T> where
T: Float,
impl<T> Mul<T> for NotNan<T> where
T: Float,
Multiplies a float directly.
Panics if the provided value is NaN or the computation results in NaN
sourceimpl<'_, T> MulAssign<&NotNan<T>> for NotNan<T> where
T: Float + MulAssign<T>,
impl<'_, T> MulAssign<&NotNan<T>> for NotNan<T> where
T: Float + MulAssign<T>,
sourcefn mul_assign(&mut self, other: &NotNan<T>)
fn mul_assign(&mut self, other: &NotNan<T>)
Performs the *=
operation. Read more
sourceimpl<'_, T> MulAssign<&T> for NotNan<T> where
T: Float + MulAssign<T>,
impl<'_, T> MulAssign<&T> for NotNan<T> where
T: Float + MulAssign<T>,
sourcefn mul_assign(&mut self, other: &T)
fn mul_assign(&mut self, other: &T)
Performs the *=
operation. Read more
sourceimpl<T> MulAssign<NotNan<T>> for NotNan<T> where
T: Float + MulAssign<T>,
impl<T> MulAssign<NotNan<T>> for NotNan<T> where
T: Float + MulAssign<T>,
sourcefn mul_assign(&mut self, other: NotNan<T>)
fn mul_assign(&mut self, other: NotNan<T>)
Performs the *=
operation. Read more
sourceimpl<T> MulAssign<T> for NotNan<T> where
T: Float + MulAssign<T>,
impl<T> MulAssign<T> for NotNan<T> where
T: Float + MulAssign<T>,
sourcefn mul_assign(&mut self, other: T)
fn mul_assign(&mut self, other: T)
Performs the *=
operation. Read more
sourceimpl<T> Num for NotNan<T> where
T: Float,
impl<T> Num for NotNan<T> where
T: Float,
type FromStrRadixErr = ParseNotNanError<<T as Num>::FromStrRadixErr>
sourcefn from_str_radix(
src: &str,
radix: u32
) -> Result<NotNan<T>, <NotNan<T> as Num>::FromStrRadixErr>
fn from_str_radix(
src: &str,
radix: u32
) -> Result<NotNan<T>, <NotNan<T> as Num>::FromStrRadixErr>
Convert from a string and radix (typically 2..=36
). Read more
sourceimpl<T> Ord for NotNan<T> where
T: Float,
impl<T> Ord for NotNan<T> where
T: Float,
sourceimpl<T> PartialOrd<NotNan<T>> for NotNan<T> where
T: PartialOrd<T>,
impl<T> PartialOrd<NotNan<T>> for NotNan<T> where
T: PartialOrd<T>,
sourcefn partial_cmp(&self, other: &NotNan<T>) -> Option<Ordering>
fn partial_cmp(&self, other: &NotNan<T>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl<T> Rem<T> for NotNan<T> where
T: Float,
impl<T> Rem<T> for NotNan<T> where
T: Float,
Calculates %
with a float directly.
Panics if the provided value is NaN or the computation results in NaN
sourceimpl<'_, T> RemAssign<&NotNan<T>> for NotNan<T> where
T: Float + RemAssign<T>,
impl<'_, T> RemAssign<&NotNan<T>> for NotNan<T> where
T: Float + RemAssign<T>,
sourcefn rem_assign(&mut self, other: &NotNan<T>)
fn rem_assign(&mut self, other: &NotNan<T>)
Performs the %=
operation. Read more
sourceimpl<'_, T> RemAssign<&T> for NotNan<T> where
T: Float + RemAssign<T>,
impl<'_, T> RemAssign<&T> for NotNan<T> where
T: Float + RemAssign<T>,
sourcefn rem_assign(&mut self, other: &T)
fn rem_assign(&mut self, other: &T)
Performs the %=
operation. Read more
sourceimpl<T> RemAssign<NotNan<T>> for NotNan<T> where
T: Float + RemAssign<T>,
impl<T> RemAssign<NotNan<T>> for NotNan<T> where
T: Float + RemAssign<T>,
sourcefn rem_assign(&mut self, other: NotNan<T>)
fn rem_assign(&mut self, other: NotNan<T>)
Performs the %=
operation. Read more
sourceimpl<T> RemAssign<T> for NotNan<T> where
T: Float + RemAssign<T>,
impl<T> RemAssign<T> for NotNan<T> where
T: Float + RemAssign<T>,
sourcefn rem_assign(&mut self, other: T)
fn rem_assign(&mut self, other: T)
Performs the %=
operation. Read more
sourceimpl<T> Signed for NotNan<T> where
T: Float + Signed,
impl<T> Signed for NotNan<T> where
T: Float + Signed,
sourcefn abs_sub(&self, other: &NotNan<T>) -> NotNan<T>
fn abs_sub(&self, other: &NotNan<T>) -> NotNan<T>
The positive difference of two numbers. Read more
sourcefn is_positive(&self) -> bool
fn is_positive(&self) -> bool
Returns true if the number is positive and false if the number is zero or negative.
sourcefn is_negative(&self) -> bool
fn is_negative(&self) -> bool
Returns true if the number is negative and false if the number is zero or positive.
sourceimpl<T> Sub<T> for NotNan<T> where
T: Float,
impl<T> Sub<T> for NotNan<T> where
T: Float,
Subtracts a float directly.
Panics if the provided value is NaN or the computation results in NaN
sourceimpl<'_, T> SubAssign<&NotNan<T>> for NotNan<T> where
T: Float + SubAssign<T>,
impl<'_, T> SubAssign<&NotNan<T>> for NotNan<T> where
T: Float + SubAssign<T>,
sourcefn sub_assign(&mut self, other: &NotNan<T>)
fn sub_assign(&mut self, other: &NotNan<T>)
Performs the -=
operation. Read more
sourceimpl<'_, T> SubAssign<&T> for NotNan<T> where
T: Float + SubAssign<T>,
impl<'_, T> SubAssign<&T> for NotNan<T> where
T: Float + SubAssign<T>,
sourcefn sub_assign(&mut self, other: &T)
fn sub_assign(&mut self, other: &T)
Performs the -=
operation. Read more
sourceimpl<T> SubAssign<NotNan<T>> for NotNan<T> where
T: Float + SubAssign<T>,
impl<T> SubAssign<NotNan<T>> for NotNan<T> where
T: Float + SubAssign<T>,
sourcefn sub_assign(&mut self, other: NotNan<T>)
fn sub_assign(&mut self, other: NotNan<T>)
Performs the -=
operation. Read more
sourceimpl<T> SubAssign<T> for NotNan<T> where
T: Float + SubAssign<T>,
impl<T> SubAssign<T> for NotNan<T> where
T: Float + SubAssign<T>,
sourcefn sub_assign(&mut self, other: T)
fn sub_assign(&mut self, other: T)
Performs the -=
operation. Read more
sourceimpl<T> Sum<NotNan<T>> for NotNan<T> where
T: Float + Sum<T>,
impl<T> Sum<NotNan<T>> for NotNan<T> where
T: Float + Sum<T>,
Adds a float directly.
Panics if the provided value is NaN.
sourceimpl<T> ToPrimitive for NotNan<T> where
T: Float,
impl<T> ToPrimitive for NotNan<T> where
T: Float,
sourcefn to_i64(&self) -> Option<i64>
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. Read more
sourcefn to_u64(&self) -> Option<u64>
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. Read more
sourcefn to_isize(&self) -> Option<isize>
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. Read more
sourcefn to_i8(&self) -> Option<i8>
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. Read more
sourcefn to_i16(&self) -> Option<i16>
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. Read more
sourcefn to_i32(&self) -> Option<i32>
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. Read more
sourcefn to_usize(&self) -> Option<usize>
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. Read more
sourcefn to_u8(&self) -> Option<u8>
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. Read more
sourcefn to_u16(&self) -> Option<u16>
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. Read more
sourcefn to_u32(&self) -> Option<u32>
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. Read more
sourcefn to_f32(&self) -> Option<f32>
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
. Read more
sourcefn to_f64(&self) -> Option<f64>
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
. Read more
impl<T> Copy for NotNan<T> where
T: Copy,
impl<T> Eq for NotNan<T> where
T: Float + PartialEq<T>,
impl<T> StructuralPartialEq for NotNan<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for NotNan<T> where
T: RefUnwindSafe,
impl<T> Send for NotNan<T> where
T: Send,
impl<T> Sync for NotNan<T> where
T: Sync,
impl<T> Unpin for NotNan<T> where
T: Unpin,
impl<T> UnwindSafe for NotNan<T> where
T: UnwindSafe,
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