Struct 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)));

Some non-identical values are still considered equal by the PartialEq implementation, and will therefore also be considered equal by maps, sets, and the == operator:

• -0.0 and +0.0 are 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).
• All NaN values are considered equal, even though they may have different bits, and therefore different sign, signaling/quiet status, and NaN payload bits.

Therefore, OrderedFloat may be unsuitable for use as a key in interning and memoization applications which require equal results from equal inputs, unless these cases make no difference or are canonicalized before insertion.

Representation

OrderedFloat has #[repr(transparent)] and permits any value, so it is sound to use transmute or pointer casts to convert between any type T and OrderedFloat<T>. However, consider using bytemuck as a safe alternative if possible.

Tuple Fields

0: T

Implementations

impl<T> OrderedFloat<T>

where T: FloatCore,

pub fn into_inner(self) -> T

Get the value out.

Trait Implementations

impl<'a, 'b, T> Add<&'b OrderedFloat<T>> for &'a OrderedFloat<T>

where T: Add + Copy,

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

The resulting type after applying the + operator.

fn add( self, other: &'b OrderedFloat<T>, ) -> <&'a OrderedFloat<T> as Add<&'b OrderedFloat<T>>>::Output

Performs the + operation.

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 OrderedFloat<T>, ) -> <OrderedFloat<T> as Add<&'a OrderedFloat<T>>>::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>::Output>

The resulting type after applying the + operator.

fn add(self, other: &'a T) -> <&'a OrderedFloat<T> as Add<&'a T>>::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) -> <OrderedFloat<T> as Add<&'a T>>::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>, ) -> <&'a OrderedFloat<T> as Add<OrderedFloat<T>>>::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) -> <&'a OrderedFloat<T> as Add<T>>::Output

Performs the + operation.

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

where T: Add,

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

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add for OrderedFloat<T>

where T: Add,

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

The resulting type after applying the + operator.

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

Performs the + operation.

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

where T: AddAssign<&'a T>,

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

Performs the += operation.

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

where T: AddAssign<&'a T>,

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

Performs the += operation.

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

where T: AddAssign,

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T> AddAssign for OrderedFloat<T>

where T: AddAssign,

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

Performs the += operation.

impl<T> AsMut<T> for OrderedFloat<T>

where T: FloatCore,

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

where T: FloatCore,

fn as_ref(&self) -> &T

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

impl<T> Bounded for OrderedFloat<T>

where T: Bounded,

fn min_value() -> OrderedFloat<T>

Returns the smallest finite number this type can represent

fn max_value() -> OrderedFloat<T>

Returns the largest finite number this type can represent

impl<T> Clone for OrderedFloat<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for OrderedFloat<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for OrderedFloat<T>

where T: Default,

fn default() -> OrderedFloat<T>

Returns the “default value” for a type.

impl<T> Deref for OrderedFloat<T>

where T: FloatCore,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<OrderedFloat<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for OrderedFloat<T>

where T: FloatCore,

fn deref_mut(&mut self) -> &mut <OrderedFloat<T> as Deref>::Target

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for OrderedFloat<T>

where T: FloatCore + Deserialize<'de>,

fn deserialize<D>( d: D, ) -> Result<OrderedFloat<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for OrderedFloat<T>

where T: FloatCore + Display,

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

Formats the value using the given formatter.

impl<'a, 'b, T> Div<&'b OrderedFloat<T>> for &'a OrderedFloat<T>

where T: Div + Copy,

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

The resulting type after applying the / operator.

fn div( self, other: &'b OrderedFloat<T>, ) -> <&'a OrderedFloat<T> as Div<&'b OrderedFloat<T>>>::Output

Performs the / operation.

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 OrderedFloat<T>, ) -> <OrderedFloat<T> as Div<&'a OrderedFloat<T>>>::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>::Output>

The resulting type after applying the / operator.

fn div(self, other: &'a T) -> <&'a OrderedFloat<T> as Div<&'a T>>::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) -> <OrderedFloat<T> as Div<&'a T>>::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>, ) -> <&'a OrderedFloat<T> as Div<OrderedFloat<T>>>::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) -> <&'a OrderedFloat<T> as Div<T>>::Output

Performs the / operation.

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

where T: Div,

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

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> Div for OrderedFloat<T>

where T: Div,

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

The resulting type after applying the / operator.

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

Performs the / operation.

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

where T: DivAssign<&'a T>,

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

Performs the /= operation.

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

where T: DivAssign<&'a T>,

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

Performs the /= operation.

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

where T: DivAssign,

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T> DivAssign for OrderedFloat<T>

