Struct ordered_float::OrderedFloat

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

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

NaN is sorted as greater than all other values and equal to itself, in contradiction with the IEEE standard.

use ordered_float::OrderedFloat;
use std::f32::NAN;

let mut v = [OrderedFloat(NAN), OrderedFloat(2.0), OrderedFloat(1.0)];
v.sort();
assert_eq!(v, [OrderedFloat(1.0), OrderedFloat(2.0), OrderedFloat(NAN)]);

Because OrderedFloat 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<OrderedFloat<f32>> = HashSet::new();
s.insert(OrderedFloat(NAN));
assert!(s.contains(&OrderedFloat(NAN)));

Tuple Fields

0: T

Implementations

impl<T: Float> OrderedFloat<T>

pub fn into_inner(self) -> T

Get the value out.

Trait Implementations

impl<'a, T> Add<&'a OrderedFloat<T>> for OrderedFloat<T>where
    T: Add<&'a T>,

type Output = OrderedFloat<<T as Add<&'a T>>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, T> Add<&'a T> for &'a OrderedFloat<T>where
    &'a T: Add,

type Output = OrderedFloat<<&'a T as Add<&'a T>>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, T> Add<&'a T> for OrderedFloat<T>where
    T: Add<&'a T>,

type Output = OrderedFloat<<T as Add<&'a T>>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, T> Add<OrderedFloat<T>> for &'a OrderedFloat<T>where
    &'a T: Add<T>,

type Output = OrderedFloat<<&'a T as Add<T>>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Add> Add<OrderedFloat<T>> for OrderedFloat<T>

type Output = OrderedFloat<<T as Add<T>>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, T> Add<T> for &'a OrderedFloat<T>where
    &'a T: Add<T>,

type Output = OrderedFloat<<&'a T as Add<T>>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Add> Add<T> for OrderedFloat<T>

type Output = OrderedFloat<<T as Add<T>>::Output>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, T: AddAssign<&'a T>> AddAssign<&'a OrderedFloat<T>> for OrderedFloat<T>

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

Performs the += operation.

impl<'a, T: AddAssign<&'a T>> AddAssign<&'a T> for OrderedFloat<T>

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

Performs the += operation.

impl<T: AddAssign> AddAssign<OrderedFloat<T>> for OrderedFloat<T>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: AddAssign> AddAssign<T> for OrderedFloat<T>

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T: Float> AsMut<T> for OrderedFloat<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsPrimitive<OrderedFloat<f32>> for OrderedFloat<f32>

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for OrderedFloat<f64>

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for f32

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for f64

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for i16

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for i32

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for i64

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for i8

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for isize

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for u16

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for u32

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for u64

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for u8

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f32>> for usize

fn as_(self) -> OrderedFloat<f32>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for OrderedFloat<f32>

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for OrderedFloat<f64>

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for f32

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for f64

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for i16

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for i32

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for i64

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for i8

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for isize

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for u16

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for u32

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for u64

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for u8

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<OrderedFloat<f64>> for usize

fn as_(self) -> OrderedFloat<f64>

Convert a value to another, using the as operator.

impl AsPrimitive<f32> for OrderedFloat<f32>

fn as_(self) -> f32

Convert a value to another, using the as operator.

impl AsPrimitive<f32> for OrderedFloat<f64>

fn as_(self) -> f32

Convert a value to another, using the as operator.

impl AsPrimitive<f64> for OrderedFloat<f32>

fn as_(self) -> f64

Convert a value to another, using the as operator.

impl AsPrimitive<f64> for OrderedFloat<f64>

fn as_(self) -> f64

Convert a value to another, using the as operator.

impl AsPrimitive<i16> for OrderedFloat<f32>

fn as_(self) -> i16

Convert a value to another, using the as operator.

impl AsPrimitive<i16> for OrderedFloat<f64>

fn as_(self) -> i16

Convert a value to another, using the as operator.

