<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="The set of circuit instructions required to use the Poseidon permutation."><title>PoseidonInstructions in halo2_gadgets::poseidon - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-f3501f0f5ae15dfb.css"id="mainThemeStyle"><divid="rustdoc-vars"data-root-path="../../"data-static-root-path="../../static.files/"data-current-crate="halo2_gadgets"data-themes=""data-resource-suffix=""data-rustdoc-version="1.71.0-nightly (8b4b20836 2023-05-22)"data-search-js="search-4926e5fc22a5646a.js"data-settings-js="settings-de11bff964e9d4e5.js"data-settings-css="settings-6f6ffb5395b17c6e.css"data-theme-light-css="light-0f8c037637f9eb3e.css"data-theme-dark-css="dark-1097f8e92a01e3cf.css"data-theme-ayu-css="ayu-614652228113ac93.css"></div><scriptsrc="../../static.files/storage-62ce34ea385b278a.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-f0540c1d82cde29b.js"></script><noscript><linkrel="stylesheet"media="(prefers-color-scheme:light)"href="../../static.files/light-0f8c037637f9eb3e.css"><linkrel="stylesheet"media="(prefers-color-scheme:dark)"href="../../static.files/dark-1097f8e92a01e3cf.css"><linkrel="stylesheet"href="../../static.files/noscript-13285aec31fa243e.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"><linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.css"integrity="sha384-9eLZqc9ds8eNjO3TmqPeYcDj8n+Qfa4nuSiGYa6DjLNcv9BtN69ZIulL9+8CqC9Y"crossorigin="anonymous">
</head><bodyclass="rustdoc trait"><!--[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="logo-container"href="../../halo2_gadgets/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2></h2></nav><navclass="sidebar"><aclass="logo-container"href="../../halo2_gadgets/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2class="location"><ahref="#">PoseidonInstructions</a></h2><divclass="sidebar-elems"><section><h3><ahref="#required-associated-types">Required Associated Types</a></h3><ulclass="block"><li><ahref="#associatedtype.Word">Word</a></li></ul><h3><ahref="#required-methods">Required Methods</a></h3><ulclass="block"><li><ahref="#tymethod.permute">permute</a></li></ul><h3><ahref="#implementors">Implementors</a></h3></section><h2><ahref="index.html">In halo2_gadgets::poseidon</a></h2></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><ahref="../../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Trait <ahref="../index.html">halo2_gadgets</a>::<wbr><ahref="index.html">poseidon</a>::<wbr><aclass="trait"href="#">PoseidonInstructions</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="srclink"href="../../src/halo2_gadgets/poseidon.rs.html#29-41">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub trait PoseidonInstructions<F: Field, S: <aclass="trait"href="primitives/trait.Spec.html"title="trait halo2_gadgets::poseidon::primitives::Spec">Spec</a><F, T, RATE>, const T: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, const RATE: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>: Chip<F> {
}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>The set of circuit instructions required to use the Poseidon permutation.</p>
) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><[Self::<aclass="associatedtype"href="trait.PoseidonInstructions.html#associatedtype.Word"title="type halo2_gadgets::poseidon::PoseidonInstructions::Word">Word</a>; <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.array.html">T</a>], Error></h4></section></summary><divclass="docblock"><p>Applies the Poseidon permutation to the given state.</p>