Skip to content

Commit

Permalink
deploy: 977fc5f
Browse files Browse the repository at this point in the history
  • Loading branch information
@adria0
adria0 committed Sep 24, 2024
1 parent 0ffc18e commit a08eca5
Show file tree
Hide file tree
Showing 88 changed files with 282 additions and 280 deletions.
2 changes: 1 addition & 1 deletion halo2_backend/multicore/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
});
</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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../halo2_backend/index.html">halo2_backend</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">Module multicore</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate halo2_backend</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">halo2_backend</a>::<wbr><a class="mod" href="#">multicore</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/halo2_middleware/lib.rs.html#4">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Scope.html" title="struct halo2_backend::multicore::Scope">Scope</a></div><div class="desc docblock-short">Represents a fork-join scope which can be used to spawn any number of tasks.
</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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../halo2_backend/index.html">halo2_backend</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">Module multicore</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate halo2_backend</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">halo2_backend</a>::<wbr><a class="mod" href="#">multicore</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Scope.html" title="struct halo2_backend::multicore::Scope">Scope</a></div><div class="desc docblock-short">Represents a fork-join scope which can be used to spawn any number of tasks.
See <a href="fn.scope.html"><code>scope()</code></a> for more information.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.IndexedParallelIterator.html" title="trait halo2_backend::multicore::IndexedParallelIterator">IndexedParallelIterator</a></div><div class="desc docblock-short">An iterator that supports “random access” to its data, meaning
that you can split it at arbitrary indices and draw data from
those points.</div></li><li><div class="item-name"><a class="trait" href="trait.IntoParallelIterator.html" title="trait halo2_backend::multicore::IntoParallelIterator">IntoParallelIterator</a></div><div class="desc docblock-short"><code>IntoParallelIterator</code> implements the conversion to a <a href="trait.ParallelIterator.html"><code>ParallelIterator</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.IntoParallelRefIterator.html" title="trait halo2_backend::multicore::IntoParallelRefIterator">IntoParallelRefIterator</a></div><div class="desc docblock-short"><code>IntoParallelRefIterator</code> implements the conversion to a
Expand Down
6 changes: 3 additions & 3 deletions halo2_backend/multicore/trait.TryFoldAndReduce.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@
});
</script>

