<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="This is a trait that circuits provide implementations for so that the backend prover can ask the circuit to synthesize using some given [`ConstraintSystem`] implementation."><metaname="keywords"content="rust, rustlang, rust-lang, Circuit"><title>Circuit in halo2_proofs::plonk - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../../storage.js"></script><scriptsrc="../../crates.js"></script><scriptdefersrc="../../main.js"></script>
</head><bodyclass="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../../halo2_proofs/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">Circuit</a></h2><divclass="sidebar-elems"><section><divclass="block"><h3class="sidebar-title"><ahref="#required-associated-types">Required Associated Types</a></h3><ul><li><ahref="#associatedtype.Config">Config</a></li><li><ahref="#associatedtype.FloorPlanner">FloorPlanner</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#required-methods">Required Methods</a></h3><ul><li><ahref="#tymethod.configure">configure</a></li><li><ahref="#tymethod.synthesize">synthesize</a></li><li><ahref="#tymethod.without_witnesses">without_witnesses</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#implementors">Implementors</a></h3></div></section><h2class="location"><ahref="index.html">In halo2_proofs::plonk</a></h2><divid="sidebar-vars"data-name="Circuit"data-ty="trait"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../../halo2_proofs/index.html"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="22"height="22"alt="Pick another theme!"src="../../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading">
<h1class="fqn"><spanclass="in-band">Trait <ahref="../index.html">halo2_proofs</a>::<wbr><ahref="index.html">plonk</a>::<wbr><aclass="trait"href="#">Circuit</a><buttonid="copy-path"onclick="copy_path(this)"title="Copy item path to clipboard"><imgsrc="../../clipboard.svg"width="19"height="18"alt="Copy item path"></button></span></h1><spanclass="out-of-band"><aclass="srclink"href="../../src/halo2_proofs/plonk/circuit.rs.html#423-442">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><divclass="docblock item-decl"><preclass="rust trait"><code>pub trait Circuit<F: <aclass="trait"href="../arithmetic/trait.Field.html"title="trait halo2_proofs::arithmetic::Field">Field</a>> {
type <ahref="#associatedtype.Config"class="associatedtype">Config</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>;
type <ahref="#associatedtype.FloorPlanner"class="associatedtype">FloorPlanner</a>: <aclass="trait"href="trait.FloorPlanner.html"title="trait halo2_proofs::plonk::FloorPlanner">FloorPlanner</a>;
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>This is a trait that circuits provide implementations for so that the
backend prover can ask the circuit to synthesize using some given
</div></details><h2id="required-associated-types"class="small-section-header">Required Associated Types<ahref="#required-associated-types"class="anchor"></a></h2><divclass="methods"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Config"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../src/halo2_proofs/plonk/circuit.rs.html#425">source</a></div><h4class="code-header">type <ahref="#associatedtype.Config"class="associatedtype">Config</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a></h4></div></summary><divclass="docblock"><p>This is a configuration object that stores things like columns.</p>
</div></details><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.FloorPlanner"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../src/halo2_proofs/plonk/circuit.rs.html#428">source</a></div><h4class="code-header">type <ahref="#associatedtype.FloorPlanner"class="associatedtype">FloorPlanner</a>: <aclass="trait"href="trait.FloorPlanner.html"title="trait halo2_proofs::plonk::FloorPlanner">FloorPlanner</a></h4></div></summary><divclass="docblock"><p>The floor planner used for this circuit. This is an associated type of the
</div></details></div><h2id="required-methods"class="small-section-header">Required Methods<ahref="#required-methods"class="anchor"></a></h2><divclass="methods"><detailsclass="rustdoc-toggle"open><summary><divid="tymethod.without_witnesses"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../src/halo2_proofs/plonk/circuit.rs.html#432">source</a></div><h4class="code-header">fn <ahref="#tymethod.without_witnesses"class="fnname">without_witnesses</a>(&self) -> Self</h4></div></summary><divclass="docblock"><p>Returns a copy of this circuit with no witness values (i.e. all witnesses set to
</div></details><detailsclass="rustdoc-toggle"open><summary><divid="tymethod.configure"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../src/halo2_proofs/plonk/circuit.rs.html#436">source</a></div><h4class="code-header">fn <ahref="#tymethod.configure"class="fnname">configure</a>(meta: &mut <aclass="struct"href="struct.ConstraintSystem.html"title="struct halo2_proofs::plonk::ConstraintSystem">ConstraintSystem</a><F>) -> Self::<aclass="associatedtype"href="trait.Circuit.html#associatedtype.Config"title="type halo2_proofs::plonk::Circuit::Config">Config</a></h4></div></summary><divclass="docblock"><p>The circuit is given an opportunity to describe the exact gate
</div></details><detailsclass="rustdoc-toggle"open><summary><divid="tymethod.synthesize"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../src/halo2_proofs/plonk/circuit.rs.html#441">source</a></div><h4class="code-header">fn <ahref="#tymethod.synthesize"class="fnname">synthesize</a>(<br> &self, <br> config: Self::<aclass="associatedtype"href="trait.Circuit.html#associatedtype.Config"title="type halo2_proofs::plonk::Circuit::Config">Config</a>, <br> layouter: impl <aclass="trait"href="../circuit/trait.Layouter.html"title="trait halo2_proofs::circuit::Layouter">Layouter</a><F><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <aclass="enum"href="enum.Error.html"title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><divclass="docblock"><p>Given the provided <code>cs</code>, synthesize the circuit. The concrete type of