pub struct NotNan<T>(/* private fields */);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));-0.0 and +0.0 are still considered equal. This different sign may show up in printing,
or when dividing by zero (the sign of the zero becomes the sign of the resulting infinity).
Therefore, NotNan may be unsuitable for use as a key in interning and memoization
applications which require equal results from equal inputs, unless signed zeros make no
difference or are canonicalized before insertion.
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;§Representation
NotNan has #[repr(transparent)], so it is sound to use
transmute or pointer casts to convert between any type T and
NotNan<T>, as long as this does not create a NaN value.
However, consider using [bytemuck] as a safe alternative if possible.
[bytemuck]: https://docs.rs/bytemuck/1/
Implementations§
Source§impl<T: FloatCore> NotNan<T>
impl<T: FloatCore> NotNan<T>
Sourcepub fn new(val: T) -> Result<Self, FloatIsNan>
pub fn new(val: T) -> Result<Self, FloatIsNan>
Create a NotNan value.
Returns Err if val is NaN
Source§impl<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) -> Self
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
Sourcepub const unsafe fn unchecked_new(val: T) -> Self
👎Deprecated since 2.5.0: Please use the new_unchecked function instead.
pub const unsafe fn unchecked_new(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
Trait Implementations§
Source§impl<T: FloatCore> Add<T> for NotNan<T>
Adds a float directly.
impl<T: FloatCore> Add<T> for NotNan<T>
Adds a float directly.
This returns a T and not a NotNan<T> because if the added value is NaN, this will be NaN
Source§impl<T: FloatCore + AddAssign> AddAssign<&NotNan<T>> for NotNan<T>
impl<T: FloatCore + AddAssign> AddAssign<&NotNan<T>> for NotNan<T>
Source§fn add_assign(&mut self, other: &Self)
fn add_assign(&mut self, other: &Self)
Performs the
+= operation. Read moreSource§impl<T: FloatCore + AddAssign> AddAssign for NotNan<T>
impl<T: FloatCore + AddAssign> AddAssign for NotNan<T>
Source§fn add_assign(&mut self, other: Self)
fn add_assign(&mut self, other: Self)
Performs the
+= operation. Read moreSource§impl<'de, T: FloatCore + Deserialize<'de>> Deserialize<'de> for NotNan<T>
impl<'de, T: FloatCore + Deserialize<'de>> Deserialize<'de> for NotNan<T>
Source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more
Source§impl<T: FloatCore> Div<T> for NotNan<T>
Divides a float directly.
impl<T: FloatCore> Div<T> for NotNan<T>
Divides a float directly.
This returns a T and not a NotNan<T> because if the divided-by value is NaN, this will be
NaN
Source§impl<T: FloatCore + DivAssign> DivAssign<&NotNan<T>> for NotNan<T>
impl<T: FloatCore + DivAssign> DivAssign<&NotNan<T>> for NotNan<T>
Source§fn div_assign(&mut self, other: &Self)
fn div_assign(&mut self, other: &Self)
Performs the
/= operation. Read moreSource§impl<T: FloatCore + DivAssign> DivAssign for NotNan<T>
impl<T: FloatCore + DivAssign> DivAssign for NotNan<T>
Source§fn div_assign(&mut self, other: Self)
fn div_assign(&mut self, other: Self)
Performs the
/= operation. Read moreSource§impl<T: FloatConst> FloatConst for NotNan<T>
impl<T: FloatConst> FloatConst for NotNan<T>
Source§fn FRAC_1_SQRT_2() -> Self
fn FRAC_1_SQRT_2() -> Self
Return
1.0 / sqrt(2.0).Source§fn FRAC_2_SQRT_PI() -> Self
fn FRAC_2_SQRT_PI() -> Self
Return
2.0 / sqrt(π).Source§impl<T: FloatCore + FromPrimitive> FromPrimitive for NotNan<T>
impl<T: FloatCore + FromPrimitive> FromPrimitive for NotNan<T>
Source§fn from_i64(n: i64) -> Option<Self>
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.Source§fn from_u64(n: u64) -> Option<Self>
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.Source§fn from_isize(n: isize) -> Option<Self>
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.Source§fn from_i8(n: i8) -> Option<Self>
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.Source§fn from_i16(n: i16) -> Option<Self>
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.Source§fn from_i32(n: i32) -> Option<Self>
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.Source§fn from_usize(n: usize) -> Option<Self>
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.Source§fn from_u8(n: u8) -> Option<Self>
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.Source§fn from_u16(n: u16) -> Option<Self>
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.Source§fn from_u32(n: u32) -> Option<Self>
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.Source§fn from_f32(n: f32) -> Option<Self>
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.Source§fn from_f64(n: f64) -> Option<Self>
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. Read moreSource§impl<T: FloatCore + FromStr> FromStr for NotNan<T>
impl<T: FloatCore + FromStr> FromStr for NotNan<T>
Source§fn from_str(src: &str) -> Result<Self, Self::Err>
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());Source§impl<T: PrimitiveFloat> Hash for NotNan<T>
impl<T: PrimitiveFloat> Hash for NotNan<T>
Source§impl<T: FloatCore> Mul<T> for NotNan<T>
Multiplies a float directly.
impl<T: FloatCore> Mul<T> for NotNan<T>
Multiplies a float directly.
This returns a T and not a NotNan<T> because if the multiplied value is NaN, this will be
NaN
Source§impl<T: FloatCore + MulAssign> MulAssign<&NotNan<T>> for NotNan<T>
impl<T: FloatCore + MulAssign> MulAssign<&NotNan<T>> for NotNan<T>
Source§fn mul_assign(&mut self, other: &Self)
fn mul_assign(&mut self, other: &Self)
Performs the
*= operation. Read moreSource§impl<T: FloatCore + MulAssign> MulAssign for NotNan<T>
impl<T: FloatCore + MulAssign> MulAssign for NotNan<T>
Source§fn mul_assign(&mut self, other: Self)
fn mul_assign(&mut self, other: Self)
Performs the
*= operation. Read moreSource§impl<T: FloatCore> Num for NotNan<T>
impl<T: FloatCore> Num for NotNan<T>
type FromStrRadixErr = ParseNotNanError<<T as Num>::FromStrRadixErr>
Source§fn from_str_radix(src: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>
fn from_str_radix(src: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>
Convert from a string and radix (typically
2..=36). Read moreSource§impl<T: FloatCore> Ord for NotNan<T>
impl<T: FloatCore> Ord for NotNan<T>
Source§impl<T: PartialOrd> PartialOrd for NotNan<T>
impl<T: PartialOrd> PartialOrd for NotNan<T>
Source§impl<T: FloatCore> Rem<T> for NotNan<T>
Calculates % with a float directly.
impl<T: FloatCore> Rem<T> for NotNan<T>
Calculates % with a float directly.
This returns a T and not a NotNan<T> because if the RHS is NaN, this will be NaN
Source§impl<T: FloatCore + RemAssign> RemAssign<&NotNan<T>> for NotNan<T>
impl<T: FloatCore + RemAssign> RemAssign<&NotNan<T>> for NotNan<T>
Source§fn rem_assign(&mut self, other: &Self)
fn rem_assign(&mut self, other: &Self)
Performs the
%= operation. Read moreSource§impl<T: FloatCore + RemAssign> RemAssign for NotNan<T>
impl<T: FloatCore + RemAssign> RemAssign for NotNan<T>
Source§fn rem_assign(&mut self, other: Self)
fn rem_assign(&mut self, other: Self)
Performs the
%= operation. Read moreSource§impl<T: FloatCore + Signed> Signed for NotNan<T>
impl<T: FloatCore + Signed> Signed for NotNan<T>
Source§fn 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.
Source§fn 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.
Source§impl<T: FloatCore> Sub<T> for NotNan<T>
Subtracts a float directly.
impl<T: FloatCore> Sub<T> for NotNan<T>
Subtracts a float directly.
This returns a T and not a NotNan<T> because if the substracted value is NaN, this will be
NaN
Source§impl<T: FloatCore + SubAssign> SubAssign<&NotNan<T>> for NotNan<T>
impl<T: FloatCore + SubAssign> SubAssign<&NotNan<T>> for NotNan<T>
Source§fn sub_assign(&mut self, other: &Self)
fn sub_assign(&mut self, other: &Self)
Performs the
-= operation. Read moreSource§impl<T: FloatCore + SubAssign> SubAssign for NotNan<T>
impl<T: FloatCore + SubAssign> SubAssign for NotNan<T>
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Performs the
-= operation. Read moreSource§impl<T: FloatCore + Sum> Sum for NotNan<T>
Adds a float directly.
impl<T: FloatCore + Sum> Sum for NotNan<T>
Adds a float directly.
Panics if the provided value is NaN.
Source§impl<T: FloatCore> ToPrimitive for NotNan<T>
impl<T: FloatCore> ToPrimitive for NotNan<T>
Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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.Source§fn 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 moreimpl<T: Copy> Copy for NotNan<T>
impl<T: FloatCore + PartialEq> Eq for NotNan<T>
impl<T> StructuralPartialEq for NotNan<T>
Auto Trait Implementations§
impl<T> Freeze for NotNan<T>where
T: Freeze,
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§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more