UNPKG

@dedis/kyber

Version:

A typescript implementation of Kyber interfaces

794 lines 46.2 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>NistScalar | @dedis/kyber</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@dedis/kyber</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_curve_nist_scalar_.html">&quot;curve/nist/scalar&quot;</a> </li> <li> <a href="_curve_nist_scalar_.nistscalar.html">NistScalar</a> </li> </ul> <h1>Class NistScalar</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">NistScalar</span> </li> </ul> </section> <section class="tsd-panel"> <h3>Implements</h3> <ul class="tsd-hierarchy"> <li><a href="../interfaces/_suite_.scalar.html" class="tsd-signature-type">Scalar</a></li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#ref" class="tsd-kind-icon">ref</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#add" class="tsd-kind-icon">add</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#bytes" class="tsd-kind-icon">bytes</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#clone" class="tsd-kind-icon">clone</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#div" class="tsd-kind-icon">div</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#equals" class="tsd-kind-icon">equals</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#inspect" class="tsd-kind-icon">inspect</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#inv" class="tsd-kind-icon">inv</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#marshalbinary" class="tsd-kind-icon">marshal<wbr>Binary</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#marshalsize" class="tsd-kind-icon">marshal<wbr>Size</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#mul" class="tsd-kind-icon">mul</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#neg" class="tsd-kind-icon">neg</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#one" class="tsd-kind-icon">one</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#pick" class="tsd-kind-icon">pick</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#set" class="tsd-kind-icon">set</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#setbytes" class="tsd-kind-icon">set<wbr>Bytes</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#sub" class="tsd-kind-icon">sub</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#unmarshalbinary" class="tsd-kind-icon">unmarshal<wbr>Binary</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_curve_nist_scalar_.nistscalar.html#zero" class="tsd-kind-icon">zero</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Nist<wbr>Scalar<span class="tsd-signature-symbol">(</span>curve<span class="tsd-signature-symbol">: </span><a href="_curve_nist_curve_.weierstrass.html" class="tsd-signature-type">Weierstrass</a>, red<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L9">curve/nist/scalar.ts:9</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>curve: <a href="_curve_nist_curve_.weierstrass.html" class="tsd-signature-type">Weierstrass</a></h5> </li> <li> <h5>red: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="ref" class="tsd-anchor"></a> <h3>ref</h3> <div class="tsd-signature tsd-kind-icon">ref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L9">curve/nist/scalar.ts:9</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5> </li> <li class="tsd-parameter"> <h5>curve<span class="tsd-signature-symbol">: </span><a href="_curve_nist_curve_.weierstrass.html" class="tsd-signature-type">Weierstrass</a></h5> </li> <li class="tsd-parameter"> <h5>red<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="add" class="tsd-anchor"></a> <h3>add</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>s1<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a>, s2<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#add">add</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L38">curve/nist/scalar.ts:38</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>s1: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> <li> <h5>s2: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the new scalar resulting from the sum</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="bytes" class="tsd-anchor"></a> <h3>bytes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">bytes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L86">curve/nist/scalar.ts:86</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="clone" class="tsd-anchor"></a> <h3>clone</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#clone">clone</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L25">curve/nist/scalar.ts:25</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>a new clone of the scalar</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="div" class="tsd-anchor"></a> <h3>div</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">div<span class="tsd-signature-symbol">(</span>s1<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a>, s2<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#div">div</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L68">curve/nist/scalar.ts:68</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>s1: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> <li> <h5>s2: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the new scalar resulting from the division</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="equals" class="tsd-anchor"></a> <h3>equals</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">equals<span class="tsd-signature-symbol">(</span>s2<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#equals">equals</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L124">curve/nist/scalar.ts:124</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>s2: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>true when both are equal</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="inspect" class="tsd-anchor"></a> <h3>inspect</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">inspect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L136">curve/nist/scalar.ts:136</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="inv" class="tsd-anchor"></a> <h3>inv</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">inv<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#inv">inv</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L74">curve/nist/scalar.ts:74</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>a: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the new scalar resulting from the inversion</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="marshalbinary" class="tsd-anchor"></a> <h3>marshal<wbr>Binary</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">marshal<wbr>Binary<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#marshalbinary">marshalBinary</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L104">curve/nist/scalar.ts:104</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> <p>the buffer</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="marshalsize" class="tsd-anchor"></a> <h3>marshal<wbr>Size</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">marshal<wbr>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#marshalsize">marshalSize</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L99">curve/nist/scalar.ts:99</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <p>the length as a number</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="mul" class="tsd-anchor"></a> <h3>mul</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">mul<span class="tsd-signature-symbol">(</span>s1<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a>, s2<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#mul">mul</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L62">curve/nist/scalar.ts:62</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>s1: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> <li> <h5>s2: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the new scalar resulting from the multiplication</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="neg" class="tsd-anchor"></a> <h3>neg</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">neg<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#neg">neg</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L50">curve/nist/scalar.ts:50</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>a: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the negative scalar</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="one" class="tsd-anchor"></a> <h3>one</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">one<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#one">one</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L56">curve/nist/scalar.ts:56</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the scalar</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="pick" class="tsd-anchor"></a> <h3>pick</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">pick<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L91">curve/nist/scalar.ts:91</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>length: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="set" class="tsd-anchor"></a> <h3>set</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#set">set</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L19">curve/nist/scalar.ts:19</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>a: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the current scalar set to the new value</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setbytes" class="tsd-anchor"></a> <h3>set<wbr>Bytes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Bytes<span class="tsd-signature-symbol">(</span>b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#setbytes">setBytes</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L80">curve/nist/scalar.ts:80</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>b: <span class="tsd-signature-type">Buffer</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the scalar</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="sub" class="tsd-anchor"></a> <h3>sub</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">sub<span class="tsd-signature-symbol">(</span>s1<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a>, s2<span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#sub">sub</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L44">curve/nist/scalar.ts:44</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>s1: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> <li> <h5>s2: <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the new scalar resulting from the subtraction</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="tostring" class="tsd-anchor"></a> <h3>to<wbr>String</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L129">curve/nist/scalar.ts:129</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="unmarshalbinary" class="tsd-anchor"></a> <h3>unmarshal<wbr>Binary</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">unmarshal<wbr>Binary<span class="tsd-signature-symbol">(</span>bytes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#unmarshalbinary">unmarshalBinary</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L111">curve/nist/scalar.ts:111</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>bytes: <span class="tsd-signature-type">Buffer</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="zero" class="tsd-anchor"></a> <h3>zero</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">zero<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Implementation of <a href="../interfaces/_suite_.scalar.html">Scalar</a>.<a href="../interfaces/_suite_.scalar.html#zero">zero</a></p> <ul> <li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/curve/nist/scalar.ts#L32">curve/nist/scalar.ts:32</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-signature-type">NistScalar</a></h4> <p>the scalar</p> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_curve_nist_scalar_.html">"curve/nist/scalar"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_curve_nist_scalar_.nistscalar.html" class="tsd-kind-icon">Nist<wbr>Scalar</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#ref" class="tsd-kind-icon">ref</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#add" class="tsd-kind-icon">add</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#bytes" class="tsd-kind-icon">bytes</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#clone" class="tsd-kind-icon">clone</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#div" class="tsd-kind-icon">div</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#equals" class="tsd-kind-icon">equals</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#inspect" class="tsd-kind-icon">inspect</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#inv" class="tsd-kind-icon">inv</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#marshalbinary" class="tsd-kind-icon">marshal<wbr>Binary</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#marshalsize" class="tsd-kind-icon">marshal<wbr>Size</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#mul" class="tsd-kind-icon">mul</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#neg" class="tsd-kind-icon">neg</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#one" class="tsd-kind-icon">one</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#pick" class="tsd-kind-icon">pick</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#set" class="tsd-kind-icon">set</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#setbytes" class="tsd-kind-icon">set<wbr>Bytes</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#sub" class="tsd-kind-icon">sub</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#tostring" class="tsd-kind-icon">to<wbr>String</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#unmarshalbinary" class="tsd-kind-icon">unmarshal<wbr>Binary</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_curve_nist_scalar_.nistscalar.html#zero" class="tsd-kind-icon">zero</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>