blob: 3c07138bbfb71f72dda56ab2e74c635f55883834 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AMCL: fp_BLS381.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AMCL
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df7310d1a865926cc859bcfb1880083f.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">fp_BLS381.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>FP Header File.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="big__384__58_8h_source.html">big_384_58.h</a>&quot;</code><br />
<code>#include &quot;config_field_BLS381.h&quot;</code><br />
</div>
<p><a href="fp__BLS381_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFP__BLS381.html">FP_BLS381</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__BLS381.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a39729e49a6a22773672b8ae1250dcba4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a39729e49a6a22773672b8ae1250dcba4">MODBITS_BLS381</a>&#160;&#160;&#160;MBITS_BLS381</td></tr>
<tr class="separator:a39729e49a6a22773672b8ae1250dcba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad125a785ef7ebb13455b15666b9e2073"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#ad125a785ef7ebb13455b15666b9e2073">TBITS_BLS381</a>&#160;&#160;&#160;(MBITS_BLS381%<a class="el" href="config__big__384__58_8h.html#aef3a9fbfcd02db7e7fae8c77794c2fec">BASEBITS_384_58</a>)</td></tr>
<tr class="separator:ad125a785ef7ebb13455b15666b9e2073"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44db6e85dc08ef6da305dec6e0c81e9d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a44db6e85dc08ef6da305dec6e0c81e9d">TMASK_BLS381</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BLS381_8h.html#ad125a785ef7ebb13455b15666b9e2073">TBITS_BLS381</a>)-1)</td></tr>
<tr class="separator:a44db6e85dc08ef6da305dec6e0c81e9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d85e9890eac395143ddd2255f7a6544"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a4d85e9890eac395143ddd2255f7a6544">FEXCESS_BLS381</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BLS381)-1)</td></tr>
<tr class="separator:a4d85e9890eac395143ddd2255f7a6544"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a471bfc2f9466a419ae316aa5431e1b89"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a471bfc2f9466a419ae316aa5431e1b89">OMASK_BLS381</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BLS381_8h.html#ad125a785ef7ebb13455b15666b9e2073">TBITS_BLS381</a>))</td></tr>
<tr class="separator:a471bfc2f9466a419ae316aa5431e1b89"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3c2bc91b50ba2e6270af0072e13a8308"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a3c2bc91b50ba2e6270af0072e13a8308">FP_BLS381_iszilch</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:a3c2bc91b50ba2e6270af0072e13a8308"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#a3c2bc91b50ba2e6270af0072e13a8308">More...</a><br /></td></tr>
<tr class="separator:a3c2bc91b50ba2e6270af0072e13a8308"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7af4bd12a364ccdd44ad8d34ca3269f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a7af4bd12a364ccdd44ad8d34ca3269f3">FP_BLS381_zero</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:a7af4bd12a364ccdd44ad8d34ca3269f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#a7af4bd12a364ccdd44ad8d34ca3269f3">More...</a><br /></td></tr>
<tr class="separator:a7af4bd12a364ccdd44ad8d34ca3269f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf87ddbcb436e3262ae1f78dacfe3d59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#acf87ddbcb436e3262ae1f78dacfe3d59">FP_BLS381_copy</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:acf87ddbcb436e3262ae1f78dacfe3d59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#acf87ddbcb436e3262ae1f78dacfe3d59">More...</a><br /></td></tr>
<tr class="separator:acf87ddbcb436e3262ae1f78dacfe3d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf7a0866b5fa4b17d9207fce5f28fbf9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#abf7a0866b5fa4b17d9207fce5f28fbf9">FP_BLS381_rcopy</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, const <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a> x)</td></tr>
<tr class="memdesc:abf7a0866b5fa4b17d9207fce5f28fbf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#abf7a0866b5fa4b17d9207fce5f28fbf9">More...</a><br /></td></tr>
<tr class="separator:abf7a0866b5fa4b17d9207fce5f28fbf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5bcf74a6273bb20d02c24316d1f73b2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#ad5bcf74a6273bb20d02c24316d1f73b2">FP_BLS381_equals</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y)</td></tr>
<tr class="memdesc:ad5bcf74a6273bb20d02c24316d1f73b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#ad5bcf74a6273bb20d02c24316d1f73b2">More...</a><br /></td></tr>
<tr class="separator:ad5bcf74a6273bb20d02c24316d1f73b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dd2b3cac4097f35856d0f8e45b7c8e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a9dd2b3cac4097f35856d0f8e45b7c8e9">FP_BLS381_cswap</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, int s)</td></tr>
<tr class="memdesc:a9dd2b3cac4097f35856d0f8e45b7c8e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#a9dd2b3cac4097f35856d0f8e45b7c8e9">More...</a><br /></td></tr>
<tr class="separator:a9dd2b3cac4097f35856d0f8e45b7c8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a867229095f08e814dd28f79a9bafdf7a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a867229095f08e814dd28f79a9bafdf7a">FP_BLS381_cmove</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, int s)</td></tr>
<tr class="memdesc:a867229095f08e814dd28f79a9bafdf7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#a867229095f08e814dd28f79a9bafdf7a">More...</a><br /></td></tr>
<tr class="separator:a867229095f08e814dd28f79a9bafdf7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad40a8055cddb6c7aca090a0990bfd583"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#ad40a8055cddb6c7aca090a0990bfd583">FP_BLS381_nres</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a> x)</td></tr>
<tr class="memdesc:ad40a8055cddb6c7aca090a0990bfd583"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#ad40a8055cddb6c7aca090a0990bfd583">More...</a><br /></td></tr>
<tr class="separator:ad40a8055cddb6c7aca090a0990bfd583"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ac55e034ab1e546b5fcf2d184639d47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a6ac55e034ab1e546b5fcf2d184639d47">FP_BLS381_redc</a> (<a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a> x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y)</td></tr>
<tr class="memdesc:a6ac55e034ab1e546b5fcf2d184639d47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#a6ac55e034ab1e546b5fcf2d184639d47">More...</a><br /></td></tr>
<tr class="separator:a6ac55e034ab1e546b5fcf2d184639d47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a844a9f1e7e162295fa2a0ffb01bef6d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a844a9f1e7e162295fa2a0ffb01bef6d1">FP_BLS381_one</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:a844a9f1e7e162295fa2a0ffb01bef6d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a844a9f1e7e162295fa2a0ffb01bef6d1">More...</a><br /></td></tr>
<tr class="separator:a844a9f1e7e162295fa2a0ffb01bef6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab20eb29b539f8c8668095443c8b3ccc8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#ab20eb29b539f8c8668095443c8b3ccc8">FP_BLS381_mod</a> (<a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a> r, <a class="el" href="big__384__58_8h.html#ab914db55caa046b50795e836a4a052ea">DBIG_384_58</a> d)</td></tr>
<tr class="memdesc:ab20eb29b539f8c8668095443c8b3ccc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#ab20eb29b539f8c8668095443c8b3ccc8">More...</a><br /></td></tr>
<tr class="separator:ab20eb29b539f8c8668095443c8b3ccc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab244ef49d296e7bf043f2915be7de01b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#ab244ef49d296e7bf043f2915be7de01b">FP_BLS381_mul</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *z)</td></tr>
<tr class="memdesc:ab244ef49d296e7bf043f2915be7de01b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#ab244ef49d296e7bf043f2915be7de01b">More...</a><br /></td></tr>
<tr class="separator:ab244ef49d296e7bf043f2915be7de01b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22046f935c63b4ca44bd4f233d3a0b1e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a22046f935c63b4ca44bd4f233d3a0b1e">FP_BLS381_imul</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, int i)</td></tr>
<tr class="memdesc:a22046f935c63b4ca44bd4f233d3a0b1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#a22046f935c63b4ca44bd4f233d3a0b1e">More...</a><br /></td></tr>
<tr class="separator:a22046f935c63b4ca44bd4f233d3a0b1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5a0f5115d20bb53c3fc9d7be0ef637a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#af5a0f5115d20bb53c3fc9d7be0ef637a">FP_BLS381_sqr</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y)</td></tr>
<tr class="memdesc:af5a0f5115d20bb53c3fc9d7be0ef637a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#af5a0f5115d20bb53c3fc9d7be0ef637a">More...</a><br /></td></tr>
<tr class="separator:af5a0f5115d20bb53c3fc9d7be0ef637a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f686a251ad7bebee5a76260d17bab12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a9f686a251ad7bebee5a76260d17bab12">FP_BLS381_add</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *z)</td></tr>
<tr class="memdesc:a9f686a251ad7bebee5a76260d17bab12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#a9f686a251ad7bebee5a76260d17bab12">More...</a><br /></td></tr>
<tr class="separator:a9f686a251ad7bebee5a76260d17bab12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90774fad6c223c8e829129fa0ac1abeb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a90774fad6c223c8e829129fa0ac1abeb">FP_BLS381_sub</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *z)</td></tr>
<tr class="memdesc:a90774fad6c223c8e829129fa0ac1abeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#a90774fad6c223c8e829129fa0ac1abeb">More...</a><br /></td></tr>
<tr class="separator:a90774fad6c223c8e829129fa0ac1abeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf1543802a0dfeb012bf0b7df6f1cbda"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#aaf1543802a0dfeb012bf0b7df6f1cbda">FP_BLS381_div2</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y)</td></tr>
<tr class="memdesc:aaf1543802a0dfeb012bf0b7df6f1cbda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#aaf1543802a0dfeb012bf0b7df6f1cbda">More...</a><br /></td></tr>
<tr class="separator:aaf1543802a0dfeb012bf0b7df6f1cbda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa09d6506ebac654b73562508ad5eb6bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#aa09d6506ebac654b73562508ad5eb6bc">FP_BLS381_pow</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y, <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a> z)</td></tr>
<tr class="memdesc:aa09d6506ebac654b73562508ad5eb6bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#aa09d6506ebac654b73562508ad5eb6bc">More...</a><br /></td></tr>
<tr class="separator:aa09d6506ebac654b73562508ad5eb6bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa66dff7a84a14e4d8efbd041a9f6af03"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#aa66dff7a84a14e4d8efbd041a9f6af03">FP_BLS381_sqrt</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y)</td></tr>
<tr class="memdesc:aa66dff7a84a14e4d8efbd041a9f6af03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#aa66dff7a84a14e4d8efbd041a9f6af03">More...</a><br /></td></tr>
<tr class="separator:aa66dff7a84a14e4d8efbd041a9f6af03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00ebe6444eb3ff5352ed90291746ae18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a00ebe6444eb3ff5352ed90291746ae18">FP_BLS381_neg</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y)</td></tr>
<tr class="memdesc:a00ebe6444eb3ff5352ed90291746ae18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#a00ebe6444eb3ff5352ed90291746ae18">More...</a><br /></td></tr>
<tr class="separator:a00ebe6444eb3ff5352ed90291746ae18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91b88f402eb14329b6c6610dd9bd3b22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a91b88f402eb14329b6c6610dd9bd3b22">FP_BLS381_output</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:a91b88f402eb14329b6c6610dd9bd3b22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a91b88f402eb14329b6c6610dd9bd3b22">More...</a><br /></td></tr>
<tr class="separator:a91b88f402eb14329b6c6610dd9bd3b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae396571634206c852cbad10ccc8f405c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#ae396571634206c852cbad10ccc8f405c">FP_BLS381_rawoutput</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:ae396571634206c852cbad10ccc8f405c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#ae396571634206c852cbad10ccc8f405c">More...</a><br /></td></tr>
<tr class="separator:ae396571634206c852cbad10ccc8f405c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa666c1c2b7ef5db83467017c86bcec52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#aa666c1c2b7ef5db83467017c86bcec52">FP_BLS381_reduce</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:aa666c1c2b7ef5db83467017c86bcec52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#aa666c1c2b7ef5db83467017c86bcec52">More...</a><br /></td></tr>
<tr class="separator:aa666c1c2b7ef5db83467017c86bcec52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e7bbb59e5605ca362828efbe4bde61d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a4e7bbb59e5605ca362828efbe4bde61d">FP_BLS381_norm</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:a4e7bbb59e5605ca362828efbe4bde61d"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#a4e7bbb59e5605ca362828efbe4bde61d">More...</a><br /></td></tr>
<tr class="separator:a4e7bbb59e5605ca362828efbe4bde61d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95c6e1b126d58cf4ea3bfb75810ba18e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a95c6e1b126d58cf4ea3bfb75810ba18e">FP_BLS381_qr</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x)</td></tr>
<tr class="memdesc:a95c6e1b126d58cf4ea3bfb75810ba18e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#a95c6e1b126d58cf4ea3bfb75810ba18e">More...</a><br /></td></tr>
<tr class="separator:a95c6e1b126d58cf4ea3bfb75810ba18e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfb22e4c329ecf15a56b72e00e4842cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#abfb22e4c329ecf15a56b72e00e4842cb">FP_BLS381_inv</a> (<a class="el" href="structFP__BLS381.html">FP_BLS381</a> *x, <a class="el" href="structFP__BLS381.html">FP_BLS381</a> *y)</td></tr>
<tr class="memdesc:abfb22e4c329ecf15a56b72e00e4842cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#abfb22e4c329ecf15a56b72e00e4842cb">More...</a><br /></td></tr>
<tr class="separator:abfb22e4c329ecf15a56b72e00e4842cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ad37b3c376264a673e0bdb7b241e2232f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#ad37b3c376264a673e0bdb7b241e2232f">Modulus_BLS381</a></td></tr>
<tr class="separator:ad37b3c376264a673e0bdb7b241e2232f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc2c7c16e428bb69fa75a6a3135ea2a4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#abc2c7c16e428bb69fa75a6a3135ea2a4">R2modp_BLS381</a></td></tr>
<tr class="separator:abc2c7c16e428bb69fa75a6a3135ea2a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ace8f6c7b2be20531c00b517d139eb5"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS381_8h.html#a6ace8f6c7b2be20531c00b517d139eb5">MConst_BLS381</a></td></tr>
<tr class="separator:a6ace8f6c7b2be20531c00b517d139eb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Mike Scott </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a4d85e9890eac395143ddd2255f7a6544"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d85e9890eac395143ddd2255f7a6544">&#9670;&nbsp;</a></span>FEXCESS_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_BLS381&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BLS381)-1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>2^(BASEBITS*NLEN-MODBITS)-1 - normalised BIG can be multiplied by less than this before reduction </p>
</div>
</div>
<a id="a39729e49a6a22773672b8ae1250dcba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39729e49a6a22773672b8ae1250dcba4">&#9670;&nbsp;</a></span>MODBITS_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_BLS381&#160;&#160;&#160;MBITS_BLS381</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="a471bfc2f9466a419ae316aa5431e1b89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a471bfc2f9466a419ae316aa5431e1b89">&#9670;&nbsp;</a></span>OMASK_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_BLS381&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BLS381_8h.html#ad125a785ef7ebb13455b15666b9e2073">TBITS_BLS381</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="ad125a785ef7ebb13455b15666b9e2073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad125a785ef7ebb13455b15666b9e2073">&#9670;&nbsp;</a></span>TBITS_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_BLS381&#160;&#160;&#160;(MBITS_BLS381%<a class="el" href="config__big__384__58_8h.html#aef3a9fbfcd02db7e7fae8c77794c2fec">BASEBITS_384_58</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of active bits in top word </p>
</div>
</div>
<a id="a44db6e85dc08ef6da305dec6e0c81e9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44db6e85dc08ef6da305dec6e0c81e9d">&#9670;&nbsp;</a></span>TMASK_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_BLS381&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BLS381_8h.html#ad125a785ef7ebb13455b15666b9e2073">TBITS_BLS381</a>)-1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mask for active bits in top word </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a9f686a251ad7bebee5a76260d17bab12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f686a251ad7bebee5a76260d17bab12">&#9670;&nbsp;</a></span>FP_BLS381_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular sum = y+z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
<tr><td class="paramname">z</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a867229095f08e814dd28f79a9bafdf7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a867229095f08e814dd28f79a9bafdf7a">&#9670;&nbsp;</a></span>FP_BLS381_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Conditionally copies second parameter to the first (without branching) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>an FP number </td></tr>
<tr><td class="paramname">y</td><td>another FP number </td></tr>
<tr><td class="paramname">s</td><td>copy takes place if not equal to 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acf87ddbcb436e3262ae1f78dacfe3d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf87ddbcb436e3262ae1f78dacfe3d59">&#9670;&nbsp;</a></span>FP_BLS381_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">y</td><td>FP number to be copied to </td></tr>
<tr><td class="paramname">x</td><td>FP to be copied from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9dd2b3cac4097f35856d0f8e45b7c8e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dd2b3cac4097f35856d0f8e45b7c8e9">&#9670;&nbsp;</a></span>FP_BLS381_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Conditionally swaps parameters in constant time (without branching) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>an FP number </td></tr>
<tr><td class="paramname">y</td><td>another FP number </td></tr>
<tr><td class="paramname">s</td><td>swap takes place if not equal to 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaf1543802a0dfeb012bf0b7df6f1cbda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf1543802a0dfeb012bf0b7df6f1cbda">&#9670;&nbsp;</a></span>FP_BLS381_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit =y/2 mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad5bcf74a6273bb20d02c24316d1f73b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5bcf74a6273bb20d02c24316d1f73b2">&#9670;&nbsp;</a></span>FP_BLS381_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS381_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if equal, else returns 0 </dd></dl>
</div>
</div>
<a id="a22046f935c63b4ca44bd4f233d3a0b1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22046f935c63b4ca44bd4f233d3a0b1e">&#9670;&nbsp;</a></span>FP_BLS381_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular product = y*i mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the multiplicand </td></tr>
<tr><td class="paramname">i</td><td>a small number, the multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abfb22e4c329ecf15a56b72e00e4842cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfb22e4c329ecf15a56b72e00e4842cb">&#9670;&nbsp;</a></span>FP_BLS381_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit = 1/y mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3c2bc91b50ba2e6270af0072e13a8308"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c2bc91b50ba2e6270af0072e13a8308">&#9670;&nbsp;</a></span>FP_BLS381_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS381_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>BIG number to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if zero, else returns 0 </dd></dl>
</div>
</div>
<a id="ab20eb29b539f8c8668095443c8b3ccc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab20eb29b539f8c8668095443c8b3ccc8">&#9670;&nbsp;</a></span>FP_BLS381_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_mod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a>&#160;</td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="big__384__58_8h.html#ab914db55caa046b50795e836a4a052ea">DBIG_384_58</a>&#160;</td>
<td class="paramname"><em>d</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function comes in different flavours depending on the form of Modulus that is currently in use. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>BIG number, on exit = d mod Modulus </td></tr>
<tr><td class="paramname">d</td><td>DBIG number to be reduced </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab244ef49d296e7bf043f2915be7de01b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab244ef49d296e7bf043f2915be7de01b">&#9670;&nbsp;</a></span>FP_BLS381_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses appropriate fast modular reduction method </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular product = y*z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the multiplicand </td></tr>
<tr><td class="paramname">z</td><td>FP number, the multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a00ebe6444eb3ff5352ed90291746ae18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00ebe6444eb3ff5352ed90291746ae18">&#9670;&nbsp;</a></span>FP_BLS381_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit = -y mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4e7bbb59e5605ca362828efbe4bde61d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e7bbb59e5605ca362828efbe4bde61d">&#9670;&nbsp;</a></span>FP_BLS381_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit normalized </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad40a8055cddb6c7aca090a0990bfd583"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad40a8055cddb6c7aca090a0990bfd583">&#9670;&nbsp;</a></span>FP_BLS381_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a>&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>BIG number to be converted </td></tr>
<tr><td class="paramname">y</td><td>FP result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a844a9f1e7e162295fa2a0ffb01bef6d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a844a9f1e7e162295fa2a0ffb01bef6d1">&#9670;&nbsp;</a></span>FP_BLS381_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number to be set equal to unity. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a91b88f402eb14329b6c6610dd9bd3b22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91b88f402eb14329b6c6610dd9bd3b22">&#9670;&nbsp;</a></span>FP_BLS381_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts from residue form before output </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>an FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa09d6506ebac654b73562508ad5eb6bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa09d6506ebac654b73562508ad5eb6bc">&#9670;&nbsp;</a></span>FP_BLS381_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a>&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit = y^z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
<tr><td class="paramname">z</td><td>BIG number exponent </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a95c6e1b126d58cf4ea3bfb75810ba18e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95c6e1b126d58cf4ea3bfb75810ba18e">&#9670;&nbsp;</a></span>FP_BLS381_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS381_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if quadratic residue, else returns 0 if quadratic non-residue </dd></dl>
</div>
</div>
<a id="ae396571634206c852cbad10ccc8f405c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae396571634206c852cbad10ccc8f405c">&#9670;&nbsp;</a></span>FP_BLS381_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>a BIG number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abf7a0866b5fa4b17d9207fce5f28fbf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf7a0866b5fa4b17d9207fce5f28fbf9">&#9670;&nbsp;</a></span>FP_BLS381_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a>&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">y</td><td>FP number to be copied to </td></tr>
<tr><td class="paramname">x</td><td>BIG to be copied from ROM </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6ac55e034ab1e546b5fcf2d184639d47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ac55e034ab1e546b5fcf2d184639d47">&#9670;&nbsp;</a></span>FP_BLS381_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_redc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a>&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">y</td><td>FP number to be converted to BIG </td></tr>
<tr><td class="paramname">x</td><td>BIG result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa666c1c2b7ef5db83467017c86bcec52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa666c1c2b7ef5db83467017c86bcec52">&#9670;&nbsp;</a></span>FP_BLS381_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit reduced mod Modulus </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af5a0f5115d20bb53c3fc9d7be0ef637a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5a0f5115d20bb53c3fc9d7be0ef637a">&#9670;&nbsp;</a></span>FP_BLS381_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses appropriate fast modular reduction method </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular product = y^2 mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the number to be squared </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa66dff7a84a14e4d8efbd041a9f6af03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa66dff7a84a14e4d8efbd041a9f6af03">&#9670;&nbsp;</a></span>FP_BLS381_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit = sqrt(y) mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the number whose square root is calculated </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a90774fad6c223c8e829129fa0ac1abeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90774fad6c223c8e829129fa0ac1abeb">&#9670;&nbsp;</a></span>FP_BLS381_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular difference = y-z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
<tr><td class="paramname">z</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7af4bd12a364ccdd44ad8d34ca3269f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7af4bd12a364ccdd44ad8d34ca3269f3">&#9670;&nbsp;</a></span>FP_BLS381_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS381_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS381.html">FP_BLS381</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number to be set to 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a6ace8f6c7b2be20531c00b517d139eb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ace8f6c7b2be20531c00b517d139eb5">&#9670;&nbsp;</a></span>MConst_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a> MConst_BLS381</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="ad37b3c376264a673e0bdb7b241e2232f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad37b3c376264a673e0bdb7b241e2232f">&#9670;&nbsp;</a></span>Modulus_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a> Modulus_BLS381</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="abc2c7c16e428bb69fa75a6a3135ea2a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc2c7c16e428bb69fa75a6a3135ea2a4">&#9670;&nbsp;</a></span>R2modp_BLS381</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__384__58_8h.html#ab8c68dbf8612f8f005c402a289c5da31">BIG_384_58</a> R2modp_BLS381</td>
</tr>
</table>
</div><div class="memdoc">
<p>Montgomery constant </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>