Struct Word

pub struct Word(pub u64);

Word is 64-bit value and is a fundamental unit of data in Binius64. All computation and constraints operate on it.

Tuple Fields

0: u64

Implementations

impl Word

pub const ZERO: Word

All zero bit pattern, zero, nil, null.

pub const ONE: Word

pub const ALL_ONE: Word

All bits set to one.

pub const MASK_32: Word

32 lower bits are set to one, all other bits are zero.

pub const MSB_ONE: Word

Most Significant Bit is set to one, all other bits are zero.

This is a canonical representation of true.

impl Word

pub fn from_u64(value: u64) -> Word

Creates a new Word from a 64-bit unsigned integer.

pub fn iadd_cout_32(self, rhs: Word) -> (Word, Word)

Performs 32-bit addition.

Returns (sum, carry_out) where ith carry_out bit is set to one if there is a carry out at that bit position.

pub fn iadd_cin_cout(self, rhs: Word, cin: Word) -> (Word, Word)

Performs 64-bit addition with carry input bit.

cin is a carry-in from the previous addition. Since it can only affect the LSB only, the cin could be 1 if there is carry over, or 0 otherwise.

Returns (sum, carry_out) where ith carry_out bit is set to one if there is a carry out at that bit position.

pub fn isub_bin_bout(self, rhs: Word, bin: Word) -> (Word, Word)

Performs 64-bit subtraction with borrow input bit.

bin is a borrow-in from the previous subtraction. Since it can only affect the LSB only, the bin could be 1 if there is borrow over, or 0 otherwise.

Returns (diff, borrow_out) where ith borrow_out bit is set to one if there is a borrow out at that bit position.

pub fn shr_32(self, n: u32) -> Word

Performs shift right by a given number of bits followed by masking with a 32-bit mask.

pub fn sar(&self, n: u32) -> Word

Shift Arithmetic Right by a given number of bits.

This is similar to a logical shift right, but it shifts the sign bit to the right.

pub fn rotr_32(self, n: u32) -> Word

Rotate Right by a given number of bits followed by masking with a 32-bit mask.

pub fn rotr(self, n: u32) -> Word

Rotate Right by a given number of bits.

pub fn imul(self, rhs: Word) -> (Word, Word)

Unsigned integer multiplication.

Multiplies two 64-bit unsigned integers and returns the 128-bit result split into high and low 64-bit words, respectively.

pub fn smul(self, rhs: Word) -> (Word, Word)

Signed integer multiplication.

Multiplies two 64-bit signed integers and returns the 128-bit result split into high and low 64-bit words, respectively.

pub fn wrapping_add(self, rhs: Word) -> Word

Integer addition.

Wraps around on overflow.

pub fn wrapping_sub(self, rhs: Word) -> Word

Integer subtraction.

Wraps around on overflow.

pub fn as_u64(self) -> u64

Returns the integer value as a 64-bit unsigned integer.

pub fn is_msb_true(self) -> bool

Tests if this Word represents true as an MSB-bool.

In MSB-bool representation, a value is true if its Most Significant Bit (bit 63) is set to

1. All other bits are ignored for the boolean value.

Returns true if the MSB is 1, false otherwise.

pub fn is_msb_false(self) -> bool

Tests if this Word represents false as an MSB-bool.

In MSB-bool representation, a value is false if its Most Significant Bit (bit 63) is 0. All other bits are ignored for the boolean value.

Returns true if the MSB is 0, false otherwise.

Trait Implementations

impl BitAnd for Word

type Output = Word

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for Word

type Output = Word

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor for Word

type Output = Word

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for Word

fn clone(&self) -> Word

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Word

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

Formats the value using the given formatter.

impl DeserializeBytes for Word

fn deserialize(read_buf: impl Buf) -> Result<Self, SerializationError>

where Self: Sized,

impl Hash for Word

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 Word

type Output = Word

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Word

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

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

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

fn serialize(&self, write_buf: impl BufMut) -> Result<(), SerializationError>

impl Shl<u32> for Word

type Output = Word

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> Self::Output

Performs the << operation.

impl Shr<u32> for Word

type Output = Word

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Self::Output

Performs the >> operation.

impl Copy for Word

impl Eq for Word

impl StructuralPartialEq for Word