where T: DivAssign,

fn div_assign(&mut self, other: OrderedFloat<T>)

Performs the /= operation.

impl<T> FloatConst for OrderedFloat<T>

where T: FloatConst,

fn E() -> OrderedFloat<T>

Return Euler’s number.

fn FRAC_1_PI() -> OrderedFloat<T>

Return 1.0 / π.

fn FRAC_1_SQRT_2() -> OrderedFloat<T>

Return 1.0 / sqrt(2.0).

fn FRAC_2_PI() -> OrderedFloat<T>

Return 2.0 / π.

fn FRAC_2_SQRT_PI() -> OrderedFloat<T>

Return 2.0 / sqrt(π).

fn FRAC_PI_2() -> OrderedFloat<T>

Return π / 2.0.

fn FRAC_PI_3() -> OrderedFloat<T>

Return π / 3.0.

fn FRAC_PI_4() -> OrderedFloat<T>

Return π / 4.0.

fn FRAC_PI_6() -> OrderedFloat<T>

Return π / 6.0.

fn FRAC_PI_8() -> OrderedFloat<T>

Return π / 8.0.

fn LN_10() -> OrderedFloat<T>

Return ln(10.0).

fn LN_2() -> OrderedFloat<T>

Return ln(2.0).

fn LOG10_E() -> OrderedFloat<T>

Return log10(e).

fn LOG2_E() -> OrderedFloat<T>

Return log2(e).

fn PI() -> OrderedFloat<T>

Return Archimedes’ constant π.

fn SQRT_2() -> OrderedFloat<T>

Return sqrt(2.0).

fn TAU() -> Self

where Self: Sized + Add<Output = Self>,

Return the full circle constant τ.

fn LOG10_2() -> Self

where Self: Sized + Div<Output = Self>,

Return log10(2.0).

fn LOG2_10() -> Self

where Self: Sized + Div<Output = Self>,

Return log2(10.0).

impl<T> FloatCore for OrderedFloat<T>

where T: FloatCore,

fn nan() -> OrderedFloat<T>

Returns NaN.

fn infinity() -> OrderedFloat<T>

Returns positive infinity.

fn neg_infinity() -> OrderedFloat<T>

Returns negative infinity.

fn neg_zero() -> OrderedFloat<T>

Returns -0.0.

fn min_value() -> OrderedFloat<T>

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> OrderedFloat<T>

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

fn max_value() -> OrderedFloat<T>

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) -> OrderedFloat<T>

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

fn ceil(self) -> OrderedFloat<T>

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

fn round(self) -> OrderedFloat<T>

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

fn trunc(self) -> OrderedFloat<T>

Return the integer part of a number.

fn fract(self) -> OrderedFloat<T>

Returns the fractional part of a number.

fn abs(self) -> OrderedFloat<T>

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

fn signum(self) -> OrderedFloat<T>

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 FloatCore::nan().

fn is_sign_negative(self) -> bool

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

fn recip(self) -> OrderedFloat<T>

Returns the reciprocal (multiplicative inverse) of the number.

fn powi(self, n: i32) -> OrderedFloat<T>

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() -> OrderedFloat<T>

Returns epsilon, a small positive value.

fn to_degrees(self) -> OrderedFloat<T>

Converts to degrees, assuming the number is in radians.

fn to_radians(self) -> OrderedFloat<T>

Converts to radians, assuming the number is in degrees.

fn is_subnormal(self) -> bool

Returns true if the number is subnormal.

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.

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

A value bounded by a minimum and a maximum

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

where T: FloatCore,

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

Converts to this type from the input type.

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

where T: FloatCore,

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

Converts to this type from the input type.

impl<T> From<T> for OrderedFloat<T>

where T: FloatCore,

fn from(val: T) -> OrderedFloat<T>

Converts to this type from the input type.

impl From<bool> for OrderedFloat<f32>

fn from(val: bool) -> OrderedFloat<f32>

Converts to this type from the input type.

impl From<bool> for OrderedFloat<f64>

fn from(val: bool) -> OrderedFloat<f64>

Converts to this type from the input type.

impl From<i16> for OrderedFloat<f32>

fn from(val: i16) -> OrderedFloat<f32>

Converts to this type from the input type.

impl From<i16> for OrderedFloat<f64>

fn from(val: i16) -> OrderedFloat<f64>

Converts to this type from the input type.

impl From<i32> for OrderedFloat<f64>

fn from(val: i32) -> OrderedFloat<f64>

Converts to this type from the input type.

impl From<i8> for OrderedFloat<f32>

fn from(val: i8) -> OrderedFloat<f32>