</head><body class="rustdoc trait"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../halo2_backend/index.html">halo2_backend</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">TryFoldAndReduce</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.try_fold_and_reduce">try_fold_and_reduce</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In halo2_backend::multicore</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">halo2_backend</a>::<wbr><a href="index.html">multicore</a>::<wbr><a class="trait" href="#">TryFoldAndReduce</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/halo2_middleware/multicore.rs.html#10">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TryFoldAndReduce&lt;T, E&gt; {
</head><body class="rustdoc trait"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../halo2_backend/index.html">halo2_backend</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">TryFoldAndReduce</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.try_fold_and_reduce">try_fold_and_reduce</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In halo2_backend::multicore</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">halo2_backend</a>::<wbr><a href="index.html">multicore</a>::<wbr><a class="trait" href="#">TryFoldAndReduce</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TryFoldAndReduce&lt;T, E&gt; {
// Required method
fn <a href="#tymethod.try_fold_and_reduce" class="fn">try_fold_and_reduce</a>(
self,
identity: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -&gt; T + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
fold_op: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(T, <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;;
}</code></pre><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.try_fold_and_reduce" class="method"><a class="src rightside" href="../../src/halo2_middleware/multicore.rs.html#17-21">source</a><h4 class="code-header">fn <a href="#tymethod.try_fold_and_reduce" class="fn">try_fold_and_reduce</a>(
}</code></pre><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.try_fold_and_reduce" class="method"><h4 class="code-header">fn <a href="#tymethod.try_fold_and_reduce" class="fn">try_fold_and_reduce</a>(
self,
identity: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -&gt; T + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
fold_op: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(T, <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
Expand All @@ -31,7 +31,7 @@
The <code>try_fold_and_reduce</code> function can only be called by a iter with
<code>Result&lt;T, E&gt;</code> item type because the <code>fold_op</code> must meet the trait
bounds of both <code>try_fold</code> and <code>try_reduce</code> from rayon. </p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-TryFoldAndReduce%3CT,+E%3E-for-I" class="impl"><a class="src rightside" href="../../src/halo2_middleware/multicore.rs.html#24-28">source</a><a href="#impl-TryFoldAndReduce%3CT,+E%3E-for-I" class="anchor">§</a><h3 class="code-header">impl&lt;T, E, I&gt; <a class="trait" href="trait.TryFoldAndReduce.html" title="trait halo2_backend::multicore::TryFoldAndReduce">TryFoldAndReduce</a>&lt;T, E&gt; for I<div class="where">where
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-TryFoldAndReduce%3CT,+E%3E-for-I" class="impl"><a href="#impl-TryFoldAndReduce%3CT,+E%3E-for-I" class="anchor">§</a><h3 class="code-header">impl&lt;T, E, I&gt; <a class="trait" href="trait.TryFoldAndReduce.html" title="trait halo2_backend::multicore::TryFoldAndReduce">TryFoldAndReduce</a>&lt;T, E&gt; for I<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
I: <a class="trait" href="trait.ParallelIterator.html" title="trait halo2_backend::multicore::ParallelIterator">ParallelIterator</a>&lt;Item = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;&gt;,</div></h3></section></div><script src="../../trait.impl/halo2_middleware/multicore/trait.TryFoldAndReduce.js" async></script></section></div></main></body></html>
4 changes: 2 additions & 2 deletions halo2_backend/plonk/enum.Error.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
current_k: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
},
InstanceTooLarge,
ColumnNotInPermutation(<a class="struct" href="../../halo2_middleware/circuit/struct.ColumnMid.html" title="struct halo2_middleware::circuit::ColumnMid">ColumnMid</a>),
ColumnNotInPermutation(ColumnMid),
Other(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This is an error that could occur during proving.</p>
</div></details><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.InvalidInstances" class="variant"><a href="#variant.InvalidInstances" class="anchor">§</a><h3 class="code-header">InvalidInstances</h3></section><div class="docblock"><p>The provided instances do not match the circuit parameters.</p>
Expand All @@ -35,7 +35,7 @@
</div><section id="variant.NotEnoughRowsAvailable" class="variant"><a href="#variant.NotEnoughRowsAvailable" class="anchor">§</a><h3 class="code-header">NotEnoughRowsAvailable</h3></section><div class="docblock"><p><code>k</code> is too small for the given circuit.</p>
</div><div class="sub-variant" id="variant.NotEnoughRowsAvailable.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.NotEnoughRowsAvailable.field.current_k" class="section-header"><a href="#variant.NotEnoughRowsAvailable.field.current_k" class="anchor field">§</a><code>current_k: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><div class="docblock"><p>The current value of <code>k</code> being used.</p>
</div></div></div><section id="variant.InstanceTooLarge" class="variant"><a href="#variant.InstanceTooLarge" class="anchor">§</a><h3 class="code-header">InstanceTooLarge</h3></section><div class="docblock"><p>Instance provided exceeds number of available rows</p>
</div><section id="variant.ColumnNotInPermutation" class="variant"><a href="#variant.ColumnNotInPermutation" class="anchor">§</a><h3 class="code-header">ColumnNotInPermutation(<a class="struct" href="../../halo2_middleware/circuit/struct.ColumnMid.html" title="struct halo2_middleware::circuit::ColumnMid">ColumnMid</a>)</h3></section><div class="docblock"><p>The instance sets up a copy constraint involving a column that has not been
</div><section id="variant.ColumnNotInPermutation" class="variant"><a href="#variant.ColumnNotInPermutation" class="anchor">§</a><h3 class="code-header">ColumnNotInPermutation(ColumnMid)</h3></section><div class="docblock"><p>The instance sets up a copy constraint involving a column that has not been
included in the permutation.</p>
</div><section id="variant.Other" class="variant"><a href="#variant.Other" class="anchor">§</a><h3 class="code-header">Other(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</h3></section><div class="docblock"><p>Generic error not covered by previous cases</p>
</div></div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Error" class="impl"><a class="src rightside" href="../../src/halo2_backend/plonk/error.rs.html#41-46">source</a><a href="#impl-Error" class="anchor">§</a><h3 class="code-header">impl <a class="enum" href="enum.Error.html" title="enum halo2_backend::plonk::Error">Error</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.not_enough_rows_available" class="method"><a class="src rightside" href="../../src/halo2_backend/plonk/error.rs.html#43-45">source</a><h4 class="code-header">pub fn <a href="#method.not_enough_rows_available" class="fn">not_enough_rows_available</a>(current_k: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Constructs an <code>Error::NotEnoughRowsAvailable</code>.</p>
Expand Down
Loading

0 comments on commit a08eca5

Please sign in to comment.