Struct halo2_frontend::dev::CircuitGates

pub struct CircuitGates { /* private fields */ }

A struct for collecting and displaying the gates within a circuit.

Examples

use halo2_middleware::ff::Field;
use halo2_middleware::poly::Rotation;
use halo2_frontend::{
    circuit::{Layouter, SimpleFloorPlanner},
    dev::CircuitGates,
    plonk::{Circuit, ConstraintSystem, Error},
};
use halo2curves::pasta::pallas;

#[derive(Copy, Clone)]
struct MyConfig {}

#[derive(Clone, Default)]
struct MyCircuit {}

impl<F: Field> Circuit<F> for MyCircuit {
    type Config = MyConfig;
    type FloorPlanner = SimpleFloorPlanner;
    #[cfg(feature = "circuit-params")]
    type Params = ();

    fn without_witnesses(&self) -> Self {
        Self::default()
    }

    fn configure(meta: &mut ConstraintSystem<F>) -> MyConfig {
        let a = meta.advice_column();
        let b = meta.advice_column();
        let c = meta.advice_column();
        let s = meta.selector();

        meta.create_gate("R1CS constraint", |meta| {
            let a = meta.query_advice(a, Rotation::cur());
            let b = meta.query_advice(b, Rotation::cur());
            let c = meta.query_advice(c, Rotation::cur());
            let s = meta.query_selector(s);

            Some(("R1CS", s * (a * b - c)))
        });

        // We aren't using this circuit for anything in this example.
        MyConfig {}
    }

    fn synthesize(&self, _: MyConfig, _: impl Layouter<F>) -> Result<(), Error> {
        // Gates are known at configure time; it doesn't matter how we use them.
        Ok(())
    }
}

#[cfg(feature = "circuit-params")]
let gates = CircuitGates::collect::<pallas::Base, MyCircuit>(());
#[cfg(not(feature = "circuit-params"))]
let gates = CircuitGates::collect::<pallas::Base, MyCircuit>();
assert_eq!(
    format!("{}", gates),
    r#####"R1CS constraint:
- R1CS:
  S0 * (A0@0 * A1@0 - A2@0)
Total gates: 1
Total custom constraint polynomials: 1
Total negations: 1
Total additions: 1
Total multiplications: 2
"#####,
);

Implementations

impl CircuitGates

pub fn collect<F: PrimeField, C: Circuit<F>>(params: C::Params) -> Self

Collects the gates from within the circuit.

pub fn queries_to_csv(&self) -> String

Prints the queries in this circuit to a CSV grid.

Trait Implementations

impl Debug for CircuitGates

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

Formats the value using the given formatter.

impl Display for CircuitGates

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

Formats the value using the given formatter.