Converts to this type from the input type.

impl From<i8> for OrderedFloat<f64>

fn from(val: i8) -> OrderedFloat<f64>

Converts to this type from the input type.

impl From<u16> for OrderedFloat<f32>

fn from(val: u16) -> OrderedFloat<f32>

Converts to this type from the input type.

impl From<u16> for OrderedFloat<f64>

fn from(val: u16) -> OrderedFloat<f64>

Converts to this type from the input type.

impl From<u32> for OrderedFloat<f64>

fn from(val: u32) -> OrderedFloat<f64>

Converts to this type from the input type.

impl From<u8> for OrderedFloat<f32>

fn from(val: u8) -> OrderedFloat<f32>

Converts to this type from the input type.

impl From<u8> for OrderedFloat<f64>

fn from(val: u8) -> OrderedFloat<f64>

Converts to this type from the input type.

impl<T> FromPrimitive for OrderedFloat<T>

where T: FromPrimitive,

fn from_i64(n: i64) -> Option<OrderedFloat<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.

fn from_u64(n: u64) -> Option<OrderedFloat<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.

fn from_isize(n: isize) -> Option<OrderedFloat<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.

fn from_i8(n: i8) -> Option<OrderedFloat<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.

fn from_i16(n: i16) -> Option<OrderedFloat<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.

fn from_i32(n: i32) -> Option<OrderedFloat<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.

fn from_usize(n: usize) -> Option<OrderedFloat<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.

fn from_u8(n: u8) -> Option<OrderedFloat<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.

fn from_u16(n: u16) -> Option<OrderedFloat<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.

fn from_u32(n: u32) -> Option<OrderedFloat<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.

fn from_f32(n: f32) -> Option<OrderedFloat<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.

fn from_f64(n: f64) -> Option<OrderedFloat<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.

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

where T: FromStr,

fn from_str( s: &str, ) -> Result<OrderedFloat<T>, <OrderedFloat<T> as FromStr>::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> Hash for OrderedFloat<T>

where T: PrimitiveFloat,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> LowerExp for OrderedFloat<T>

where T: FloatCore + LowerExp,

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

Formats the value using the given formatter.

impl<'a, 'b, T> Mul<&'b OrderedFloat<T>> for &'a OrderedFloat<T>

where T: Mul + Copy,

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

The resulting type after applying the * operator.

fn mul( self, other: &'b OrderedFloat<T>, ) -> <&'a OrderedFloat<T> as Mul<&'b OrderedFloat<T>>>::Output

Performs the * operation.

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 OrderedFloat<T>, ) -> <OrderedFloat<T> as Mul<&'a OrderedFloat<T>>>::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>::Output>

The resulting type after applying the * operator.

fn mul(self, other: &'a T) -> <&'a OrderedFloat<T> as Mul<&'a T>>::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) -> <OrderedFloat<T> as Mul<&'a T>>::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>, ) -> <&'a OrderedFloat<T> as Mul<OrderedFloat<T>>>::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) -> <&'a OrderedFloat<T> as Mul<T>>::Output

Performs the * operation.

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

where T: Mul,

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

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul for OrderedFloat<T>

where T: Mul,

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

The resulting type after applying the * operator.

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

Performs the * operation.

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

where T: MulAssign<&'a T>,

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

Performs the *= operation.

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

where T: MulAssign<&'a T>,

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

Performs the *= operation.

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

where T: MulAssign,

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T> MulAssign for OrderedFloat<T>

where T: MulAssign,

fn mul_assign(&mut self, other: OrderedFloat<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) -> <&'a OrderedFloat<T> as Neg>::Output

Performs the unary - operation.

impl<T> Neg for OrderedFloat<T>

where T: Neg,

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

The resulting type after applying the - operator.

fn neg(self) -> <OrderedFloat<T> as Neg>::Output

Performs the unary - operation.

impl<T> Num for OrderedFloat<T>

where T: FloatCore + Num,

type FromStrRadixErr = <T as Num>::FromStrRadixErr

fn from_str_radix( str: &str, radix: u32, ) -> Result<OrderedFloat<T>, <OrderedFloat<T> as Num>::FromStrRadixErr>

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

impl<T> NumCast for OrderedFloat<T>

where T: NumCast,

fn from<F>(n: F) -> Option<OrderedFloat<T>>

where F: ToPrimitive,

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

where T: One,

fn one() -> OrderedFloat<T>

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,

Returns true if self is equal to the multiplicative identity.

impl<T> Ord for OrderedFloat<T>

where T: FloatCore,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq<T> for OrderedFloat<T>

