Struct Signed 

pub struct Signed<T: Magnitude> {
    magnitude: T,
    sign: Sign,
}

A signed value composed of a magnitude and a sign.

This type represents signed quantities where the sign is tracked separately from the magnitude. This is useful for representing values that can be positive or negative without using two’s complement.

Zero is always normalized to have a positive sign.

Fields

magnitude: T

sign: Sign

Implementations

impl<T: Magnitude> Signed<T>

fn normalize(magnitude: T, sign: Sign) -> Self

Normalizes the sign: zero magnitude always has positive sign.

pub fn new(magnitude: T, sign: Sign) -> Self

Creates a new signed value with the given magnitude and sign.

Zero magnitude is always normalized to positive sign.

pub fn pos(magnitude: T) -> Self

Creates a new positive signed value.

Zero magnitude is normalized to positive sign.

pub fn neg(magnitude: T) -> Self

Creates a new negative signed value.

Zero magnitude is normalized to positive sign.

pub const fn zero() -> Self

Creates the zero value.

pub const fn magnitude(&self) -> T

Returns the magnitude (absolute value).

pub const fn sign(&self) -> Sign

Returns the sign.

pub fn is_zero(&self) -> bool

Returns true if this value is zero.

pub const fn is_pos(&self) -> bool

Returns true if this value is positive (including zero).

pub const fn is_neg(&self) -> bool

Returns true if this value is negative.

pub fn checked_add(self, other: Self) -> Option<Self>

Checked addition of two signed values.

Returns None if overflow occurs.

pub fn checked_sub(self, other: Self) -> Option<Self>

Checked subtraction of two signed values.

Returns None if overflow occurs.

Trait Implementations

impl<T: Clone + Magnitude> Clone for Signed<T>

fn clone(&self) -> Signed<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Magnitude> Debug for Signed<T>

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

Formats the value using the given formatter.

impl<T: Magnitude> Default for Signed<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Magnitude + Display> Display for Signed<T>

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

Formats the value using the given formatter.

impl<T: Hash + Magnitude> Hash for Signed<T>

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<T: Magnitude> Neg for Signed<T>

type Output = Signed<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: PartialEq + Magnitude> PartialEq for Signed<T>

fn eq(&self, other: &Signed<T>) -> 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<T: Copy + Magnitude> Copy for Signed<T>

impl<T: Eq + Magnitude> Eq for Signed<T>

impl<T: Magnitude> StructuralPartialEq for Signed<T>