impl AsPrimitive<i32> for OrderedFloat<f32>

fn as_(self) -> i32

Convert a value to another, using the as operator.

impl AsPrimitive<i32> for OrderedFloat<f64>

fn as_(self) -> i32

Convert a value to another, using the as operator.

impl AsPrimitive<i64> for OrderedFloat<f32>

fn as_(self) -> i64

Convert a value to another, using the as operator.

impl AsPrimitive<i64> for OrderedFloat<f64>

fn as_(self) -> i64

Convert a value to another, using the as operator.

impl AsPrimitive<i8> for OrderedFloat<f32>

fn as_(self) -> i8

Convert a value to another, using the as operator.

impl AsPrimitive<i8> for OrderedFloat<f64>

fn as_(self) -> i8

Convert a value to another, using the as operator.

impl AsPrimitive<isize> for OrderedFloat<f32>

fn as_(self) -> isize

Convert a value to another, using the as operator.

impl AsPrimitive<isize> for OrderedFloat<f64>

fn as_(self) -> isize

Convert a value to another, using the as operator.

impl AsPrimitive<u16> for OrderedFloat<f32>

fn as_(self) -> u16

Convert a value to another, using the as operator.

impl AsPrimitive<u16> for OrderedFloat<f64>

fn as_(self) -> u16

Convert a value to another, using the as operator.

impl AsPrimitive<u32> for OrderedFloat<f32>

fn as_(self) -> u32

Convert a value to another, using the as operator.

impl AsPrimitive<u32> for OrderedFloat<f64>

fn as_(self) -> u32

Convert a value to another, using the as operator.

impl AsPrimitive<u64> for OrderedFloat<f32>

fn as_(self) -> u64

Convert a value to another, using the as operator.

impl AsPrimitive<u64> for OrderedFloat<f64>

fn as_(self) -> u64

Convert a value to another, using the as operator.

impl AsPrimitive<u8> for OrderedFloat<f32>

fn as_(self) -> u8

Convert a value to another, using the as operator.

impl AsPrimitive<u8> for OrderedFloat<f64>

fn as_(self) -> u8

Convert a value to another, using the as operator.

impl AsPrimitive<usize> for OrderedFloat<f32>

fn as_(self) -> usize

Convert a value to another, using the as operator.

impl AsPrimitive<usize> for OrderedFloat<f64>

fn as_(self) -> usize

Convert a value to another, using the as operator.

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

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Bounded> Bounded for OrderedFloat<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 OrderedFloat<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for OrderedFloat<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for OrderedFloat<T>

fn default() -> OrderedFloat<T>

Returns the “default value” for a type.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Float> DerefMut for OrderedFloat<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

impl<'a, T> Div<&'a OrderedFloat<T>> for OrderedFloat<T>where
    T: Div<&'a T>,

type Output = OrderedFloat<<T as Div<&'a T>>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, T> Div<&'a T> for &'a OrderedFloat<T>where
    &'a T: Div,

type Output = OrderedFloat<<&'a T as Div<&'a T>>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, T> Div<&'a T> for OrderedFloat<T>where
    T: Div<&'a T>,

type Output = OrderedFloat<<T as Div<&'a T>>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, T> Div<OrderedFloat<T>> for &'a OrderedFloat<T>where
    &'a T: Div<T>,

type Output = OrderedFloat<<&'a T as Div<T>>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Div> Div<OrderedFloat<T>> for OrderedFloat<T>

type Output = OrderedFloat<<T as Div<T>>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, T> Div<T> for &'a OrderedFloat<T>where
    &'a T: Div<T>,

type Output = OrderedFloat<<&'a T as Div<T>>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Div> Div<T> for OrderedFloat<T>

type Output = OrderedFloat<<T as Div<T>>::Output>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, T: DivAssign<&'a T>> DivAssign<&'a OrderedFloat<T>> for OrderedFloat<T>

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

Performs the /= operation.

