mirror of https://github.com/zcash/halo2.git
68 lines
36 KiB
HTML
68 lines
36 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Helper trait for implementing a custom `Layouter`."><meta name="keywords" content="rust, rustlang, rust-lang, RegionLayouter"><title>RegionLayouter in halo2_proofs::circuit::layouter - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><script defer src="../../../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.css" integrity="sha384-9eLZqc9ds8eNjO3TmqPeYcDj8n+Qfa4nuSiGYa6DjLNcv9BtN69ZIulL9+8CqC9Y" crossorigin="anonymous">
|
||
<script src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.js" integrity="sha384-K3vbOmF2BtaVai+Qk37uypf7VrgBubhQreNQe9aGsz9lB63dIFiQVlJbr92dw2Lx" crossorigin="anonymous"></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/contrib/auto-render.min.js" integrity="sha384-kmZOZB5ObwgQnS/DuDg6TScgOiWWBiVt0plIRkZCmE6rDZGrEOQeHM5PcHi+nyqe" crossorigin="anonymous"></script>
|
||
<script>
|
||
document.addEventListener("DOMContentLoaded", function() {
|
||
renderMathInElement(document.body, {
|
||
delimiters: [
|
||
{left: "$$", right: "$$", display: true},
|
||
{left: "\\(", right: "\\)", display: false},
|
||
{left: "$", right: "$", display: false},
|
||
{left: "\\[", right: "\\]", display: true}
|
||
]
|
||
});
|
||
});
|
||
</script>
|
||
</head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../../halo2_proofs/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"><a href="#">Trait RegionLayouter</a></h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.assign_advice">assign_advice</a><a href="#tymethod.assign_advice_from_constant">assign_advice_from_constant</a><a href="#tymethod.assign_advice_from_instance">assign_advice_from_instance</a><a href="#tymethod.assign_fixed">assign_fixed</a><a href="#tymethod.constrain_constant">constrain_constant</a><a href="#tymethod.constrain_equal">constrain_equal</a><a href="#tymethod.enable_selector">enable_selector</a></div><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><div class="sidebar-links"><a href="#impl-From%3C%26%27r%20mut%20(dyn%20RegionLayouter%3CF%3E%20+%20%27r)%3E">From<&'r mut (dyn RegionLayouter<F> + 'r)></a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../../index.html">halo2_proofs</a>::<wbr><a href="../index.html">circuit</a>::<wbr><a href="index.html">layouter</a></h2><div id="sidebar-vars" data-name="RegionLayouter" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../halo2_proofs/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div>
|
||
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
|
||
<h1 class="fqn"><span class="in-band">Trait <a href="../../index.html">halo2_proofs</a>::<wbr><a href="../index.html">circuit</a>::<wbr><a href="index.html">layouter</a>::<wbr><a class="trait" href="#">RegionLayouter</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#42-105" title="goto source code">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait RegionLayouter<F: <a class="trait" href="../../arithmetic/trait.Field.html" title="trait halo2_proofs::arithmetic::Field">Field</a>>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
|
||
fn <a href="#tymethod.enable_selector" class="fnname">enable_selector</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> selector: &<a class="struct" href="../../plonk/struct.Selector.html" title="struct halo2_proofs::plonk::Selector">Selector</a>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.assign_advice" class="fnname">assign_advice</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> column: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Advice.html" title="struct halo2_proofs::plonk::Advice">Advice</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> to: &'v mut (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>> + 'v)<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.assign_advice_from_constant" class="fnname">assign_advice_from_constant</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> column: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Advice.html" title="struct halo2_proofs::plonk::Advice">Advice</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> constant: <a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.assign_advice_from_instance" class="fnname">assign_advice_from_instance</a><'v>(<br> &mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> instance: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Instance.html" title="struct halo2_proofs::plonk::Instance">Instance</a>>, <br> row: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> advice: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Advice.html" title="struct halo2_proofs::plonk::Advice">Advice</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><F><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.assign_fixed" class="fnname">assign_fixed</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> column: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Fixed.html" title="struct halo2_proofs::plonk::Fixed">Fixed</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> to: &'v mut (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>> + 'v)<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.constrain_constant" class="fnname">constrain_constant</a>(<br> &mut self, <br> cell: <a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <br> constant: <a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.constrain_equal" class="fnname">constrain_equal</a>(&mut self, left: <a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, right: <a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper trait for implementing a custom <a href="../trait.Layouter.html"><code>Layouter</code></a>.</p>
|
||
<p>This trait is used for implementing region assignments:</p>
|
||
|
||
<div class='information'><div class='tooltip ignore'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore"><code><span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">F</span>: <span class="ident">FieldExt</span>, <span class="ident">C</span>: <span class="ident">Chip</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>, <span class="ident">CS</span>: <span class="ident">Assignment</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'a</span><span class="op">></span> <span class="ident">Layouter</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MyLayouter</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">C</span>, <span class="ident">CS</span><span class="op">></span> {
|
||
<span class="kw">fn</span> <span class="ident">assign_region</span>(
|
||
<span class="kw-2">&mut</span> <span class="self">self</span>,
|
||
<span class="ident">assignment</span>: <span class="kw">impl</span> <span class="ident">FnOnce</span>(<span class="ident">Region</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">F</span>, <span class="ident">C</span><span class="op">></span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span>,
|
||
) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">region_index</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">regions</span>.<span class="ident">len</span>();
|
||
<span class="self">self</span>.<span class="ident">regions</span>.<span class="ident">push</span>(<span class="self">self</span>.<span class="ident">current_gate</span>);
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">region</span> <span class="op">=</span> <span class="ident">MyRegion::new</span>(<span class="self">self</span>, <span class="ident">region_index</span>);
|
||
{
|
||
<span class="kw">let</span> <span class="ident">region</span>: <span class="kw-2">&mut</span> <span class="kw">dyn</span> <span class="ident">RegionLayouter</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> <span class="op">=</span> <span class="kw-2">&mut</span> <span class="ident">region</span>;
|
||
<span class="ident">assignment</span>(<span class="ident">region</span>.<span class="ident">into</span>())<span class="question-mark">?</span>;
|
||
}
|
||
<span class="self">self</span>.<span class="ident">current_gate</span> <span class="op">+</span><span class="op">=</span> <span class="ident">region</span>.<span class="ident">row_count</span>;
|
||
|
||
<span class="prelude-val">Ok</span>(())
|
||
}
|
||
}</code></pre></div>
|
||
<p>TODO: It would be great if we could constrain the columns in these types to be
|
||
“logical” columns that are guaranteed to correspond to the chip (and have come from
|
||
<code>Chip::Config</code>).</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.enable_selector" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#44-49" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.enable_selector" class="fnname">enable_selector</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> selector: &<a class="struct" href="../../plonk/struct.Selector.html" title="struct halo2_proofs::plonk::Selector">Selector</a>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><div class="docblock"><p>Enables a selector at the given offset.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.assign_advice" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#52-58" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.assign_advice" class="fnname">assign_advice</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> column: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Advice.html" title="struct halo2_proofs::plonk::Advice">Advice</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> to: &'v mut (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>> + 'v)<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><div class="docblock"><p>Assign an advice column value (witness)</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.assign_advice_from_constant" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#66-72" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.assign_advice_from_constant" class="fnname">assign_advice_from_constant</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> column: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Advice.html" title="struct halo2_proofs::plonk::Advice">Advice</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> constant: <a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><div class="docblock"><p>Assigns a constant value to the column <code>advice</code> at <code>offset</code> within this region.</p>
|
||
<p>The constant value will be assigned to a cell within one of the fixed columns
|
||
configured via <code>ConstraintSystem::enable_constant</code>.</p>
|
||
<p>Returns the advice cell that has been equality-constrained to the constant.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.assign_advice_from_instance" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#78-85" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.assign_advice_from_instance" class="fnname">assign_advice_from_instance</a><'v>(<br> &mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> instance: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Instance.html" title="struct halo2_proofs::plonk::Instance">Instance</a>>, <br> row: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> advice: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Advice.html" title="struct halo2_proofs::plonk::Advice">Advice</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><F><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><div class="docblock"><p>Assign the value of the instance column’s cell at absolute location
|
||
<code>row</code> to the column <code>advice</code> at <code>offset</code> within this region.</p>
|
||
<p>Returns the advice cell, and its value if known.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.assign_fixed" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#88-94" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.assign_fixed" class="fnname">assign_fixed</a><'v>(<br> &'v mut self, <br> annotation: &'v (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'v), <br> column: <a class="struct" href="../../plonk/struct.Column.html" title="struct halo2_proofs::plonk::Column">Column</a><<a class="struct" href="../../plonk/struct.Fixed.html" title="struct halo2_proofs::plonk::Fixed">Fixed</a>>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> to: &'v mut (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>> + 'v)<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><div class="docblock"><p>Assign a fixed value</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.constrain_constant" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#99" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.constrain_constant" class="fnname">constrain_constant</a>(<br> &mut self, <br> cell: <a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, <br> constant: <a class="enum" href="../../plonk/enum.Assigned.html" title="enum halo2_proofs::plonk::Assigned">Assigned</a><F><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><div class="docblock"><p>Constrains a cell to have a constant value.</p>
|
||
<p>Returns an error if the cell is in a column where equality has not been enabled.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.constrain_equal" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#104" title="goto source code">source</a></div><h4 class="code-header">fn <a href="#tymethod.constrain_equal" class="fnname">constrain_equal</a>(&mut self, left: <a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>, right: <a class="struct" href="../struct.Cell.html" title="struct halo2_proofs::circuit::Cell">Cell</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../plonk/enum.Error.html" title="enum halo2_proofs::plonk::Error">Error</a>></h4></div></summary><div class="docblock"><p>Constraint two cells to have the same value.</p>
|
||
<p>Returns an error if either of the cells is not within the given permutation.</p>
|
||
</div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl-From%3C%26%27r%20mut%20(dyn%20RegionLayouter%3CF%3E%20+%20%27r)%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit.rs.html#169-173" title="goto source code">source</a></div><a href="#impl-From%3C%26%27r%20mut%20(dyn%20RegionLayouter%3CF%3E%20+%20%27r)%3E" class="anchor"></a><h3 class="code-header in-band">impl<'r, F: <a class="trait" href="../../arithmetic/trait.Field.html" title="trait halo2_proofs::arithmetic::Field">Field</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><&'r mut (dyn <a class="trait" href="trait.RegionLayouter.html" title="trait halo2_proofs::circuit::layouter::RegionLayouter">RegionLayouter</a><F> + 'r)> for <a class="struct" href="../struct.Region.html" title="struct halo2_proofs::circuit::Region">Region</a><'r, F></h3></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.from" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit.rs.html#170-172" title="goto source code">source</a></div><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(region: &'r mut dyn <a class="trait" href="trait.RegionLayouter.html" title="trait halo2_proofs::circuit::layouter::RegionLayouter">RegionLayouter</a><F>) -> Self</h4></div></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-RegionLayouter%3CF%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_proofs/circuit/layouter.rs.html#199-287" title="goto source code">source</a></div><a href="#impl-RegionLayouter%3CF%3E" class="anchor"></a><h3 class="code-header in-band">impl<F: <a class="trait" href="../../arithmetic/trait.Field.html" title="trait halo2_proofs::arithmetic::Field">Field</a>> <a class="trait" href="trait.RegionLayouter.html" title="trait halo2_proofs::circuit::layouter::RegionLayouter">RegionLayouter</a><F> for <a class="struct" href="struct.RegionShape.html" title="struct halo2_proofs::circuit::layouter::RegionShape">RegionShape</a></h3></div></div><script type="text/javascript" src="../../../implementors/halo2_proofs/circuit/layouter/trait.RegionLayouter.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="halo2_proofs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (ee5d8d37b 2022-01-17)" ></div>
|
||
</body></html> |