Struct Reg

pub struct Reg { /* private fields */ }

Implementations

impl Reg

pub fn new(nbits: usize) -> Self

create a new register with the given number of bits

pub fn from_bits(nbits: usize, hi_bits: &[usize]) -> Self

constructor that takes the indices of the high bits

pub fn hi_bits(&self) -> Vec<usize>

return the high bits of the register as a vector of indices.

pub fn get(&self, ix: usize) -> bool

fetch value of a bit by index

pub fn put(&mut self, ix: usize, v: bool)

assign value of a bit by index

pub fn var_get(&self, v: VID) -> bool

fetch value of bit with the given variable’s index

pub fn var_put(&mut self, v: VID, val: bool)

assign value of bit with the given variable’s index

pub fn len(&self) -> usize

return the number of bits in the register.

pub fn is_empty(&self) -> bool

true when the number of bits is 0. (mostly because clippy complains about len() without is_empty())

pub fn as_usize(&self) -> usize

build a usize from the least significant bits of the register.

pub fn as_usize_rev(&self) -> usize

build a usize from the least significant bits of the register, in reverse order.

pub fn permute_bits(&self, pv: &[usize]) -> Self

pub fn ripple(&mut self, start: usize, end: usize) -> Option<usize>

ripple add with carry within the region specified by start and end (inclusive), returning Some position where a 0 became a 1, or None on overflow.

pub fn increment(&mut self) -> Option<usize>

increment the register as if adding 1. return position where the ripple-carry stopped.

Trait Implementations

impl<'b> BitAnd<&'b Reg> for &Reg

type Output = Reg

The resulting type after applying the & operator.

fn bitand(self, rhs: &'b Reg) -> Self::Output

Performs the & operation.

impl<'b> BitOr<&'b Reg> for &Reg

type Output = Reg

The resulting type after applying the | operator.

fn bitor(self, rhs: &'b Reg) -> Self::Output

Performs the | operation.

impl<'b> BitXor<&'b Reg> for &Reg

type Output = Reg

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'b Reg) -> Self::Output

Performs the ^ operation.

impl Clone for Reg

fn clone(&self) -> Reg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reg

Same as fmt::Display.

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

Formats the value using the given formatter.

impl Display for Reg

display the bits of the register and the usize e.g. reg[11o=06]

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

Formats the value using the given formatter.

impl Hash for Reg

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 Not for &Reg

type Output = Reg

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Reg

fn cmp(&self, other: &Reg) -> 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 PartialEq for Reg

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

fn partial_cmp(&self, other: &Reg) -> 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 Eq for Reg

impl StructuralPartialEq for Reg