blob: 2300880f9815619772d318596dc34155e1decb44 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AMCL: fp2_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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AMCL
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df7310d1a865926cc859bcfb1880083f.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fp2_BN254.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>FP2 Header File.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="fp__BN254_8h_source.html">fp_BN254.h</a>&quot;</code><br />
</div>
<p><a href="fp2__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="structFP2__BN254.html">FP2_BN254</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP2 Structure - quadratic extension field. <a href="structFP2__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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8a0211125b06623021a5d88177b7ad09"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a8a0211125b06623021a5d88177b7ad09">FP2_BN254_iszilch</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a8a0211125b06623021a5d88177b7ad09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP2 equal to zero. <a href="#a8a0211125b06623021a5d88177b7ad09">More...</a><br /></td></tr>
<tr class="separator:a8a0211125b06623021a5d88177b7ad09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab85fa38b64bf516823a3f44ee02d1105"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#ab85fa38b64bf516823a3f44ee02d1105">FP2_BN254_cmove</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, int s)</td></tr>
<tr class="memdesc:ab85fa38b64bf516823a3f44ee02d1105"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP2 number. <a href="#ab85fa38b64bf516823a3f44ee02d1105">More...</a><br /></td></tr>
<tr class="separator:ab85fa38b64bf516823a3f44ee02d1105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3a37c7157967c85eef164d1d5ada7f9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#aa3a37c7157967c85eef164d1d5ada7f9">FP2_BN254_isunity</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:aa3a37c7157967c85eef164d1d5ada7f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP2 equal to one. <a href="#aa3a37c7157967c85eef164d1d5ada7f9">More...</a><br /></td></tr>
<tr class="separator:aa3a37c7157967c85eef164d1d5ada7f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac35c269782a9c50c2a4a7f0f7eb59c85"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#ac35c269782a9c50c2a4a7f0f7eb59c85">FP2_BN254_equals</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:ac35c269782a9c50c2a4a7f0f7eb59c85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for equality of two FP2s. <a href="#ac35c269782a9c50c2a4a7f0f7eb59c85">More...</a><br /></td></tr>
<tr class="separator:ac35c269782a9c50c2a4a7f0f7eb59c85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff82cb726b8db070099434f7567bcdbb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#aff82cb726b8db070099434f7567bcdbb">FP2_BN254_from_FPs</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *a, <a class="el" href="structFP__BN254.html">FP_BN254</a> *b)</td></tr>
<tr class="memdesc:aff82cb726b8db070099434f7567bcdbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from two FP numbers. <a href="#aff82cb726b8db070099434f7567bcdbb">More...</a><br /></td></tr>
<tr class="separator:aff82cb726b8db070099434f7567bcdbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6a6f13d8b3d9303cd3a941015b512de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#af6a6f13d8b3d9303cd3a941015b512de">FP2_BN254_from_BIGs</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> a, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:af6a6f13d8b3d9303cd3a941015b512de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from two BIG integers. <a href="#af6a6f13d8b3d9303cd3a941015b512de">More...</a><br /></td></tr>
<tr class="separator:af6a6f13d8b3d9303cd3a941015b512de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a690f1b2f00c04a826fbdf0b1edf452e0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a690f1b2f00c04a826fbdf0b1edf452e0">FP2_BN254_from_FP</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP__BN254.html">FP_BN254</a> *a)</td></tr>
<tr class="memdesc:a690f1b2f00c04a826fbdf0b1edf452e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from single FP. <a href="#a690f1b2f00c04a826fbdf0b1edf452e0">More...</a><br /></td></tr>
<tr class="separator:a690f1b2f00c04a826fbdf0b1edf452e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d0330d00fa06c54950156d8b9b4e397"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a2d0330d00fa06c54950156d8b9b4e397">FP2_BN254_from_BIG</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> a)</td></tr>
<tr class="memdesc:a2d0330d00fa06c54950156d8b9b4e397"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from single BIG. <a href="#a2d0330d00fa06c54950156d8b9b4e397">More...</a><br /></td></tr>
<tr class="separator:a2d0330d00fa06c54950156d8b9b4e397"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedec591a1b436f7079e609de188eb0e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#aedec591a1b436f7079e609de188eb0e3">FP2_BN254_copy</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:aedec591a1b436f7079e609de188eb0e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy FP2 to another FP2. <a href="#aedec591a1b436f7079e609de188eb0e3">More...</a><br /></td></tr>
<tr class="separator:aedec591a1b436f7079e609de188eb0e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06a4cbd531ab40e5b7450f0320f78c58"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a06a4cbd531ab40e5b7450f0320f78c58">FP2_BN254_zero</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a06a4cbd531ab40e5b7450f0320f78c58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP2 to zero. <a href="#a06a4cbd531ab40e5b7450f0320f78c58">More...</a><br /></td></tr>
<tr class="separator:a06a4cbd531ab40e5b7450f0320f78c58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0661313fc0aaf0189ca9434c50e2d15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#aa0661313fc0aaf0189ca9434c50e2d15">FP2_BN254_one</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:aa0661313fc0aaf0189ca9434c50e2d15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP2 to unity. <a href="#aa0661313fc0aaf0189ca9434c50e2d15">More...</a><br /></td></tr>
<tr class="separator:aa0661313fc0aaf0189ca9434c50e2d15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affb8f7756e9787c90af15475625d1752"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#affb8f7756e9787c90af15475625d1752">FP2_BN254_neg</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:affb8f7756e9787c90af15475625d1752"><td class="mdescLeft">&#160;</td><td class="mdescRight">Negation of FP2. <a href="#affb8f7756e9787c90af15475625d1752">More...</a><br /></td></tr>
<tr class="separator:affb8f7756e9787c90af15475625d1752"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b6c69d71b8819db43bf8beb270ec666"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a7b6c69d71b8819db43bf8beb270ec666">FP2_BN254_conj</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:a7b6c69d71b8819db43bf8beb270ec666"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conjugation of FP2. <a href="#a7b6c69d71b8819db43bf8beb270ec666">More...</a><br /></td></tr>
<tr class="separator:a7b6c69d71b8819db43bf8beb270ec666"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1102f14d4bb70c05f69423e8864ccd3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a1102f14d4bb70c05f69423e8864ccd3a">FP2_BN254_add</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *z)</td></tr>
<tr class="memdesc:a1102f14d4bb70c05f69423e8864ccd3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">addition of two FP2s <a href="#a1102f14d4bb70c05f69423e8864ccd3a">More...</a><br /></td></tr>
<tr class="separator:a1102f14d4bb70c05f69423e8864ccd3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abed281de2b418ffe42e4926a4276a21b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#abed281de2b418ffe42e4926a4276a21b">FP2_BN254_sub</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *z)</td></tr>
<tr class="memdesc:abed281de2b418ffe42e4926a4276a21b"><td class="mdescLeft">&#160;</td><td class="mdescRight">subtraction of two FP2s <a href="#abed281de2b418ffe42e4926a4276a21b">More...</a><br /></td></tr>
<tr class="separator:abed281de2b418ffe42e4926a4276a21b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2793cb43119dca382c0d91b910eef30a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a2793cb43119dca382c0d91b910eef30a">FP2_BN254_pmul</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, <a class="el" href="structFP__BN254.html">FP_BN254</a> *b)</td></tr>
<tr class="memdesc:a2793cb43119dca382c0d91b910eef30a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplication of an FP2 by an FP. <a href="#a2793cb43119dca382c0d91b910eef30a">More...</a><br /></td></tr>
<tr class="separator:a2793cb43119dca382c0d91b910eef30a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98dc5550629973587dcd370637a59184"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a98dc5550629973587dcd370637a59184">FP2_BN254_imul</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, int i)</td></tr>
<tr class="memdesc:a98dc5550629973587dcd370637a59184"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplication of an FP2 by a small integer. <a href="#a98dc5550629973587dcd370637a59184">More...</a><br /></td></tr>
<tr class="separator:a98dc5550629973587dcd370637a59184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69bdc7b3a097f4f26861f36bc53d3b80"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a69bdc7b3a097f4f26861f36bc53d3b80">FP2_BN254_sqr</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:a69bdc7b3a097f4f26861f36bc53d3b80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Squaring an FP2. <a href="#a69bdc7b3a097f4f26861f36bc53d3b80">More...</a><br /></td></tr>
<tr class="separator:a69bdc7b3a097f4f26861f36bc53d3b80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9155826c0c313604a4a777885b9594ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a9155826c0c313604a4a777885b9594ff">FP2_BN254_mul</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *z)</td></tr>
<tr class="memdesc:a9155826c0c313604a4a777885b9594ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplication of two FP2s. <a href="#a9155826c0c313604a4a777885b9594ff">More...</a><br /></td></tr>
<tr class="separator:a9155826c0c313604a4a777885b9594ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbf3a0ac10cfc495281a10464f7eb63c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#abbf3a0ac10cfc495281a10464f7eb63c">FP2_BN254_output</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:abbf3a0ac10cfc495281a10464f7eb63c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP2 to the console. <a href="#abbf3a0ac10cfc495281a10464f7eb63c">More...</a><br /></td></tr>
<tr class="separator:abbf3a0ac10cfc495281a10464f7eb63c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d4cf5f5ddebf71b92d61fdfee80f0ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a8d4cf5f5ddebf71b92d61fdfee80f0ba">FP2_BN254_rawoutput</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a8d4cf5f5ddebf71b92d61fdfee80f0ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP2 to the console in raw form (for debugging) <a href="#a8d4cf5f5ddebf71b92d61fdfee80f0ba">More...</a><br /></td></tr>
<tr class="separator:a8d4cf5f5ddebf71b92d61fdfee80f0ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9900b790c2c3aa3a3470c5d95e8662ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a9900b790c2c3aa3a3470c5d95e8662ff">FP2_BN254_inv</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:a9900b790c2c3aa3a3470c5d95e8662ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverting an FP2. <a href="#a9900b790c2c3aa3a3470c5d95e8662ff">More...</a><br /></td></tr>
<tr class="separator:a9900b790c2c3aa3a3470c5d95e8662ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab23344bbcfd3cd6c06ef75c4772a65d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#ab23344bbcfd3cd6c06ef75c4772a65d1">FP2_BN254_div2</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:ab23344bbcfd3cd6c06ef75c4772a65d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Divide an FP2 by 2. <a href="#ab23344bbcfd3cd6c06ef75c4772a65d1">More...</a><br /></td></tr>
<tr class="separator:ab23344bbcfd3cd6c06ef75c4772a65d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b9071be029d78a8f5becd6204311c19"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a1b9071be029d78a8f5becd6204311c19">FP2_BN254_mul_ip</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a1b9071be029d78a8f5becd6204311c19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiply an FP2 by (1+sqrt(-1)) <a href="#a1b9071be029d78a8f5becd6204311c19">More...</a><br /></td></tr>
<tr class="separator:a1b9071be029d78a8f5becd6204311c19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab742bbb7714039af62218e92f32d5f21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#ab742bbb7714039af62218e92f32d5f21">FP2_BN254_div_ip2</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:ab742bbb7714039af62218e92f32d5f21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Divide an FP2 by (1+sqrt(-1))/2 -. <a href="#ab742bbb7714039af62218e92f32d5f21">More...</a><br /></td></tr>
<tr class="separator:ab742bbb7714039af62218e92f32d5f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4f55df31206ab55e02d635a2c021eeb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#af4f55df31206ab55e02d635a2c021eeb">FP2_BN254_div_ip</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:af4f55df31206ab55e02d635a2c021eeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Divide an FP2 by (1+sqrt(-1)) <a href="#af4f55df31206ab55e02d635a2c021eeb">More...</a><br /></td></tr>
<tr class="separator:af4f55df31206ab55e02d635a2c021eeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb09afb23d212f2c2d37e3a3a50ab837"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#acb09afb23d212f2c2d37e3a3a50ab837">FP2_BN254_norm</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:acb09afb23d212f2c2d37e3a3a50ab837"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalises the components of an FP2. <a href="#acb09afb23d212f2c2d37e3a3a50ab837">More...</a><br /></td></tr>
<tr class="separator:acb09afb23d212f2c2d37e3a3a50ab837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c3e83ab012e7cdc16efe803c1c612ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a9c3e83ab012e7cdc16efe803c1c612ea">FP2_BN254_reduce</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a9c3e83ab012e7cdc16efe803c1c612ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces all components of possibly unreduced FP2 mod Modulus. <a href="#a9c3e83ab012e7cdc16efe803c1c612ea">More...</a><br /></td></tr>
<tr class="separator:a9c3e83ab012e7cdc16efe803c1c612ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8113c98d6a54c4d1e13412d8e30548d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a8113c98d6a54c4d1e13412d8e30548d7">FP2_BN254_pow</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:a8113c98d6a54c4d1e13412d8e30548d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP2 to the power of a BIG. <a href="#a8113c98d6a54c4d1e13412d8e30548d7">More...</a><br /></td></tr>
<tr class="separator:a8113c98d6a54c4d1e13412d8e30548d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2019a313b40c4c95021c6c752c3bccfe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a2019a313b40c4c95021c6c752c3bccfe">FP2_BN254_sqrt</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:a2019a313b40c4c95021c6c752c3bccfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Square root of an FP2. <a href="#a2019a313b40c4c95021c6c752c3bccfe">More...</a><br /></td></tr>
<tr class="separator:a2019a313b40c4c95021c6c752c3bccfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46c5eb6372d6adefff59cc02ad1457e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254_8h.html#a46c5eb6372d6adefff59cc02ad1457e1">FP2_BN254_times_i</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a46c5eb6372d6adefff59cc02ad1457e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiply an FP2 by sqrt(-1) <a href="#a46c5eb6372d6adefff59cc02ad1457e1">More...</a><br /></td></tr>
<tr class="separator:a46c5eb6372d6adefff59cc02ad1457e1"><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">Function Documentation</h2>
<a id="a1102f14d4bb70c05f69423e8864ccd3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1102f14d4bb70c05f69423e8864ccd3a">&#9670;&nbsp;</a></span>FP2_BN254_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = y+z </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
<tr><td class="paramname">z</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab85fa38b64bf516823a3f44ee02d1105"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab85fa38b64bf516823a3f44ee02d1105">&#9670;&nbsp;</a></span>FP2_BN254_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, set to y if s!=0 </td></tr>
<tr><td class="paramname">y</td><td>another FP2 instance </td></tr>
<tr><td class="paramname">s</td><td>copy only takes place if not equal to 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7b6c69d71b8819db43bf8beb270ec666"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b6c69d71b8819db43bf8beb270ec666">&#9670;&nbsp;</a></span>FP2_BN254_conj()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_conj </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>If y=(a,b) on exit x=(a,-b) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 instance, on exit = conj(y) </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aedec591a1b436f7079e609de188eb0e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedec591a1b436f7079e609de188eb0e3">&#9670;&nbsp;</a></span>FP2_BN254_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = y </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance to be copied </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab23344bbcfd3cd6c06ef75c4772a65d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab23344bbcfd3cd6c06ef75c4772a65d1">&#9670;&nbsp;</a></span>FP2_BN254_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = y/2 </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af4f55df31206ab55e02d635a2c021eeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4f55df31206ab55e02d635a2c021eeb">&#9670;&nbsp;</a></span>FP2_BN254_div_ip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_div_ip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Note that (1+sqrt(-1)) is irreducible for FP4 </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 instance, on exit = x/(1+sqrt(-1)) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab742bbb7714039af62218e92f32d5f21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab742bbb7714039af62218e92f32d5f21">&#9670;&nbsp;</a></span>FP2_BN254_div_ip2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_div_ip2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Note that (1+sqrt(-1)) is irreducible for FP4 </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 instance, on exit = 2x/(1+sqrt(-1)) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac35c269782a9c50c2a4a7f0f7eb59c85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac35c269782a9c50c2a4a7f0f7eb59c85">&#9670;&nbsp;</a></span>FP2_BN254_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance to be compared </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance to be compared </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if x=y, else returns 0 </dd></dl>
</div>
</div>
<a id="a2d0330d00fa06c54950156d8b9b4e397"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d0330d00fa06c54950156d8b9b4e397">&#9670;&nbsp;</a></span>FP2_BN254_from_BIG()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_from_BIG </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td>
<td class="paramname"><em>a</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Imaginary part is set to zero </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 instance to be initialised </td></tr>
<tr><td class="paramname">a</td><td>BIG to form real part of FP2 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af6a6f13d8b3d9303cd3a941015b512de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6a6f13d8b3d9303cd3a941015b512de">&#9670;&nbsp;</a></span>FP2_BN254_from_BIGs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_from_BIGs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td>
<td class="paramname"><em>a</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>b</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>FP2 instance to be initialised </td></tr>
<tr><td class="paramname">a</td><td>BIG to form real part of FP2 </td></tr>
<tr><td class="paramname">b</td><td>BIG to form imaginary part of FP2 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a690f1b2f00c04a826fbdf0b1edf452e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a690f1b2f00c04a826fbdf0b1edf452e0">&#9670;&nbsp;</a></span>FP2_BN254_from_FP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_from_FP </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>a</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Imaginary part is set to zero </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 instance to be initialised </td></tr>
<tr><td class="paramname">a</td><td>FP to form real part of FP2 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aff82cb726b8db070099434f7567bcdbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff82cb726b8db070099434f7567bcdbb">&#9670;&nbsp;</a></span>FP2_BN254_from_FPs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_from_FPs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>a</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>b</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>FP2 instance to be initialised </td></tr>
<tr><td class="paramname">a</td><td>FP to form real part of FP2 </td></tr>
<tr><td class="paramname">b</td><td>FP to form imaginary part of FP2 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a98dc5550629973587dcd370637a59184"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98dc5550629973587dcd370637a59184">&#9670;&nbsp;</a></span>FP2_BN254_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = y*i </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
<tr><td class="paramname">i</td><td>an integer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9900b790c2c3aa3a3470c5d95e8662ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9900b790c2c3aa3a3470c5d95e8662ff">&#9670;&nbsp;</a></span>FP2_BN254_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = 1/y </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa3a37c7157967c85eef164d1d5ada7f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3a37c7157967c85eef164d1d5ada7f9">&#9670;&nbsp;</a></span>FP2_BN254_isunity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254_isunity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 instance to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if x=1, else returns 0 </dd></dl>
</div>
</div>
<a id="a8a0211125b06623021a5d88177b7ad09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a0211125b06623021a5d88177b7ad09">&#9670;&nbsp;</a></span>FP2_BN254_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 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="a9155826c0c313604a4a777885b9594ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9155826c0c313604a4a777885b9594ff">&#9670;&nbsp;</a></span>FP2_BN254_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = y*z </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
<tr><td class="paramname">z</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1b9071be029d78a8f5becd6204311c19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b9071be029d78a8f5becd6204311c19">&#9670;&nbsp;</a></span>FP2_BN254_mul_ip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_mul_ip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Note that (1+sqrt(-1)) is irreducible for FP4 </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 instance, on exit = x*(1+sqrt(-1)) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="affb8f7756e9787c90af15475625d1752"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affb8f7756e9787c90af15475625d1752">&#9670;&nbsp;</a></span>FP2_BN254_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = -y </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acb09afb23d212f2c2d37e3a3a50ab837"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb09afb23d212f2c2d37e3a3a50ab837">&#9670;&nbsp;</a></span>FP2_BN254_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 instance to be normalised </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa0661313fc0aaf0189ca9434c50e2d15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0661313fc0aaf0189ca9434c50e2d15">&#9670;&nbsp;</a></span>FP2_BN254_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 instance to be set to one </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abbf3a0ac10cfc495281a10464f7eb63c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbf3a0ac10cfc495281a10464f7eb63c">&#9670;&nbsp;</a></span>FP2_BN254_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2793cb43119dca382c0d91b910eef30a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2793cb43119dca382c0d91b910eef30a">&#9670;&nbsp;</a></span>FP2_BN254_pmul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_pmul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>b</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>FP2 instance, on exit = y*b </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
<tr><td class="paramname">b</td><td>FP residue </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8113c98d6a54c4d1e13412d8e30548d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8113c98d6a54c4d1e13412d8e30548d7">&#9670;&nbsp;</a></span>FP2_BN254_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>b</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>FP2 instance, on exit = y^b </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
<tr><td class="paramname">b</td><td>BIG number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8d4cf5f5ddebf71b92d61fdfee80f0ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d4cf5f5ddebf71b92d61fdfee80f0ba">&#9670;&nbsp;</a></span>FP2_BN254_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9c3e83ab012e7cdc16efe803c1c612ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c3e83ab012e7cdc16efe803c1c612ea">&#9670;&nbsp;</a></span>FP2_BN254_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 instance, on exit reduced mod Modulus </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a69bdc7b3a097f4f26861f36bc53d3b80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69bdc7b3a097f4f26861f36bc53d3b80">&#9670;&nbsp;</a></span>FP2_BN254_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = y^2 </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2019a313b40c4c95021c6c752c3bccfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2019a313b40c4c95021c6c752c3bccfe">&#9670;&nbsp;</a></span>FP2_BN254_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = sqrt(y) </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abed281de2b418ffe42e4926a4276a21b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abed281de2b418ffe42e4926a4276a21b">&#9670;&nbsp;</a></span>FP2_BN254_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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="structFP2__BN254.html">FP2_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>FP2 instance, on exit = y-z </td></tr>
<tr><td class="paramname">y</td><td>FP2 instance </td></tr>
<tr><td class="paramname">z</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a46c5eb6372d6adefff59cc02ad1457e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46c5eb6372d6adefff59cc02ad1457e1">&#9670;&nbsp;</a></span>FP2_BN254_times_i()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_times_i </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Note that -1 is QNR </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 instance, on exit = x*sqrt(-1) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a06a4cbd531ab40e5b7450f0320f78c58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06a4cbd531ab40e5b7450f0320f78c58">&#9670;&nbsp;</a></span>FP2_BN254_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_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>FP2 instance to be set to zero </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>