Struct awint_ext::OrdBits

pub struct OrdBits<B>(pub B)
where
    B: BorrowMut<Bits>;

A wrapper implementing total ordering

Implements PartialEq, Eq, PartialOrd, and Ord by using Bits::total_cmp. Hash also uses the Bits. This is intended for fast comparisons in ordered structures.

Tuple Fields

0: B

Methods from Deref<Target = Bits>

pub fn nzbw(&self) -> NonZero<usize>

Returns the bitwidth as a NonZeroUsize

pub fn bw(&self) -> usize

Returns the bitwidth as a usize

pub fn u8_slice_(&'a mut self, buf: &[u8])

Assigns the bits of buf to self. If (buf.len() * 8) > self.bw() then the corresponding bits in buf beyond self.bw() are ignored. If (buf.len() * 8) < self.bw() then the rest of the bits in self are zeroed. This function is portable across target architecture pointer sizes and endianness.

pub fn to_u8_slice(&'a self, buf: &mut [u8])

Assigns the bits of self to buf. If (buf.len() * 8) > self.bw() then the corresponding bits in buf beyond self.bw() are zeroed. If (buf.len() * 8) < self.bw() then the bits of self beyond the buffer do nothing. This function is portable across target architecture pointer sizes and endianness.

pub fn zero_(&mut self)

Zero-assigns. Same as the Unsigned-minimum-value. All bits are set to 0.

pub fn umax_(&mut self)

Unsigned-maximum-value-assigns. All bits are set to 1.

pub fn imax_(&mut self)

Signed-maximum-value-assigns. All bits are set to 1, except for the most significant bit.

pub fn imin_(&mut self)

Signed-minimum-value-assigns. Only the most significant bit is set.

pub fn uone_(&mut self)

Unsigned-one-assigns. Only the least significant bit is set. The unsigned distinction is important, because a positive one value does not exist for signed integers with a bitwidth of 1.

pub fn not_(&mut self)

Not-assigns self

pub fn copy_(&mut self, rhs: &Bits) -> Option<()>

Copy-assigns the bits of rhs to self

pub fn or_(&mut self, rhs: &Bits) -> Option<()>

Or-assigns rhs to self

pub fn and_(&mut self, rhs: &Bits) -> Option<()>

And-assigns rhs to self

pub fn xor_(&mut self, rhs: &Bits) -> Option<()>

Xor-assigns rhs to self

pub fn range_or_(&mut self, range: Range<usize>) -> Option<()>

Or-assigns a range of ones to self. An empty or reversed range does nothing to self. None is returned if range.start > self.bw() or range.end > self.bw().

pub fn range_and_(&mut self, range: Range<usize>) -> Option<()>

And-assigns a range of ones to self. Useful for masking. An empty or reversed range zeroes self. None is returned if range.start > self.bw() or range.end > self.bw().

pub fn range_xor_(&mut self, range: Range<usize>) -> Option<()>

Xor-assigns a range of ones to self. An empty or reversed range does nothing to self. None is returned if range.start > self.bw() or range.end > self.bw().

pub fn digit_or_(&mut self, rhs: usize, shl: usize)

Or-assigns rhs to self at a position shl. Set bits of rhs that are shifted beyond the bitwidth of self are truncated.

pub fn resize_(&mut self, rhs: &Bits, extension: bool)

Resize-copy-assigns rhs to self. If self.bw() >= rhs.bw(), the copied value of rhs will be extended with bits set to extension. If self.bw() < rhs.bw(), the copied value of rhs will be truncated.

pub fn zero_resize_(&mut self, rhs: &Bits) -> bool

Zero-resize-copy-assigns rhs to self and returns overflow. This is the same as lhs.resize_(rhs, false), but returns true if the unsigned meaning of the integer is changed.

pub fn sign_resize_(&mut self, rhs: &Bits) -> bool

Sign-resize-copy-assigns rhs to self and returns overflow. This is the same as lhs.resize_(rhs, rhs.msb()), but returns true if the signed meaning of the integer is changed.

pub fn is_zero(&self) -> bool

If self is zero

pub fn is_umax(&self) -> bool

If self is unsigned-maximum

pub fn is_imax(&self) -> bool

If self is signed-maximum

pub fn is_imin(&self) -> bool

If self is signed-minimum

pub fn is_uone(&self) -> bool

If self is unsigned-one

pub fn const_eq(&self, rhs: &Bits) -> Option<bool>

Equality comparison, self == rhs

pub fn const_ne(&self, rhs: &Bits) -> Option<bool>

Not-equal comparison, self != rhs

pub fn ult(&self, rhs: &Bits) -> Option<bool>

Unsigned-less-than comparison, self < rhs

pub fn ule(&self, rhs: &Bits) -> Option<bool>

Unsigned-less-than-or-equal comparison, self <= rhs

pub fn ugt(&self, rhs: &Bits) -> Option<bool>

Unsigned-greater-than comparison, self > rhs

pub fn uge(&self, rhs: &Bits) -> Option<bool>

Unsigned-greater-than-or-equal comparison, self >= rhs

pub fn ilt(&self, rhs: &Bits) -> Option<bool>

Signed-less-than comparison, self < rhs

pub fn ile(&self, rhs: &Bits) -> Option<bool>

Signed-less-than-or-equal comparison, self <= rhs

pub fn igt(&self, rhs: &Bits) -> Option<bool>

Signed-greater-than comparison, self > rhs

pub fn ige(&self, rhs: &Bits) -> Option<bool>

Signed-greater-than-or-equal comparison, self >= rhs

pub fn total_cmp(&self, rhs: &Bits) -> Ordering

Total ordering over bitstrings, including differentiation between differing bitwidths of self and rhs. This orders first on bitwidth and then on unsigned value.

pub fn bytes_radix_( &mut self, sign: Option<bool>, src: &[u8], radix: u8, pad0: &mut Bits, pad1: &mut Bits ) -> Result<(), SerdeError>

Assigns to self the integer value represented by src in the given radix. If src should be interpreted as unsigned, sign should be None, otherwise it should be set to the sign. In order for this function to be const, two scratchpads pad0 and pad1 with the same bitwidth as self must be supplied, which can be mutated by the function in arbitrary ways.

Errors

self is not mutated if an error occurs. See crate::SerdeError for error conditions. The characters 0..=9, a..=z, and A..=Z are allowed depending on the radix. The char _ is ignored, and all other chars result in an error. src cannot be empty. The value of the string must be representable in the bitwidth of self with the specified sign, otherwise an overflow error is returned.

pub fn to_bytes_radix( &self, signed: bool, dst: &mut [u8], radix: u8, upper: bool, pad: &mut Bits ) -> Result<(), SerdeError>

Assigns the [u8] representation of self to dst (sign indicators, prefixes, and postfixes not included). signed specifies if self should be interpreted as signed. radix specifies the radix, and upper specifies if letters should be uppercase. In order for this function to be const, a scratchpad pad with the same bitwidth as self must be supplied. Note that if dst.len() is more than what is needed to store the representation, the leading bytes will all be set to b’0’.

Errors

Note: If an error is returned, dst may be set to anything

This function can fail from NonEqualWidths, InvalidRadix, and Overflow (if dst cannot represent the value of self). See crate::SerdeError.

pub fn digit_udivide_inplace_(&mut self, div: usize) -> Option<usize>

Unsigned-divides self by div, sets self to the quotient, and returns the remainder. Returns None if div == 0.

pub fn digit_udivide_(&mut self, duo: &Bits, div: usize) -> Option<usize>

pub fn lsb(&self) -> bool

Returns the least significant bit

pub fn msb(&self) -> bool

Returns the most significant bit

pub fn get(&self, inx: usize) -> Option<bool>

Gets the bit at inx bits from the least significant bit, returning None if inx >= self.bw()

pub fn set(&mut self, inx: usize, bit: bool) -> Option<()>

Sets the bit at inx bits from the least significant bit, returning None if inx >= self.bw()

pub fn lz(&self) -> usize

Returns the number of leading zero bits

pub fn tz(&self) -> usize

Returns the number of trailing zero bits

pub fn sig(&self) -> usize

Returns the number of significant bits, self.bw() - self.lz()

pub fn count_ones(&self) -> usize

Returns the number of set ones

pub fn field( &mut self, to: usize, rhs: &Bits, from: usize, width: usize ) -> Option<()>

“Fielding” bitfields with targeted copy assigns. The bitwidths of self and rhs do not have to be equal, but the inputs must collectively obey width <= self.bw() && width <= rhs.bw() && to <= (self.bw() - width) && from <= (rhs.bw() - width) or else None is returned. width can be zero, in which case this function just checks the input correctness and does not mutate self.

This function works by copying a width sized bitfield from rhs at bitposition from and overwriting width bits at bitposition to in self. Only the width bits in self are mutated, any bits before and after the bitfield are left unchanged.

use awint::{inlawi, Bits, InlAwi};
// As an example, two hexadecimal digits will be overwritten
// starting with the 12th digit in `y` using a bitfield with
// value 0x42u8 extracted from `x`.
let x = inlawi!(0x11142111u50);
// the underscores are just for emphasis
let mut y = inlawi!(0xfd_ec_ba9876543210u100);
// from `x` digit place 3, we copy 2 digits to `y` digit place 12.
y.field(12 * 4, &x, 3 * 4, 2 * 4);
assert_eq!(y, inlawi!(0xfd_42_ba9876543210u100));

pub fn field_to(&mut self, to: usize, rhs: &Bits, width: usize) -> Option<()>

A specialization of Bits::field with from set to 0.

pub fn field_from( &mut self, rhs: &Bits, from: usize, width: usize ) -> Option<()>

A specialization of Bits::field with to set to 0.

pub fn field_width(&mut self, rhs: &Bits, width: usize) -> Option<()>

A specialization of Bits::field with to and from set to 0.

pub fn field_bit(&mut self, to: usize, rhs: &Bits, from: usize) -> Option<()>

A specialization of Bits::field with width set to 1.

pub fn lut_(&mut self, lut: &Bits, inx: &Bits) -> Option<()>

Copy entry from lookup table. Copies a self.bw() sized bitfield from lut at bit position inx.to_usize() * self.bw(). If lut.bw() != (self.bw() * (2^inx.bw())), None will be returned.

use awint::{inlawi, Bits, InlAwi};
let mut out = inlawi!(0u10);
// lookup table consisting of 4 10-bit entries
let lut = inlawi!(4u10, 3u10, 2u10, 1u10);
// the indexer has to have a bitwidth of 2 to index 2^2 = 4 entries
let mut inx = inlawi!(0u2);

// get the third entry (this is using zero indexing)
inx.usize_(2);
out.lut_(&lut, &inx).unwrap();
assert_eq!(out, inlawi!(3u10));

pub fn lut_set(&mut self, entry: &Bits, inx: &Bits) -> Option<()>

Set entry in lookup table. The inverse of Bits::lut_, this uses entry as a bitfield to overwrite part of self at bit position inx.to_usize() * entry.bw(). If self.bw() != (entry.bw() * (2^inx.bw())), None will be returned.

pub fn mux_(&mut self, rhs: &Bits, b: bool) -> Option<()>

Multiplex by conditionally copy-assigning rhs to self if b

pub fn repeat_(&mut self, rhs: &Bits)

Repeat-assigns self by rhs. This is logically equivalent to concatenating an infinite number of rhs bit strings together, then resize-assigning to self.

pub fn digit_cin_mul_(&mut self, cin: usize, rhs: usize) -> usize

Assigns cin + (self * rhs) to self and returns the overflow

pub fn digit_mul_add_(&mut self, lhs: &Bits, rhs: usize) -> Option<bool>

Add-assigns lhs * rhs to self and returns if overflow happened

pub fn mul_add_(&mut self, lhs: &Bits, rhs: &Bits) -> Option<()>

Multiplies lhs by rhs and add-assigns the product to self. Three operands eliminates the need for an allocating temporary.

pub fn mul_(&mut self, rhs: &Bits, pad: &mut Bits) -> Option<()>

Multiply-assigns self by rhs. pad is a scratchpad that will be mutated arbitrarily.

pub fn arb_umul_add_(&mut self, lhs: &Bits, rhs: &Bits)

Arbitrarily-unsigned-multiplies lhs by rhs and add-assigns the product to self. This function is equivalent to:

use awint::awi::*;

fn arb_umul_(add: &mut Bits, lhs: &Bits, rhs: &Bits) {
    let mut resized_lhs = Awi::zero(add.nzbw());
    // Note that this function is specified as unsigned,
    // because we use `zero_resize_`
    resized_lhs.zero_resize_(lhs);
    let mut resized_rhs = Awi::zero(add.nzbw());
    resized_rhs.zero_resize_(rhs);
    add.mul_add_(&resized_lhs, &resized_rhs).unwrap();
}

except that it avoids allocation and is more efficient overall

pub fn arb_imul_add_(&mut self, lhs: &mut Bits, rhs: &mut Bits)

Arbitrarily-signed-multiplies lhs by rhs and add-assigns the product to self. Has the same behavior as Bits::arb_umul_add_ except that is interprets the arguments as signed. lhs and rhs are marked mutable but their values are not changed by this function.

pub fn shl_(&mut self, s: usize) -> Option<()>

Left-shifts-assigns by s bits. If s >= self.bw(), then None is returned and the Bits are left unchanged.

Left shifts can act as a very fast multiplication by a power of two for both the signed and unsigned interpretation of Bits.

pub fn lshr_(&mut self, s: usize) -> Option<()>

Logically-right-shift-assigns by s bits. If s >= self.bw(), then None is returned and the Bits are left unchanged.

Logical right shifts do not copy the sign bit, and thus can act as a very fast floored division by a power of two for the unsigned interpretation of Bits.

pub fn ashr_(&mut self, s: usize) -> Option<()>

Arithmetically-right-shift-assigns by s bits. If s >= self.bw(), then None is returned and the Bits are left unchanged.

Arithmetic right shifts copy the sign bit, and thus can act as a very fast floored division by a power of two for the signed interpretation of Bits.

pub fn rotl_(&mut self, s: usize) -> Option<()>

Left-rotate-assigns by s bits. If s >= self.bw(), then None is returned and the Bits are left unchanged.

This function is equivalent to the following:

use awint::awi::*;
let mut input = inlawi!(0x4321u16);
let mut output = inlawi!(0u16);
// rotate left by 4 bits or one hexadecimal digit
let shift = 4;

// temporary clone of the input
let mut tmp = Awi::from(input);
cc!(input; output).unwrap();
if shift != 0 {
    if shift >= input.bw() {
        // the actual function would return `None`
        panic!();
    }
    output.shl_(shift).unwrap();
    tmp.lshr_(input.bw() - shift).unwrap();
    output.or_(&tmp);
};

assert_eq!(output, inlawi!(0x3214u16));
let mut using_rotate = Awi::from(input);
using_rotate.rotl_(shift).unwrap();
assert_eq!(using_rotate, awi!(0x3214u16));

// Note that slices are typed in a little-endian order opposite of
// how integers are typed, but they still visually rotate in the
// same way. This means `Rust`s built in slice rotation is in the
// opposite direction to integers and `Bits`
let mut array = [4, 3, 2, 1];
array.rotate_left(1);
assert_eq!(array, [3, 2, 1, 4]);
assert_eq!(0x4321u16.rotate_left(4), 0x3214);
let mut x = inlawi!(0x4321u16);
x.rotl_(4).unwrap();
// `Bits` has the preferred endianness
assert_eq!(x, inlawi!(0x3214u16));

Unlike the example above which needs cloning, this function avoids any allocation and has many optimized branches for different input sizes and shifts.

pub fn rotr_(&mut self, s: usize) -> Option<()>

Right-rotate-assigns by s bits. If s >= self.bw(), then None is returned and the Bits are left unchanged.

See Bits::rotl_ for more details.

pub fn rev_(&mut self)

Reverse-bit-order-assigns self. The least significant bit becomes the most significant bit, the second least significant bit becomes the second most significant bit, etc.

pub fn funnel_(&mut self, rhs: &Bits, s: &Bits) -> Option<()>

Funnel shift with power-of-two bitwidths. Returns None if 2*self.bw() != rhs.bw() || 2^s.bw() != self.bw(). A self.bw() sized field is assigned to self from rhs starting from the bit position s. The shift cannot overflow because of the restriction on the bitwidth of s.

use awint::awi::*;
let mut lhs = inlawi!(0xffff_ffffu32);
let mut rhs = inlawi!(0xfedc_ba98_7654_3210u64);
// `lhs.bw()` must be a power of two, `s.bw()` here is
// `log_2(32) == 5`. The value of `s` is set to what bit
// of `rhs` should be the starting bit for `lhs`.
let mut s = inlawi!(12u5);
lhs.funnel_(&rhs, &s).unwrap();
assert_eq!(lhs, inlawi!(0xa9876543_u32))

pub fn u8_(&mut self, x: u8)

pub fn i8_(&mut self, x: i8)

pub fn u16_(&mut self, x: u16)

pub fn i16_(&mut self, x: i16)

pub fn u32_(&mut self, x: u32)

pub fn i32_(&mut self, x: i32)

pub fn u64_(&mut self, x: u64)

pub fn i64_(&mut self, x: i64)

pub fn u128_(&mut self, x: u128)

pub fn i128_(&mut self, x: i128)

pub fn usize_(&mut self, x: usize)

pub fn isize_(&mut self, x: isize)

pub fn bool_(&mut self, x: bool)

pub fn digit_(&mut self, x: usize)

pub fn to_u8(&self) -> u8

pub fn to_i8(&self) -> i8

pub fn to_u16(&self) -> u16

pub fn to_i16(&self) -> i16

pub fn to_u32(&self) -> u32

pub fn to_i32(&self) -> i32

pub fn to_u64(&self) -> u64

pub fn to_i64(&self) -> i64

pub fn to_u128(&self) -> u128

pub fn to_i128(&self) -> i128

pub fn to_usize(&self) -> usize

pub fn to_isize(&self) -> isize

pub fn to_bool(&self) -> bool

pub fn to_digit(&self) -> usize

pub fn inc_(&mut self, cin: bool) -> bool

Increment-assigns self with a carry-in cin and returns the carry-out bit. If cin == true then one is added to self, otherwise nothing happens. false is always returned unless self.is_umax().

pub fn dec_(&mut self, cin: bool) -> bool

Decrement-assigns self with a carry-in cin and returns the carry-out bit. If cin == false then one is subtracted from self, otherwise nothing happens. true is always returned unless self.is_zero().

pub fn neg_(&mut self, neg: bool)

Negate-assigns self if neg is true. Note that signed minimum values will overflow.

pub fn abs_(&mut self)

Absolute-value-assigns self. Note that signed minimum values will overflow, unless self is interpreted as unsigned after a call to this function.

pub fn add_(&mut self, rhs: &Bits) -> Option<()>

Add-assigns by rhs

pub fn sub_(&mut self, rhs: &Bits) -> Option<()>

Subtract-assigns by rhs

pub fn rsb_(&mut self, rhs: &Bits) -> Option<()>

Reverse-subtract-assigns by rhs. Sets self to (-self) + rhs.

pub fn neg_add_(&mut self, neg: bool, rhs: &Bits) -> Option<()>

Negate-add-assigns by rhs. Negates conditionally on neg.

pub fn cin_sum_( &mut self, cin: bool, lhs: &Bits, rhs: &Bits ) -> Option<(bool, bool)>

A general summation with carry-in cin and two inputs lhs and rhs. self is set to the sum. The unsigned overflow (equivalent to the carry-out bit) and the signed overflow is returned as a tuple. None is returned if any bitwidths do not match. If subtraction is desired, one of the operands can be negated.

Trait Implementations

impl<B> Binary for OrdBits<B>

where B: Binary + BorrowMut<Bits>,

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

Formats the value using the given formatter.

impl<B> Clone for OrdBits<B>

where B: Clone + BorrowMut<Bits>,

fn clone(&self) -> OrdBits<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for OrdBits<B>

where B: Debug + BorrowMut<Bits>,

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

Formats the value using the given formatter.

impl<B> Deref for OrdBits<B>

where B: BorrowMut<Bits>,

type Target = Bits

The resulting type after dereferencing.

fn deref(&self) -> &<OrdBits<B> as Deref>::Target

Dereferences the value.

impl<B> DerefMut for OrdBits<B>

where B: BorrowMut<Bits>,

fn deref_mut(&mut self) -> &mut Bits

Mutably dereferences the value.

impl<B> Display for OrdBits<B>

where B: Display + BorrowMut<Bits>,

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

Formats the value using the given formatter.

impl<B> Hash for OrdBits<B>

where B: BorrowMut<Bits>,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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<B> LowerHex for OrdBits<B>

where B: LowerHex + BorrowMut<Bits>,

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

Formats the value using the given formatter.

impl<B> Octal for OrdBits<B>

where B: Octal + BorrowMut<Bits>,

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

Formats the value using the given formatter.

impl<B> Ord for OrdBits<B>

where B: BorrowMut<Bits>,

fn cmp(&self, other: &OrdBits<B>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<B> PartialEq for OrdBits<B>

where B: BorrowMut<Bits>,

fn eq(&self, rhs: &OrdBits<B>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B> PartialOrd for OrdBits<B>

where B: BorrowMut<Bits>,

fn partial_cmp(&self, other: &OrdBits<B>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<B> UpperHex for OrdBits<B>

where B: UpperHex + BorrowMut<Bits>,

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

Formats the value using the given formatter.

impl<B> Copy for OrdBits<B>

where B: Copy + BorrowMut<Bits>,

impl<B> Eq for OrdBits<B>

where B: BorrowMut<Bits>,