Enum FloatPred 

pub enum FloatPred {
    False,
    Oeq,
    Ogt,
    Oge,
    Olt,
    Ole,
    One,
    Ord,
    Uno,
    Ueq,
    Ugt,
    Uge,
    Ult,
    Ule,
    Une,
    True,
}

The floating point comparisons, ordered and unordered.

An ordered predicate is false if either operand is a NaN, and an unordered one is true. C’s < is olt and C’s != is une, which is the whole of why both families are here.

Variants

False

Always false.

Oeq

Ordered and equal.

Ogt

Ordered and greater than.

Oge

Ordered and greater than or equal.

Olt

Ordered and less than.

Ole

Ordered and less than or equal.

One

Ordered and not equal.

Ord

Ordered, which is to say neither operand is a NaN.

Uno

Unordered, which is to say one of them is.

Ueq

Unordered or equal.

Ugt

Unordered or greater than.

Uge

Unordered or greater than or equal.

Ult

Unordered or less than.

Ule

Unordered or less than or equal.

Une

Unordered or not equal.

True

Always true.

Implementations

impl FloatPred

pub const fn name(self) -> &'static str

The textual form.

pub fn from_name(name: &str) -> Option<Self>

The predicate with that name, if there is one.

pub fn all() -> impl Iterator<Item = Self>

Every predicate.

pub const fn inverse(self) -> Self

The predicate that holds exactly when this one does not.

pub const fn swapped(self) -> Self

The predicate that holds when the operands are given the other way round.

pub const fn is_ordered(self) -> bool

Whether this is false when either operand is a NaN.

FloatPred::False and FloatPred::True are neither ordered nor unordered, since they do not look at their operands at all, and both answer no here.

Trait Implementations

impl Clone for FloatPred

fn clone(&self) -> FloatPred

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FloatPred

impl Debug for FloatPred

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

Formats the value using the given formatter.

impl Display for FloatPred

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

Formats the value using the given formatter.

impl Eq for FloatPred

impl Hash for FloatPred

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FloatPred

fn cmp(&self, other: &FloatPred) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for FloatPred

fn eq(&self, other: &FloatPred) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FloatPred

fn partial_cmp(&self, other: &FloatPred) -> 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 StructuralPartialEq for FloatPred