Enum Sign 

#[repr(i8)]
pub enum Sign {
    Negative = -1,
    Zero = 0,
    Positive = 1,
}

The sign of a real quantity.

The discriminants are -1, 0 and 1, so sign as i8 (or i8::from(sign)) gives the usual integer sign, and signs are ordered as those integers: Negative < Zero < Positive.

Examples

use implicit_predicates_core::Sign;

assert_eq!(Sign::Negative as i8, -1);
assert_eq!(Sign::Zero as i8, 0);
assert_eq!(Sign::Positive as i8, 1);
assert!(Sign::Negative < Sign::Zero && Sign::Zero < Sign::Positive);

Variants

Negative = -1

Strictly less than zero.

Zero = 0

Exactly zero.

Positive = 1

Strictly greater than zero.

Implementations

impl Sign

pub fn of(x: f64) -> Sign

Returns the sign of x. Both 0.0 and -0.0 give Sign::Zero.

NaN is not a valid input: debug builds panic on it, and release builds return Sign::Zero, which is meaningless.

Examples

use implicit_predicates_core::Sign;

assert_eq!(Sign::of(2.5), Sign::Positive);
assert_eq!(Sign::of(-2.5), Sign::Negative);
assert_eq!(Sign::of(-0.0), Sign::Zero);

pub fn is_zero(self) -> bool

Returns true if the sign is Sign::Zero.

Examples

use implicit_predicates_core::Sign;

assert!(Sign::Zero.is_zero());
assert!(!Sign::Positive.is_zero());

pub fn is_positive(self) -> bool

Returns true if the sign is Sign::Positive.

Examples

use implicit_predicates_core::Sign;

assert!(Sign::Positive.is_positive());
assert!(!Sign::Zero.is_positive());

pub fn is_negative(self) -> bool

Returns true if the sign is Sign::Negative.

Examples

use implicit_predicates_core::Sign;

assert!(Sign::Negative.is_negative());
assert!(!Sign::Zero.is_negative());

Trait Implementations

impl Clone for Sign

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Sign

impl Debug for Sign

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

Formats the value using the given formatter.

impl Eq for Sign

impl From<Ordering> for Sign

fn from(ordering: Ordering) -> Sign

The sign of a - b when a.cmp(&b) is ordering: Less is negative, Equal zero and Greater positive.

Examples

use implicit_predicates_core::Sign;

assert_eq!(Sign::from(3.cmp(&5)), Sign::Negative);
assert_eq!(Sign::from(5.cmp(&5)), Sign::Zero);

impl From<Sign> for i8

fn from(sign: Sign) -> i8

The integer sign: -1, 0 or 1.

Examples

use implicit_predicates_core::Sign;

assert_eq!(i8::from(Sign::Negative), -1);
assert_eq!(i8::from(Sign::Positive), 1);

impl Hash for Sign

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 Mul for Sign

fn mul(self, rhs: Sign) -> Sign

The sign of a product: zero if either factor is zero, positive if the signs agree, negative otherwise.

Examples

use implicit_predicates_core::Sign;

assert_eq!(Sign::Negative * Sign::Negative, Sign::Positive);
assert_eq!(Sign::Negative * Sign::Positive, Sign::Negative);
assert_eq!(Sign::Zero * Sign::Positive, Sign::Zero);

type Output = Sign

The resulting type after applying the * operator.

impl Neg for Sign

fn neg(self) -> Sign

Flips the sign; Sign::Zero stays zero.

Examples

use implicit_predicates_core::Sign;

assert_eq!(-Sign::Positive, Sign::Negative);
assert_eq!(-Sign::Zero, Sign::Zero);

type Output = Sign

The resulting type after applying the - operator.

impl Ord for Sign

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Sign

fn partial_cmp(&self, other: &Self) -> 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 Sign