mirror of https://github.com/zcash/halo2.git
23 lines
14 KiB
HTML
23 lines
14 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="The set of circuit instructions required to use the Poseidon permutation."><meta name="keywords" content="rust, rustlang, rust-lang, PoseidonInstructions"><title>PoseidonInstructions 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">
|
||
<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="mobile-topbar"><button class="sidebar-menu-toggle">☰</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="#">PoseidonInstructions</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.Word">Word</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.permute">permute</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="#">PoseidonInstructions</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#30-42">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 PoseidonInstructions<F: FieldExt, S: <a class="trait" href="primitives/trait.Spec.html" title="trait halo2_gadgets::poseidon::primitives::Spec">Spec</a><F, T, RATE>, const T: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, const RATE: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>: <a class="trait" href="../../halo2_proofs/circuit/trait.Chip.html" title="trait halo2_proofs::circuit::Chip">Chip</a><F> {
|
||
type <a href="#associatedtype.Word" class="associatedtype">Word</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../halo2_proofs/circuit/struct.AssignedCell.html" title="struct halo2_proofs::circuit::AssignedCell">AssignedCell</a><F, F>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../halo2_proofs/circuit/struct.AssignedCell.html" title="struct halo2_proofs::circuit::AssignedCell">AssignedCell</a><F, F>>;
|
||
|
||
fn <a href="#tymethod.permute" class="fnname">permute</a>(<br> &self,<br> layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,<br> initial_state: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>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> ) -> <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.array.html">[</a>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>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::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>The set of circuit instructions required to use the Poseidon permutation.</p>
|
||
</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.Word" class="method has-srclink"><a class="srclink rightside" href="../../src/halo2_gadgets/poseidon.rs.html#34">source</a><h4 class="code-header">type <a href="#associatedtype.Word" class="associatedtype">Word</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../halo2_proofs/circuit/struct.AssignedCell.html" title="struct halo2_proofs::circuit::AssignedCell">AssignedCell</a><F, F>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../../halo2_proofs/circuit/struct.AssignedCell.html" title="struct halo2_proofs::circuit::AssignedCell">AssignedCell</a><F, F>></h4></div></summary><div class="docblock"><p>Variable representing the word over which the Poseidon permutation operates.</p>
|
||
</div></details></div><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.permute" class="method has-srclink"><a class="srclink rightside" href="../../src/halo2_gadgets/poseidon.rs.html#37-41">source</a><h4 class="code-header">fn <a href="#tymethod.permute" class="fnname">permute</a>(<br> &self,<br> layouter: &mut impl <a class="trait" href="../../halo2_proofs/circuit/trait.Layouter.html" title="trait halo2_proofs::circuit::Layouter">Layouter</a><F>,<br> initial_state: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>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>) -> <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.array.html">[</a>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>, <a class="enum" href="../../halo2_proofs/plonk/error/enum.Error.html" title="enum halo2_proofs::plonk::error::Error">Error</a>></h4></div></summary><div class="docblock"><p>Applies the Poseidon permutation to 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"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-PoseidonInstructions%3CF%2C%20S%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#225-273">source</a><a href="#impl-PoseidonInstructions%3CF%2C%20S%2C%20WIDTH%2C%20RATE%3E-for-Pow5Chip%3CF%2C%20WIDTH%2C%20RATE%3E" class="anchor"></a><h3 class="code-header in-band">impl<F: FieldExt, S: <a class="trait" href="primitives/trait.Spec.html" title="trait halo2_gadgets::poseidon::primitives::Spec">Spec</a><F, WIDTH, RATE>, const WIDTH: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, const RATE: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.PoseidonInstructions.html" title="trait halo2_gadgets::poseidon::PoseidonInstructions">PoseidonInstructions</a><F, S, WIDTH, RATE> for <a class="struct" href="struct.Pow5Chip.html" title="struct halo2_gadgets::poseidon::Pow5Chip">Pow5Chip</a><F, WIDTH, RATE></h3></section></summary><div class="impl-items"><section id="associatedtype.Word-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Word-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Word" class="associatedtype">Word</a> = <a class="struct" href="struct.StateWord.html" title="struct halo2_gadgets::poseidon::StateWord">StateWord</a><F></h4></section></div></details></div><script src="../../implementors/halo2_gadgets/poseidon/trait.PoseidonInstructions.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.65.0-nightly (59e7a308e 2022-09-11)" ></div></body></html> |