halo2/rustdoc/latest/halo2_gadgets/ecc/chip/constants/index.html

22 lines
8.3 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="Constants required for the ECC chip."><title>halo2_gadgets::ecc::chip::constants - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="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.75.0-nightly (2bbb61989 2023-10-04)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-2c020d218678b618.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="logo-container" href="../../../../halo2_gadgets/index.html"><img class="rust-logo" src="../../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../../../../halo2_gadgets/index.html"><img class="rust-logo" src="../../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module constants</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="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"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../../index.html">halo2_gadgets</a>::<wbr><a href="../../index.html">ecc</a>::<wbr><a href="../index.html">chip</a>::<wbr><a class="mod" href="#">constants</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../../src/halo2_gadgets/ecc/chip/constants.rs.html#1-277">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Constants required for the ECC chip.</p>
</div></details><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.FIXED_BASE_WINDOW_SIZE.html" title="constant halo2_gadgets::ecc::chip::constants::FIXED_BASE_WINDOW_SIZE">FIXED_BASE_WINDOW_SIZE</a></div><div class="desc docblock-short">Window size for fixed-base scalar multiplication</div></li><li><div class="item-name"><a class="constant" href="constant.H.html" title="constant halo2_gadgets::ecc::chip::constants::H">H</a></div><div class="desc docblock-short">$2^{<code>FIXED_BASE_WINDOW_SIZE</code>}$</div></li><li><div class="item-name"><a class="constant" href="constant.NUM_WINDOWS.html" title="constant halo2_gadgets::ecc::chip::constants::NUM_WINDOWS">NUM_WINDOWS</a></div><div class="desc docblock-short">Number of windows for a full-width scalar</div></li><li><div class="item-name"><a class="constant" href="constant.NUM_WINDOWS_SHORT.html" title="constant halo2_gadgets::ecc::chip::constants::NUM_WINDOWS_SHORT">NUM_WINDOWS_SHORT</a></div><div class="desc docblock-short">Number of windows for a short signed scalar</div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.compute_lagrange_coeffs.html" title="fn halo2_gadgets::ecc::chip::constants::compute_lagrange_coeffs">compute_lagrange_coeffs</a></div><div class="desc docblock-short">For each window, we interpolate the $x$-coordinate.
Here, we pre-compute and store the coefficients of the interpolation polynomial.</div></li><li><div class="item-name"><a class="fn" href="fn.find_zs_and_us.html" title="fn halo2_gadgets::ecc::chip::constants::find_zs_and_us">find_zs_and_us</a></div><div class="desc docblock-short">For each window, $z$ is a field element such that for each point $(x, y)$ in the window:</div></li><li><div class="item-name"><a class="fn" href="fn.test_lagrange_coeffs.html" title="fn halo2_gadgets::ecc::chip::constants::test_lagrange_coeffs">test_lagrange_coeffs</a><span class="stab portability" title="Available on crate feature `test-dependencies` only"><code>test-dependencies</code></span></div><div class="desc docblock-short">Test that Lagrange interpolation coefficients reproduce the correct x-coordinate
for each fixed-base multiple in each window.</div></li><li><div class="item-name"><a class="fn" href="fn.test_zs_and_us.html" title="fn halo2_gadgets::ecc::chip::constants::test_zs_and_us">test_zs_and_us</a><span class="stab portability" title="Available on crate feature `test-dependencies` only"><code>test-dependencies</code></span></div><div class="desc docblock-short">Test that the z-values and u-values satisfy the conditions:
1. z + y = u^2,
2. z - y is not a square
for the y-coordinate of each fixed-base multiple in each window.</div></li></ul></section></div></main></body></html>