Struct r1cs::BinaryExpression

pub struct BinaryExpression<F: Field> {
    pub bits: Vec<BooleanExpression<F>>,
}

A BinaryExpression is comprised of several bits, each one being a BooleanExpression.

The sequence of bits is often interpreted as an unsigned integer for the purpose of binary arithmetic. When doing so, our convention is to treat the left-most bit as the least significant, and the right-most bit as the most significant.

Fields

bits: Vec<BooleanExpression<F>>

The sequence of bits, ordered from least significant to most significant.

Methods

impl<F: Field> BinaryExpression<F>

pub fn len(&self) -> usize

The number of bits.

pub fn zero() -> Self

pub fn truncate(&mut self, l: usize)

Truncate the bits in this expression, discarding the more significant bits while keeping the less significant bits.

pub fn truncated(&self, l: usize) -> Self

Return a copy of this expression truncated to l bits, discarding the more significant bits while keeping the less significant bits.

pub fn pad(&mut self, l: usize)

Pad this bit vector, adding 0 bits on the more significant side.

pub fn padded(&self, l: usize) -> Self

Return a copy this bit vector, with 0 bits added on the more significant side.

pub fn chunks(&self, chunk_bits: usize) -> Vec<BinaryExpression<F>>

pub fn add_most_significant(&mut self, bit: BooleanExpression<F>)

pub fn join(&self) -> Expression<F>

Join these bits into the field element they encode. This method requires that 2^self.len() < |F|, otherwise the result might not fit in a single field element.

pub fn join_allowing_overflow(&self) -> Expression<F>

Join these bits into the field element they encode. This method allows binary expressions of any size, so overflow is possible.

pub fn dependencies(&self) -> Vec<Wire>

pub fn evaluate(&self, values: &WireValues<F>) -> BigUint

pub fn concat(expressions: &[BinaryExpression<F>]) -> Self

Trait Implementations

impl<'_, F: Field> From<&'_ BinaryWire> for BinaryExpression<F>

fn from(wire: &BinaryWire) -> Self

Performs the conversion.

impl<F: Field> From<BinaryWire> for BinaryExpression<F>

fn from(wire: BinaryWire) -> Self

Performs the conversion.

impl<F: Field> From<BigUint> for BinaryExpression<F>

fn from(value: BigUint) -> Self

Performs the conversion.

impl<F: Field> From<usize> for BinaryExpression<F>

fn from(value: usize) -> Self

Performs the conversion.

impl<F: Field> From<u128> for BinaryExpression<F>

fn from(value: u128) -> Self

Performs the conversion.

impl<F: Field> From<u64> for BinaryExpression<F>

fn from(value: u64) -> Self

Performs the conversion.

impl<F: Field> From<u32> for BinaryExpression<F>

fn from(value: u32) -> Self

Performs the conversion.

impl<F: Field> From<u16> for BinaryExpression<F>

fn from(value: u16) -> Self

Performs the conversion.

impl<F: Field> From<u8> for BinaryExpression<F>

fn from(value: u8) -> Self

Performs the conversion.

impl<F: Field> Clone for BinaryExpression<F>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Field> Debug for BinaryExpression<F>

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

Formats the value using the given formatter.