Enum Sign

pub enum Sign {
    Positive,
    Negative,
}

Sign of the floating-point number.

Variants

Positive

Indicate positive floating-point numbers.

Negative

Indicate negative floating-point numbers.

Implementations

impl Sign

pub const fn as_str(&self, force_sign: bool) -> &'static str

Returns the display of this character as a &’static str.

Examples

assert_eq!(Sign::Positive.as_str(false), "");
assert_eq!(Sign::Positive.as_str(true), "+");
assert_eq!(Sign::Negative.as_str(false), "-");
assert_eq!(Sign::Negative.as_str(true), "-");

pub const fn negate(self) -> Self

Performs a NOT operation on the Sign type.

Examples

assert_eq!(Sign::Positive.negate(), Sign::Negative);
assert_eq!(Sign::Negative.negate(), Sign::Positive);

Sign::negate is used in const functions.

const fn negate(sign: Sign) -> Sign {
    !sign
}

pub const fn xor(self, other: Self) -> Self

Performs an XOR operation on two Sign types.

Examples

assert_eq!(Sign::Positive.xor(Sign::Positive), Sign::Positive);
assert_eq!(Sign::Positive.xor(Sign::Negative), Sign::Negative);
assert_eq!(Sign::Negative.xor(Sign::Positive), Sign::Negative);
assert_eq!(Sign::Negative.xor(Sign::Negative), Sign::Positive);

Sign::xor is used in const functions.

const fn xor(sign1: Sign, sign2: Sign) -> Sign {
    sign1 ^ sign2
}

pub const fn is_positive(&self) -> bool

Returns true of the Sign is Positive.

Examples

let positive = Sign::Positive;
let negative = Sign::Negative;

assert_eq!(Sign::Positive.is_positive(), true);
assert_eq!(negative.is_positive(), false);

Sign::is_positive is used in const functions.

const fn is_positive(sign: Sign) -> bool {
    Sign::Positive == sign
}

pub const fn is_negative(&self) -> bool

Returns true of the Sign is Negative.

Examples

let positive = Sign::Positive;
let negative = Sign::Negative;

assert_eq!(Sign::Positive.is_negative(), false);
assert_eq!(negative.is_negative(), true);

Sign::is_negative is used in const functions.

const fn is_negative(sign: Sign) -> bool {
    Sign::Negative == sign
}

pub const fn from_byte(ch: u8) -> Self

Returns the Sign based on an ASCII byte.

Expects ‘+’ or ‘-’. Invalid values return Sign::Positive.

Examples

assert_eq!(Sign::from_byte(b'+'), Sign::Positive);
assert_eq!(Sign::from_byte(b'-'), Sign::Negative);

Trait Implementations

impl BitXor for Sign

type Output = Sign

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for Sign

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl Clone for Sign

fn clone(&self) -> Sign

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sign

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

Formats the value using the given formatter.

impl Default for Sign

fn default() -> Sign

Returns the “default value” for a type.

impl PartialEq for Sign

fn eq(&self, other: &Sign) -> 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 Copy for Sign

impl Eq for Sign

impl StructuralPartialEq for Sign