Struct ordered_float::OrderedFloat

pub struct OrderedFloat<T: Float>(pub T);

A wrapper around Floats providing an implementation of Ord and Hash.

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

Methods

impl<T: Float> OrderedFloat<T>

pub fn into_inner(self) -> T

Get the value out.

Trait Implementations

impl<T: Float + PartialOrd> 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.

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<T: Float + PartialEq> 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 ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

fn default() -> OrderedFloat<T>

Returns the "default value" for a type.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn as_ref(&self) -> &T

Performs the conversion.

impl Into<f32> for OrderedFloat<f32>

fn into(self) -> f32

Performs the conversion.

impl Into<f64> for OrderedFloat<f64>

fn into(self) -> f64

Performs the conversion.

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

fn from(val: T) -> Self

Performs the conversion.

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

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

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

Performs the conversion.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Serialize this value into the given Serde serializer.

impl<'de, T: Float + Deserialize<'de>> Deserialize<'de> for OrderedFloat<T>

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

Deserialize this value from the given Serde deserializer.