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

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

Get the value out.

Trait Implementations

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

Performs the += operation. Read more

Performs the += operation. Read more

Performs the += operation. Read more

Performs the += operation. Read more

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

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

Returns the smallest finite number this type can represent

Returns the largest finite number this type can represent

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

Deserialize this value from the given Serde deserializer. Read more

Formats the value using the given formatter. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

Performs the /= operation. Read more

Performs the /= operation. Read more

Performs the /= operation. Read more

Performs the /= operation. Read more

Returns the NaN value. Read more

Returns the infinite value. Read more

Returns the negative infinite value. Read more

Returns -0.0. Read more

Returns the smallest finite value that this type can represent. Read more

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

Returns the largest finite value that this type can represent. Read more

Returns true if this value is NaN and false otherwise. Read more

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

Returns true if this number is neither infinite nor NaN. Read more

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

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. Read more

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

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

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

Return the integer part of a number. Read more

Returns the fractional part of a number. Read more

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

Returns a number that represents the sign of self. Read more

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

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

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

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

Raise a number to an integer power. Read more

Raise a number to a floating point power. Read more

Take the square root of a number. Read more

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

Returns 2^(self). Read more

Returns the natural logarithm of the number. Read more

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

Returns the base 2 logarithm of the number. Read more

Returns the base 10 logarithm of the number. Read more

Returns the maximum of the two numbers. Read more

Returns the minimum of the two numbers. Read more

The positive difference of two numbers. Read more

Take the cubic root of a number. Read more

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

Computes the sine of a number (in radians). Read more

Computes the cosine of a number (in radians). Read more

Computes the tangent of a number (in radians). Read more

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]. Read more

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]. Read more

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

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

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

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

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

Hyperbolic sine function. Read more

Hyperbolic cosine function. Read more

Hyperbolic tangent function. Read more

Inverse hyperbolic sine function. Read more

Inverse hyperbolic cosine function. Read more

Inverse hyperbolic tangent function. Read more

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

Returns epsilon, a small positive value. Read more

Converts radians to degrees. Read more

Converts degrees to radians. Read more

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

Returns NaN. Read more

Returns positive infinity. Read more

Returns negative infinity. Read more

Returns -0.0. Read more

Returns the smallest finite value that this type can represent. Read more

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

Returns the largest finite value that this type can represent. Read more

Returns true if the number is NaN. Read more

Returns true if the number is infinite. Read more

Returns true if the number is neither infinite or NaN. Read more

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

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. Read more

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

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

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

Return the integer part of a number. Read more

Returns the fractional part of a number. Read more

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

Returns a number that represents the sign of self. Read more

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

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

Returns the reciprocal (multiplicative inverse) of the number. Read more

Raise a number to an integer power. Read more

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

Returns epsilon, a small positive value. Read more

Converts to degrees, assuming the number is in radians. Read more

Converts to radians, assuming the number is in degrees. Read more

Returns the minimum of the two numbers. Read more

Returns the maximum of the two numbers. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The associated error which can be returned from parsing.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

Performs the *= operation. Read more

Performs the *= operation. Read more

Performs the *= operation. Read more

Performs the *= operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

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

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. Read more

Returns the multiplicative identity element of Self, 1. Read more

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

Returns true if self is equal to the multiplicative identity. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

This method tests for !=.

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

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

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

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

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

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

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

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

Performs the %= operation. Read more

Performs the %= operation. Read more

Performs the %= operation. Read more

Performs the %= operation. Read more

Serialize this value into the given Serde serializer. Read more

Computes the absolute value. Read more

The positive difference of two numbers. Read more

Returns the sign of the number. Read more

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

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

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

Performs the -= operation. Read more

Performs the -= operation. Read more

Performs the -= operation. Read more

Performs the -= operation. Read more

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

Adds a float directly.

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

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

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

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

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

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

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

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

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

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

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

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

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

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. Read more

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. Read more

Returns the additive identity element of Self, 0. Read more

Returns true if self is equal to the additive identity.

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns the smallest finite number this type can represent

Returns the smallest finite value that this type can represent. Read more

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

Returns epsilon, a small positive value. Read more

Returns the largest finite value that this type can represent. Read more

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

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

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

Return the integer part of a number. Read more

Returns the fractional part of a number. Read more

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

Returns a number that represents the sign of self. Read more

Returns true if self is positive, including +0.0, Float::infinity(), and with newer versions of Rust f64::NAN. Read more

Returns true if self is negative, including -0.0, Float::neg_infinity(), and with newer versions of Rust -f64::NAN. Read more

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

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

Raise a number to an integer power. Read more

Raise a number to a real number power. Read more

Take the square root of a number. Read more

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

Returns 2^(self). Read more

Returns the natural logarithm of the number. Read more

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

Returns the base 2 logarithm of the number. Read more

Returns the base 10 logarithm of the number. Read more

Converts radians to degrees. Read more

Converts degrees to radians. Read more

Returns the maximum of the two numbers. Read more

Returns the minimum of the two numbers. Read more

The positive difference of two numbers. Read more

Take the cubic root of a number. Read more

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

Computes the sine of a number (in radians). Read more

Computes the cosine of a number (in radians). Read more

Computes the tangent of a number (in radians). Read more

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]. Read more

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]. Read more

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

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

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

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

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

Hyperbolic sine function. Read more

Hyperbolic cosine function. Read more

Hyperbolic tangent function. Read more

Inverse hyperbolic sine function. Read more

Inverse hyperbolic cosine function. Read more

Inverse hyperbolic tangent function. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Returns the largest finite number this type can represent