Struct OrderedFloat

#[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§

§

impl<T> OrderedFloat<T>
where T: Float,

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

Performs the + operation. Read more

§

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

§

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

§

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

§

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

§

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

§

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

§

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

§

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

§

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

§

fn add_assign(&mut self, other: T)

Performs the += operation. Read more

§

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

§

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

Performs the += operation. Read more

§

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

§

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

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

§