Struct bevy_core::FloatOrd

pub struct FloatOrd(pub f32);

A wrapper type that enables ordering floats. This is a work around for the famous "rust float ordering" problem. By using it, you acknowledge that sorting NaN is undefined according to spec. This implementation treats NaN as the "smallest" float.

Trait Implementations

impl Clone for FloatOrd

fn clone(&self) -> FloatOrd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FloatOrd

impl Debug for FloatOrd

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

Formats the value using the given formatter.

impl Eq for FloatOrd

impl Hash for FloatOrd

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 Neg for FloatOrd

type Output = FloatOrd

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for FloatOrd

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<FloatOrd> for FloatOrd

fn eq(&self, other: &Self) -> 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 PartialOrd<FloatOrd> for FloatOrd

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

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

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

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

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

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

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

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

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

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