impl<'a, T: DivAssign<&'a T>> DivAssign<&'a T> for OrderedFloat<T>

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

Performs the /= operation.

impl<T: DivAssign> DivAssign<OrderedFloat<T>> for OrderedFloat<T>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T: DivAssign> DivAssign<T> for OrderedFloat<T>

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T: Float> Float for OrderedFloat<T>

fn nan() -> Self

Returns the NaN value.

fn infinity() -> Self

Returns the infinite value.

fn neg_infinity() -> Self

Returns the negative infinite value.

fn neg_zero() -> Self

Returns -0.0.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

fn is_infinite(self) -> bool

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

fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

fn is_normal(self) -> bool

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

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.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn abs(self) -> Self

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0, Float::infinity(), and since Rust 1.20 also Float::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0, Float::neg_infinity(), and since Rust 1.20 also -Float::nan().

fn mul_add(self, a: Self, b: Self) -> Self

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

fn recip(self) -> Self

Take the reciprocal (inverse) of a number, 1/x.

fn powi(self, n: i32) -> Self

Raise a number to an integer power.

fn powf(self, n: Self) -> Self

Raise a number to a floating point power.

fn sqrt(self) -> Self

Take the square root of a number.

fn exp(self) -> Self

Returns e^(self), (the exponential function).

fn exp2(self) -> Self

Returns 2^(self).

fn ln(self) -> Self

Returns the natural logarithm of the number.

fn log(self, base: Self) -> Self

Returns the logarithm of the number with respect to an arbitrary base.

fn log2(self) -> Self

Returns the base 2 logarithm of the number.

fn log10(self) -> Self

Returns the base 10 logarithm of the number.

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

Returns the maximum of the two numbers.

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

Returns the minimum of the two numbers.

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

The positive difference of two numbers.

fn cbrt(self) -> Self

Take the cubic root of a number.

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

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

fn sin(self) -> Self

Computes the sine of a number (in radians).

fn cos(self) -> Self

Computes the cosine of a number (in radians).

fn tan(self) -> Self

Computes the tangent of a number (in radians).

fn asin(self) -> Self

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

fn acos(self) -> Self

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

fn atan(self) -> Self

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

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

Computes the four quadrant arctangent of self (y) and other (x).

fn sin_cos(self) -> (Self, Self)

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

fn exp_m1(self) -> Self

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

fn ln_1p(self) -> Self

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

fn sinh(self) -> Self

Hyperbolic sine function.

fn cosh(self) -> Self

Hyperbolic cosine function.

fn tanh(self) -> Self

Hyperbolic tangent function.

fn asinh(self) -> Self

Inverse hyperbolic sine function.

fn acosh(self) -> Self

Inverse hyperbolic cosine function.

fn atanh(self) -> Self

Inverse hyperbolic tangent function.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn epsilon() -> Self

Returns epsilon, a small positive value.

fn to_degrees(self) -> Self

Converts radians to degrees.

fn to_radians(self) -> Self

Converts degrees to radians.

fn copysign(self, sign: Self) -> Self

Returns a number composed of the magnitude of self and the sign of sign.

impl<T: Float> FloatCore for OrderedFloat<T>

fn nan() -> Self

Returns NaN.

fn infinity() -> Self

Returns positive infinity.

fn neg_infinity() -> Self

Returns negative infinity.

fn neg_zero() -> Self

Returns -0.0.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if the number is NaN.

fn is_infinite(self) -> bool

Returns true if the number is infinite.

fn is_finite(self) -> bool

Returns true if the number is neither infinite or NaN.

fn is_normal(self) -> bool

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

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.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn abs(self) -> Self

Computes the absolute value of self. Returns FloatCore::nan() if the number is FloatCore::nan().

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0 and FloatCore::infinity(), and since Rust 1.20 also FloatCore::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0 and FloatCore::neg_infinity(), and since Rust 1.20 also -FloatCore::nan().

fn recip(self) -> Self

Returns the reciprocal (multiplicative inverse) of the number.

