Struct ConstraintCircuitMonad

pub struct ConstraintCircuitMonad<II: InputIndicator> {
    pub circuit: Rc<RefCell<ConstraintCircuit<II>>>,
    pub builder: ConstraintCircuitBuilder<II>,
}

ConstraintCircuit with extra context pertaining to the whole multicircuit.

This context is needed to ensure that two equal nodes (meaning: same expression) are not added to the multicircuit. It also enables a rudimentary check for node equivalence (commutation + constant folding), in which case the existing expression is used instead.

One can create new instances of ConstraintCircuitMonad by applying arithmetic operations to existing instances, e.g., let c = a * b;.

Fields

circuit: Rc<RefCell<ConstraintCircuit<II>>>

builder: ConstraintCircuitBuilder<II>

Implementations

impl<II: InputIndicator> ConstraintCircuitMonad<II>

pub fn consume(&self) -> ConstraintCircuit<II>

Unwrap a ConstraintCircuitMonad to reveal its inner ConstraintCircuit

pub fn lower_to_degree( multicircuit: &mut [Self], info: DegreeLoweringInfo, ) -> (Vec<Self>, Vec<Self>)

Lower the degree of a given multicircuit to the target degree. This is achieved by introducing additional variables and constraints. The appropriate substitutions are applied to the given multicircuit. The target degree must be greater than 1.

The new constraints are returned as two vector of ConstraintCircuitMonads: the first corresponds to main columns and constraints, the second to auxiliary columns and constraints. The modifications are applied to the function argument in-place.

Each returned constraint is guaranteed to correspond to some CircuitExpression::BinaryOperation(BinOp::Sub, lhs, rhs) where

• lhs is the new variable, and
• rhs is the (sub)circuit replaced by lhs. These can then be used to construct new columns, as well as derivation rules for filling those new columns.

For example, starting with the constraint set {x^4}, we insert {y - x^2} and modify in-place (x^4) –> (y^2).

The highest index of main and auxiliary columns used by the multicircuit have to be provided. The uniqueness of the new columns’ indices depends on these provided values. Note that these indices are generally not equal to the number of used columns, especially when a tables’ constraints are built using the master table’s column indices.

pub fn all_nodes_in_multicircuit( multicircuit: &[ConstraintCircuit<II>], ) -> Vec<ConstraintCircuit<II>>

Returns all nodes used in the multicircuit. This is distinct from ConstraintCircuitBuilder::all_nodes because it

1. only considers nodes used in the given multicircuit, not all nodes in the builder,
2. returns the nodes as ConstraintCircuits, not as ConstraintCircuitMonads, and
3. keeps duplicates, allowing to count how often a node occurs.

pub fn num_visible_nodes(constraints: &[Self]) -> usize

Counts the number of nodes in this multicircuit. Only counts nodes that are used; not nodes that have been forgotten.

pub fn multicircuit_degree(multicircuit: &[ConstraintCircuitMonad<II>]) -> isize

Returns the maximum degree of all circuits in the multicircuit.

Trait Implementations

impl<II: InputIndicator> Add for ConstraintCircuitMonad<II>

type Output = ConstraintCircuitMonad<II>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, II: InputIndicator + Arbitrary<'a>> Arbitrary<'a> for ConstraintCircuitMonad<II>

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<II: Clone + InputIndicator> Clone for ConstraintCircuitMonad<II>

fn clone(&self) -> ConstraintCircuitMonad<II>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<II: InputIndicator> Debug for ConstraintCircuitMonad<II>

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

Formats the value using the given formatter.

impl<II: InputIndicator> Display for ConstraintCircuitMonad<II>

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

Formats the value using the given formatter.

impl<II: InputIndicator> Hash for ConstraintCircuitMonad<II>

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<II: InputIndicator> Mul for ConstraintCircuitMonad<II>

type Output = ConstraintCircuitMonad<II>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<II: InputIndicator> Neg for ConstraintCircuitMonad<II>

type Output = ConstraintCircuitMonad<II>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<II: InputIndicator> PartialEq for ConstraintCircuitMonad<II>

fn eq(&self, other: &Self) -> 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<II: InputIndicator> Sub for ConstraintCircuitMonad<II>

type Output = ConstraintCircuitMonad<II>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<II: InputIndicator> Sum for ConstraintCircuitMonad<II>

This will panic if the iterator is empty because the neutral element needs a unique ID, and we have no way of getting that here.

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<II: InputIndicator> Eq for ConstraintCircuitMonad<II>