Struct ordered_float::OrderedFloat

source · [−]

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

Tuple Fields

0: T

Implementations

source

impl<T: Float> OrderedFloat<T>

source

pub fn into_inner(self) -> T

Get the value out.

Trait Implementations

source

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

type Output = Self

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

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

source

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

Performs the conversion.

source

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

source

fn as_ref(&self) -> &T

Performs the conversion.

source

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

source

fn min_value() -> Self

returns the smallest finite number this type can represent

source

fn max_value() -> Self

returns the largest finite number this type can represent

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn default() -> OrderedFloat<T>

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

source

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

type Target = T

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

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

source

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

Mutably dereferences the value.

source

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

source

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

Formats the value using the given formatter. Read more

source

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

type Output = Self

The resulting type after applying the / operator.

source

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

Performs the / operation. Read more

source

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

source

fn from(val: T) -> Self

Performs the conversion.

source

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

source

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

type Err = T::Err

The associated error which can be returned from parsing.

source

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

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

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

source

impl Into<f32> for OrderedFloat<f32>

source

fn into(self) -> f32

Performs the conversion.

source

impl Into<f64> for OrderedFloat<f64>

source

fn into(self) -> f64

Performs the conversion.

source

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

type Output = Self

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

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

type Output = Self

The resulting type after applying the - operator.

source

fn neg(self) -> Self

Performs the unary - operation. Read more

source

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

source

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

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

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

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

source

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

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

1.0.0 · source

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

This method tests for !=.

source

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

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

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

type Output = Self

The resulting type after applying the - operator.

source

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

Performs the - operation. Read more

source

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

source

fn zero() -> Self

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

source

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

source

fn set_zero(&mut self)

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

source

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

source

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<!> for T

const: unstable · source

pub fn from(t: !) -> T

Performs the conversion.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ordered_float::OrderedFloat

Tuple Fields

Implementations

impl<T: Float> OrderedFloat<T>

pub fn into_inner(self) -> T

Trait Implementations

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

type Output = Self

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

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

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

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

fn as_ref(&self) -> &T

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

fn min_value() -> Self

fn max_value() -> Self

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

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

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

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

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

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

fn default() -> OrderedFloat<T>

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

type Target = T

fn deref(&self) -> &Self::Target

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

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

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

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

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

type Output = Self

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

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

fn from(val: T) -> Self

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

fn from_str(s: &str) -> Result<Self, Self::Err>

type Err = T::Err

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

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

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

impl Into<f32> for OrderedFloat<f32>

fn into(self) -> f32

impl Into<f64> for OrderedFloat<f64>

fn into(self) -> f64

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

type Output = Self

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

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

type Output = Self

fn neg(self) -> Self

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type Output = Self

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

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

fn zero() -> Self

fn is_zero(&self) -> bool

fn set_zero(&mut self)

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

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

Auto Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,