Struct ordered_float::OrderedFloat

[+] Show declaration

[+] Expand attributes
#[repr(transparent)]pub struct OrderedFloat<T: Float>(pub T);

[−] Expand description

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.

Implementations

impl<T: Float> OrderedFloat<T>[−]

pub fn into_inner(self) -> T[−]

Get the value out.

Trait Implementations

impl<T: Float> Add<OrderedFloat<T>> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self[−]

Performs the + operation.

impl<T: Float> AsMut<T> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

fn as_mut(&mut self) -> &mut T[−]

Performs the conversion.

impl<T: Float> AsRef<T> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &T[−]

Performs the conversion.

impl<T: Float> Bounded for OrderedFloat<T>[+]

[+] Show hidden undocumented items

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 + Float> Clone for OrderedFloat<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> OrderedFloat<T>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

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

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

[+] Show hidden undocumented items

fn default() -> OrderedFloat<T>[−]

Returns the “default value” for a type.

impl<T: Float> Deref for OrderedFloat<T>[+]

[+] Show hidden undocumented items

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target[−]

Dereferences the value.

impl<T: Float> DerefMut for OrderedFloat<T>[+]

[+] Show hidden undocumented items

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

Mutably dereferences the value.

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T: Float> Div<OrderedFloat<T>> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self[−]

Performs the / operation.

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

impl<T: Float> From<T> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

fn from(val: T) -> Self[−]

Performs the conversion.

impl<T: Float + FromStr> FromStr for OrderedFloat<T>[+]

type Err = T::Err

The associated error which can be returned from parsing.

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

impl<T: Float> Hash for OrderedFloat<T>[+]

[+] Show hidden undocumented items

fn hash<H: Hasher>(&self, state: &mut H)[−]

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Into<f32> for OrderedFloat<f32>[+]

[+] Show hidden undocumented items

fn into(self) -> f32[−]

Performs the conversion.

impl Into<f64> for OrderedFloat<f64>[+]

[+] Show hidden undocumented items

fn into(self) -> f64[−]

Performs the conversion.

impl<T: Float> Mul<OrderedFloat<T>> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self[−]

Performs the * operation.

impl<T: Float> Neg for OrderedFloat<T>[+]

[+] Show hidden undocumented items

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self[−]

Performs the unary - operation.

impl<T: Float> Ord for OrderedFloat<T>[+]

[+] Show hidden undocumented items

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

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl<T: Float> PartialEq<OrderedFloat<T>> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

This method tests for !=.

impl<T: Float> PartialOrd<OrderedFloat<T>> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

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

[+] Expand attributes

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

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

[+] Expand attributes

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

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

[+] Expand attributes

#[must_use]pub 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> Sub<OrderedFloat<T>> for OrderedFloat<T>[+]

[+] Show hidden undocumented items

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self[−]

Performs the - operation.

impl<T: Float> Zero for OrderedFloat<T>[+]

[+] Show hidden undocumented items

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.

pub fn set_zero(&mut self)[−]

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