<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="The set of circuit instructions required to use the ECC gadgets."><metaname="keywords"content="rust, rustlang, rust-lang, EccInstructions"><title>EccInstructions in halo2_gadgets::ecc - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"href="../../normalize.css"><linkrel="stylesheet"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"href="../../ayu.css"disabled><linkrel="stylesheet"href="../../dark.css"disabled><linkrel="stylesheet"href="../../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../../storage.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../main.js"></script><noscript><linkrel="stylesheet"href="../../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../../favicon.svg"><linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.css"integrity="sha384-9eLZqc9ds8eNjO3TmqPeYcDj8n+Qfa4nuSiGYa6DjLNcv9BtN69ZIulL9+8CqC9Y"crossorigin="anonymous">
type <ahref="#associatedtype.NonIdentityPoint"class="associatedtype">NonIdentityPoint</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>;
type <ahref="#associatedtype.X"class="associatedtype">X</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>;
type <ahref="#associatedtype.FixedPoints"class="associatedtype">FixedPoints</a>: <aclass="trait"href="trait.FixedPoints.html"title="trait halo2_gadgets::ecc::FixedPoints">FixedPoints</a><C>;
</details>}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>The set of circuit instructions required to use the ECC gadgets.</p>
<p>This type is treated as a full-width scalar. However, if <code>Self</code> implements
<ahref="trait.BaseFitsInScalarInstructions.html"title="BaseFitsInScalarInstructions"><code>BaseFitsInScalarInstructions</code></a> then this may also be constructed from an element
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="associatedtype.ScalarFixed"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#27">source</a><h4class="code-header">type <ahref="#associatedtype.ScalarFixed"class="associatedtype">ScalarFixed</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a></h4></section></summary><divclass="docblock"><p>Variable representing a full-width element of the elliptic curve’s
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="associatedtype.ScalarFixedShort"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#32">source</a><h4class="code-header">type <ahref="#associatedtype.ScalarFixedShort"class="associatedtype">ScalarFixedShort</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a></h4></section></summary><divclass="docblock"><p>Variable representing a signed short element of the elliptic curve’s
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="associatedtype.X"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#39">source</a><h4class="code-header">type <ahref="#associatedtype.X"class="associatedtype">X</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a></h4></section></summary><divclass="docblock"><p>Variable representing the affine short Weierstrass x-coordinate of an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="associatedtype.FixedPoints"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#44">source</a><h4class="code-header">type <ahref="#associatedtype.FixedPoints"class="associatedtype">FixedPoints</a>: <aclass="trait"href="trait.FixedPoints.html"title="trait halo2_gadgets::ecc::FixedPoints">FixedPoints</a><C></h4></section></summary><divclass="docblock"><p>Enumeration of the set of fixed bases to be used in scalar mul.
</div></details></div><h2id="required-methods"class="small-section-header">Required Methods<ahref="#required-methods"class="anchor"></a></h2><divclass="methods"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="tymethod.constrain_equal"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#47-52">source</a><h4class="code-header">fn <ahref="#tymethod.constrain_equal"class="fnname">constrain_equal</a>(<br> &self,<br> layouter: &mut impl Layouter<C::Base>,<br> a: &Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.Point"title="type halo2_gadgets::ecc::EccInstructions::Point">Point</a>,<br> b: &Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.Point"title="type halo2_gadgets::ecc::EccInstructions::Point">Point</a><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error></h4></section></summary><divclass="docblock"><p>Constrains point <code>a</code> to be equal in value to point <code>b</code>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="tymethod.witness_point"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#57-61">source</a><h4class="code-header">fn <ahref="#tymethod.witness_point"class="fnname">witness_point</a>(<br> &self,<br> layouter: &mut impl Layouter<C::Base>,<br> value: Value<C><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.Point"title="type halo2_gadgets::ecc::EccInstructions::Point">Point</a>, Error></h4></section></summary><divclass="docblock"><p>Witnesses the given point as a private input to the circuit.
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="tymethod.witness_point_non_id"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#65-69">source</a><h4class="code-header">fn <ahref="#tymethod.witness_point_non_id"class="fnname">witness_point_non_id</a>(<br> &self,<br> layouter: &mut impl Layouter<C::Base>,<br> value: Value<C><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.NonIdentityPoint"title="type halo2_gadgets::ecc::EccInstructions::NonIdentityPoint">NonIdentityPoint</a>, Error></h4></section></summary><divclass="docblock"><p>Witnesses the given point as a private input to the circuit.
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="tymethod.witness_scalar_var"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#72-76">source</a><h4class="code-header">fn <ahref="#tymethod.witness_scalar_var"class="fnname">witness_scalar_var</a>(<br> &self,<br> layouter: &mut impl Layouter<C::Base>,<br> value: Value<C::Scalar><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.ScalarVar"title="type halo2_gadgets::ecc::EccInstructions::ScalarVar">ScalarVar</a>, Error></h4></section></summary><divclass="docblock"><p>Witnesses a full-width scalar to be used in variable-base multiplication.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="tymethod.witness_scalar_fixed"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#79-83">source</a><h4class="code-header">fn <ahref="#tymethod.witness_scalar_fixed"class="fnname">witness_scalar_fixed</a>(<br> &self,<br> layouter: &mut impl Layouter<C::Base>,<br> value: Value<C::Scalar><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.ScalarFixed"title="type halo2_gadgets::ecc::EccInstructions::ScalarFixed">ScalarFixed</a>, Error></h4></section></summary><divclass="docblock"><p>Witnesses a full-width scalar to be used in fixed-base multiplication.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="tymethod.scalar_fixed_from_signed_short"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#87-91">source</a><h4class="code-header">fn <ahref="#tymethod.scalar_fixed_from_signed_short"class="fnname">scalar_fixed_from_signed_short</a>(<br> &self,<br> layouter: &mut impl Layouter<C::Base>,<br> magnitude_sign: (Self::<aclass="associatedtype"href="../utilities/trait.UtilitiesInstructions.html#associatedtype.Var"title="type halo2_gadgets::utilities::UtilitiesInstructions::Var">Var</a>, Self::<aclass="associatedtype"href="../utilities/trait.UtilitiesInstructions.html#associatedtype.Var"title="type halo2_gadgets::utilities::UtilitiesInstructions::Var">Var</a>)<br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.ScalarFixedShort"title="type halo2_gadgets::ecc::EccInstructions::ScalarFixedShort">ScalarFixedShort</a>, Error></h4></section></summary><divclass="docblock"><p>Converts a magnitude and sign that exists as variables in the circuit into a
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="tymethod.mul_fixed_base_field_elem"class="method has-srclink"><aclass="srclink rightside"href="../../src/halo2_gadgets/ecc.rs.html#142-147">source</a><h4class="code-header">fn <ahref="#tymethod.mul_fixed_base_field_elem"class="fnname">mul_fixed_base_field_elem</a>(<br> &self,<br> layouter: &mut impl Layouter<C::Base>,<br> base_field_elem: Self::<aclass="associatedtype"href="../utilities/trait.UtilitiesInstructions.html#associatedtype.Var"title="type halo2_gadgets::utilities::UtilitiesInstructions::Var">Var</a>,<br> base: &<Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.FixedPoints"title="type halo2_gadgets::ecc::EccInstructions::FixedPoints">FixedPoints</a> as <aclass="trait"href="trait.FixedPoints.html"title="trait halo2_gadgets::ecc::FixedPoints">FixedPoints</a><C>>::<aclass="associatedtype"href="trait.FixedPoints.html#associatedtype.Base"title="type halo2_gadgets::ecc::FixedPoints::Base">Base</a><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self::<aclass="associatedtype"href="trait.EccInstructions.html#associatedtype.Point"title="type halo2_gadgets::ecc::EccInstructions::Point">Point</a>, Error></h4></section></summary><divclass="docblock"><p>Performs fixed-base scalar multiplication using a base field element as the scalar.
