zec
/
halo2
mirror of https://github.com/zcash/halo2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
halo2/rustdoc/latest/halo2_gadgets/utilities/trait.UtilitiesInstructions...

32 lines
14 KiB
HTML
Raw Normal View History

deploy: 9617336d46a18f3949260731d02bd711fba9d863
2022-02-03 17:33:56 -08:00
<!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="Trait for utilities used across circuits."><meta name="keywords" content="rust, rustlang, rust-lang, UtilitiesInstructions"><title>UtilitiesInstructions in halo2_gadgets::utilities - 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>
deploy: 5d99f7d5a15fd411d12acf638efc8ff21f3c094f
2022-04-24 16:22:22 -07:00
</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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../halo2_gadgets/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../halo2_gadgets/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
deploy: 34b2e77a573f115c954832c1f0977cd057aac9d0
2022-05-24 21:57:35 -07:00
</a><h2 class="location"><a href="#">UtilitiesInstructions</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-associated-types">Required Associated Types</a></h3><ul><li><a href="#associatedtype.Var">Var</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.load_private">load_private</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In halo2_gadgets::utilities</a></h2><div id="sidebar-vars" data-name="UtilitiesInstructions" 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_gadgets/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><div id="settings-menu" tabindex="-1">
<a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div>
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
deploy: b2e2b9b08125d806cb5836bd7c7dea0955febca5
2022-05-05 08:08:48 -07:00
<h1 class="fqn"><span class="in-band">Trait <a href="../index.html">halo2_gadgets</a>::<wbr><a href="index.html">utilities</a>::<wbr><a class="trait" href="#">UtilitiesInstructions</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_gadgets/utilities.rs.html#54-79">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait UtilitiesInstructions&lt;F:&nbsp;FieldExt&gt; {
deploy: 9617336d46a18f3949260731d02bd711fba9d863
2022-02-03 17:33:56 -08:00
type <a href="#associatedtype.Var" class="associatedtype">Var</a>: <a class="trait" href="trait.Var.html" title="trait halo2_gadgets::utilities::Var">Var</a>&lt;F&gt;;
deploy: 5d99f7d5a15fd411d12acf638efc8ff21f3c094f
2022-04-24 16:22:22 -07:00
deploy: 9617336d46a18f3949260731d02bd711fba9d863
2022-02-03 17:33:56 -08:00
fn <a href="#method.load_private" class="fnname">load_private</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;layouter: impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a>&lt;F&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;column: <a class="struct" href="../../halo2_proofs/plonk/circuit/struct.Column.html" title="struct halo2_proofs::plonk::circuit::Column">Column</a>&lt;<a class="struct" href="../../halo2_proofs/plonk/circuit/struct.Advice.html" title="struct halo2_proofs::plonk::circuit::Advice">Advice</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;F&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="associatedtype" href="trait.UtilitiesInstructions.html#associatedtype.Var" title="type halo2_gadgets::utilities::UtilitiesInstructions::Var">Var</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>&gt; { ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for utilities used across circuits.</p>
deploy: b2e2b9b08125d806cb5836bd7c7dea0955febca5
2022-05-05 08:08:48 -07:00
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Var" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/halo2_gadgets/utilities.rs.html#56">source</a></div><h4 class="code-header">type <a href="#associatedtype.Var" class="associatedtype">Var</a>: <a class="trait" href="trait.Var.html" title="trait halo2_gadgets::utilities::Var">Var</a>&lt;F&gt;</h4></div></summary><div class="docblock"><p>Variable in the circuit.</p>
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.load_private" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/halo2_gadgets/utilities.rs.html#59-78">source</a></div><h4 class="code-header">fn <a href="#method.load_private" class="fnname">load_private</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;layouter: impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a>&lt;F&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;column: <a class="struct" href="../../halo2_proofs/plonk/circuit/struct.Column.html" title="struct halo2_proofs::plonk::circuit::Column">Column</a>&lt;<a class="struct" href="../../halo2_proofs/plonk/circuit/struct.Advice.html" title="struct halo2_proofs::plonk::circuit::Advice">Advice</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;value: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;F&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="associatedtype" href="trait.UtilitiesInstructions.html#associatedtype.Var" title="type halo2_gadgets::utilities::UtilitiesInstructions::Var">Var</a>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>&gt;</h4></div></summary><div class="docblock"><p>Load a variable.</p>
deploy: 1cf376e9a60448571df6049ffeb3f4c801b01260
2022-06-09 16:55:36 -07:00
</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"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-UtilitiesInstructions%3CF%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/halo2_gadgets/utilities/cond_swap.rs.html#66-68">source</a></span><a href="#impl-UtilitiesInstructions%3CF%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;F:&nbsp;FieldExt&gt; <a class="trait" href="trait.UtilitiesInstructions.html" title="trait halo2_gadgets::utilities::UtilitiesInstructions">UtilitiesInstructions</a>&lt;F&gt; for <a class="struct" href="cond_swap/struct.CondSwapChip.html" title="struct halo2_gadgets::utilities::cond_swap::CondSwapChip">CondSwapChip</a>&lt;F&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Var-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Var-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Var" class="associatedtype">Var</a> = <a class="struct" href="../../halo2_proofs/circuit/struct.AssignedCell.html" title="struct halo2_proofs::circuit::AssignedCell">AssignedCell</a>&lt;F, F&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-UtilitiesInstructions%3CFp%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/halo2_gadgets/ecc/chip.rs.html#254-258">source</a></span><a href="#impl-UtilitiesInstructions%3CFp%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;Fixed:&nbsp;<a class="trait" href="../ecc/trait.FixedPoints.html" title="trait halo2_gadgets::ecc::FixedPoints">FixedPoints</a>&lt;Affine&gt;&gt; <a class="trait" href="trait.UtilitiesInstructions.html" title="trait halo2_gadgets::utilities::UtilitiesInstructions">UtilitiesInstructions</a>&lt;Fp&gt; for <a class="struct" href="../ecc/chip/struct.EccChip.html" title="struct halo2_gadgets::ecc::chip::EccChip">EccChip</a>&lt;Fixed&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Var-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Var-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Var" class="associatedtype">Var</a> = <a class="struct" href="../../halo2_proofs/circuit/struct.AssignedCell.html" title="struct halo2_proofs::circuit::AssignedCell">AssignedCell</a>&lt;Fp, Fp&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-UtilitiesInstructions%3CFp%3E-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/halo2_gadgets/sinsemilla/merkle/chip.rs.html#415-422">source</a></span><a href="#impl-UtilitiesInstructions%3CFp%3E-1" class="anchor"></a><h3 class="code-header in-band">impl&lt;Hash, Commit, F&gt; <a class="trait" href="trait.UtilitiesInstructions.html" title="trait halo2_gadgets::utilities::UtilitiesInstructions">UtilitiesInstructions</a>&lt;Fp&gt; for <a class="struct" href="../sinsemilla/merkle/chip/struct.MerkleChip.html" title="struct halo2_gadgets::sinsemilla::merkle::chip::MerkleChip">MerkleChip</a>&lt;Hash, Commit, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Hash: <a class="trait" href="../sinsemilla/trait.HashDomains.html" title="trait halo2_gadgets::sinsemilla::HashDomains">HashDomains</a>&lt;Affine&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="../ecc/trait.FixedPoints.html" title="trait halo2_gadgets::ecc::FixedPoints">FixedPoints</a>&lt;Affine&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Commit: <a class="trait" href="../sinsemilla/trait.CommitDomains.html" title="trait halo2_gadgets::sinsemilla::CommitDomains">CommitDomains</a>&lt;Affine, F, Hash&gt;,&nbsp;</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Var-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Var-3" class="anchor"></a><h4 class="cod
deploy: 9617336d46a18f3949260731d02bd711fba9d863
2022-02-03 17:33:56 -08:00
</body></html>