mirror of https://github.com/zcash/halo2.git
41 lines
7.6 KiB
HTML
41 lines
7.6 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="This crate provides various common gadgets and chips for use with `halo2_proofs`."><meta name="keywords" content="rust, rustlang, rust-lang, halo2_gadgets"><title>halo2_gadgets - 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="../crates.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 mod crate"><!--[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="#">Crate halo2_gadgets</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.2.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#modules">Modules</a></li></ul></div></section></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">Crate <a class="mod" href="#">halo2_gadgets</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/lib.rs.html#1-32">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate provides various common gadgets and chips for use with <code>halo2_proofs</code>.</p>
|
||
<h2 id="gadgets"><a href="#gadgets">Gadgets</a></h2>
|
||
<p>Gadgets are an abstraction for writing reusable and interoperable circuit logic. They
|
||
do not create any circuit constraints or assignments themselves, instead interacting
|
||
with the circuit through a defined “instruction set”. A circuit developer uses gadgets
|
||
by instantiating them with a particular choice of chip.</p>
|
||
<h2 id="chips"><a href="#chips">Chips</a></h2>
|
||
<p>Chips implement the low-level circuit constraints. The same instructions may be
|
||
implemented by multiple chips, enabling different performance trade-offs to be made.
|
||
Chips can be highly optimised by their developers, as long as they conform to the
|
||
defined instructions.</p>
|
||
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="ecc/index.html" title="halo2_gadgets::ecc mod">ecc</a></div><div class="item-right docblock-short"><p>Elliptic curve operations.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="poseidon/index.html" title="halo2_gadgets::poseidon mod">poseidon</a></div><div class="item-right docblock-short"><p>The Poseidon algebraic hash function.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sha256/index.html" title="halo2_gadgets::sha256 mod">sha256</a><span class="stab portability" title="Available on crate feature `unstable` only"><code>unstable</code></span></div><div class="item-right docblock-short"><p>The <a href="https://tools.ietf.org/html/rfc6234">SHA-256</a> hash function.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sinsemilla/index.html" title="halo2_gadgets::sinsemilla mod">sinsemilla</a></div><div class="item-right docblock-short"><p>The <a href="https://zips.z.cash/protocol/protocol.pdf#concretesinsemillahash">Sinsemilla</a> hash function.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="utilities/index.html" title="halo2_gadgets::utilities mod">utilities</a></div><div class="item-right docblock-short"><p>Utility gadgets.</p>
|
||
</div></div></div></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.64.0-nightly (7665c3543 2022-07-06)" ></div>
|
||
</body></html> |