Struct OrderedFloat

pub struct OrderedFloat<T>(pub T);

Wraps a floating-point value to add total order and hash. Possible types for T are f32 and f64.

All NaNs are considered equal to each other. The size of zero is ignored.

See also Float.

Tuple Fields

0: T

Implementations

impl<T> OrderedFloat<T>

where T: Float + Copy,

pub fn into_inner(self) -> T

Trait Implementations

impl<T> Clone for OrderedFloat<T>

where T: Clone,

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> From<T> for OrderedFloat<T>

fn from(val: T) -> OrderedFloat<T>

Converts to this type from the input type.

impl<T> Hash for OrderedFloat<T>

where T: Float,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for OrderedFloat<T>

where T: Float,

fn cmp(&self, other: &OrderedFloat<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for OrderedFloat<T>

where T: Float,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for OrderedFloat<T>

where T: Float,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Copy for OrderedFloat<T>

where T: Copy,

impl<T> Eq for OrderedFloat<T>

where T: Float,