mirror of https://github.com/zcash/halo2.git
41 lines
14 KiB
HTML
41 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="A specification for a Poseidon permutation."><meta name="keywords" content="rust, rustlang, rust-lang, Spec"><title>Spec in halo2_gadgets::poseidon::primitives - 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 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="#">Spec</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.full_rounds">full_rounds</a></li><li><a href="#tymethod.partial_rounds">partial_rounds</a></li><li><a href="#tymethod.sbox">sbox</a></li><li><a href="#tymethod.secure_mds">secure_mds</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.constants">constants</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::primitives</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"><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">
|
||
<h1 class="fqn"><span class="in-band">Trait <a href="../../index.html">halo2_gadgets</a>::<wbr><a href="../index.html">poseidon</a>::<wbr><a href="index.html">primitives</a>::<wbr><a class="trait" href="#">Spec</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/primitives.rs.html#33-76">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 Spec<F: FieldExt, 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="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
|
||
fn <a href="#tymethod.full_rounds" class="fnname">full_rounds</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.partial_rounds" class="fnname">partial_rounds</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.sbox" class="fnname">sbox</a>(val: F) -> F;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.secure_mds" class="fnname">secure_mds</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
|
||
fn <a href="#method.constants" class="fnname">constants</a>() -> (<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>F<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a>>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>F<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>F<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a>) { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A specification for a Poseidon permutation.</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.full_rounds" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_gadgets/poseidon/primitives.rs.html#37">source</a></div><h4 class="code-header">fn <a href="#tymethod.full_rounds" class="fnname">full_rounds</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></div></summary><div class="docblock"><p>The number of full rounds for this specification.</p>
|
||
<p>This must be an even number.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.partial_rounds" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_gadgets/poseidon/primitives.rs.html#40">source</a></div><h4 class="code-header">fn <a href="#tymethod.partial_rounds" class="fnname">partial_rounds</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></div></summary><div class="docblock"><p>The number of partial rounds for this specification.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.sbox" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_gadgets/poseidon/primitives.rs.html#43">source</a></div><h4 class="code-header">fn <a href="#tymethod.sbox" class="fnname">sbox</a>(val: F) -> F</h4></div></summary><div class="docblock"><p>The S-box for this specification.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.secure_mds" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_gadgets/poseidon/primitives.rs.html#50">source</a></div><h4 class="code-header">fn <a href="#tymethod.secure_mds" class="fnname">secure_mds</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></div></summary><div class="docblock"><p>Side-loaded index of the first correct and secure MDS that will be generated by
|
||
the reference implementation.</p>
|
||
<p>This is used by the default implementation of <a href="trait.Spec.html#method.constants" title="Spec::constants"><code>Spec::constants</code></a>. If you are
|
||
hard-coding the constants, you may leave this unimplemented.</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.constants" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/halo2_gadgets/poseidon/primitives.rs.html#53-75">source</a></div><h4 class="code-header">fn <a href="#method.constants" class="fnname">constants</a>() -> (<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>F<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a>>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>F<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a>F<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; T]</a>)</h4></div></summary><div class="docblock"><p>Generates <code>(round_constants, mds, mds^-1)</code> corresponding to this specification.</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-Spec%3CFp%2C%203_usize%2C%202_usize%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../src/halo2_gadgets/poseidon/primitives/p128pow5t3.rs.html#15-39">source</a></span><a href="#impl-Spec%3CFp%2C%203_usize%2C%202_usize%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Spec.html" title="trait halo2_gadgets::poseidon::primitives::Spec">Spec</a><Fp, 3_usize, 2_usize> for <a class="struct" href="struct.P128Pow5T3.html" title="struct halo2_gadgets::poseidon::primitives::P128Pow5T3">P128Pow5T3</a></h3></section><section id="impl-Spec%3CFq%2C%203_usize%2C%202_usize%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../src/halo2_gadgets/poseidon/primitives/p128pow5t3.rs.html#41-65">source</a></span><a href="#impl-Spec%3CFq%2C%203_usize%2C%202_usize%3E" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Spec.html" title="trait halo2_gadgets::poseidon::primitives::Spec">Spec</a><Fq, 3_usize, 2_usize> for <a class="struct" href="struct.P128Pow5T3.html" title="struct halo2_gadgets::poseidon::primitives::P128Pow5T3">P128Pow5T3</a></h3></section></div><script type="text/javascript" src="../../../implementors/halo2_gadgets/poseidon/primitives/trait.Spec.js" data-ignore-extern-crates="" 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.63.0-nightly (10f4ce324 2022-06-22)" ></div>
|
||
</body></html> |