Struct orzir_core::ApInt

pub struct ApInt { /* private fields */ }

An arbitrary precision integer with signedless semantics.

Implementations

impl ApInt

pub fn zero(width: usize) -> Self

Create a 0 with given width.

pub fn is_zero(&self) -> bool

Check if the integer is zero.

pub fn one(width: usize) -> Self

Create a 1 with given width.

pub fn is_one(&self) -> bool

Check if the integer is one.

pub fn width(&self) -> usize

Get the width of the integer.

pub fn inplace_bitor(&mut self, other: &Self)

Inplace bitwise or operation.

pub fn inplace_bitand(&mut self, other: &Self)

Inplace bitwise and operation.

pub fn inplace_bitxor(&mut self, other: &Self)

Inplace bitwise xor operation.

pub fn inplace_bitnot(&mut self)

Inplace bitwise not operation.

pub fn zeroext(&mut self, width: usize)

Inplace addition operation.

pub fn signext(&mut self, width: usize)

Inplace addition operation.

pub fn into_signext(self, width: usize) -> Self

Consumes the integer and zero extends it.

pub fn into_zeroext(self, width: usize) -> Self

Consumes the integer and zero extends it.

pub fn truncate(&mut self, width: usize) -> Self

Inplace addition operation.

pub fn into_truncated(self, width: usize) -> (Self, Self)

Consumes the integer and truncates it.

pub fn inplace_add(&mut self, rhs: &Self) -> bool

Inplace addition and return the carry.

pub fn inplace_sub(&mut self, rhs: &Self) -> bool

Inplace subtraction and return the borrow.

pub fn inplace_widening_shl(&mut self, shamt: usize)

Inplace shift left and widen the integer.

pub fn inplace_carrying_shl(&mut self, shamt: usize) -> Self

Inplace shift left and return the overflow.

pub fn highest_bit(&self) -> bool

Get the highest bit of the integer.

pub fn all_ones(width: usize) -> Self

Get the lowest bit of the integer.

pub fn inplace_neg(&mut self)

Inplace negation.

pub fn inplace_abs(&mut self) -> bool

Inplace absolute value and return the sign.

pub fn into_abs(self) -> (Self, bool)

Consumes the integer and return the absolute value and the sign.

pub fn inplace_widening_umul_chunk(&mut self, chunk: u64)

Inplace widening unsigned multiplication by a chunk.

This operation widen the integer by one chunk width.

pub fn shrink_to_fit(&mut self)

Shrinks the integer to minimum width.

pub fn into_shrunk(self) -> Self

Consumes the integer and return the shrunk integer.

pub fn inplace_carrying_umul_chunk(&mut self, chunk: u64) -> Self

Inplace carrying unsigned multiplication by a chunk.

pub fn inplace_widening_umul(&mut self, rhs: &Self)

Inplace widening unsigned multiplication.

pub fn inplace_widening_smul(&mut self, rhs: &Self)

Inplace widening signed multiplication.

pub fn inplace_carrying_umul(&mut self, rhs: &Self) -> Self

Inplace carrying signed multiplication, return the overflow.

pub fn inplace_carrying_smul(&mut self, rhs: &Self) -> Self

Inplace carrying signed multiplication, return the overflow.

pub fn inplace_lshr(&mut self, shamt: usize) -> Self

Inplace logical shift right and return the discarded bits.

pub fn inplace_ashr(&mut self, shamt: usize) -> Self

Inplace arithmetic shift right and return the discarded bits.

pub fn inplace_udiv(&mut self, divisor: &Self) -> Self

Unsigned division and return the remainder.

pub fn inplace_sdiv(&mut self, divisor: &Self) -> Self

Signed division and return the remainder.

Trait Implementations

impl Binary for ApInt

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

Formats the value using the given formatter.

impl Clone for ApInt

fn clone(&self) -> ApInt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApInt

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

Formats the value using the given formatter.

impl Display for ApInt

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

Formats the value using the given formatter.

impl From<Vec<u64>> for ApInt

fn from(chunks: Vec<u64>) -> Self

Converts to this type from the input type.

impl From<i16> for ApInt

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for ApInt

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for ApInt

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for ApInt

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for ApInt

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for ApInt

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for ApInt

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for ApInt

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for ApInt

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 LowerHex for ApInt

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

Formats the value using the given formatter.

impl Ord for ApInt

fn cmp(&self, other: &Self) -> Ordering

Compare two integers as unsigned integers.

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 Parse for ApInt

type Item = ApInt

fn parse(_: &mut Context, state: &mut ParseState<'_>) -> ParseResult<Self::Item>

impl PartialEq for ApInt

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

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

Compare two integers as unsigned integers.

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 Print for ApInt

fn print(&self, _: &Context, state: &mut PrintState) -> PrintResult<()>

impl TryFrom<&str> for ApInt

type Error = ApIntParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for ApInt

type Error = ApIntParseError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for ApInt

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

Formats the value using the given formatter.

impl Eq for ApInt

impl StructuralPartialEq for ApInt