Google Git
Sign in
apache / incubator-milagro / 9d0a178fcdbc4e7c600b3e0667649c17af548ac2 / . / website / static / cdocs / fp__BN254_8h.html
blob: 0d67dab6a694839cca588122b14da4fe8f22bb4e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AMCL: fp_BN254.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>
<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.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_BN254.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_BN254.h&quot;</code><br />
</div>
<p><a href="fp__BN254_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__BN254.html">FP_BN254</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__BN254.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:a3f3e492eaf57a968aa6233410c262fe8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a3f3e492eaf57a968aa6233410c262fe8">MODBITS_BN254</a>&#160;&#160;&#160;MBITS_BN254</td></tr>
<tr class="separator:a3f3e492eaf57a968aa6233410c262fe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fdd19163fc9231212ebf9afa9a22793"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a9fdd19163fc9231212ebf9afa9a22793">TBITS_BN254</a>&#160;&#160;&#160;(MBITS_BN254%<a class="el" href="config__big__256__56_8h.html#ac6cb0299279eb5c9a07bccfd297f1b40">BASEBITS_256_56</a>)</td></tr>
<tr class="separator:a9fdd19163fc9231212ebf9afa9a22793"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab21f7d8c697c60a7d00888963e2ff3cb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#ab21f7d8c697c60a7d00888963e2ff3cb">TMASK_BN254</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BN254_8h.html#a9fdd19163fc9231212ebf9afa9a22793">TBITS_BN254</a>)-1)</td></tr>
<tr class="separator:ab21f7d8c697c60a7d00888963e2ff3cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22540457c1bcce596f902e3bf3c738ea"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a22540457c1bcce596f902e3bf3c738ea">FEXCESS_BN254</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BN254)-1)</td></tr>
<tr class="separator:a22540457c1bcce596f902e3bf3c738ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a237041adecb729b288aa6a243c4a0cac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a237041adecb729b288aa6a243c4a0cac">OMASK_BN254</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BN254_8h.html#a9fdd19163fc9231212ebf9afa9a22793">TBITS_BN254</a>))</td></tr>
<tr class="separator:a237041adecb729b288aa6a243c4a0cac"><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:ae22f0d358cc5707ae7deb3f763ad2581"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#ae22f0d358cc5707ae7deb3f763ad2581">FP_BN254_iszilch</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:ae22f0d358cc5707ae7deb3f763ad2581"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#ae22f0d358cc5707ae7deb3f763ad2581">More...</a><br /></td></tr>
<tr class="separator:ae22f0d358cc5707ae7deb3f763ad2581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a420bf442f094f392e2c0116f3eef8c69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a420bf442f094f392e2c0116f3eef8c69">FP_BN254_zero</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:a420bf442f094f392e2c0116f3eef8c69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#a420bf442f094f392e2c0116f3eef8c69">More...</a><br /></td></tr>
<tr class="separator:a420bf442f094f392e2c0116f3eef8c69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6f5e846f1186dbff86ee5b5714454ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#ab6f5e846f1186dbff86ee5b5714454ea">FP_BN254_copy</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *y, <a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:ab6f5e846f1186dbff86ee5b5714454ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#ab6f5e846f1186dbff86ee5b5714454ea">More...</a><br /></td></tr>
<tr class="separator:ab6f5e846f1186dbff86ee5b5714454ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6de42f0e349c8cd0799cf1348f5fe5c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#ab6de42f0e349c8cd0799cf1348f5fe5c">FP_BN254_rcopy</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *y, const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:ab6de42f0e349c8cd0799cf1348f5fe5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#ab6de42f0e349c8cd0799cf1348f5fe5c">More...</a><br /></td></tr>
<tr class="separator:ab6de42f0e349c8cd0799cf1348f5fe5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3904fffa0cc33cbcbe810a7ee4d26edd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a3904fffa0cc33cbcbe810a7ee4d26edd">FP_BN254_equals</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y)</td></tr>
<tr class="memdesc:a3904fffa0cc33cbcbe810a7ee4d26edd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a3904fffa0cc33cbcbe810a7ee4d26edd">More...</a><br /></td></tr>
<tr class="separator:a3904fffa0cc33cbcbe810a7ee4d26edd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adecb221f91cbcaf83f4960aa9c665d04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#adecb221f91cbcaf83f4960aa9c665d04">FP_BN254_cswap</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y, int s)</td></tr>
<tr class="memdesc:adecb221f91cbcaf83f4960aa9c665d04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#adecb221f91cbcaf83f4960aa9c665d04">More...</a><br /></td></tr>
<tr class="separator:adecb221f91cbcaf83f4960aa9c665d04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa63afef46ecfae45ea5dc3b9e3b2b493"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#aa63afef46ecfae45ea5dc3b9e3b2b493">FP_BN254_cmove</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y, int s)</td></tr>
<tr class="memdesc:aa63afef46ecfae45ea5dc3b9e3b2b493"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#aa63afef46ecfae45ea5dc3b9e3b2b493">More...</a><br /></td></tr>
<tr class="separator:aa63afef46ecfae45ea5dc3b9e3b2b493"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f89f76c387a056ef079e8d8e9342a6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a7f89f76c387a056ef079e8d8e9342a6a">FP_BN254_nres</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:a7f89f76c387a056ef079e8d8e9342a6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#a7f89f76c387a056ef079e8d8e9342a6a">More...</a><br /></td></tr>
<tr class="separator:a7f89f76c387a056ef079e8d8e9342a6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaca7086053f84d1a9acd1a61fa26e01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#aeaca7086053f84d1a9acd1a61fa26e01">FP_BN254_redc</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y)</td></tr>
<tr class="memdesc:aeaca7086053f84d1a9acd1a61fa26e01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#aeaca7086053f84d1a9acd1a61fa26e01">More...</a><br /></td></tr>
<tr class="separator:aeaca7086053f84d1a9acd1a61fa26e01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fc9de4de22d4acf65f327e073ff6868"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a4fc9de4de22d4acf65f327e073ff6868">FP_BN254_one</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:a4fc9de4de22d4acf65f327e073ff6868"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a4fc9de4de22d4acf65f327e073ff6868">More...</a><br /></td></tr>
<tr class="separator:a4fc9de4de22d4acf65f327e073ff6868"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32878ff78f9a1ead1d2ff46daa0f9ecd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a32878ff78f9a1ead1d2ff46daa0f9ecd">FP_BN254_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:a32878ff78f9a1ead1d2ff46daa0f9ecd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#a32878ff78f9a1ead1d2ff46daa0f9ecd">More...</a><br /></td></tr>
<tr class="separator:a32878ff78f9a1ead1d2ff46daa0f9ecd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40c78f68890810b3c3db61bd9a99b059"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a40c78f68890810b3c3db61bd9a99b059">FP_BN254_mul</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y, <a class="el" href="structFP__BN254.html">FP_BN254</a> *z)</td></tr>
<tr class="memdesc:a40c78f68890810b3c3db61bd9a99b059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#a40c78f68890810b3c3db61bd9a99b059">More...</a><br /></td></tr>
<tr class="separator:a40c78f68890810b3c3db61bd9a99b059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2be5d0f0882d62c0ec8ffc3a0f3572b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a2be5d0f0882d62c0ec8ffc3a0f3572b9">FP_BN254_imul</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y, int i)</td></tr>
<tr class="memdesc:a2be5d0f0882d62c0ec8ffc3a0f3572b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#a2be5d0f0882d62c0ec8ffc3a0f3572b9">More...</a><br /></td></tr>
<tr class="separator:a2be5d0f0882d62c0ec8ffc3a0f3572b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1383bb84c66c6e42510769d70b26c684"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a1383bb84c66c6e42510769d70b26c684">FP_BN254_sqr</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y)</td></tr>
<tr class="memdesc:a1383bb84c66c6e42510769d70b26c684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#a1383bb84c66c6e42510769d70b26c684">More...</a><br /></td></tr>
<tr class="separator:a1383bb84c66c6e42510769d70b26c684"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a528588da12fe13fe2a25262aa33f47e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a528588da12fe13fe2a25262aa33f47e2">FP_BN254_add</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y, <a class="el" href="structFP__BN254.html">FP_BN254</a> *z)</td></tr>
<tr class="memdesc:a528588da12fe13fe2a25262aa33f47e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#a528588da12fe13fe2a25262aa33f47e2">More...</a><br /></td></tr>
<tr class="separator:a528588da12fe13fe2a25262aa33f47e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94ea2f736ecbfa16a1ddf209bd9945eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a94ea2f736ecbfa16a1ddf209bd9945eb">FP_BN254_sub</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y, <a class="el" href="structFP__BN254.html">FP_BN254</a> *z)</td></tr>
<tr class="memdesc:a94ea2f736ecbfa16a1ddf209bd9945eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#a94ea2f736ecbfa16a1ddf209bd9945eb">More...</a><br /></td></tr>
<tr class="separator:a94ea2f736ecbfa16a1ddf209bd9945eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47dff95c17d1e5085b01e441ee552677"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a47dff95c17d1e5085b01e441ee552677">FP_BN254_div2</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y)</td></tr>
<tr class="memdesc:a47dff95c17d1e5085b01e441ee552677"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#a47dff95c17d1e5085b01e441ee552677">More...</a><br /></td></tr>
<tr class="separator:a47dff95c17d1e5085b01e441ee552677"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abebd25f8fdaa6f0ce0d888d861611edd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#abebd25f8fdaa6f0ce0d888d861611edd">FP_BN254_pow</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> z)</td></tr>
<tr class="memdesc:abebd25f8fdaa6f0ce0d888d861611edd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#abebd25f8fdaa6f0ce0d888d861611edd">More...</a><br /></td></tr>
<tr class="separator:abebd25f8fdaa6f0ce0d888d861611edd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cdc08067b27c99e0743a9b0f337c6d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a3cdc08067b27c99e0743a9b0f337c6d4">FP_BN254_sqrt</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y)</td></tr>
<tr class="memdesc:a3cdc08067b27c99e0743a9b0f337c6d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#a3cdc08067b27c99e0743a9b0f337c6d4">More...</a><br /></td></tr>
<tr class="separator:a3cdc08067b27c99e0743a9b0f337c6d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10b9010a7c55e787034848a4790a299a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a10b9010a7c55e787034848a4790a299a">FP_BN254_neg</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y)</td></tr>
<tr class="memdesc:a10b9010a7c55e787034848a4790a299a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#a10b9010a7c55e787034848a4790a299a">More...</a><br /></td></tr>
<tr class="separator:a10b9010a7c55e787034848a4790a299a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ab5327eacae16f90875c2c587c6270c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a5ab5327eacae16f90875c2c587c6270c">FP_BN254_output</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:a5ab5327eacae16f90875c2c587c6270c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a5ab5327eacae16f90875c2c587c6270c">More...</a><br /></td></tr>
<tr class="separator:a5ab5327eacae16f90875c2c587c6270c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5f3440e0a9dcc9a6e7766f13ca443ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#ac5f3440e0a9dcc9a6e7766f13ca443ef">FP_BN254_rawoutput</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:ac5f3440e0a9dcc9a6e7766f13ca443ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#ac5f3440e0a9dcc9a6e7766f13ca443ef">More...</a><br /></td></tr>
<tr class="separator:ac5f3440e0a9dcc9a6e7766f13ca443ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2816ef0b657315f32274266f02defea9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a2816ef0b657315f32274266f02defea9">FP_BN254_reduce</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:a2816ef0b657315f32274266f02defea9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#a2816ef0b657315f32274266f02defea9">More...</a><br /></td></tr>
<tr class="separator:a2816ef0b657315f32274266f02defea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67c9ec28bfd03f040f0aeeacb89472fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a67c9ec28bfd03f040f0aeeacb89472fb">FP_BN254_norm</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:a67c9ec28bfd03f040f0aeeacb89472fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#a67c9ec28bfd03f040f0aeeacb89472fb">More...</a><br /></td></tr>
<tr class="separator:a67c9ec28bfd03f040f0aeeacb89472fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0933cb4f43dd767eed7f9ef4667d36c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#ab0933cb4f43dd767eed7f9ef4667d36c">FP_BN254_qr</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x)</td></tr>
<tr class="memdesc:ab0933cb4f43dd767eed7f9ef4667d36c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#ab0933cb4f43dd767eed7f9ef4667d36c">More...</a><br /></td></tr>
<tr class="separator:ab0933cb4f43dd767eed7f9ef4667d36c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5905490a4fd2992b024807607af6e917"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254_8h.html#a5905490a4fd2992b024807607af6e917">FP_BN254_inv</a> (<a class="el" href="structFP__BN254.html">FP_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *y)</td></tr>
<tr class="memdesc:a5905490a4fd2992b024807607af6e917"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#a5905490a4fd2992b024807607af6e917">More...</a><br /></td></tr>
<tr class="separator:a5905490a4fd2992b024807607af6e917"><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:a57cd93681eb36ae0ead921a1175f8eae"><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__BN254_8h.html#a57cd93681eb36ae0ead921a1175f8eae">Modulus_BN254</a></td></tr>
<tr class="separator:a57cd93681eb36ae0ead921a1175f8eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6724ba752782195d1c2094448d84a0a2"><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__BN254_8h.html#a6724ba752782195d1c2094448d84a0a2">R2modp_BN254</a></td></tr>
<tr class="separator:a6724ba752782195d1c2094448d84a0a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a831f5859c3bda417b9d90cfb700a65e0"><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__BN254_8h.html#a831f5859c3bda417b9d90cfb700a65e0">MConst_BN254</a></td></tr>
<tr class="separator:a831f5859c3bda417b9d90cfb700a65e0"><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="a22540457c1bcce596f902e3bf3c738ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22540457c1bcce596f902e3bf3c738ea">&#9670;&nbsp;</a></span>FEXCESS_BN254</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_BN254&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BN254)-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="a3f3e492eaf57a968aa6233410c262fe8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f3e492eaf57a968aa6233410c262fe8">&#9670;&nbsp;</a></span>MODBITS_BN254</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_BN254&#160;&#160;&#160;MBITS_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="a237041adecb729b288aa6a243c4a0cac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a237041adecb729b288aa6a243c4a0cac">&#9670;&nbsp;</a></span>OMASK_BN254</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_BN254&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BN254_8h.html#a9fdd19163fc9231212ebf9afa9a22793">TBITS_BN254</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="a9fdd19163fc9231212ebf9afa9a22793"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fdd19163fc9231212ebf9afa9a22793">&#9670;&nbsp;</a></span>TBITS_BN254</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_BN254&#160;&#160;&#160;(MBITS_BN254%<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="ab21f7d8c697c60a7d00888963e2ff3cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab21f7d8c697c60a7d00888963e2ff3cb">&#9670;&nbsp;</a></span>TMASK_BN254</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_BN254&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BN254_8h.html#a9fdd19163fc9231212ebf9afa9a22793">TBITS_BN254</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="a528588da12fe13fe2a25262aa33f47e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a528588da12fe13fe2a25262aa33f47e2">&#9670;&nbsp;</a></span>FP_BN254_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="aa63afef46ecfae45ea5dc3b9e3b2b493"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa63afef46ecfae45ea5dc3b9e3b2b493">&#9670;&nbsp;</a></span>FP_BN254_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="ab6f5e846f1186dbff86ee5b5714454ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6f5e846f1186dbff86ee5b5714454ea">&#9670;&nbsp;</a></span>FP_BN254_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="adecb221f91cbcaf83f4960aa9c665d04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adecb221f91cbcaf83f4960aa9c665d04">&#9670;&nbsp;</a></span>FP_BN254_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a47dff95c17d1e5085b01e441ee552677"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47dff95c17d1e5085b01e441ee552677">&#9670;&nbsp;</a></span>FP_BN254_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a3904fffa0cc33cbcbe810a7ee4d26edd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3904fffa0cc33cbcbe810a7ee4d26edd">&#9670;&nbsp;</a></span>FP_BN254_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BN254_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a2be5d0f0882d62c0ec8ffc3a0f3572b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2be5d0f0882d62c0ec8ffc3a0f3572b9">&#9670;&nbsp;</a></span>FP_BN254_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a5905490a4fd2992b024807607af6e917"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5905490a4fd2992b024807607af6e917">&#9670;&nbsp;</a></span>FP_BN254_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="ae22f0d358cc5707ae7deb3f763ad2581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae22f0d358cc5707ae7deb3f763ad2581">&#9670;&nbsp;</a></span>FP_BN254_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BN254_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="a32878ff78f9a1ead1d2ff46daa0f9ecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32878ff78f9a1ead1d2ff46daa0f9ecd">&#9670;&nbsp;</a></span>FP_BN254_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_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="a40c78f68890810b3c3db61bd9a99b059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40c78f68890810b3c3db61bd9a99b059">&#9670;&nbsp;</a></span>FP_BN254_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a10b9010a7c55e787034848a4790a299a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10b9010a7c55e787034848a4790a299a">&#9670;&nbsp;</a></span>FP_BN254_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a67c9ec28bfd03f040f0aeeacb89472fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67c9ec28bfd03f040f0aeeacb89472fb">&#9670;&nbsp;</a></span>FP_BN254_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="a7f89f76c387a056ef079e8d8e9342a6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f89f76c387a056ef079e8d8e9342a6a">&#9670;&nbsp;</a></span>FP_BN254_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="a4fc9de4de22d4acf65f327e073ff6868"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fc9de4de22d4acf65f327e073ff6868">&#9670;&nbsp;</a></span>FP_BN254_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="a5ab5327eacae16f90875c2c587c6270c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ab5327eacae16f90875c2c587c6270c">&#9670;&nbsp;</a></span>FP_BN254_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="abebd25f8fdaa6f0ce0d888d861611edd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abebd25f8fdaa6f0ce0d888d861611edd">&#9670;&nbsp;</a></span>FP_BN254_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="ab0933cb4f43dd767eed7f9ef4667d36c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0933cb4f43dd767eed7f9ef4667d36c">&#9670;&nbsp;</a></span>FP_BN254_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BN254_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="ac5f3440e0a9dcc9a6e7766f13ca443ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5f3440e0a9dcc9a6e7766f13ca443ef">&#9670;&nbsp;</a></span>FP_BN254_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="ab6de42f0e349c8cd0799cf1348f5fe5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6de42f0e349c8cd0799cf1348f5fe5c">&#9670;&nbsp;</a></span>FP_BN254_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="aeaca7086053f84d1a9acd1a61fa26e01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaca7086053f84d1a9acd1a61fa26e01">&#9670;&nbsp;</a></span>FP_BN254_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_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__BN254.html">FP_BN254</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="a2816ef0b657315f32274266f02defea9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2816ef0b657315f32274266f02defea9">&#9670;&nbsp;</a></span>FP_BN254_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="a1383bb84c66c6e42510769d70b26c684"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1383bb84c66c6e42510769d70b26c684">&#9670;&nbsp;</a></span>FP_BN254_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a3cdc08067b27c99e0743a9b0f337c6d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cdc08067b27c99e0743a9b0f337c6d4">&#9670;&nbsp;</a></span>FP_BN254_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a94ea2f736ecbfa16a1ddf209bd9945eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94ea2f736ecbfa16a1ddf209bd9945eb">&#9670;&nbsp;</a></span>FP_BN254_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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__BN254.html">FP_BN254</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="a420bf442f094f392e2c0116f3eef8c69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a420bf442f094f392e2c0116f3eef8c69">&#9670;&nbsp;</a></span>FP_BN254_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254.html">FP_BN254</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="a831f5859c3bda417b9d90cfb700a65e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a831f5859c3bda417b9d90cfb700a65e0">&#9670;&nbsp;</a></span>MConst_BN254</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_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="a57cd93681eb36ae0ead921a1175f8eae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57cd93681eb36ae0ead921a1175f8eae">&#9670;&nbsp;</a></span>Modulus_BN254</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_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="a6724ba752782195d1c2094448d84a0a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6724ba752782195d1c2094448d84a0a2">&#9670;&nbsp;</a></span>R2modp_BN254</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_BN254</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.15
</small></address>
</body>
</html>