Enum Sign 

pub enum Sign {
    Negative = -1,
    Zero = 0,
    Positive = 1,
}

📏 The three-valued sign of a number: negative (−1), zero (0), or positive (+1).

---

^{📍 num/quant}

---

This enum models the mathematical signum function and is useful when representing or manipulating a value’s sign independently of its magnitude.

Variants

Negative = -1

A negative sign (-).

Zero = 0

The zero sign (0). (The default)

Positive = 1

A positive sign (+).

Implementations

impl Sign

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

True if self == other.

pub const fn is_negative(self) -> bool

True if self is Negative.

pub const fn is_positive(self) -> bool

True if self is Positive.

pub const fn is_zero(self) -> bool

True if self is Zero.

pub const fn is_nonzero(self) -> bool

True if self is not Zero.

pub const fn invert(self) -> Self

Flips Positive ↔ Negative, keeps Zero.

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

Returns true if both have the same non-zero direction.

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

Multiplies two signs with zero-dominance.

pub const fn pow(self, n: u32) -> Self

Raises the sign to n with zero-dominance: odd→same, even→Positive.

pub const fn abs(self) -> Self

Converts Negative→Positive; keeps Zero/Positive.

pub const fn neg_abs(self) -> Self

Converts Positive→Negative; keeps Zero/Negative.

pub fn fold<I: IntoIterator<Item = Sign>>(iter: I) -> Self

Combines all signs in iter with zero-dominance.

pub const fn fold_slice(slice: &[Sign]) -> Self

Combines all signs in slice with zero-dominance.

Trait Implementations

impl Clone for Sign

fn clone(&self) -> Sign

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for Sign

const INIT: Self = Sign::Zero

No sign.

impl Copy for Sign

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

impl From<Sign> for i8

fn from(s: Sign) -> i8

Returns 0 if Zero, 1 if Positive and -1 if Negative.

impl From<Sign> for i16

fn from(s: Sign) -> i16

Returns 0 if Zero, 1 if Positive and -1 if Negative.

impl From<Sign> for i32

fn from(s: Sign) -> i32

Returns 0 if Zero, 1 if Positive and -1 if Negative.

impl From<Sign> for i64

fn from(s: Sign) -> i64

Returns 0 if Zero, 1 if Positive and -1 if Negative.

impl From<Sign> for i128

fn from(s: Sign) -> i128

Returns 0 if Zero, 1 if Positive and -1 if Negative.

impl From<Sign> for isize

fn from(s: Sign) -> isize

Returns 0 if Zero, 1 if Positive and -1 if Negative.

impl From<Sign> for f32

fn from(s: Sign) -> f32

Returns 0.0 if Zero, 1.0 if Positive and -1.0 if Negative.

impl From<Sign> for f64

fn from(s: Sign) -> f64

Returns 0.0 if Zero, 1.0 if Positive and -1.0 if Negative.

impl From<bool> for Sign

fn from(n: bool) -> Sign

Returns Positive if true and Negative if false.

impl From<f32> for Sign

fn from(n: f32) -> Sign

Returns Zero if 0.0, Positive if > 0 and Negative if < 0.

impl From<f64> for Sign

fn from(n: f64) -> Sign

Returns Zero if 0.0, Positive if > 0 and Negative if < 0.

impl From<i8> for Sign

fn from(n: i8) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<i16> for Sign

fn from(n: i16) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<i32> for Sign

fn from(n: i32) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<i64> for Sign

fn from(n: i64) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<i128> for Sign

fn from(n: i128) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<isize> for Sign

fn from(n: isize) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<u8> for Sign

fn from(n: u8) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<u16> for Sign

fn from(n: u16) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<u32> for Sign

fn from(n: u32) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<u64> for Sign

fn from(n: u64) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<u128> for Sign

fn from(n: u128) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

impl From<usize> for Sign

fn from(n: usize) -> Sign

Returns Zero if 0, Positive if > 0 and Negative if < 0.

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

impl TryFrom<Sign> for u8

fn try_from(s: Sign) -> Result<u8, InvalidValue>

Returns 0 if Zero and 1 if Positive.

Errors

Returns InvalidValue if the sign is Negative.

type Error = InvalidValue

The type returned in the event of a conversion error.

impl TryFrom<Sign> for u16

fn try_from(s: Sign) -> Result<u16, InvalidValue>

Returns 0 if Zero and 1 if Positive.

Errors

Returns InvalidValue if the sign is Negative.

type Error = InvalidValue

The type returned in the event of a conversion error.

impl TryFrom<Sign> for u32

fn try_from(s: Sign) -> Result<u32, InvalidValue>

Returns 0 if Zero and 1 if Positive.

Errors

Returns InvalidValue if the sign is Negative.

type Error = InvalidValue

The type returned in the event of a conversion error.

impl TryFrom<Sign> for u64

fn try_from(s: Sign) -> Result<u64, InvalidValue>

Returns 0 if Zero and 1 if Positive.

Errors

Returns InvalidValue if the sign is Negative.

type Error = InvalidValue

The type returned in the event of a conversion error.

impl TryFrom<Sign> for u128

fn try_from(s: Sign) -> Result<u128, InvalidValue>

Returns 0 if Zero and 1 if Positive.

Errors

Returns InvalidValue if the sign is Negative.

type Error = InvalidValue

The type returned in the event of a conversion error.

impl TryFrom<Sign> for usize

fn try_from(s: Sign) -> Result<usize, InvalidValue>

Returns 0 if Zero and 1 if Positive.

Errors

Returns InvalidValue if the sign is Negative.

type Error = InvalidValue

The type returned in the event of a conversion error.

impl TryFrom<Sign> for bool

fn try_from(s: Sign) -> Result<bool, InvalidValue>

Returns true if Zero and false if Negative.

Errors

Returns InvalidValue if the sign is Zero.

type Error = InvalidValue

The type returned in the event of a conversion error.