Google Git
Sign in
apache / incubator-milagro / b63e6dda48758c6d401a89facac899310e183962 / . / website / static / cdocs / fp__BN254CX_8h.html
blob: 377e9211ecaa42869d79271ea3569d2ec047e016 [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_BN254CX.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_BN254CX.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_BN254CX.h&quot;</code><br />
</div>
<p><a href="fp__BN254CX_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__BN254CX.html">FP_BN254CX</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__BN254CX.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:a56b7d198001d9eacb07f13cfdcdae2ac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a56b7d198001d9eacb07f13cfdcdae2ac">MODBITS_BN254CX</a>&#160;&#160;&#160;MBITS_BN254CX</td></tr>
<tr class="separator:a56b7d198001d9eacb07f13cfdcdae2ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05d5b75b96172325dae497d78b55397c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a05d5b75b96172325dae497d78b55397c">TBITS_BN254CX</a>&#160;&#160;&#160;(MBITS_BN254CX%<a class="el" href="config__big__256__56_8h.html#ac6cb0299279eb5c9a07bccfd297f1b40">BASEBITS_256_56</a>)</td></tr>
<tr class="separator:a05d5b75b96172325dae497d78b55397c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ce479e2e2a45a1bb96633d574681669"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a9ce479e2e2a45a1bb96633d574681669">TMASK_BN254CX</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BN254CX_8h.html#a05d5b75b96172325dae497d78b55397c">TBITS_BN254CX</a>)-1)</td></tr>
<tr class="separator:a9ce479e2e2a45a1bb96633d574681669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9efd59092ebb1d3dcd928c09ef06c23"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ac9efd59092ebb1d3dcd928c09ef06c23">FEXCESS_BN254CX</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BN254CX)-1)</td></tr>
<tr class="separator:ac9efd59092ebb1d3dcd928c09ef06c23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3b8410e93853e777ae71c9b6dda4733"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ad3b8410e93853e777ae71c9b6dda4733">OMASK_BN254CX</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BN254CX_8h.html#a05d5b75b96172325dae497d78b55397c">TBITS_BN254CX</a>))</td></tr>
<tr class="separator:ad3b8410e93853e777ae71c9b6dda4733"><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:afafe45a4c546adf0360559c5dfcf7633"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#afafe45a4c546adf0360559c5dfcf7633">FP_BN254CX_iszilch</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:afafe45a4c546adf0360559c5dfcf7633"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#afafe45a4c546adf0360559c5dfcf7633">More...</a><br /></td></tr>
<tr class="separator:afafe45a4c546adf0360559c5dfcf7633"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8d9d233cc25a36baeb03022657ceea6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#aa8d9d233cc25a36baeb03022657ceea6">FP_BN254CX_zero</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:aa8d9d233cc25a36baeb03022657ceea6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#aa8d9d233cc25a36baeb03022657ceea6">More...</a><br /></td></tr>
<tr class="separator:aa8d9d233cc25a36baeb03022657ceea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d540c873c8cacb84daa5ddd0e660b3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a7d540c873c8cacb84daa5ddd0e660b3c">FP_BN254CX_copy</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a7d540c873c8cacb84daa5ddd0e660b3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#a7d540c873c8cacb84daa5ddd0e660b3c">More...</a><br /></td></tr>
<tr class="separator:a7d540c873c8cacb84daa5ddd0e660b3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f5e08d3bdb7ea90ae0e9177e5837e0d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a1f5e08d3bdb7ea90ae0e9177e5837e0d">FP_BN254CX_rcopy</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:a1f5e08d3bdb7ea90ae0e9177e5837e0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#a1f5e08d3bdb7ea90ae0e9177e5837e0d">More...</a><br /></td></tr>
<tr class="separator:a1f5e08d3bdb7ea90ae0e9177e5837e0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cce6ac1f66046b3aa71f2af74dfdd65"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a4cce6ac1f66046b3aa71f2af74dfdd65">FP_BN254CX_equals</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a4cce6ac1f66046b3aa71f2af74dfdd65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a4cce6ac1f66046b3aa71f2af74dfdd65">More...</a><br /></td></tr>
<tr class="separator:a4cce6ac1f66046b3aa71f2af74dfdd65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a364b8a02841b3f7c6da2582281f8ada9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a364b8a02841b3f7c6da2582281f8ada9">FP_BN254CX_cswap</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, int s)</td></tr>
<tr class="memdesc:a364b8a02841b3f7c6da2582281f8ada9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#a364b8a02841b3f7c6da2582281f8ada9">More...</a><br /></td></tr>
<tr class="separator:a364b8a02841b3f7c6da2582281f8ada9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5a545006aa3f9868f23ee14bff1c014"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ae5a545006aa3f9868f23ee14bff1c014">FP_BN254CX_cmove</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, int s)</td></tr>
<tr class="memdesc:ae5a545006aa3f9868f23ee14bff1c014"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#ae5a545006aa3f9868f23ee14bff1c014">More...</a><br /></td></tr>
<tr class="separator:ae5a545006aa3f9868f23ee14bff1c014"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7375a58451529f19c7097b3ec5fa93eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a7375a58451529f19c7097b3ec5fa93eb">FP_BN254CX_nres</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:a7375a58451529f19c7097b3ec5fa93eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#a7375a58451529f19c7097b3ec5fa93eb">More...</a><br /></td></tr>
<tr class="separator:a7375a58451529f19c7097b3ec5fa93eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5289585c51bfd3639e8208f874268568"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a5289585c51bfd3639e8208f874268568">FP_BN254CX_redc</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a5289585c51bfd3639e8208f874268568"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#a5289585c51bfd3639e8208f874268568">More...</a><br /></td></tr>
<tr class="separator:a5289585c51bfd3639e8208f874268568"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e4be0b9084103476af84eb68e1897af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a0e4be0b9084103476af84eb68e1897af">FP_BN254CX_one</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a0e4be0b9084103476af84eb68e1897af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a0e4be0b9084103476af84eb68e1897af">More...</a><br /></td></tr>
<tr class="separator:a0e4be0b9084103476af84eb68e1897af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae321ed7b7270ea118cc82cbd1ac2c081"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ae321ed7b7270ea118cc82cbd1ac2c081">FP_BN254CX_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:ae321ed7b7270ea118cc82cbd1ac2c081"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#ae321ed7b7270ea118cc82cbd1ac2c081">More...</a><br /></td></tr>
<tr class="separator:ae321ed7b7270ea118cc82cbd1ac2c081"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ade68e39dc9f7b1110cbf234a98edfc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a9ade68e39dc9f7b1110cbf234a98edfc">FP_BN254CX_mul</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *z)</td></tr>
<tr class="memdesc:a9ade68e39dc9f7b1110cbf234a98edfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#a9ade68e39dc9f7b1110cbf234a98edfc">More...</a><br /></td></tr>
<tr class="separator:a9ade68e39dc9f7b1110cbf234a98edfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98e0cf29a31114c0cd093b5fe53fdfd6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a98e0cf29a31114c0cd093b5fe53fdfd6">FP_BN254CX_imul</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, int i)</td></tr>
<tr class="memdesc:a98e0cf29a31114c0cd093b5fe53fdfd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#a98e0cf29a31114c0cd093b5fe53fdfd6">More...</a><br /></td></tr>
<tr class="separator:a98e0cf29a31114c0cd093b5fe53fdfd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af78a547b9a6c9507dbfa7202d8b9aaa8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#af78a547b9a6c9507dbfa7202d8b9aaa8">FP_BN254CX_sqr</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y)</td></tr>
<tr class="memdesc:af78a547b9a6c9507dbfa7202d8b9aaa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#af78a547b9a6c9507dbfa7202d8b9aaa8">More...</a><br /></td></tr>
<tr class="separator:af78a547b9a6c9507dbfa7202d8b9aaa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac04f27285cb04e549c44f5dfd8023645"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ac04f27285cb04e549c44f5dfd8023645">FP_BN254CX_add</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *z)</td></tr>
<tr class="memdesc:ac04f27285cb04e549c44f5dfd8023645"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#ac04f27285cb04e549c44f5dfd8023645">More...</a><br /></td></tr>
<tr class="separator:ac04f27285cb04e549c44f5dfd8023645"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc144e393cc32d8d61f0953005f10ee4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#acc144e393cc32d8d61f0953005f10ee4">FP_BN254CX_sub</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *z)</td></tr>
<tr class="memdesc:acc144e393cc32d8d61f0953005f10ee4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#acc144e393cc32d8d61f0953005f10ee4">More...</a><br /></td></tr>
<tr class="separator:acc144e393cc32d8d61f0953005f10ee4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56fcd8a364447307388b23223a0eb5fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a56fcd8a364447307388b23223a0eb5fe">FP_BN254CX_div2</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a56fcd8a364447307388b23223a0eb5fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#a56fcd8a364447307388b23223a0eb5fe">More...</a><br /></td></tr>
<tr class="separator:a56fcd8a364447307388b23223a0eb5fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8911db12d3d36b413591d6ff225f906"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ae8911db12d3d36b413591d6ff225f906">FP_BN254CX_pow</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> z)</td></tr>
<tr class="memdesc:ae8911db12d3d36b413591d6ff225f906"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#ae8911db12d3d36b413591d6ff225f906">More...</a><br /></td></tr>
<tr class="separator:ae8911db12d3d36b413591d6ff225f906"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b3393d07680ae552ae67981e4e8fcca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a1b3393d07680ae552ae67981e4e8fcca">FP_BN254CX_sqrt</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a1b3393d07680ae552ae67981e4e8fcca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#a1b3393d07680ae552ae67981e4e8fcca">More...</a><br /></td></tr>
<tr class="separator:a1b3393d07680ae552ae67981e4e8fcca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f2fed5f47d3b1a94bde5c098a047cb0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a1f2fed5f47d3b1a94bde5c098a047cb0">FP_BN254CX_neg</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a1f2fed5f47d3b1a94bde5c098a047cb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#a1f2fed5f47d3b1a94bde5c098a047cb0">More...</a><br /></td></tr>
<tr class="separator:a1f2fed5f47d3b1a94bde5c098a047cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52d0534a7a5bc2795a80c9b2bf7302f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a52d0534a7a5bc2795a80c9b2bf7302f2">FP_BN254CX_output</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a52d0534a7a5bc2795a80c9b2bf7302f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a52d0534a7a5bc2795a80c9b2bf7302f2">More...</a><br /></td></tr>
<tr class="separator:a52d0534a7a5bc2795a80c9b2bf7302f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae29188a279ead7912d65a22d95bbb0a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ae29188a279ead7912d65a22d95bbb0a2">FP_BN254CX_rawoutput</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:ae29188a279ead7912d65a22d95bbb0a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#ae29188a279ead7912d65a22d95bbb0a2">More...</a><br /></td></tr>
<tr class="separator:ae29188a279ead7912d65a22d95bbb0a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c1319f45d2624124c5b40bc80219bf4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a0c1319f45d2624124c5b40bc80219bf4">FP_BN254CX_reduce</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a0c1319f45d2624124c5b40bc80219bf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#a0c1319f45d2624124c5b40bc80219bf4">More...</a><br /></td></tr>
<tr class="separator:a0c1319f45d2624124c5b40bc80219bf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf09bd2ba94fe591fb2199b9921c9ade"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#abf09bd2ba94fe591fb2199b9921c9ade">FP_BN254CX_norm</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:abf09bd2ba94fe591fb2199b9921c9ade"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#abf09bd2ba94fe591fb2199b9921c9ade">More...</a><br /></td></tr>
<tr class="separator:abf09bd2ba94fe591fb2199b9921c9ade"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c20b8725b1576e538c835b7fc330916"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#a7c20b8725b1576e538c835b7fc330916">FP_BN254CX_qr</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a7c20b8725b1576e538c835b7fc330916"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#a7c20b8725b1576e538c835b7fc330916">More...</a><br /></td></tr>
<tr class="separator:a7c20b8725b1576e538c835b7fc330916"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab091b38fbcc00e817cbe8b1bb5458dd5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__BN254CX_8h.html#ab091b38fbcc00e817cbe8b1bb5458dd5">FP_BN254CX_inv</a> (<a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *y)</td></tr>
<tr class="memdesc:ab091b38fbcc00e817cbe8b1bb5458dd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#ab091b38fbcc00e817cbe8b1bb5458dd5">More...</a><br /></td></tr>
<tr class="separator:ab091b38fbcc00e817cbe8b1bb5458dd5"><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:a72560e821d70b957f0b2d657647a15c3"><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__BN254CX_8h.html#a72560e821d70b957f0b2d657647a15c3">Modulus_BN254CX</a></td></tr>
<tr class="separator:a72560e821d70b957f0b2d657647a15c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c884b526eef7b0fd36e2a8a215c3108"><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__BN254CX_8h.html#a2c884b526eef7b0fd36e2a8a215c3108">R2modp_BN254CX</a></td></tr>
<tr class="separator:a2c884b526eef7b0fd36e2a8a215c3108"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a027389eab6f7e1a2ae45e51e42ab9177"><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__BN254CX_8h.html#a027389eab6f7e1a2ae45e51e42ab9177">MConst_BN254CX</a></td></tr>
<tr class="separator:a027389eab6f7e1a2ae45e51e42ab9177"><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="ac9efd59092ebb1d3dcd928c09ef06c23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9efd59092ebb1d3dcd928c09ef06c23">&#9670;&nbsp;</a></span>FEXCESS_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_BN254CX&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_BN254CX)-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="a56b7d198001d9eacb07f13cfdcdae2ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56b7d198001d9eacb07f13cfdcdae2ac">&#9670;&nbsp;</a></span>MODBITS_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_BN254CX&#160;&#160;&#160;MBITS_BN254CX</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="ad3b8410e93853e777ae71c9b6dda4733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3b8410e93853e777ae71c9b6dda4733">&#9670;&nbsp;</a></span>OMASK_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_BN254CX&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__BN254CX_8h.html#a05d5b75b96172325dae497d78b55397c">TBITS_BN254CX</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="a05d5b75b96172325dae497d78b55397c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05d5b75b96172325dae497d78b55397c">&#9670;&nbsp;</a></span>TBITS_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_BN254CX&#160;&#160;&#160;(MBITS_BN254CX%<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="a9ce479e2e2a45a1bb96633d574681669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ce479e2e2a45a1bb96633d574681669">&#9670;&nbsp;</a></span>TMASK_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_BN254CX&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__BN254CX_8h.html#a05d5b75b96172325dae497d78b55397c">TBITS_BN254CX</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="ac04f27285cb04e549c44f5dfd8023645"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac04f27285cb04e549c44f5dfd8023645">&#9670;&nbsp;</a></span>FP_BN254CX_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="ae5a545006aa3f9868f23ee14bff1c014"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5a545006aa3f9868f23ee14bff1c014">&#9670;&nbsp;</a></span>FP_BN254CX_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a7d540c873c8cacb84daa5ddd0e660b3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d540c873c8cacb84daa5ddd0e660b3c">&#9670;&nbsp;</a></span>FP_BN254CX_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a364b8a02841b3f7c6da2582281f8ada9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a364b8a02841b3f7c6da2582281f8ada9">&#9670;&nbsp;</a></span>FP_BN254CX_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a56fcd8a364447307388b23223a0eb5fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56fcd8a364447307388b23223a0eb5fe">&#9670;&nbsp;</a></span>FP_BN254CX_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a4cce6ac1f66046b3aa71f2af74dfdd65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4cce6ac1f66046b3aa71f2af74dfdd65">&#9670;&nbsp;</a></span>FP_BN254CX_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BN254CX_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a98e0cf29a31114c0cd093b5fe53fdfd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98e0cf29a31114c0cd093b5fe53fdfd6">&#9670;&nbsp;</a></span>FP_BN254CX_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="ab091b38fbcc00e817cbe8b1bb5458dd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab091b38fbcc00e817cbe8b1bb5458dd5">&#9670;&nbsp;</a></span>FP_BN254CX_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="afafe45a4c546adf0360559c5dfcf7633"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afafe45a4c546adf0360559c5dfcf7633">&#9670;&nbsp;</a></span>FP_BN254CX_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BN254CX_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="ae321ed7b7270ea118cc82cbd1ac2c081"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae321ed7b7270ea118cc82cbd1ac2c081">&#9670;&nbsp;</a></span>FP_BN254CX_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_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="a9ade68e39dc9f7b1110cbf234a98edfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ade68e39dc9f7b1110cbf234a98edfc">&#9670;&nbsp;</a></span>FP_BN254CX_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a1f2fed5f47d3b1a94bde5c098a047cb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f2fed5f47d3b1a94bde5c098a047cb0">&#9670;&nbsp;</a></span>FP_BN254CX_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="abf09bd2ba94fe591fb2199b9921c9ade"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf09bd2ba94fe591fb2199b9921c9ade">&#9670;&nbsp;</a></span>FP_BN254CX_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="a7375a58451529f19c7097b3ec5fa93eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7375a58451529f19c7097b3ec5fa93eb">&#9670;&nbsp;</a></span>FP_BN254CX_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="a0e4be0b9084103476af84eb68e1897af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e4be0b9084103476af84eb68e1897af">&#9670;&nbsp;</a></span>FP_BN254CX_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="a52d0534a7a5bc2795a80c9b2bf7302f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52d0534a7a5bc2795a80c9b2bf7302f2">&#9670;&nbsp;</a></span>FP_BN254CX_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="ae8911db12d3d36b413591d6ff225f906"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8911db12d3d36b413591d6ff225f906">&#9670;&nbsp;</a></span>FP_BN254CX_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a7c20b8725b1576e538c835b7fc330916"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c20b8725b1576e538c835b7fc330916">&#9670;&nbsp;</a></span>FP_BN254CX_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_BN254CX_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="ae29188a279ead7912d65a22d95bbb0a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae29188a279ead7912d65a22d95bbb0a2">&#9670;&nbsp;</a></span>FP_BN254CX_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="a1f5e08d3bdb7ea90ae0e9177e5837e0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f5e08d3bdb7ea90ae0e9177e5837e0d">&#9670;&nbsp;</a></span>FP_BN254CX_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="a5289585c51bfd3639e8208f874268568"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5289585c51bfd3639e8208f874268568">&#9670;&nbsp;</a></span>FP_BN254CX_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_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__BN254CX.html">FP_BN254CX</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="a0c1319f45d2624124c5b40bc80219bf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c1319f45d2624124c5b40bc80219bf4">&#9670;&nbsp;</a></span>FP_BN254CX_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="af78a547b9a6c9507dbfa7202d8b9aaa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af78a547b9a6c9507dbfa7202d8b9aaa8">&#9670;&nbsp;</a></span>FP_BN254CX_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="a1b3393d07680ae552ae67981e4e8fcca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b3393d07680ae552ae67981e4e8fcca">&#9670;&nbsp;</a></span>FP_BN254CX_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="acc144e393cc32d8d61f0953005f10ee4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc144e393cc32d8d61f0953005f10ee4">&#9670;&nbsp;</a></span>FP_BN254CX_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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__BN254CX.html">FP_BN254CX</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="aa8d9d233cc25a36baeb03022657ceea6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8d9d233cc25a36baeb03022657ceea6">&#9670;&nbsp;</a></span>FP_BN254CX_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_BN254CX_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__BN254CX.html">FP_BN254CX</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="a027389eab6f7e1a2ae45e51e42ab9177"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a027389eab6f7e1a2ae45e51e42ab9177">&#9670;&nbsp;</a></span>MConst_BN254CX</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_BN254CX</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="a72560e821d70b957f0b2d657647a15c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72560e821d70b957f0b2d657647a15c3">&#9670;&nbsp;</a></span>Modulus_BN254CX</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_BN254CX</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="a2c884b526eef7b0fd36e2a8a215c3108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c884b526eef7b0fd36e2a8a215c3108">&#9670;&nbsp;</a></span>R2modp_BN254CX</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_BN254CX</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>