Struct halo2_frontend::dev::CircuitLayout

pub struct CircuitLayout { /* private fields */ }

Available on crate feature dev-graph only.

Graphical renderer for circuit layouts.

Cells that have been assigned to by the circuit will be shaded. If any cells are assigned to more than once (which is usually a mistake), they will be shaded darker than the surrounding cells.

Examples

use halo2_proofs::dev::CircuitLayout;
use plotters::prelude::*;

let drawing_area = BitMapBackend::new("example-circuit-layout.png", (1024, 768))
    .into_drawing_area();
drawing_area.fill(&WHITE).unwrap();
let drawing_area = drawing_area
    .titled("Example Circuit Layout", ("sans-serif", 60))
    .unwrap();

let circuit = MyCircuit::default();
let k = 5; // Suitable size for MyCircuit
CircuitLayout::default().render(k, &circuit, &drawing_area).unwrap();

Implementations

impl CircuitLayout

pub fn show_labels(self, show: bool) -> Self

Sets the visibility of region labels.

The default is to show labels.

pub fn mark_equality_cells(self, show: bool) -> Self

Marks cells involved in equality constraints, in red.

The default is to not mark these cells.

pub fn show_equality_constraints(self, show: bool) -> Self

Draws red lines between equality-constrained cells.

The default is to not show these, as they can get very messy.

pub fn view_width(self, width: Range<usize>) -> Self

Sets the view width for this layout, as a number of columns.

pub fn view_height(self, height: Range<usize>) -> Self

Sets the view height for this layout, as a number of rows.

pub fn render<F: Field, ConcreteCircuit: Circuit<F>, DB: DrawingBackend>( self, k: u32, circuit: &ConcreteCircuit, drawing_area: &DrawingArea<DB, Shift> ) -> Result<(), DrawingAreaErrorKind<DB::ErrorType>>

Renders the given circuit on the given drawing area.

Trait Implementations

impl Debug for CircuitLayout

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

Formats the value using the given formatter.

impl Default for CircuitLayout

fn default() -> CircuitLayout

Returns the “default value” for a type.