halo2/rustdoc/latest/halo2_proofs/poly/index.html

27 lines
10 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="Contains utilities for performing arithmetic over univariate polynomials in various forms, including computing commitments to them and provably opening the committed polynomials at arbitrary points."><meta name="keywords" content="rust, rustlang, rust-lang, poly"><title>halo2_proofs::poly - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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-124a1ca42af929b6.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-cd23e1e4557aa9dd.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-a21928845c7a186a.css"><link rel="stylesheet" disabled href="../../static.files/dark-90fc67ff25a42f29.css"><link rel="stylesheet" disabled href="../../static.files/ayu-d75a8bbde915b8ed.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/main-458bffc4c06ccf37.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.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="sidebar-logo" href="../../halo2_proofs/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../halo2_proofs/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module poly</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</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" 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-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">halo2_proofs</a>::<wbr><a class="mod" href="#">poly</a><button id="copy-path" onclick="copy_path(this)" 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="srclink" href="../../src/halo2_proofs/poly.rs.html#1-365">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Contains utilities for performing arithmetic over univariate polynomials in
various forms, including computing commitments to them and provably opening
the committed polynomials at arbitrary points.</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="commitment/index.html" title="halo2_proofs::poly::commitment mod">commitment</a></div><div class="item-right docblock-short">This module contains an implementation of the polynomial commitment scheme
described in the <a href="https://eprint.iacr.org/2019/1021">Halo</a> paper.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="multiopen/index.html" title="halo2_proofs::poly::multiopen mod">multiopen</a></div><div class="item-right docblock-short">This module contains an optimisation of the polynomial commitment opening
scheme described in the <a href="https://eprint.iacr.org/2019/1021">Halo</a> paper.</div></div></div><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.Coeff.html" title="halo2_proofs::poly::Coeff struct">Coeff</a></div><div class="item-right docblock-short">The polynomial is defined as coefficients</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EvaluationDomain.html" title="halo2_proofs::poly::EvaluationDomain struct">EvaluationDomain</a></div><div class="item-right docblock-short">This structure contains precomputed constants and other details needed for
performing operations on an evaluation domain of size $2^k$ and an extended
domain of size $2^{k} * j$ with $j \neq 0$.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ExtendedLagrangeCoeff.html" title="halo2_proofs::poly::ExtendedLagrangeCoeff struct">ExtendedLagrangeCoeff</a></div><div class="item-right docblock-short">The polynomial is defined as coefficients of Lagrange basis polynomials in
an extended size domain which supports multiplication</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LagrangeCoeff.html" title="halo2_proofs::poly::LagrangeCoeff struct">LagrangeCoeff</a></div><div class="item-right docblock-short">The polynomial is defined as coefficients of Lagrange basis polynomials</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PinnedEvaluationDomain.html" title="halo2_proofs::poly::PinnedEvaluationDomain struct">PinnedEvaluationDomain</a></div><div class="item-right docblock-short">Represents the minimal parameters that determine an <code>EvaluationDomain</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Polynomial.html" title="halo2_proofs::poly::Polynomial struct">Polynomial</a></div><div class="item-right docblock-short">Represents a univariate polynomial defined over a field and a particular
basis.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Rotation.html" title="halo2_proofs::poly::Rotation struct">Rotation</a></div><div class="item-right docblock-short">Describes the relative rotation of a vector. Negative numbers represent
reverse (leftmost) rotations and positive numbers represent forward (rightmost)
rotations. Zero represents no rotation.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Error.html" title="halo2_proofs::poly::Error enum">Error</a></div><div class="item-right docblock-short">This is an error that could occur during proving or circuit synthesis.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Basis.html" title="halo2_proofs::poly::Basis trait">Basis</a></div><div class="item-right docblock-short">The basis over which a polynomial is described.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="halo2_proofs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.0-nightly (70f8737b2 2022-11-23)" data-search-js="search-df80cc3cb87b6482.js" data-settings-js="settings-7e1cf5cc683233f7.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>