@dedis/kyber
Version:
A typescript implementation of Kyber interfaces
721 lines • 38.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>GfP | @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/_pairing_gfp_.html">"pairing/gfp"</a>
</li>
<li>
<a href="_pairing_gfp_.gfp.html">GfP</a>
</li>
</ul>
<h1>Class GfP</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">GfP</span>
</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="_pairing_gfp_.gfp.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_pairing_gfp_.gfp.html#v" class="tsd-kind-icon">v</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_pairing_gfp_.gfp.html#elem_size" class="tsd-kind-icon">ELEM_<wbr>SIZE</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="_pairing_gfp_.gfp.html#add" class="tsd-kind-icon">add</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#compareto" class="tsd-kind-icon">compare<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#equals" class="tsd-kind-icon">equals</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#getvalue" class="tsd-kind-icon">get<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#invmod" class="tsd-kind-icon">invmod</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#isone" class="tsd-kind-icon">is<wbr>One</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#iszero" class="tsd-kind-icon">is<wbr>Zero</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#mod" class="tsd-kind-icon">mod</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#mul" class="tsd-kind-icon">mul</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#negate" class="tsd-kind-icon">negate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#pow" class="tsd-kind-icon">pow</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#shiftleft" class="tsd-kind-icon">shift<wbr>Left</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#signum" class="tsd-kind-icon">signum</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#sqr" class="tsd-kind-icon">sqr</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#sub" class="tsd-kind-icon">sub</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#tobytes" class="tsd-kind-icon">to<wbr>Bytes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#tohex" class="tsd-kind-icon">to<wbr>Hex</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_pairing_gfp_.gfp.html#tostring" class="tsd-kind-icon">to<wbr>String</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>GfP<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../modules/_constants_.html#bntype" class="tsd-signature-type">BNType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L12">pairing/gfp.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <a href="../modules/_constants_.html#bntype" class="tsd-signature-type">BNType</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="v" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> v</h3>
<div class="tsd-signature tsd-kind-icon">v<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/pairing/gfp.ts#L12">pairing/gfp.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="elem_size" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> ELEM_<wbr>SIZE</h3>
<div class="tsd-signature tsd-kind-icon">ELEM_<wbr>SIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 256 / 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/pairing/gfp.ts#L10">pairing/gfp.ts:10</a></li>
</ul>
</aside>
</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>a<span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L55">pairing/gfp.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="compareto" class="tsd-anchor"></a>
<h3>compare<wbr>To</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">compare<wbr>To<span class="tsd-signature-symbol">(</span>o<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><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">-1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</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/pairing/gfp.ts#L134">pairing/gfp.ts:134</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>o: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">0</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">-1</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">1</span>
</h4>
<p>-1 when o is greater, 1 when smaller and 0 when equal</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>o<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><span class="tsd-signature-type">boolean</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/pairing/gfp.ts#L143">pairing/gfp.ts:143</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>o: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>true when equal, false otherwise</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getvalue" class="tsd-anchor"></a>
<h3>get<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</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/pairing/gfp.ts#L22">pairing/gfp.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BN</span></h4>
<p>the BN object</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="invmod" class="tsd-anchor"></a>
<h3>invmod</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">invmod<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L108">pairing/gfp.ts:108</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>p: <span class="tsd-signature-type">BN</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="isone" class="tsd-anchor"></a>
<h3>is<wbr>One</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>One<span class="tsd-signature-symbol">(</span><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">
<ul>
<li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/pairing/gfp.ts#L38">pairing/gfp.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>true for one, false otherwise</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="iszero" class="tsd-anchor"></a>
<h3>is<wbr>Zero</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">is<wbr>Zero<span class="tsd-signature-symbol">(</span><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">
<ul>
<li>Defined in <a href="https://github.com/dedis/cothority/blob/bad37ffbb/external/js/kyber/src/pairing/gfp.ts#L46">pairing/gfp.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>true for zero, false otherwise</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="mod" class="tsd-anchor"></a>
<h3>mod</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">mod<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L99">pairing/gfp.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>p: <span class="tsd-signature-type">BN</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</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>a<span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L73">pairing/gfp.ts:73</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="negate" class="tsd-anchor"></a>
<h3>negate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">negate<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L116">pairing/gfp.ts:116</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="pow" class="tsd-anchor"></a>
<h3>pow</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">pow<span class="tsd-signature-symbol">(</span>k<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L90">pairing/gfp.ts:90</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>k: <span class="tsd-signature-type">BN</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="shiftleft" class="tsd-anchor"></a>
<h3>shift<wbr>Left</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">shift<wbr>Left<span class="tsd-signature-symbol">(</span>k<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><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L125">pairing/gfp.ts:125</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>k: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="signum" class="tsd-anchor"></a>
<h3>signum</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">signum<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">-1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</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/pairing/gfp.ts#L30">pairing/gfp.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">-1</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">0</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">1</span>
</h4>
<p>-1 for a negative, 1 for a positive and 0 for zero</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sqr" class="tsd-anchor"></a>
<h3>sqr</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">sqr<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L81">pairing/gfp.ts:81</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</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>a<span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</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/pairing/gfp.ts#L64">pairing/gfp.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_pairing_gfp_.gfp.html" class="tsd-signature-type">GfP</a></h4>
<p>the new value</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="tobytes" class="tsd-anchor"></a>
<h3>to<wbr>Bytes</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>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/pairing/gfp.ts#L152">pairing/gfp.ts:152</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="tohex" class="tsd-anchor"></a>
<h3>to<wbr>Hex</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">to<wbr>Hex<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/pairing/gfp.ts#L168">pairing/gfp.ts:168</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>the hex shape in a string</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/pairing/gfp.ts#L160">pairing/gfp.ts:160</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>the hex string</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/_pairing_gfp_.html">"pairing/gfp"</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="_pairing_gfp_.gfp.html" class="tsd-kind-icon">GfP</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_pairing_gfp_.gfp.html#v" class="tsd-kind-icon">v</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="_pairing_gfp_.gfp.html#elem_size" class="tsd-kind-icon">ELEM_<wbr>SIZE</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#add" class="tsd-kind-icon">add</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#compareto" class="tsd-kind-icon">compare<wbr>To</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#equals" class="tsd-kind-icon">equals</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#getvalue" class="tsd-kind-icon">get<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#invmod" class="tsd-kind-icon">invmod</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#isone" class="tsd-kind-icon">is<wbr>One</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#iszero" class="tsd-kind-icon">is<wbr>Zero</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#mod" class="tsd-kind-icon">mod</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#mul" class="tsd-kind-icon">mul</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#negate" class="tsd-kind-icon">negate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#pow" class="tsd-kind-icon">pow</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#shiftleft" class="tsd-kind-icon">shift<wbr>Left</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#signum" class="tsd-kind-icon">signum</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#sqr" class="tsd-kind-icon">sqr</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#sub" class="tsd-kind-icon">sub</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#tobytes" class="tsd-kind-icon">to<wbr>Bytes</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#tohex" class="tsd-kind-icon">to<wbr>Hex</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_pairing_gfp_.gfp.html#tostring" class="tsd-kind-icon">to<wbr>String</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>