fn powi(self, n: i32) -> Self

Raise a number to an integer power.

fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn epsilon() -> Self

Returns epsilon, a small positive value.

fn to_degrees(self) -> Self

Converts to degrees, assuming the number is in radians.

fn to_radians(self) -> Self

Converts to radians, assuming the number is in degrees.

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

Returns the minimum of the two numbers.

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

Returns the maximum of the two numbers.

impl<'a, T: Float> From<&'a T> for &'a OrderedFloat<T>

fn from(t: &'a T) -> &'a OrderedFloat<T>

Converts to this type from the input type.

impl<'a, T: Float> From<&'a mut T> for &'a mut OrderedFloat<T>

fn from(t: &'a mut T) -> &'a mut OrderedFloat<T>

Converts to this type from the input type.

impl From<OrderedFloat<f32>> for f32

fn from(f: OrderedFloat<f32>) -> f32

Converts to this type from the input type.

impl From<OrderedFloat<f64>> for f64

fn from(f: OrderedFloat<f64>) -> f64

Converts to this type from the input type.

impl<T: Float> From<T> for OrderedFloat<T>

fn from(val: T) -> Self

Converts to this type from the input type.

impl<T: FromPrimitive> FromPrimitive for OrderedFloat<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: FromStr> FromStr for OrderedFloat<T>

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

Convert a &str to OrderedFloat. Returns an error if the string fails to parse.

use ordered_float::OrderedFloat;

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

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.

impl<T: Float> Hash for OrderedFloat<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 + LowerExp> LowerExp for OrderedFloat<T>

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

Formats the value using the given formatter.

impl<'a, T> Mul<&'a OrderedFloat<T>> for OrderedFloat<T>where
    T: Mul<&'a T>,

type Output = OrderedFloat<<T as Mul<&'a T>>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, T> Mul<&'a T> for &'a OrderedFloat<T>where
    &'a T: Mul,

type Output = OrderedFloat<<&'a T as Mul<&'a T>>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, T> Mul<&'a T> for OrderedFloat<T>where
    T: Mul<&'a T>,

type Output = OrderedFloat<<T as Mul<&'a T>>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, T> Mul<OrderedFloat<T>> for &'a OrderedFloat<T>where
    &'a T: Mul<T>,

type Output = OrderedFloat<<&'a T as Mul<T>>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Mul> Mul<OrderedFloat<T>> for OrderedFloat<T>

type Output = OrderedFloat<<T as Mul<T>>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, T> Mul<T> for &'a OrderedFloat<T>where
    &'a T: Mul<T>,

type Output = OrderedFloat<<&'a T as Mul<T>>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Mul> Mul<T> for OrderedFloat<T>

type Output = OrderedFloat<<T as Mul<T>>::Output>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, T: MulAssign<&'a T>> MulAssign<&'a OrderedFloat<T>> for OrderedFloat<T>

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

Performs the *= operation.

impl<'a, T: MulAssign<&'a T>> MulAssign<&'a T> for OrderedFloat<T>

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

Performs the *= operation.

impl<T: MulAssign> MulAssign<OrderedFloat<T>> for OrderedFloat<T>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T: MulAssign> MulAssign<T> for OrderedFloat<T>

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<'a, T> Neg for &'a OrderedFloat<T>where
    &'a T: Neg,

type Output = OrderedFloat<<&'a T as Neg>::Output>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Neg> Neg for OrderedFloat<T>

type Output = OrderedFloat<<T as Neg>::Output>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Float + Num> Num for OrderedFloat<T>

type FromStrRadixErr = <T as Num>::FromStrRadixErr

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

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

impl<T: NumCast> NumCast for OrderedFloat<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: One> One for OrderedFloat<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.

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Float> PartialOrd<OrderedFloat<T>> for OrderedFloat<T>

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

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

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

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

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

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

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

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

const 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 OrderedFloat<T>> for OrderedFloat<T>

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

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

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

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

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

impl<'a, T> Rem<&'a OrderedFloat<T>> for OrderedFloat<T>where
    T: Rem<&'a T>,

type Output = OrderedFloat<<T as Rem<&'a T>>::Output>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'a, T> Rem<&'a T> for &'a OrderedFloat<T>where
    &'a T: Rem,

type Output = OrderedFloat<<&'a T as Rem<&'a T>>::Output>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'a, T> Rem<&'a T> for OrderedFloat<T>where
    T: Rem<&'a T>,

type Output = OrderedFloat<<T as Rem<&'a T>>::Output>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'a, T> Rem<OrderedFloat<T>> for &'a OrderedFloat<T>where
    &'a T: Rem<T>,

type Output = OrderedFloat<<&'a T as Rem<T>>::Output>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T: Rem> Rem<OrderedFloat<T>> for OrderedFloat<T>

type Output = OrderedFloat<<T as Rem<T>>::Output>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'a, T> Rem<T> for &'a OrderedFloat<T>where
    &'a T: Rem<T>,

type Output = OrderedFloat<<&'a T as Rem<T>>::Output>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T: Rem> Rem<T> for OrderedFloat<T>

type Output = OrderedFloat<<T as Rem<T>>::Output>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<'a, T: RemAssign<&'a T>> RemAssign<&'a OrderedFloat<T>> for OrderedFloat<T>

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

Performs the %= operation.

impl<'a, T: RemAssign<&'a T>> RemAssign<&'a T> for OrderedFloat<T>

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

Performs the %= operation.

impl<T: RemAssign> RemAssign<OrderedFloat<T>> for OrderedFloat<T>

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<T: RemAssign> RemAssign<T> for OrderedFloat<T>

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T: Float + Signed> Signed for OrderedFloat<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<'a, T> Sub<&'a OrderedFloat<T>> for OrderedFloat<T>where
    T: Sub<&'a T>,

type Output = OrderedFloat<<T as Sub<&'a T>>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T> Sub<&'a T> for &'a OrderedFloat<T>where
    &'a T: Sub,

type Output = OrderedFloat<<&'a T as Sub<&'a T>>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T> Sub<&'a T> for OrderedFloat<T>where
    T: Sub<&'a T>,

type Output = OrderedFloat<<T as Sub<&'a T>>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T> Sub<OrderedFloat<T>> for &'a OrderedFloat<T>where
    &'a T: Sub<T>,

type Output = OrderedFloat<<&'a T as Sub<T>>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Sub> Sub<OrderedFloat<T>> for OrderedFloat<T>

type Output = OrderedFloat<<T as Sub<T>>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T> Sub<T> for &'a OrderedFloat<T>where
    &'a T: Sub<T>,

type Output = OrderedFloat<<&'a T as Sub<T>>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Sub> Sub<T> for OrderedFloat<T>

type Output = OrderedFloat<<T as Sub<T>>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T: SubAssign<&'a T>> SubAssign<&'a OrderedFloat<T>> for OrderedFloat<T>

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

Performs the -= operation.

impl<'a, T: SubAssign<&'a T>> SubAssign<&'a T> for OrderedFloat<T>

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

Performs the -= operation.

impl<T: SubAssign> SubAssign<OrderedFloat<T>> for OrderedFloat<T>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: SubAssign> SubAssign<T> for OrderedFloat<T>

fn sub_assign(&mut self, other: T)

Performs the -= operation.

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

fn sum<I: Iterator<Item = &'a OrderedFloat<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<OrderedFloat<T>> for OrderedFloat<T>

Adds a float directly.

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

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

impl<T: ToPrimitive> ToPrimitive for OrderedFloat<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<T: Float + UpperExp> UpperExp for OrderedFloat<T>

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

Formats the value using the given formatter.

impl<T: Zero> Zero for OrderedFloat<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 OrderedFloat<T>

impl<T: Float> Eq for OrderedFloat<T>