blob: f60762ba17113c5394c7c9d278519f5bc1a4d7c2 [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_BLS24.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_BLS24.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__480__56_8h_source.html">big_480_56.h</a>&quot;</code><br />
<code>#include &quot;config_field_BLS24.h&quot;</code><br />
</div>
<p><a href="fp__BLS24_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__BLS24.html">FP_BLS24</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__BLS24.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:afe9802ec0ebba6de141ab0f9eb1f4e38"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#afe9802ec0ebba6de141ab0f9eb1f4e38">MODBITS_BLS24</a>&#160;&#160;&#160;MBITS_BLS24</td></tr>
<tr class="separator:afe9802ec0ebba6de141ab0f9eb1f4e38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a255580240df5618c1683e4bcb1abb302"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a255580240df5618c1683e4bcb1abb302">TBITS_BLS24</a>&#160;&#160;&#160;(MBITS_BLS24%<a class="el" href="config__big__480__56_8h.html#a8b36f73ee9c8cd16183b3a6d4ac21c8c">BASEBITS_480_56</a>)</td></tr>
<tr class="separator:a255580240df5618c1683e4bcb1abb302"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d484b3d45ea6d66f7a56cbb23199d1c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a7d484b3d45ea6d66f7a56cbb23199d1c">TMASK_BLS24</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BLS24_8h.html#a255580240df5618c1683e4bcb1abb302">TBITS_BLS24</a>)-1)</td></tr>
<tr class="separator:a7d484b3d45ea6d66f7a56cbb23199d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01c07718b6373a650b4f020539a011de"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a01c07718b6373a650b4f020539a011de">FEXCESS_BLS24</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BLS24)-1)</td></tr>
<tr class="separator:a01c07718b6373a650b4f020539a011de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c14f6d6fbbd5fd1542576d0c0bea32a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a2c14f6d6fbbd5fd1542576d0c0bea32a">OMASK_BLS24</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BLS24_8h.html#a255580240df5618c1683e4bcb1abb302">TBITS_BLS24</a>))</td></tr>
<tr class="separator:a2c14f6d6fbbd5fd1542576d0c0bea32a"><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:a25236ffb0d06cc273c63a39a1a26a63d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a25236ffb0d06cc273c63a39a1a26a63d">FP_BLS24_iszilch</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:a25236ffb0d06cc273c63a39a1a26a63d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#a25236ffb0d06cc273c63a39a1a26a63d">More...</a><br /></td></tr>
<tr class="separator:a25236ffb0d06cc273c63a39a1a26a63d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af89cae5ca815e09570611a7e00230953"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#af89cae5ca815e09570611a7e00230953">FP_BLS24_zero</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:af89cae5ca815e09570611a7e00230953"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#af89cae5ca815e09570611a7e00230953">More...</a><br /></td></tr>
<tr class="separator:af89cae5ca815e09570611a7e00230953"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1adfd38c422e30df2fb94ffafc5eabc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#aa1adfd38c422e30df2fb94ffafc5eabc">FP_BLS24_copy</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:aa1adfd38c422e30df2fb94ffafc5eabc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#aa1adfd38c422e30df2fb94ffafc5eabc">More...</a><br /></td></tr>
<tr class="separator:aa1adfd38c422e30df2fb94ffafc5eabc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cfc8ae73d0c590de29950e5aa7aeb72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a2cfc8ae73d0c590de29950e5aa7aeb72">FP_BLS24_rcopy</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, const <a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a> x)</td></tr>
<tr class="memdesc:a2cfc8ae73d0c590de29950e5aa7aeb72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#a2cfc8ae73d0c590de29950e5aa7aeb72">More...</a><br /></td></tr>
<tr class="separator:a2cfc8ae73d0c590de29950e5aa7aeb72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06cc27ed2bc69bab9665a1a882f87293"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a06cc27ed2bc69bab9665a1a882f87293">FP_BLS24_equals</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y)</td></tr>
<tr class="memdesc:a06cc27ed2bc69bab9665a1a882f87293"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a06cc27ed2bc69bab9665a1a882f87293">More...</a><br /></td></tr>
<tr class="separator:a06cc27ed2bc69bab9665a1a882f87293"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65f96b559c8ce67c2a8862d48de65dad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a65f96b559c8ce67c2a8862d48de65dad">FP_BLS24_cswap</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, int s)</td></tr>
<tr class="memdesc:a65f96b559c8ce67c2a8862d48de65dad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#a65f96b559c8ce67c2a8862d48de65dad">More...</a><br /></td></tr>
<tr class="separator:a65f96b559c8ce67c2a8862d48de65dad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a8c8686899e32ecbc9fb176e3075156"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a7a8c8686899e32ecbc9fb176e3075156">FP_BLS24_cmove</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, int s)</td></tr>
<tr class="memdesc:a7a8c8686899e32ecbc9fb176e3075156"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#a7a8c8686899e32ecbc9fb176e3075156">More...</a><br /></td></tr>
<tr class="separator:a7a8c8686899e32ecbc9fb176e3075156"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8165ce696fea79d6821049df8eeb32a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a8165ce696fea79d6821049df8eeb32a6">FP_BLS24_nres</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, <a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a> x)</td></tr>
<tr class="memdesc:a8165ce696fea79d6821049df8eeb32a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#a8165ce696fea79d6821049df8eeb32a6">More...</a><br /></td></tr>
<tr class="separator:a8165ce696fea79d6821049df8eeb32a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af91d25b42172d167a1f026ef60097317"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#af91d25b42172d167a1f026ef60097317">FP_BLS24_redc</a> (<a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a> x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y)</td></tr>
<tr class="memdesc:af91d25b42172d167a1f026ef60097317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#af91d25b42172d167a1f026ef60097317">More...</a><br /></td></tr>
<tr class="separator:af91d25b42172d167a1f026ef60097317"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2303fbefaae7925a324e805f35e6fc01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a2303fbefaae7925a324e805f35e6fc01">FP_BLS24_one</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:a2303fbefaae7925a324e805f35e6fc01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a2303fbefaae7925a324e805f35e6fc01">More...</a><br /></td></tr>
<tr class="separator:a2303fbefaae7925a324e805f35e6fc01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a509b55400d0f521348e02074e78815fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a509b55400d0f521348e02074e78815fe">FP_BLS24_mod</a> (<a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a> r, <a class="el" href="big__480__56_8h.html#a0431a818206f629e340731bd19e6c948">DBIG_480_56</a> d)</td></tr>
<tr class="memdesc:a509b55400d0f521348e02074e78815fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#a509b55400d0f521348e02074e78815fe">More...</a><br /></td></tr>
<tr class="separator:a509b55400d0f521348e02074e78815fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4effb07861d65f788adee97c76b1108"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#aa4effb07861d65f788adee97c76b1108">FP_BLS24_mul</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *z)</td></tr>
<tr class="memdesc:aa4effb07861d65f788adee97c76b1108"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#aa4effb07861d65f788adee97c76b1108">More...</a><br /></td></tr>
<tr class="separator:aa4effb07861d65f788adee97c76b1108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35de8aa1f3836f158ae0520157a68941"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a35de8aa1f3836f158ae0520157a68941">FP_BLS24_imul</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, int i)</td></tr>
<tr class="memdesc:a35de8aa1f3836f158ae0520157a68941"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#a35de8aa1f3836f158ae0520157a68941">More...</a><br /></td></tr>
<tr class="separator:a35de8aa1f3836f158ae0520157a68941"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4be44302e3ee29f9af0eb9f603ff3d88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a4be44302e3ee29f9af0eb9f603ff3d88">FP_BLS24_sqr</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y)</td></tr>
<tr class="memdesc:a4be44302e3ee29f9af0eb9f603ff3d88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#a4be44302e3ee29f9af0eb9f603ff3d88">More...</a><br /></td></tr>
<tr class="separator:a4be44302e3ee29f9af0eb9f603ff3d88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1b37925415682106d527f9dea5dd134"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#ad1b37925415682106d527f9dea5dd134">FP_BLS24_add</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *z)</td></tr>
<tr class="memdesc:ad1b37925415682106d527f9dea5dd134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#ad1b37925415682106d527f9dea5dd134">More...</a><br /></td></tr>
<tr class="separator:ad1b37925415682106d527f9dea5dd134"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf6da2f2c8ed442e7868bf64b4fa7394"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#adf6da2f2c8ed442e7868bf64b4fa7394">FP_BLS24_sub</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *z)</td></tr>
<tr class="memdesc:adf6da2f2c8ed442e7868bf64b4fa7394"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#adf6da2f2c8ed442e7868bf64b4fa7394">More...</a><br /></td></tr>
<tr class="separator:adf6da2f2c8ed442e7868bf64b4fa7394"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5e80a40fdb1eb869afb26b727703eae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#ac5e80a40fdb1eb869afb26b727703eae">FP_BLS24_div2</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y)</td></tr>
<tr class="memdesc:ac5e80a40fdb1eb869afb26b727703eae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#ac5e80a40fdb1eb869afb26b727703eae">More...</a><br /></td></tr>
<tr class="separator:ac5e80a40fdb1eb869afb26b727703eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67cae6490d678b90d0f30829a42d15b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a67cae6490d678b90d0f30829a42d15b3">FP_BLS24_pow</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y, <a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a> z)</td></tr>
<tr class="memdesc:a67cae6490d678b90d0f30829a42d15b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#a67cae6490d678b90d0f30829a42d15b3">More...</a><br /></td></tr>
<tr class="separator:a67cae6490d678b90d0f30829a42d15b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e7aec86b24eae180160b73a2ad49c18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a2e7aec86b24eae180160b73a2ad49c18">FP_BLS24_sqrt</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y)</td></tr>
<tr class="memdesc:a2e7aec86b24eae180160b73a2ad49c18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#a2e7aec86b24eae180160b73a2ad49c18">More...</a><br /></td></tr>
<tr class="separator:a2e7aec86b24eae180160b73a2ad49c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90a78055f183d0746f6fe58ae9613446"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a90a78055f183d0746f6fe58ae9613446">FP_BLS24_neg</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y)</td></tr>
<tr class="memdesc:a90a78055f183d0746f6fe58ae9613446"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#a90a78055f183d0746f6fe58ae9613446">More...</a><br /></td></tr>
<tr class="separator:a90a78055f183d0746f6fe58ae9613446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95bfd143929e4f1cdf553b2035e5e4a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a95bfd143929e4f1cdf553b2035e5e4a9">FP_BLS24_output</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:a95bfd143929e4f1cdf553b2035e5e4a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a95bfd143929e4f1cdf553b2035e5e4a9">More...</a><br /></td></tr>
<tr class="separator:a95bfd143929e4f1cdf553b2035e5e4a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03151f0ca865079b6a4897ef6ed3c9d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a03151f0ca865079b6a4897ef6ed3c9d8">FP_BLS24_rawoutput</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:a03151f0ca865079b6a4897ef6ed3c9d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#a03151f0ca865079b6a4897ef6ed3c9d8">More...</a><br /></td></tr>
<tr class="separator:a03151f0ca865079b6a4897ef6ed3c9d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c3795cac2620cbba336da3754a9742b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a2c3795cac2620cbba336da3754a9742b">FP_BLS24_reduce</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:a2c3795cac2620cbba336da3754a9742b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#a2c3795cac2620cbba336da3754a9742b">More...</a><br /></td></tr>
<tr class="separator:a2c3795cac2620cbba336da3754a9742b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add4b053ecad7c5c1052c2a96ddd4a38f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#add4b053ecad7c5c1052c2a96ddd4a38f">FP_BLS24_norm</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:add4b053ecad7c5c1052c2a96ddd4a38f"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#add4b053ecad7c5c1052c2a96ddd4a38f">More...</a><br /></td></tr>
<tr class="separator:add4b053ecad7c5c1052c2a96ddd4a38f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33dddfdce51c62b4bf924e742d1e9796"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a33dddfdce51c62b4bf924e742d1e9796">FP_BLS24_qr</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x)</td></tr>
<tr class="memdesc:a33dddfdce51c62b4bf924e742d1e9796"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#a33dddfdce51c62b4bf924e742d1e9796">More...</a><br /></td></tr>
<tr class="separator:a33dddfdce51c62b4bf924e742d1e9796"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8403fa37e24fc800d558435b7095edb4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a8403fa37e24fc800d558435b7095edb4">FP_BLS24_inv</a> (<a class="el" href="structFP__BLS24.html">FP_BLS24</a> *x, <a class="el" href="structFP__BLS24.html">FP_BLS24</a> *y)</td></tr>
<tr class="memdesc:a8403fa37e24fc800d558435b7095edb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#a8403fa37e24fc800d558435b7095edb4">More...</a><br /></td></tr>
<tr class="separator:a8403fa37e24fc800d558435b7095edb4"><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:aa6e19c2b84dab527970ee9375f1d66fb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#aa6e19c2b84dab527970ee9375f1d66fb">Modulus_BLS24</a></td></tr>
<tr class="separator:aa6e19c2b84dab527970ee9375f1d66fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2387efaa774ddcdeb08b321b689c7e99"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BLS24_8h.html#a2387efaa774ddcdeb08b321b689c7e99">R2modp_BLS24</a></td></tr>
<tr class="separator:a2387efaa774ddcdeb08b321b689c7e99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0866c8294dafe2c92f0b77e5a83379f4"><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__BLS24_8h.html#a0866c8294dafe2c92f0b77e5a83379f4">MConst_BLS24</a></td></tr>
<tr class="separator:a0866c8294dafe2c92f0b77e5a83379f4"><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="a01c07718b6373a650b4f020539a011de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01c07718b6373a650b4f020539a011de">&#9670;&nbsp;</a></span>FEXCESS_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_BLS24&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BLS24)-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="afe9802ec0ebba6de141ab0f9eb1f4e38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe9802ec0ebba6de141ab0f9eb1f4e38">&#9670;&nbsp;</a></span>MODBITS_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_BLS24&#160;&#160;&#160;MBITS_BLS24</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="a2c14f6d6fbbd5fd1542576d0c0bea32a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c14f6d6fbbd5fd1542576d0c0bea32a">&#9670;&nbsp;</a></span>OMASK_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_BLS24&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BLS24_8h.html#a255580240df5618c1683e4bcb1abb302">TBITS_BLS24</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="a255580240df5618c1683e4bcb1abb302"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a255580240df5618c1683e4bcb1abb302">&#9670;&nbsp;</a></span>TBITS_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_BLS24&#160;&#160;&#160;(MBITS_BLS24%<a class="el" href="config__big__480__56_8h.html#a8b36f73ee9c8cd16183b3a6d4ac21c8c">BASEBITS_480_56</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of active bits in top word </p>
</div>
</div>
<a id="a7d484b3d45ea6d66f7a56cbb23199d1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d484b3d45ea6d66f7a56cbb23199d1c">&#9670;&nbsp;</a></span>TMASK_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_BLS24&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BLS24_8h.html#a255580240df5618c1683e4bcb1abb302">TBITS_BLS24</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="ad1b37925415682106d527f9dea5dd134"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1b37925415682106d527f9dea5dd134">&#9670;&nbsp;</a></span>FP_BLS24_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a7a8c8686899e32ecbc9fb176e3075156"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a8c8686899e32ecbc9fb176e3075156">&#9670;&nbsp;</a></span>FP_BLS24_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="aa1adfd38c422e30df2fb94ffafc5eabc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1adfd38c422e30df2fb94ffafc5eabc">&#9670;&nbsp;</a></span>FP_BLS24_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a65f96b559c8ce67c2a8862d48de65dad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65f96b559c8ce67c2a8862d48de65dad">&#9670;&nbsp;</a></span>FP_BLS24_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="ac5e80a40fdb1eb869afb26b727703eae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5e80a40fdb1eb869afb26b727703eae">&#9670;&nbsp;</a></span>FP_BLS24_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a06cc27ed2bc69bab9665a1a882f87293"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06cc27ed2bc69bab9665a1a882f87293">&#9670;&nbsp;</a></span>FP_BLS24_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS24_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a35de8aa1f3836f158ae0520157a68941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35de8aa1f3836f158ae0520157a68941">&#9670;&nbsp;</a></span>FP_BLS24_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a8403fa37e24fc800d558435b7095edb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8403fa37e24fc800d558435b7095edb4">&#9670;&nbsp;</a></span>FP_BLS24_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a25236ffb0d06cc273c63a39a1a26a63d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25236ffb0d06cc273c63a39a1a26a63d">&#9670;&nbsp;</a></span>FP_BLS24_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS24_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a509b55400d0f521348e02074e78815fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a509b55400d0f521348e02074e78815fe">&#9670;&nbsp;</a></span>FP_BLS24_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_mod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</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__480__56_8h.html#a0431a818206f629e340731bd19e6c948">DBIG_480_56</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="aa4effb07861d65f788adee97c76b1108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4effb07861d65f788adee97c76b1108">&#9670;&nbsp;</a></span>FP_BLS24_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a90a78055f183d0746f6fe58ae9613446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90a78055f183d0746f6fe58ae9613446">&#9670;&nbsp;</a></span>FP_BLS24_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="add4b053ecad7c5c1052c2a96ddd4a38f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add4b053ecad7c5c1052c2a96ddd4a38f">&#9670;&nbsp;</a></span>FP_BLS24_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a8165ce696fea79d6821049df8eeb32a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8165ce696fea79d6821049df8eeb32a6">&#9670;&nbsp;</a></span>FP_BLS24_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</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="a2303fbefaae7925a324e805f35e6fc01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2303fbefaae7925a324e805f35e6fc01">&#9670;&nbsp;</a></span>FP_BLS24_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a95bfd143929e4f1cdf553b2035e5e4a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95bfd143929e4f1cdf553b2035e5e4a9">&#9670;&nbsp;</a></span>FP_BLS24_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a67cae6490d678b90d0f30829a42d15b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67cae6490d678b90d0f30829a42d15b3">&#9670;&nbsp;</a></span>FP_BLS24_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</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="a33dddfdce51c62b4bf924e742d1e9796"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33dddfdce51c62b4bf924e742d1e9796">&#9670;&nbsp;</a></span>FP_BLS24_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BLS24_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a03151f0ca865079b6a4897ef6ed3c9d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03151f0ca865079b6a4897ef6ed3c9d8">&#9670;&nbsp;</a></span>FP_BLS24_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a2cfc8ae73d0c590de29950e5aa7aeb72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cfc8ae73d0c590de29950e5aa7aeb72">&#9670;&nbsp;</a></span>FP_BLS24_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</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="af91d25b42172d167a1f026ef60097317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af91d25b42172d167a1f026ef60097317">&#9670;&nbsp;</a></span>FP_BLS24_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_redc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</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__BLS24.html">FP_BLS24</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="a2c3795cac2620cbba336da3754a9742b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c3795cac2620cbba336da3754a9742b">&#9670;&nbsp;</a></span>FP_BLS24_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a4be44302e3ee29f9af0eb9f603ff3d88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4be44302e3ee29f9af0eb9f603ff3d88">&#9670;&nbsp;</a></span>FP_BLS24_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="a2e7aec86b24eae180160b73a2ad49c18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e7aec86b24eae180160b73a2ad49c18">&#9670;&nbsp;</a></span>FP_BLS24_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="adf6da2f2c8ed442e7868bf64b4fa7394"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf6da2f2c8ed442e7868bf64b4fa7394">&#9670;&nbsp;</a></span>FP_BLS24_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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__BLS24.html">FP_BLS24</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="af89cae5ca815e09570611a7e00230953"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af89cae5ca815e09570611a7e00230953">&#9670;&nbsp;</a></span>FP_BLS24_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BLS24_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BLS24.html">FP_BLS24</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="a0866c8294dafe2c92f0b77e5a83379f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0866c8294dafe2c92f0b77e5a83379f4">&#9670;&nbsp;</a></span>MConst_BLS24</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_BLS24</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="aa6e19c2b84dab527970ee9375f1d66fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6e19c2b84dab527970ee9375f1d66fb">&#9670;&nbsp;</a></span>Modulus_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a> Modulus_BLS24</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="a2387efaa774ddcdeb08b321b689c7e99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2387efaa774ddcdeb08b321b689c7e99">&#9670;&nbsp;</a></span>R2modp_BLS24</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__480__56_8h.html#a5bf780014d489361cffeb4dd5a89fcba">BIG_480_56</a> R2modp_BLS24</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>