</head><bodyclass="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../../halo2_gadgets/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">Module poseidon</a></h2><divclass="sidebar-elems"><section><divclass="block"><ul><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#traits">Traits</a></li></ul></div></section><divid="sidebar-vars"data-name="poseidon"data-ty="mod"data-relpath="./"></div><scriptdefersrc="./sidebar-items.js"></script></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../../halo2_gadgets/index.html"><imgclass="rust-logo"src="../../rust-logo.svg"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="22"height="22"alt="Pick another theme!"src="../../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading">
<h1class="fqn"><spanclass="in-band">Module <ahref="../index.html">halo2_gadgets</a>::<wbr><aclass="mod"href="#">poseidon</a><buttonid="copy-path"onclick="copy_path(this)"title="Copy item path to clipboard"><imgsrc="../../clipboard.svg"width="19"height="18"alt="Copy item path"></button></span></h1><spanclass="out-of-band"><aclass="srclink"href="../../src/halo2_gadgets/poseidon.rs.html#1-298">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Gadget and chips for the Poseidon algebraic hash function.</p>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.Hash.html"title="halo2_gadgets::poseidon::Hash struct">Hash</a></div><divclass="item-right docblock-short"><p>A Poseidon hash function, built around a sponge.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.Pow5Chip.html"title="halo2_gadgets::poseidon::Pow5Chip struct">Pow5Chip</a></div><divclass="item-right docblock-short"><p>A Poseidon chip using an $x^5$ S-Box.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.Pow5Config.html"title="halo2_gadgets::poseidon::Pow5Config struct">Pow5Config</a></div><divclass="item-right docblock-short"><p>Configuration for a <ahref="struct.Pow5Chip.html"title="Pow5Chip"><code>Pow5Chip</code></a>.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.StateWord.html"title="halo2_gadgets::poseidon::StateWord struct">StateWord</a></div><divclass="item-right docblock-short"><p>A word in the Poseidon state.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="struct"href="struct.Word.html"title="halo2_gadgets::poseidon::Word struct">Word</a></div><divclass="item-right docblock-short"><p>A word over which the Poseidon permutation operates.</p>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="enum"href="enum.PaddedWord.html"title="halo2_gadgets::poseidon::PaddedWord enum">PaddedWord</a></div><divclass="item-right docblock-short"><p>A word from the padded input to a Poseidon sponge.</p>
<divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="trait"href="trait.PoseidonInstructions.html"title="halo2_gadgets::poseidon::PoseidonInstructions trait">PoseidonInstructions</a></div><divclass="item-right docblock-short"><p>The set of circuit instructions required to use the Poseidon permutation.</p>
</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="trait"href="trait.PoseidonSpongeInstructions.html"title="halo2_gadgets::poseidon::PoseidonSpongeInstructions trait">PoseidonSpongeInstructions</a></div><divclass="item-right docblock-short"><p>The set of circuit instructions required to use the <ahref="struct.Sponge.html"title="Sponge"><code>Sponge</code></a> and <ahref="struct.Hash.html"><code>Hash</code></a> gadgets.</p>