blob: b528d71a2cd8a18261bda8dfe0b28caa9e748a2a [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_FP256BN.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_FP256BN.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__256__56_8h_source.html">big_256_56.h</a>&quot;</code><br />
<code>#include &quot;config_field_FP256BN.h&quot;</code><br />
</div>
<p><a href="fp__FP256BN_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__FP256BN.html">FP_FP256BN</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__FP256BN.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:a82f13f052447ca321643ddb55237f648"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a82f13f052447ca321643ddb55237f648">MODBITS_FP256BN</a>&#160;&#160;&#160;MBITS_FP256BN</td></tr>
<tr class="separator:a82f13f052447ca321643ddb55237f648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ab6d357e0495698938e647d36f5b632"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a2ab6d357e0495698938e647d36f5b632">TBITS_FP256BN</a>&#160;&#160;&#160;(MBITS_FP256BN%<a class="el" href="config__big__256__56_8h.html#ac6cb0299279eb5c9a07bccfd297f1b40">BASEBITS_256_56</a>)</td></tr>
<tr class="separator:a2ab6d357e0495698938e647d36f5b632"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ed3f53ad32503f7b3598d17e1ea4f32"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a4ed3f53ad32503f7b3598d17e1ea4f32">TMASK_FP256BN</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__FP256BN_8h.html#a2ab6d357e0495698938e647d36f5b632">TBITS_FP256BN</a>)-1)</td></tr>
<tr class="separator:a4ed3f53ad32503f7b3598d17e1ea4f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a372e83e45275e6bb50b2a6c745669301"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a372e83e45275e6bb50b2a6c745669301">FEXCESS_FP256BN</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_FP256BN)-1)</td></tr>
<tr class="separator:a372e83e45275e6bb50b2a6c745669301"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3bcf2ff9556f47af0a48823f9889f24"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ab3bcf2ff9556f47af0a48823f9889f24">OMASK_FP256BN</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__FP256BN_8h.html#a2ab6d357e0495698938e647d36f5b632">TBITS_FP256BN</a>))</td></tr>
<tr class="separator:ab3bcf2ff9556f47af0a48823f9889f24"><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:acd652b64a6f35e70c5572cc11f0c8740"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#acd652b64a6f35e70c5572cc11f0c8740">FP_FP256BN_iszilch</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:acd652b64a6f35e70c5572cc11f0c8740"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#acd652b64a6f35e70c5572cc11f0c8740">More...</a><br /></td></tr>
<tr class="separator:acd652b64a6f35e70c5572cc11f0c8740"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af86fa5665f7d94147014130956dc3550"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#af86fa5665f7d94147014130956dc3550">FP_FP256BN_zero</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:af86fa5665f7d94147014130956dc3550"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#af86fa5665f7d94147014130956dc3550">More...</a><br /></td></tr>
<tr class="separator:af86fa5665f7d94147014130956dc3550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadc8438bfe90bba61ac8de469ff97f68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#aadc8438bfe90bba61ac8de469ff97f68">FP_FP256BN_copy</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:aadc8438bfe90bba61ac8de469ff97f68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#aadc8438bfe90bba61ac8de469ff97f68">More...</a><br /></td></tr>
<tr class="separator:aadc8438bfe90bba61ac8de469ff97f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69a36585cb5a48596c8544d95457642a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a69a36585cb5a48596c8544d95457642a">FP_FP256BN_rcopy</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:a69a36585cb5a48596c8544d95457642a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#a69a36585cb5a48596c8544d95457642a">More...</a><br /></td></tr>
<tr class="separator:a69a36585cb5a48596c8544d95457642a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01beef374daa2d23f9c5af74d3e7c6cd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a01beef374daa2d23f9c5af74d3e7c6cd">FP_FP256BN_equals</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a01beef374daa2d23f9c5af74d3e7c6cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a01beef374daa2d23f9c5af74d3e7c6cd">More...</a><br /></td></tr>
<tr class="separator:a01beef374daa2d23f9c5af74d3e7c6cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10f623f2d19faea489482fb5979d07da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a10f623f2d19faea489482fb5979d07da">FP_FP256BN_cswap</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, int s)</td></tr>
<tr class="memdesc:a10f623f2d19faea489482fb5979d07da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#a10f623f2d19faea489482fb5979d07da">More...</a><br /></td></tr>
<tr class="separator:a10f623f2d19faea489482fb5979d07da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e9a61b3ba2334b5d33b1f6642415a85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a5e9a61b3ba2334b5d33b1f6642415a85">FP_FP256BN_cmove</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, int s)</td></tr>
<tr class="memdesc:a5e9a61b3ba2334b5d33b1f6642415a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#a5e9a61b3ba2334b5d33b1f6642415a85">More...</a><br /></td></tr>
<tr class="separator:a5e9a61b3ba2334b5d33b1f6642415a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdfe833750aea47df02efa319a7ae487"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#abdfe833750aea47df02efa319a7ae487">FP_FP256BN_nres</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:abdfe833750aea47df02efa319a7ae487"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#abdfe833750aea47df02efa319a7ae487">More...</a><br /></td></tr>
<tr class="separator:abdfe833750aea47df02efa319a7ae487"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae69d75055ff8701f0869f67fa76cd6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#aae69d75055ff8701f0869f67fa76cd6d">FP_FP256BN_redc</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y)</td></tr>
<tr class="memdesc:aae69d75055ff8701f0869f67fa76cd6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#aae69d75055ff8701f0869f67fa76cd6d">More...</a><br /></td></tr>
<tr class="separator:aae69d75055ff8701f0869f67fa76cd6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a545e6a5ed6782a017300eecc538edd9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a545e6a5ed6782a017300eecc538edd9d">FP_FP256BN_one</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:a545e6a5ed6782a017300eecc538edd9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a545e6a5ed6782a017300eecc538edd9d">More...</a><br /></td></tr>
<tr class="separator:a545e6a5ed6782a017300eecc538edd9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e92c399d5f7dfe58f0a6b2e53546399"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a2e92c399d5f7dfe58f0a6b2e53546399">FP_FP256BN_mod</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> r, <a class="el" href="big__256__56_8h.html#a6183570cd770f0ce6be0d94a42ee465a">DBIG_256_56</a> d)</td></tr>
<tr class="memdesc:a2e92c399d5f7dfe58f0a6b2e53546399"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#a2e92c399d5f7dfe58f0a6b2e53546399">More...</a><br /></td></tr>
<tr class="separator:a2e92c399d5f7dfe58f0a6b2e53546399"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad94f163708b53e580dfd373b083ea44d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ad94f163708b53e580dfd373b083ea44d">FP_FP256BN_mul</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *z)</td></tr>
<tr class="memdesc:ad94f163708b53e580dfd373b083ea44d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#ad94f163708b53e580dfd373b083ea44d">More...</a><br /></td></tr>
<tr class="separator:ad94f163708b53e580dfd373b083ea44d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3db30fb03663d5f7678f132314361dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#aa3db30fb03663d5f7678f132314361dd">FP_FP256BN_imul</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, int i)</td></tr>
<tr class="memdesc:aa3db30fb03663d5f7678f132314361dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#aa3db30fb03663d5f7678f132314361dd">More...</a><br /></td></tr>
<tr class="separator:aa3db30fb03663d5f7678f132314361dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89878611dafda51fe3aed40edcf7d275"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a89878611dafda51fe3aed40edcf7d275">FP_FP256BN_sqr</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a89878611dafda51fe3aed40edcf7d275"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#a89878611dafda51fe3aed40edcf7d275">More...</a><br /></td></tr>
<tr class="separator:a89878611dafda51fe3aed40edcf7d275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d093793a1728b2c60a65ee2227c1b93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a9d093793a1728b2c60a65ee2227c1b93">FP_FP256BN_add</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *z)</td></tr>
<tr class="memdesc:a9d093793a1728b2c60a65ee2227c1b93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#a9d093793a1728b2c60a65ee2227c1b93">More...</a><br /></td></tr>
<tr class="separator:a9d093793a1728b2c60a65ee2227c1b93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d350d31385ffcf62682bdd378b449b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a63d350d31385ffcf62682bdd378b449b">FP_FP256BN_sub</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *z)</td></tr>
<tr class="memdesc:a63d350d31385ffcf62682bdd378b449b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#a63d350d31385ffcf62682bdd378b449b">More...</a><br /></td></tr>
<tr class="separator:a63d350d31385ffcf62682bdd378b449b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a068d568ef4cbea9efa112a0d38172341"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a068d568ef4cbea9efa112a0d38172341">FP_FP256BN_div2</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a068d568ef4cbea9efa112a0d38172341"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#a068d568ef4cbea9efa112a0d38172341">More...</a><br /></td></tr>
<tr class="separator:a068d568ef4cbea9efa112a0d38172341"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9970b37008d97337929edfd506dbfb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ad9970b37008d97337929edfd506dbfb1">FP_FP256BN_pow</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> z)</td></tr>
<tr class="memdesc:ad9970b37008d97337929edfd506dbfb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#ad9970b37008d97337929edfd506dbfb1">More...</a><br /></td></tr>
<tr class="separator:ad9970b37008d97337929edfd506dbfb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac17269c4f722e30dfa7e19cc2e23c057"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ac17269c4f722e30dfa7e19cc2e23c057">FP_FP256BN_sqrt</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y)</td></tr>
<tr class="memdesc:ac17269c4f722e30dfa7e19cc2e23c057"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#ac17269c4f722e30dfa7e19cc2e23c057">More...</a><br /></td></tr>
<tr class="separator:ac17269c4f722e30dfa7e19cc2e23c057"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab87b4b81f45f7e0979507287065abff9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ab87b4b81f45f7e0979507287065abff9">FP_FP256BN_neg</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y)</td></tr>
<tr class="memdesc:ab87b4b81f45f7e0979507287065abff9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#ab87b4b81f45f7e0979507287065abff9">More...</a><br /></td></tr>
<tr class="separator:ab87b4b81f45f7e0979507287065abff9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48f9ecf90bfb1ec3662e3ffe3d6a6fab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a48f9ecf90bfb1ec3662e3ffe3d6a6fab">FP_FP256BN_output</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:a48f9ecf90bfb1ec3662e3ffe3d6a6fab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a48f9ecf90bfb1ec3662e3ffe3d6a6fab">More...</a><br /></td></tr>
<tr class="separator:a48f9ecf90bfb1ec3662e3ffe3d6a6fab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4a1491066b5808d48d144952c74229f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#af4a1491066b5808d48d144952c74229f">FP_FP256BN_rawoutput</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:af4a1491066b5808d48d144952c74229f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#af4a1491066b5808d48d144952c74229f">More...</a><br /></td></tr>
<tr class="separator:af4a1491066b5808d48d144952c74229f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab78574425e1ae58101d4af57519da2c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ab78574425e1ae58101d4af57519da2c1">FP_FP256BN_reduce</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ab78574425e1ae58101d4af57519da2c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#ab78574425e1ae58101d4af57519da2c1">More...</a><br /></td></tr>
<tr class="separator:ab78574425e1ae58101d4af57519da2c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace8b59627f68804cb56d83c97325384b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ace8b59627f68804cb56d83c97325384b">FP_FP256BN_norm</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ace8b59627f68804cb56d83c97325384b"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#ace8b59627f68804cb56d83c97325384b">More...</a><br /></td></tr>
<tr class="separator:ace8b59627f68804cb56d83c97325384b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8441cc9ef5edfa2b0ce6931ff6f3ea3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ae8441cc9ef5edfa2b0ce6931ff6f3ea3">FP_FP256BN_qr</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ae8441cc9ef5edfa2b0ce6931ff6f3ea3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#ae8441cc9ef5edfa2b0ce6931ff6f3ea3">More...</a><br /></td></tr>
<tr class="separator:ae8441cc9ef5edfa2b0ce6931ff6f3ea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4745ffcdab6f14b908e35ea16c4d48f8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a4745ffcdab6f14b908e35ea16c4d48f8">FP_FP256BN_inv</a> (<a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *x, <a class="el" href="structFP__FP256BN.html">FP_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a4745ffcdab6f14b908e35ea16c4d48f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#a4745ffcdab6f14b908e35ea16c4d48f8">More...</a><br /></td></tr>
<tr class="separator:a4745ffcdab6f14b908e35ea16c4d48f8"><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:ad286f94996863e6fc9f938edd49feb89"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#ad286f94996863e6fc9f938edd49feb89">Modulus_FP256BN</a></td></tr>
<tr class="separator:ad286f94996863e6fc9f938edd49feb89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49d238ef1bf42970d78b00125cba705d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__FP256BN_8h.html#a49d238ef1bf42970d78b00125cba705d">R2modp_FP256BN</a></td></tr>
<tr class="separator:a49d238ef1bf42970d78b00125cba705d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ec8051d3784e81416f7f7fbfa8832d1"><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__FP256BN_8h.html#a8ec8051d3784e81416f7f7fbfa8832d1">MConst_FP256BN</a></td></tr>
<tr class="separator:a8ec8051d3784e81416f7f7fbfa8832d1"><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="a372e83e45275e6bb50b2a6c745669301"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a372e83e45275e6bb50b2a6c745669301">&#9670;&nbsp;</a></span>FEXCESS_FP256BN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_FP256BN&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_FP256BN)-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="a82f13f052447ca321643ddb55237f648"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82f13f052447ca321643ddb55237f648">&#9670;&nbsp;</a></span>MODBITS_FP256BN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_FP256BN&#160;&#160;&#160;MBITS_FP256BN</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="ab3bcf2ff9556f47af0a48823f9889f24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3bcf2ff9556f47af0a48823f9889f24">&#9670;&nbsp;</a></span>OMASK_FP256BN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_FP256BN&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__FP256BN_8h.html#a2ab6d357e0495698938e647d36f5b632">TBITS_FP256BN</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="a2ab6d357e0495698938e647d36f5b632"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ab6d357e0495698938e647d36f5b632">&#9670;&nbsp;</a></span>TBITS_FP256BN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_FP256BN&#160;&#160;&#160;(MBITS_FP256BN%<a class="el" href="config__big__256__56_8h.html#ac6cb0299279eb5c9a07bccfd297f1b40">BASEBITS_256_56</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of active bits in top word </p>
</div>
</div>
<a id="a4ed3f53ad32503f7b3598d17e1ea4f32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ed3f53ad32503f7b3598d17e1ea4f32">&#9670;&nbsp;</a></span>TMASK_FP256BN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_FP256BN&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__FP256BN_8h.html#a2ab6d357e0495698938e647d36f5b632">TBITS_FP256BN</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="a9d093793a1728b2c60a65ee2227c1b93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d093793a1728b2c60a65ee2227c1b93">&#9670;&nbsp;</a></span>FP_FP256BN_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="a5e9a61b3ba2334b5d33b1f6642415a85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e9a61b3ba2334b5d33b1f6642415a85">&#9670;&nbsp;</a></span>FP_FP256BN_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="aadc8438bfe90bba61ac8de469ff97f68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadc8438bfe90bba61ac8de469ff97f68">&#9670;&nbsp;</a></span>FP_FP256BN_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="a10f623f2d19faea489482fb5979d07da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10f623f2d19faea489482fb5979d07da">&#9670;&nbsp;</a></span>FP_FP256BN_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="a068d568ef4cbea9efa112a0d38172341"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a068d568ef4cbea9efa112a0d38172341">&#9670;&nbsp;</a></span>FP_FP256BN_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="a01beef374daa2d23f9c5af74d3e7c6cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01beef374daa2d23f9c5af74d3e7c6cd">&#9670;&nbsp;</a></span>FP_FP256BN_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_FP256BN_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="aa3db30fb03663d5f7678f132314361dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3db30fb03663d5f7678f132314361dd">&#9670;&nbsp;</a></span>FP_FP256BN_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="a4745ffcdab6f14b908e35ea16c4d48f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4745ffcdab6f14b908e35ea16c4d48f8">&#9670;&nbsp;</a></span>FP_FP256BN_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="acd652b64a6f35e70c5572cc11f0c8740"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd652b64a6f35e70c5572cc11f0c8740">&#9670;&nbsp;</a></span>FP_FP256BN_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_FP256BN_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="a2e92c399d5f7dfe58f0a6b2e53546399"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e92c399d5f7dfe58f0a6b2e53546399">&#9670;&nbsp;</a></span>FP_FP256BN_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_mod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_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__256__56_8h.html#a6183570cd770f0ce6be0d94a42ee465a">DBIG_256_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="ad94f163708b53e580dfd373b083ea44d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad94f163708b53e580dfd373b083ea44d">&#9670;&nbsp;</a></span>FP_FP256BN_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="ab87b4b81f45f7e0979507287065abff9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab87b4b81f45f7e0979507287065abff9">&#9670;&nbsp;</a></span>FP_FP256BN_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="ace8b59627f68804cb56d83c97325384b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace8b59627f68804cb56d83c97325384b">&#9670;&nbsp;</a></span>FP_FP256BN_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="abdfe833750aea47df02efa319a7ae487"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdfe833750aea47df02efa319a7ae487">&#9670;&nbsp;</a></span>FP_FP256BN_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_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="a545e6a5ed6782a017300eecc538edd9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a545e6a5ed6782a017300eecc538edd9d">&#9670;&nbsp;</a></span>FP_FP256BN_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="a48f9ecf90bfb1ec3662e3ffe3d6a6fab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48f9ecf90bfb1ec3662e3ffe3d6a6fab">&#9670;&nbsp;</a></span>FP_FP256BN_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="ad9970b37008d97337929edfd506dbfb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9970b37008d97337929edfd506dbfb1">&#9670;&nbsp;</a></span>FP_FP256BN_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_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="ae8441cc9ef5edfa2b0ce6931ff6f3ea3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8441cc9ef5edfa2b0ce6931ff6f3ea3">&#9670;&nbsp;</a></span>FP_FP256BN_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_FP256BN_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="af4a1491066b5808d48d144952c74229f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4a1491066b5808d48d144952c74229f">&#9670;&nbsp;</a></span>FP_FP256BN_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="a69a36585cb5a48596c8544d95457642a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69a36585cb5a48596c8544d95457642a">&#9670;&nbsp;</a></span>FP_FP256BN_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_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="aae69d75055ff8701f0869f67fa76cd6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae69d75055ff8701f0869f67fa76cd6d">&#9670;&nbsp;</a></span>FP_FP256BN_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_redc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_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__FP256BN.html">FP_FP256BN</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="ab78574425e1ae58101d4af57519da2c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab78574425e1ae58101d4af57519da2c1">&#9670;&nbsp;</a></span>FP_FP256BN_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="a89878611dafda51fe3aed40edcf7d275"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89878611dafda51fe3aed40edcf7d275">&#9670;&nbsp;</a></span>FP_FP256BN_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="ac17269c4f722e30dfa7e19cc2e23c057"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac17269c4f722e30dfa7e19cc2e23c057">&#9670;&nbsp;</a></span>FP_FP256BN_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="a63d350d31385ffcf62682bdd378b449b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d350d31385ffcf62682bdd378b449b">&#9670;&nbsp;</a></span>FP_FP256BN_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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__FP256BN.html">FP_FP256BN</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="af86fa5665f7d94147014130956dc3550"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af86fa5665f7d94147014130956dc3550">&#9670;&nbsp;</a></span>FP_FP256BN_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_FP256BN_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__FP256BN.html">FP_FP256BN</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="a8ec8051d3784e81416f7f7fbfa8832d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ec8051d3784e81416f7f7fbfa8832d1">&#9670;&nbsp;</a></span>MConst_FP256BN</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_FP256BN</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="ad286f94996863e6fc9f938edd49feb89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad286f94996863e6fc9f938edd49feb89">&#9670;&nbsp;</a></span>Modulus_FP256BN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> Modulus_FP256BN</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="a49d238ef1bf42970d78b00125cba705d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49d238ef1bf42970d78b00125cba705d">&#9670;&nbsp;</a></span>R2modp_FP256BN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> R2modp_FP256BN</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>