Struct twenty_first::shared_math::circuit::Circuit

pub struct Circuit<T: Clone + Debug + Add<Output = T> + Mul<Output = T> + Sub<Output = T> + Zero + One + Hash + Eq> {
    pub id: usize,
    pub visited_counter: usize,
    pub expression: CircuitExpression<T>,
}

A wrapper around a CircuitExpression that manages additional bookkeeping information.

Fields

id: usize

visited_counter: usize

expression: CircuitExpression<T>

Implementations

impl<T: Clone + Debug + WrappingAdd<Output = T> + WrappingMul<Output = T> + WrappingSub<Output = T> + Zero + One + Hash + Eq> Circuit<T>

pub fn traverse_multiple(ccs: &mut [Circuit<T>])

Count how many times each reachable node is reached when traversing from the starting points that are given as input. The result is stored in the visited_counter field in each node.

pub fn assert_has_unique_ids(constraints: &mut [Circuit<T>])

Verify that a multicircuit has unique IDs. Panics otherwise.

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

Return all visited counters in the subtree

pub fn print_without_parentheses(&self) -> bool

Return true if the contained multivariate polynomial consists of only a single term. This means that it can be pretty-printed without parentheses.

pub fn is_zero(&self) -> bool

Return true if this node represents a constant value of zero, does not catch composite expressions that will always evaluate to zero.

pub fn is_one(&self) -> bool

Return true if this node represents a constant value of one, does not catch composite expressions that will always evaluate to one.

pub fn assert_all_evaluate_different(circuits: &[Self], input: Vec<T>)

Panics if two nodes evaluate to the same value

pub fn evaluate(&self, inputs: &[T]) -> T

Trait Implementations

impl<T: Clone + Clone + Debug + Add<Output = T> + Mul<Output = T> + Sub<Output = T> + Zero + One + Hash + Eq> Clone for Circuit<T>

fn clone(&self) -> Circuit<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone + Debug + Add<Output = T> + Mul<Output = T> + Sub<Output = T> + Zero + One + Hash + Eq> Debug for Circuit<T>

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

Formats the value using the given formatter.

impl<T: Clone + Debug + Add<Output = T> + Mul<Output = T> + Sub<Output = T> + Zero + One + Hash + Eq> Display for Circuit<T>

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

Formats the value using the given formatter.

impl<T: Clone + Debug + Add<Output = T> + Mul<Output = T> + Sub<Output = T> + Zero + One + Hash + Eq> Hash for Circuit<T>

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<T: Clone + Debug + Add<Output = T> + Mul<Output = T> + Sub<Output = T> + Zero + One + Hash + Eq> PartialEq<Circuit<T>> for Circuit<T>

fn eq(&self, other: &Self) -> bool

Calculate equality of circuits. In particular, this function does not attempt to simplify or reduce neutral terms or products. So this comparison will return false for a == a + 0. It will also return false for XFieldElement(7) == BFieldElement(7)

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<T: Clone + Debug + Add<Output = T> + Mul<Output = T> + Sub<Output = T> + Zero + One + Hash + Eq> Eq for Circuit<T>