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/poseidon/trait.PoseidonSpongeInstruc...

24 lines
14 KiB
HTML
Raw Normal View History

deploy: 1806b88c7455f687e486ff23ae5e147b16d540a4
2022-09-02 08:32:04 -07: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="The set of circuit instructions required to use the [`Sponge`] and `Hash` gadgets."><meta name="keywords" content="rust, rustlang, rust-lang, PoseidonSpongeInstructions"><title>PoseidonSpongeInstructions in halo2_gadgets::poseidon - 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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.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">
deploy: 9617336d46a18f3949260731d02bd711fba9d863
2022-02-03 17:33:56 -08:00
<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: 6f692c0e53c50f18aae09ca731d144d4bc9e951b
2022-09-26 05:20:20 -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></a><h2 class="location"><a href="#">PoseidonSpongeInstructions</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.add_input">add_input</a></li><li><a href="#tymethod.get_output">get_output</a></li><li><a href="#tymethod.initial_state">initial_state</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::poseidon</a></h2></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"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><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"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">halo2_gadgets</a>::<wbr><a href="index.html">poseidon</a>::<wbr><a class="trait" href="#">PoseidonSpongeInstructions</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/poseidon.rs.html#47-69">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="item-decl"><pre class="rust trait"><code>pub trait PoseidonSpongeInstructions&lt;F:&nbsp;FieldExt, S:&nbsp;<a class="trait" href="primitives/trait.Spec.html" title="trait halo2_gadgets::poseidon::primitives::Spec">Spec</a>&lt;F, T, RATE&gt;, D:&nbsp;<a class="trait" href="primitives/trait.Domain.html" title="trait halo2_gadgets::poseidon::primitives::Domain">Domain</a>&lt;F, RATE&gt;, const T:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, const RATE:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;: <a class="trait" href="trait.PoseidonInstructions.html" title="trait halo2_gadgets::poseidon::PoseidonInstructions">PoseidonInstructions</a>&lt;F, S, T, RATE&gt; {
deploy: ac738ca5a143eb0389e73381967b5ab0280ed64e
2022-10-05 17:59:28 -07:00
fn <a href="#tymethod.initial_state" class="fnname">initial_state</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;layouter: &amp;mut impl Layouter&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.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>], Error&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.add_input" class="fnname">add_input</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;layouter: &amp;mut impl Layouter&lt;F&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;initial_state: &amp;[Self::<a class="associatedtype" href="trait.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>],<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;input: &amp;<a class="struct" href="primitives/struct.Absorbing.html" title="struct halo2_gadgets::poseidon::primitives::Absorbing">Absorbing</a>&lt;<a class="enum" href="enum.PaddedWord.html" title="enum halo2_gadgets::poseidon::PaddedWord">PaddedWord</a>&lt;F&gt;, RATE&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.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>], Error&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.get_output" class="fnname">get_output</a>(state: &amp;[Self::<a class="associatedtype" href="trait.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>]) -&gt; <a class="struct" href="primitives/struct.Squeezing.html" title="struct halo2_gadgets::poseidon::primitives::Squeezing">Squeezing</a>&lt;Self::<a class="associatedtype" href="trait.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>, RATE&gt;;
deploy: 9617336d46a18f3949260731d02bd711fba9d863
2022-02-03 17:33:56 -08:00
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The set of circuit instructions required to use the <a href="struct.Sponge.html" title="Sponge"><code>Sponge</code></a> and <a href="struct.Hash.html"><code>Hash</code></a> gadgets.</p>
deploy: ac738ca5a143eb0389e73381967b5ab0280ed64e
2022-10-05 17:59:28 -07:00
</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 method-toggle" open><summary><section id="tymethod.initial_state" class="method has-srclink"><a class="srclink rightside" href="../../src/halo2_gadgets/poseidon.rs.html#56-57">source</a><h4 class="code-header">fn <a href="#tymethod.initial_state" class="fnname">initial_state</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;layouter: &amp;mut impl Layouter&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.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>], Error&gt;</h4></section></summary><div class="docblock"><p>Returns the initial empty state for the given domain.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.add_input" class="method has-srclink"><a class="srclink rightside" href="../../src/halo2_gadgets/poseidon.rs.html#60-65">source</a><h4 class="code-header">fn <a href="#tymethod.add_input" class="fnname">add_input</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;layouter: &amp;mut impl Layouter&lt;F&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;initial_state: &amp;[Self::<a class="associatedtype" href="trait.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>],<br>&nbsp;&nbsp;&nbsp;&nbsp;input: &amp;<a class="struct" href="primitives/struct.Absorbing.html" title="struct halo2_gadgets::poseidon::primitives::Absorbing">Absorbing</a>&lt;<a class="enum" href="enum.PaddedWord.html" title="enum halo2_gadgets::poseidon::PaddedWord">PaddedWord</a>&lt;F&gt;, RATE&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.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>], Error&gt;</h4></section></summary><div class="docblock"><p>Adds the given input to the state.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.get_output" class="method has-srclink"><a class="srclink rightside" href="../../src/halo2_gadgets/poseidon.rs.html#68">source</a><h4 class="code-header">fn <a href="#tymethod.get_output" class="fnname">get_output</a>(state: &amp;[Self::<a class="associatedtype" href="trait.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>]) -&gt; <a class="struct" href="primitives/struct.Squeezing.html" title="struct halo2_gadgets::poseidon::primitives::Squeezing">Squeezing</a>&lt;Self::<a class="associatedtype" href="trait.PoseidonInstructions.html#associatedtype.Word" title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>, RATE&gt;</h4></section></summary><div class="docblock"><p>Extracts sponge output from the given state.</p>
</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"><section id="impl-PoseidonSpongeInstructions%3CF%2C%20S%2C%20D%2C%20WIDTH%2C%20RATE%3E-for-Pow5Chip%3CF%2C%20WIDTH%2C%20RATE%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/halo2_gadgets/poseidon/pow5.rs.html#275-402">source</a><a href="#impl-PoseidonSpongeInstructions%3CF%2C%20S%2C%20D%2C%20WIDTH%2C%20RATE%3E-for-Pow5Chip%3CF%2C%20WIDTH%2C%20RATE%3E" class="anchor"></a><h3 class="code-header">impl&lt;F:&nbsp;FieldExt, S:&nbsp;<a class="trait" href="primitives/trait.Spec.html" title="trait halo2_gadgets::poseidon::primitives::Spec">Spec</a>&lt;F, WIDTH, RATE&gt;, D:&nbsp;<a class="trait" href="primitives/trait.Domain.html" title="trait halo2_gadgets::poseidon::primitives::Domain">Domain</a>&lt;F, RATE&gt;, const WIDTH:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, const RATE:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt; <a class="trait" href="trait.PoseidonSpongeInstructions.html" title="trait halo2_gadgets::poseidon::PoseidonSpongeInstructions">PoseidonSpongeInstructions</a>&lt;F, S, D, WIDTH, RATE&gt; for <a class="struct" href="struct.Pow5Chip.html" title="struct halo2_gadgets::poseidon::Pow5Chip">Pow5Chip</a>&lt;F, WIDTH, RATE&gt;</h3></section></div><script src="../../implementors/halo2_gadgets/poseidon/trait.PoseidonSpongeInstructions.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="halo2_gadgets" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (01af5040f 2022-10-04)" ></div></body></html>