halo2/rustdoc/latest/halo2_gadgets/sinsemilla/primitives/index.html

28 lines
8.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Implementation of Sinsemilla outside the circuit."><meta name="keywords" content="rust, rustlang, rust-lang, primitives"><title>halo2_gadgets::sinsemilla::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" 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="../../../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"><!--[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">&#9776;</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="#">Module primitives</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</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">Module <a href="../../index.html">halo2_gadgets</a>::<wbr><a href="../index.html">sinsemilla</a>::<wbr><a class="mod" href="#">primitives</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/sinsemilla/primitives.rs.html#1-308">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implementation of Sinsemilla outside the circuit.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CommitDomain.html" title="halo2_gadgets::sinsemilla::primitives::CommitDomain struct">CommitDomain</a></div><div class="item-right docblock-short"><p>A domain in which $\mathsf{SinsemillaCommit}$ and $\mathsf{SinsemillaShortCommit}$ can
be used.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.HashDomain.html" title="halo2_gadgets::sinsemilla::primitives::HashDomain struct">HashDomain</a></div><div class="item-right docblock-short"><p>A domain in which $\mathsf{SinsemillaHashToPoint}$ and $\mathsf{SinsemillaHash}$ can
be used.</p>
</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.C.html" title="halo2_gadgets::sinsemilla::primitives::C constant">C</a></div><div class="item-right docblock-short"><p>The largest integer such that $2^c \leq (r_P - 1) / 2$, where $r_P$ is the order
of Pallas.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.INV_TWO_POW_K.html" title="halo2_gadgets::sinsemilla::primitives::INV_TWO_POW_K constant">INV_TWO_POW_K</a></div><div class="item-right docblock-short"><p>$\frac{1}{2^K}$</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.K.html" title="halo2_gadgets::sinsemilla::primitives::K constant">K</a></div><div class="item-right docblock-short"><p>Number of bits of each message piece in $\mathsf{SinsemillaHashToPoint}$</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.Q_PERSONALIZATION.html" title="halo2_gadgets::sinsemilla::primitives::Q_PERSONALIZATION constant">Q_PERSONALIZATION</a></div><div class="item-right docblock-short"><p>SWU hash-to-curve personalization for Sinsemilla $Q$ generators.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.SINSEMILLA_S.html" title="halo2_gadgets::sinsemilla::primitives::SINSEMILLA_S constant">SINSEMILLA_S</a></div><div class="item-right docblock-short"><p>The precomputed bases for the <a href="https://zips.z.cash/protocol/protocol.pdf#concretesinsemillahash">Sinsemilla hash function</a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.S_PERSONALIZATION.html" title="halo2_gadgets::sinsemilla::primitives::S_PERSONALIZATION constant">S_PERSONALIZATION</a></div><div class="item-right docblock-short"><p>SWU hash-to-curve personalization for Sinsemilla $S$ generators.</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.65.0-nightly (59e7a308e 2022-09-11)" ></div></body></html>