blob: 2fd3796eeaa4d380b63ca5db5caccd40490944b3 [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_BLS48.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_BLS48.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__560__58_8h_source.html">big_560_58.h</a>&quot;</code><br />
<code>#include &quot;config_field_BLS48.h&quot;</code><br />
</div>
<p><a href="fp__BLS48_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__BLS48.html">FP_BLS48</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__BLS48.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:aecc12736c1a7fdd275b037484e4bd1fd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#aecc12736c1a7fdd275b037484e4bd1fd">MODBITS_BLS48</a>&#160;&#160;&#160;MBITS_BLS48</td></tr>
<tr class="separator:aecc12736c1a7fdd275b037484e4bd1fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c6723819cd18b958f74654fda483890"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a6c6723819cd18b958f74654fda483890">TBITS_BLS48</a>&#160;&#160;&#160;(MBITS_BLS48%<a class="el" href="config__big__560__58_8h.html#a8e3d43eb3ac0cf5e5f06c1027dba473f">BASEBITS_560_58</a>)</td></tr>
<tr class="separator:a6c6723819cd18b958f74654fda483890"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf995d5ca13fb5bebef74a63b34f4bd3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#acf995d5ca13fb5bebef74a63b34f4bd3">TMASK_BLS48</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BLS48_8h.html#a6c6723819cd18b958f74654fda483890">TBITS_BLS48</a>)-1)</td></tr>
<tr class="separator:acf995d5ca13fb5bebef74a63b34f4bd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c4c59f8a2fc5f1089772282f0a1abf4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a0c4c59f8a2fc5f1089772282f0a1abf4">FEXCESS_BLS48</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BLS48)-1)</td></tr>
<tr class="separator:a0c4c59f8a2fc5f1089772282f0a1abf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9f8b274c79cc77fe113c5121c4250fd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#ab9f8b274c79cc77fe113c5121c4250fd">OMASK_BLS48</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BLS48_8h.html#a6c6723819cd18b958f74654fda483890">TBITS_BLS48</a>))</td></tr>
<tr class="separator:ab9f8b274c79cc77fe113c5121c4250fd"><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:acf1ea09e3154f7d55f5fada2aca8e322"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#acf1ea09e3154f7d55f5fada2aca8e322">FP_BLS48_iszilch</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:acf1ea09e3154f7d55f5fada2aca8e322"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#acf1ea09e3154f7d55f5fada2aca8e322">More...</a><br /></td></tr>
<tr class="separator:acf1ea09e3154f7d55f5fada2aca8e322"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbea6ded2b2a727f095f5b1a755ed74e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#abbea6ded2b2a727f095f5b1a755ed74e">FP_BLS48_zero</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:abbea6ded2b2a727f095f5b1a755ed74e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#abbea6ded2b2a727f095f5b1a755ed74e">More...</a><br /></td></tr>
<tr class="separator:abbea6ded2b2a727f095f5b1a755ed74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b04bf2fc2a1fd3cbe0e4506b7f72c5c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a7b04bf2fc2a1fd3cbe0e4506b7f72c5c">FP_BLS48_copy</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:a7b04bf2fc2a1fd3cbe0e4506b7f72c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#a7b04bf2fc2a1fd3cbe0e4506b7f72c5c">More...</a><br /></td></tr>
<tr class="separator:a7b04bf2fc2a1fd3cbe0e4506b7f72c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af564bc4c57afdc7d092d5ea2b9ded4bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#af564bc4c57afdc7d092d5ea2b9ded4bd">FP_BLS48_rcopy</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, const <a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a> x)</td></tr>
<tr class="memdesc:af564bc4c57afdc7d092d5ea2b9ded4bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#af564bc4c57afdc7d092d5ea2b9ded4bd">More...</a><br /></td></tr>
<tr class="separator:af564bc4c57afdc7d092d5ea2b9ded4bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21dbf263ab32ee94e3b560a945c7ac17"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a21dbf263ab32ee94e3b560a945c7ac17">FP_BLS48_equals</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y)</td></tr>
<tr class="memdesc:a21dbf263ab32ee94e3b560a945c7ac17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a21dbf263ab32ee94e3b560a945c7ac17">More...</a><br /></td></tr>
<tr class="separator:a21dbf263ab32ee94e3b560a945c7ac17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8e953a43bc129f075a1436cac236f85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#ac8e953a43bc129f075a1436cac236f85">FP_BLS48_cswap</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, int s)</td></tr>
<tr class="memdesc:ac8e953a43bc129f075a1436cac236f85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#ac8e953a43bc129f075a1436cac236f85">More...</a><br /></td></tr>
<tr class="separator:ac8e953a43bc129f075a1436cac236f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9baf8aaa0e741babc8ba20a90df0a2f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a9baf8aaa0e741babc8ba20a90df0a2f6">FP_BLS48_cmove</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, int s)</td></tr>
<tr class="memdesc:a9baf8aaa0e741babc8ba20a90df0a2f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#a9baf8aaa0e741babc8ba20a90df0a2f6">More...</a><br /></td></tr>
<tr class="separator:a9baf8aaa0e741babc8ba20a90df0a2f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ab87faf78b8e41760f9cbcb91824e21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a3ab87faf78b8e41760f9cbcb91824e21">FP_BLS48_nres</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, <a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a> x)</td></tr>
<tr class="memdesc:a3ab87faf78b8e41760f9cbcb91824e21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#a3ab87faf78b8e41760f9cbcb91824e21">More...</a><br /></td></tr>
<tr class="separator:a3ab87faf78b8e41760f9cbcb91824e21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fdb13c2b0f7c4b4544617ad245153d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a7fdb13c2b0f7c4b4544617ad245153d0">FP_BLS48_redc</a> (<a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a> x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y)</td></tr>
<tr class="memdesc:a7fdb13c2b0f7c4b4544617ad245153d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#a7fdb13c2b0f7c4b4544617ad245153d0">More...</a><br /></td></tr>
<tr class="separator:a7fdb13c2b0f7c4b4544617ad245153d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0258f53104a2b013ff359f058532175"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#ab0258f53104a2b013ff359f058532175">FP_BLS48_one</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:ab0258f53104a2b013ff359f058532175"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#ab0258f53104a2b013ff359f058532175">More...</a><br /></td></tr>
<tr class="separator:ab0258f53104a2b013ff359f058532175"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa104262293099cd211b5820bd03aafd2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#aa104262293099cd211b5820bd03aafd2">FP_BLS48_mod</a> (<a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a> r, <a class="el" href="big__560__58_8h.html#aa190c896863df8c0bfbe5b7421ed94f2">DBIG_560_58</a> d)</td></tr>
<tr class="memdesc:aa104262293099cd211b5820bd03aafd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#aa104262293099cd211b5820bd03aafd2">More...</a><br /></td></tr>
<tr class="separator:aa104262293099cd211b5820bd03aafd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4de6330896a9cc4e9514f5f95b444e0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#ab4de6330896a9cc4e9514f5f95b444e0">FP_BLS48_mul</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *z)</td></tr>
<tr class="memdesc:ab4de6330896a9cc4e9514f5f95b444e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#ab4de6330896a9cc4e9514f5f95b444e0">More...</a><br /></td></tr>
<tr class="separator:ab4de6330896a9cc4e9514f5f95b444e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8c643bf006d988728b10cc35d6fde35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#ac8c643bf006d988728b10cc35d6fde35">FP_BLS48_imul</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, int i)</td></tr>
<tr class="memdesc:ac8c643bf006d988728b10cc35d6fde35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#ac8c643bf006d988728b10cc35d6fde35">More...</a><br /></td></tr>
<tr class="separator:ac8c643bf006d988728b10cc35d6fde35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a907cd5f917cde0af54d08616660f1eaa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a907cd5f917cde0af54d08616660f1eaa">FP_BLS48_sqr</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y)</td></tr>
<tr class="memdesc:a907cd5f917cde0af54d08616660f1eaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#a907cd5f917cde0af54d08616660f1eaa">More...</a><br /></td></tr>
<tr class="separator:a907cd5f917cde0af54d08616660f1eaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21cd27e31a684b05991eb24f4402bbdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a21cd27e31a684b05991eb24f4402bbdb">FP_BLS48_add</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *z)</td></tr>
<tr class="memdesc:a21cd27e31a684b05991eb24f4402bbdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#a21cd27e31a684b05991eb24f4402bbdb">More...</a><br /></td></tr>
<tr class="separator:a21cd27e31a684b05991eb24f4402bbdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7bf382168159b287e0477fa57e4d28b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#ab7bf382168159b287e0477fa57e4d28b">FP_BLS48_sub</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *z)</td></tr>
<tr class="memdesc:ab7bf382168159b287e0477fa57e4d28b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#ab7bf382168159b287e0477fa57e4d28b">More...</a><br /></td></tr>
<tr class="separator:ab7bf382168159b287e0477fa57e4d28b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15d608589f971b3a8e76eac1fa79e91f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a15d608589f971b3a8e76eac1fa79e91f">FP_BLS48_div2</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y)</td></tr>
<tr class="memdesc:a15d608589f971b3a8e76eac1fa79e91f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#a15d608589f971b3a8e76eac1fa79e91f">More...</a><br /></td></tr>
<tr class="separator:a15d608589f971b3a8e76eac1fa79e91f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa249bafe8293c568b391d0e1eada4c66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#aa249bafe8293c568b391d0e1eada4c66">FP_BLS48_pow</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y, <a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a> z)</td></tr>
<tr class="memdesc:aa249bafe8293c568b391d0e1eada4c66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#aa249bafe8293c568b391d0e1eada4c66">More...</a><br /></td></tr>
<tr class="separator:aa249bafe8293c568b391d0e1eada4c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed8d01173471aa92a5ee464cc6829e18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#aed8d01173471aa92a5ee464cc6829e18">FP_BLS48_sqrt</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y)</td></tr>
<tr class="memdesc:aed8d01173471aa92a5ee464cc6829e18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#aed8d01173471aa92a5ee464cc6829e18">More...</a><br /></td></tr>
<tr class="separator:aed8d01173471aa92a5ee464cc6829e18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08b5cafde5b7a312a4b7891a8314a885"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a08b5cafde5b7a312a4b7891a8314a885">FP_BLS48_neg</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y)</td></tr>
<tr class="memdesc:a08b5cafde5b7a312a4b7891a8314a885"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#a08b5cafde5b7a312a4b7891a8314a885">More...</a><br /></td></tr>
<tr class="separator:a08b5cafde5b7a312a4b7891a8314a885"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a985fdd7575cb55fd4f98c9af6865d4b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a985fdd7575cb55fd4f98c9af6865d4b1">FP_BLS48_output</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:a985fdd7575cb55fd4f98c9af6865d4b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a985fdd7575cb55fd4f98c9af6865d4b1">More...</a><br /></td></tr>
<tr class="separator:a985fdd7575cb55fd4f98c9af6865d4b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f23fb7e592974dcd77112241357e356"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a7f23fb7e592974dcd77112241357e356">FP_BLS48_rawoutput</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:a7f23fb7e592974dcd77112241357e356"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#a7f23fb7e592974dcd77112241357e356">More...</a><br /></td></tr>
<tr class="separator:a7f23fb7e592974dcd77112241357e356"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f73ad8dfb6b45b982d63fc87651b638"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a5f73ad8dfb6b45b982d63fc87651b638">FP_BLS48_reduce</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:a5f73ad8dfb6b45b982d63fc87651b638"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#a5f73ad8dfb6b45b982d63fc87651b638">More...</a><br /></td></tr>
<tr class="separator:a5f73ad8dfb6b45b982d63fc87651b638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad680df0f443e0a99562951ff728d2d9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#ad680df0f443e0a99562951ff728d2d9e">FP_BLS48_norm</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:ad680df0f443e0a99562951ff728d2d9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#ad680df0f443e0a99562951ff728d2d9e">More...</a><br /></td></tr>
<tr class="separator:ad680df0f443e0a99562951ff728d2d9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af348c0c54603a17bba06886ec986e8ee"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#af348c0c54603a17bba06886ec986e8ee">FP_BLS48_qr</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x)</td></tr>
<tr class="memdesc:af348c0c54603a17bba06886ec986e8ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#af348c0c54603a17bba06886ec986e8ee">More...</a><br /></td></tr>
<tr class="separator:af348c0c54603a17bba06886ec986e8ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33a866224a458b0ac41cf084bb4d5144"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a33a866224a458b0ac41cf084bb4d5144">FP_BLS48_inv</a> (<a class="el" href="structFP__BLS48.html">FP_BLS48</a> *x, <a class="el" href="structFP__BLS48.html">FP_BLS48</a> *y)</td></tr>
<tr class="memdesc:a33a866224a458b0ac41cf084bb4d5144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#a33a866224a458b0ac41cf084bb4d5144">More...</a><br /></td></tr>
<tr class="separator:a33a866224a458b0ac41cf084bb4d5144"><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:a35cbb10d0cccc21bfbae6e12526e24a2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a35cbb10d0cccc21bfbae6e12526e24a2">Modulus_BLS48</a></td></tr>
<tr class="separator:a35cbb10d0cccc21bfbae6e12526e24a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ded56ee3a1d1e4713b9667459b2b182"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS48_8h.html#a2ded56ee3a1d1e4713b9667459b2b182">R2modp_BLS48</a></td></tr>
<tr class="separator:a2ded56ee3a1d1e4713b9667459b2b182"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03f0eefe01f97f6957acfba3cc418982"><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__BLS48_8h.html#a03f0eefe01f97f6957acfba3cc418982">MConst_BLS48</a></td></tr>
<tr class="separator:a03f0eefe01f97f6957acfba3cc418982"><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="a0c4c59f8a2fc5f1089772282f0a1abf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c4c59f8a2fc5f1089772282f0a1abf4">&#9670;&nbsp;</a></span>FEXCESS_BLS48</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_BLS48&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BLS48)-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="aecc12736c1a7fdd275b037484e4bd1fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecc12736c1a7fdd275b037484e4bd1fd">&#9670;&nbsp;</a></span>MODBITS_BLS48</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_BLS48&#160;&#160;&#160;MBITS_BLS48</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="ab9f8b274c79cc77fe113c5121c4250fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9f8b274c79cc77fe113c5121c4250fd">&#9670;&nbsp;</a></span>OMASK_BLS48</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_BLS48&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BLS48_8h.html#a6c6723819cd18b958f74654fda483890">TBITS_BLS48</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="a6c6723819cd18b958f74654fda483890"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c6723819cd18b958f74654fda483890">&#9670;&nbsp;</a></span>TBITS_BLS48</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_BLS48&#160;&#160;&#160;(MBITS_BLS48%<a class="el" href="config__big__560__58_8h.html#a8e3d43eb3ac0cf5e5f06c1027dba473f">BASEBITS_560_58</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of active bits in top word </p>
</div>
</div>
<a id="acf995d5ca13fb5bebef74a63b34f4bd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf995d5ca13fb5bebef74a63b34f4bd3">&#9670;&nbsp;</a></span>TMASK_BLS48</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_BLS48&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BLS48_8h.html#a6c6723819cd18b958f74654fda483890">TBITS_BLS48</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="a21cd27e31a684b05991eb24f4402bbdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21cd27e31a684b05991eb24f4402bbdb">&#9670;&nbsp;</a></span>FP_BLS48_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="a9baf8aaa0e741babc8ba20a90df0a2f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9baf8aaa0e741babc8ba20a90df0a2f6">&#9670;&nbsp;</a></span>FP_BLS48_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="a7b04bf2fc2a1fd3cbe0e4506b7f72c5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b04bf2fc2a1fd3cbe0e4506b7f72c5c">&#9670;&nbsp;</a></span>FP_BLS48_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="ac8e953a43bc129f075a1436cac236f85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8e953a43bc129f075a1436cac236f85">&#9670;&nbsp;</a></span>FP_BLS48_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="a15d608589f971b3a8e76eac1fa79e91f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15d608589f971b3a8e76eac1fa79e91f">&#9670;&nbsp;</a></span>FP_BLS48_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="a21dbf263ab32ee94e3b560a945c7ac17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21dbf263ab32ee94e3b560a945c7ac17">&#9670;&nbsp;</a></span>FP_BLS48_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS48_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="ac8c643bf006d988728b10cc35d6fde35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8c643bf006d988728b10cc35d6fde35">&#9670;&nbsp;</a></span>FP_BLS48_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="a33a866224a458b0ac41cf084bb4d5144"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33a866224a458b0ac41cf084bb4d5144">&#9670;&nbsp;</a></span>FP_BLS48_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="acf1ea09e3154f7d55f5fada2aca8e322"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf1ea09e3154f7d55f5fada2aca8e322">&#9670;&nbsp;</a></span>FP_BLS48_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS48_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="aa104262293099cd211b5820bd03aafd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa104262293099cd211b5820bd03aafd2">&#9670;&nbsp;</a></span>FP_BLS48_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_mod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_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__560__58_8h.html#aa190c896863df8c0bfbe5b7421ed94f2">DBIG_560_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="ab4de6330896a9cc4e9514f5f95b444e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4de6330896a9cc4e9514f5f95b444e0">&#9670;&nbsp;</a></span>FP_BLS48_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="a08b5cafde5b7a312a4b7891a8314a885"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08b5cafde5b7a312a4b7891a8314a885">&#9670;&nbsp;</a></span>FP_BLS48_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="ad680df0f443e0a99562951ff728d2d9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad680df0f443e0a99562951ff728d2d9e">&#9670;&nbsp;</a></span>FP_BLS48_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="a3ab87faf78b8e41760f9cbcb91824e21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ab87faf78b8e41760f9cbcb91824e21">&#9670;&nbsp;</a></span>FP_BLS48_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_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="ab0258f53104a2b013ff359f058532175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0258f53104a2b013ff359f058532175">&#9670;&nbsp;</a></span>FP_BLS48_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="a985fdd7575cb55fd4f98c9af6865d4b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a985fdd7575cb55fd4f98c9af6865d4b1">&#9670;&nbsp;</a></span>FP_BLS48_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="aa249bafe8293c568b391d0e1eada4c66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa249bafe8293c568b391d0e1eada4c66">&#9670;&nbsp;</a></span>FP_BLS48_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_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="af348c0c54603a17bba06886ec986e8ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af348c0c54603a17bba06886ec986e8ee">&#9670;&nbsp;</a></span>FP_BLS48_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS48_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="a7f23fb7e592974dcd77112241357e356"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f23fb7e592974dcd77112241357e356">&#9670;&nbsp;</a></span>FP_BLS48_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="af564bc4c57afdc7d092d5ea2b9ded4bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af564bc4c57afdc7d092d5ea2b9ded4bd">&#9670;&nbsp;</a></span>FP_BLS48_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_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="a7fdb13c2b0f7c4b4544617ad245153d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fdb13c2b0f7c4b4544617ad245153d0">&#9670;&nbsp;</a></span>FP_BLS48_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_redc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_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__BLS48.html">FP_BLS48</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="a5f73ad8dfb6b45b982d63fc87651b638"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f73ad8dfb6b45b982d63fc87651b638">&#9670;&nbsp;</a></span>FP_BLS48_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="a907cd5f917cde0af54d08616660f1eaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a907cd5f917cde0af54d08616660f1eaa">&#9670;&nbsp;</a></span>FP_BLS48_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="aed8d01173471aa92a5ee464cc6829e18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed8d01173471aa92a5ee464cc6829e18">&#9670;&nbsp;</a></span>FP_BLS48_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="ab7bf382168159b287e0477fa57e4d28b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7bf382168159b287e0477fa57e4d28b">&#9670;&nbsp;</a></span>FP_BLS48_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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__BLS48.html">FP_BLS48</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="abbea6ded2b2a727f095f5b1a755ed74e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbea6ded2b2a727f095f5b1a755ed74e">&#9670;&nbsp;</a></span>FP_BLS48_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS48_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS48.html">FP_BLS48</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="a03f0eefe01f97f6957acfba3cc418982"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03f0eefe01f97f6957acfba3cc418982">&#9670;&nbsp;</a></span>MConst_BLS48</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_BLS48</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="a35cbb10d0cccc21bfbae6e12526e24a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35cbb10d0cccc21bfbae6e12526e24a2">&#9670;&nbsp;</a></span>Modulus_BLS48</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a> Modulus_BLS48</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="a2ded56ee3a1d1e4713b9667459b2b182"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ded56ee3a1d1e4713b9667459b2b182">&#9670;&nbsp;</a></span>R2modp_BLS48</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__560__58_8h.html#a6149450df1017dc5c4ef9e54fad78b30">BIG_560_58</a> R2modp_BLS48</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>