where T: FloatCore,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialEq for OrderedFloat<T>

where T: FloatCore,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialOrd for OrderedFloat<T>

where T: FloatCore,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, T> Product<&'a OrderedFloat<T>> for OrderedFloat<T>

where T: FloatCore + Product + 'a,

fn product<I>(iter: I) -> OrderedFloat<T>

where I: Iterator<Item = &'a OrderedFloat<T>>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl<T> Product for OrderedFloat<T>

where T: FloatCore + Product,

fn product<I>(iter: I) -> OrderedFloat<T>

where I: Iterator<Item = OrderedFloat<T>>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl<'a, 'b, T> Rem<&'b OrderedFloat<T>> for &'a OrderedFloat<T>

where T: Rem + Copy,

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

The resulting type after applying the % operator.

fn rem( self, other: &'b OrderedFloat<T>, ) -> <&'a OrderedFloat<T> as Rem<&'b OrderedFloat<T>>>::Output

Performs the % operation.

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 OrderedFloat<T>, ) -> <OrderedFloat<T> as Rem<&'a OrderedFloat<T>>>::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>::Output>

The resulting type after applying the % operator.

fn rem(self, other: &'a T) -> <&'a OrderedFloat<T> as Rem<&'a T>>::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) -> <OrderedFloat<T> as Rem<&'a T>>::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>, ) -> <&'a OrderedFloat<T> as Rem<OrderedFloat<T>>>::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) -> <&'a OrderedFloat<T> as Rem<T>>::Output

Performs the % operation.

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

where T: Rem,

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

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T> Rem for OrderedFloat<T>

where T: Rem,

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

The resulting type after applying the % operator.

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

Performs the % operation.

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

where T: RemAssign<&'a T>,

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

Performs the %= operation.

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

where T: RemAssign<&'a T>,

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

Performs the %= operation.

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

where T: RemAssign,

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T> RemAssign for OrderedFloat<T>

where T: RemAssign,

fn rem_assign(&mut self, other: OrderedFloat<T>)

Performs the %= operation.

impl<T> Serialize for OrderedFloat<T>

where T: FloatCore + Serialize,

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Signed for OrderedFloat<T>

where T: FloatCore + Signed,

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

Computes the absolute value.

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

The positive difference of two numbers.

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

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, 'b, T> Sub<&'b OrderedFloat<T>> for &'a OrderedFloat<T>

where T: Sub + Copy,

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

The resulting type after applying the - operator.

fn sub( self, other: &'b OrderedFloat<T>, ) -> <&'a OrderedFloat<T> as Sub<&'b OrderedFloat<T>>>::Output

Performs the - operation.

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 OrderedFloat<T>, ) -> <OrderedFloat<T> as Sub<&'a OrderedFloat<T>>>::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>::Output>

The resulting type after applying the - operator.

fn sub(self, other: &'a T) -> <&'a OrderedFloat<T> as Sub<&'a T>>::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) -> <OrderedFloat<T> as Sub<&'a T>>::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>, ) -> <&'a OrderedFloat<T> as Sub<OrderedFloat<T>>>::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) -> <&'a OrderedFloat<T> as Sub<T>>::Output

Performs the - operation.

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

where T: Sub,

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

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub for OrderedFloat<T>

where T: Sub,

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

The resulting type after applying the - operator.

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

Performs the - operation.

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

where T: SubAssign<&'a T>,

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

Performs the -= operation.

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

where T: SubAssign<&'a T>,

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

Performs the -= operation.

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

where T: SubAssign,

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<T> SubAssign for OrderedFloat<T>

where T: SubAssign,

fn sub_assign(&mut self, other: OrderedFloat<T>)

Performs the -= operation.

impl<'a, T> Sum<&'a OrderedFloat<T>> for OrderedFloat<T>

where T: FloatCore + Sum + 'a,

fn sum<I>(iter: I) -> OrderedFloat<T>

where I: Iterator<Item = &'a OrderedFloat<T>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T> Sum for OrderedFloat<T>

where T: FloatCore + Sum,

Adds a float directly.

fn sum<I>(iter: I) -> OrderedFloat<T>

where I: Iterator<Item = OrderedFloat<T>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T> ToPrimitive for OrderedFloat<T>

where T: ToPrimitive,

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

where T: FloatCore + UpperExp,

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

Formats the value using the given formatter.

impl<T> Zero for OrderedFloat<T>

where T: Zero,

fn zero() -> OrderedFloat<T>

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

where T: Copy,

impl<T> Eq for OrderedFloat<T>

where T: FloatCore,