Struct Signed 

pub struct Signed<const W: u32>(/* private fields */);

Signed bitvector.

The width (number of bits) is specified in the generic parameter W. Signed bitvectors support bitwise operations and wrapping-arithmetic operations. Arithmetic bit extension is also possible (the sign bit is copied into any bits above it). Signed bitvectors can be converted into Unsigned or Bitvector.

Implementations

impl<const W: u32> Signed<W>

pub fn new(value: i64) -> Self

Trait Implementations

impl<const W: u32> Add for Signed<W>

fn add(self, rhs: Signed<W>) -> Self::Output

Performs wrapping addition.

type Output = Signed<W>

The resulting type after applying the + operator.

impl<const W: u32> BitAnd for Signed<W>

fn bitand(self, rhs: Signed<W>) -> Self::Output

Performs bitwise AND.

type Output = Signed<W>

The resulting type after applying the & operator.

impl<const W: u32> BitOr for Signed<W>

fn bitor(self, rhs: Signed<W>) -> Self::Output

Performs bitwise OR.

type Output = Signed<W>

The resulting type after applying the | operator.

impl<const W: u32> BitXor for Signed<W>

fn bitxor(self, rhs: Signed<W>) -> Self::Output

Performs bitwise XOR.

type Output = Signed<W>

The resulting type after applying the ^ operator.

impl<const W: u32> Clone for Signed<W>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const W: u32> Debug for Signed<W>

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

Formats the value using the given formatter.

impl<const W: u32> Div for Signed<W>

fn div(self, rhs: Signed<W>) -> Self::Output

Performs wrapping signed division.

This behaves as Rust wrapping_div, where the result of MIN / -1, which would be unrepresentable -MIN, is wrapped to MIN.

Panics

Panics if rhs is zero.

type Output = Signed<W>

The resulting type after applying the / operator.

impl<const W: u32, const X: u32> Ext<X> for Signed<W>

fn ext(self) -> Self::Output

Extends or narrows the bit-vector.

If an extension is performed, the upper bits are the copy of the original sign bit.

type Output = Signed<X>

impl<const W: u32> From<Bitvector<W>> for Signed<W>

fn from(value: Bitvector<W>) -> Self

Adds signedness information to Bitvector.

impl<const W: u32> From<Signed<W>> for Bitvector<W>

fn from(value: Signed<W>) -> Self

Drops the signedness information from Signed.

impl<const W: u32> From<Signed<W>> for Unsigned<W>

fn from(value: Signed<W>) -> Self

Converts the signedness information from Signed to Unsigned.

impl<const W: u32> From<Unsigned<W>> for Signed<W>

fn from(value: Unsigned<W>) -> Self

Converts the signedness information from Unsigned to Signed.

impl<const W: u32> Hash for Signed<W>

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<const W: u32> Mul for Signed<W>

fn mul(self, rhs: Signed<W>) -> Self::Output

Performs wrapping multiplication.

type Output = Signed<W>

The resulting type after applying the * operator.

impl<const W: u32> Not for Signed<W>

fn not(self) -> Self::Output

Performs bitwise NOT.

type Output = Signed<W>

The resulting type after applying the ! operator.

impl<const W: u32> Ord for Signed<W>

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.

impl<const W: u32> PartialEq for Signed<W>

fn eq(&self, other: &Signed<W>) -> 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<const W: u32> PartialOrd for Signed<W>

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<const W: u32> Rem for Signed<W>

fn rem(self, rhs: Signed<W>) -> Self::Output

Performs wrapping signed division.

This behaves as Rust wrapping_rem, where the result of MIN % -1, is defined as 0.

Panics

Panics if rhs is zero.

type Output = Signed<W>

The resulting type after applying the % operator.

impl<const W: u32> Shl for Signed<W>

fn shl(self, rhs: Signed<W>) -> Self::Output

Performs a left shift.

Unlike a right shift, where the behaviour is dependent on signedness, the left shift has the same behaviour: shifted-out bits on the left are discarded and zeros are shifted in on the right.

The right-hand side operand is interpreted as unsigned and if it is equal or greater to the bit-width, the result is all-zeros, as in Rust unbounded_shl. It is planned to restrict the bit-width in the future so that this edge case can never occur.

Note that this means that shifting left with a negative right operand produces an all-zeros value.

type Output = Signed<W>

The resulting type after applying the << operator.

impl<const W: u32> Shr for Signed<W>

fn shr(self, rhs: Signed<W>) -> Self::Output

Performs an arithmetic right shift.

The right-hand side operand is interpreted as unsigned and if it is equal or greater to the bit-width, the result is all-zeros or all-ones depending on the original sign bit, as in Rust unbounded_shr on signed primitives. It is planned to restrict the bit-width in the future so that this edge case can never occur.

Note that this means that shifting right with a negative right operand produces an all-zeros or all-ones value, depending on the original sign bit.

type Output = Signed<W>

The resulting type after applying the >> operator.

impl<const W: u32> Sub for Signed<W>

fn sub(self, rhs: Signed<W>) -> Self::Output

Performs wrapping subtraction.

type Output = Signed<W>

The resulting type after applying the - operator.

impl<const W: u32> Copy for Signed<W>

impl<const W: u32> Eq for Signed<W>

impl<const W: u32> StructuralPartialEq for Signed<W>