blob: e7c631d6b5b3303c8dea5543f2f1a68e26153501 [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: fp2_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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fp2_BN254CX.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__BN254CX_8h_source.html">fp_BN254CX.h</a>&quot;</code><br />
</div>
<p><a href="fp2__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="structFP2__BN254CX.html">FP2_BN254CX</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP2 Structure - quadratic extension field. <a href="structFP2__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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a214af8ebd86c773a13d77ee667aa903c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a214af8ebd86c773a13d77ee667aa903c">FP2_BN254CX_iszilch</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a214af8ebd86c773a13d77ee667aa903c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP2 equal to zero. <a href="#a214af8ebd86c773a13d77ee667aa903c">More...</a><br /></td></tr>
<tr class="separator:a214af8ebd86c773a13d77ee667aa903c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a827c447bc41fdfeb035b6c44ad83106c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a827c447bc41fdfeb035b6c44ad83106c">FP2_BN254CX_cmove</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y, int s)</td></tr>
<tr class="memdesc:a827c447bc41fdfeb035b6c44ad83106c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP2 number. <a href="#a827c447bc41fdfeb035b6c44ad83106c">More...</a><br /></td></tr>
<tr class="separator:a827c447bc41fdfeb035b6c44ad83106c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cfbcd132234e9675daaa7995ac36362"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a0cfbcd132234e9675daaa7995ac36362">FP2_BN254CX_isunity</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a0cfbcd132234e9675daaa7995ac36362"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP2 equal to one. <a href="#a0cfbcd132234e9675daaa7995ac36362">More...</a><br /></td></tr>
<tr class="separator:a0cfbcd132234e9675daaa7995ac36362"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d77dbdf208964a63b2176fd156095d9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a4d77dbdf208964a63b2176fd156095d9">FP2_BN254CX_equals</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a4d77dbdf208964a63b2176fd156095d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for equality of two FP2s. <a href="#a4d77dbdf208964a63b2176fd156095d9">More...</a><br /></td></tr>
<tr class="separator:a4d77dbdf208964a63b2176fd156095d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4743b00fe7feaa02e15e92b5dd749f5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#ae4743b00fe7feaa02e15e92b5dd749f5">FP2_BN254CX_from_FPs</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *a, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *b)</td></tr>
<tr class="memdesc:ae4743b00fe7feaa02e15e92b5dd749f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from two FP numbers. <a href="#ae4743b00fe7feaa02e15e92b5dd749f5">More...</a><br /></td></tr>
<tr class="separator:ae4743b00fe7feaa02e15e92b5dd749f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbba403075d51eafdd978e3e619d9d85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#acbba403075d51eafdd978e3e619d9d85">FP2_BN254CX_from_BIGs</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</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:acbba403075d51eafdd978e3e619d9d85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from two BIG integers. <a href="#acbba403075d51eafdd978e3e619d9d85">More...</a><br /></td></tr>
<tr class="separator:acbba403075d51eafdd978e3e619d9d85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68039be55a087b9b81a2388fdb05c9d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a68039be55a087b9b81a2388fdb05c9d1">FP2_BN254CX_from_FP</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *a)</td></tr>
<tr class="memdesc:a68039be55a087b9b81a2388fdb05c9d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from single FP. <a href="#a68039be55a087b9b81a2388fdb05c9d1">More...</a><br /></td></tr>
<tr class="separator:a68039be55a087b9b81a2388fdb05c9d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a437dc0867373ceeabfa54583117f7d16"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a437dc0867373ceeabfa54583117f7d16">FP2_BN254CX_from_BIG</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> a)</td></tr>
<tr class="memdesc:a437dc0867373ceeabfa54583117f7d16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP2 from single BIG. <a href="#a437dc0867373ceeabfa54583117f7d16">More...</a><br /></td></tr>
<tr class="separator:a437dc0867373ceeabfa54583117f7d16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a325a64ff570fa3b7d79e0bc7ad4d55"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a4a325a64ff570fa3b7d79e0bc7ad4d55">FP2_BN254CX_copy</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a4a325a64ff570fa3b7d79e0bc7ad4d55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy FP2 to another FP2. <a href="#a4a325a64ff570fa3b7d79e0bc7ad4d55">More...</a><br /></td></tr>
<tr class="separator:a4a325a64ff570fa3b7d79e0bc7ad4d55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab62590b488de2022d993d6f81e139886"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#ab62590b488de2022d993d6f81e139886">FP2_BN254CX_zero</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:ab62590b488de2022d993d6f81e139886"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP2 to zero. <a href="#ab62590b488de2022d993d6f81e139886">More...</a><br /></td></tr>
<tr class="separator:ab62590b488de2022d993d6f81e139886"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb20335e53d01fc1c0769955159ae02f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#acb20335e53d01fc1c0769955159ae02f">FP2_BN254CX_one</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:acb20335e53d01fc1c0769955159ae02f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP2 to unity. <a href="#acb20335e53d01fc1c0769955159ae02f">More...</a><br /></td></tr>
<tr class="separator:acb20335e53d01fc1c0769955159ae02f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60ee4ffbd9ba9dec701d70bbac1b97a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a60ee4ffbd9ba9dec701d70bbac1b97a2">FP2_BN254CX_neg</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a60ee4ffbd9ba9dec701d70bbac1b97a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Negation of FP2. <a href="#a60ee4ffbd9ba9dec701d70bbac1b97a2">More...</a><br /></td></tr>
<tr class="separator:a60ee4ffbd9ba9dec701d70bbac1b97a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a1e1bee9342d6ed58229414489b48ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a2a1e1bee9342d6ed58229414489b48ec">FP2_BN254CX_conj</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a2a1e1bee9342d6ed58229414489b48ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conjugation of FP2. <a href="#a2a1e1bee9342d6ed58229414489b48ec">More...</a><br /></td></tr>
<tr class="separator:a2a1e1bee9342d6ed58229414489b48ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc540eec31f929aebca3814189d1d22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a7dc540eec31f929aebca3814189d1d22">FP2_BN254CX_add</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *z)</td></tr>
<tr class="memdesc:a7dc540eec31f929aebca3814189d1d22"><td class="mdescLeft">&#160;</td><td class="mdescRight">addition of two FP2s <a href="#a7dc540eec31f929aebca3814189d1d22">More...</a><br /></td></tr>
<tr class="separator:a7dc540eec31f929aebca3814189d1d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17bd9e44d4fd76ad3c327e231587486f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a17bd9e44d4fd76ad3c327e231587486f">FP2_BN254CX_sub</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *z)</td></tr>
<tr class="memdesc:a17bd9e44d4fd76ad3c327e231587486f"><td class="mdescLeft">&#160;</td><td class="mdescRight">subtraction of two FP2s <a href="#a17bd9e44d4fd76ad3c327e231587486f">More...</a><br /></td></tr>
<tr class="separator:a17bd9e44d4fd76ad3c327e231587486f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbd4677e6f63a149ff0d5a6bfa42c5a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#acbd4677e6f63a149ff0d5a6bfa42c5a9">FP2_BN254CX_pmul</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y, <a class="el" href="structFP__BN254CX.html">FP_BN254CX</a> *b)</td></tr>
<tr class="memdesc:acbd4677e6f63a149ff0d5a6bfa42c5a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplication of an FP2 by an FP. <a href="#acbd4677e6f63a149ff0d5a6bfa42c5a9">More...</a><br /></td></tr>
<tr class="separator:acbd4677e6f63a149ff0d5a6bfa42c5a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5313e8d037d4175e79f602b6f2bf41e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a5313e8d037d4175e79f602b6f2bf41e2">FP2_BN254CX_imul</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y, int i)</td></tr>
<tr class="memdesc:a5313e8d037d4175e79f602b6f2bf41e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplication of an FP2 by a small integer. <a href="#a5313e8d037d4175e79f602b6f2bf41e2">More...</a><br /></td></tr>
<tr class="separator:a5313e8d037d4175e79f602b6f2bf41e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fa6a2a2f06eb9c50de17823db16fad1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a8fa6a2a2f06eb9c50de17823db16fad1">FP2_BN254CX_sqr</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a8fa6a2a2f06eb9c50de17823db16fad1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Squaring an FP2. <a href="#a8fa6a2a2f06eb9c50de17823db16fad1">More...</a><br /></td></tr>
<tr class="separator:a8fa6a2a2f06eb9c50de17823db16fad1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5546e623124af9c1cd297c8384b7f2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#ad5546e623124af9c1cd297c8384b7f2b">FP2_BN254CX_mul</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *z)</td></tr>
<tr class="memdesc:ad5546e623124af9c1cd297c8384b7f2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplication of two FP2s. <a href="#ad5546e623124af9c1cd297c8384b7f2b">More...</a><br /></td></tr>
<tr class="separator:ad5546e623124af9c1cd297c8384b7f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aea520ed3894269e7aa24b00e0d1f43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a2aea520ed3894269e7aa24b00e0d1f43">FP2_BN254CX_output</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a2aea520ed3894269e7aa24b00e0d1f43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP2 to the console. <a href="#a2aea520ed3894269e7aa24b00e0d1f43">More...</a><br /></td></tr>
<tr class="separator:a2aea520ed3894269e7aa24b00e0d1f43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ba773ac51820722360d46d7e0e19b33"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a2ba773ac51820722360d46d7e0e19b33">FP2_BN254CX_rawoutput</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a2ba773ac51820722360d46d7e0e19b33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP2 to the console in raw form (for debugging) <a href="#a2ba773ac51820722360d46d7e0e19b33">More...</a><br /></td></tr>
<tr class="separator:a2ba773ac51820722360d46d7e0e19b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1e285d6356489e75f383b430f740d1f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#ab1e285d6356489e75f383b430f740d1f">FP2_BN254CX_inv</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:ab1e285d6356489e75f383b430f740d1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverting an FP2. <a href="#ab1e285d6356489e75f383b430f740d1f">More...</a><br /></td></tr>
<tr class="separator:ab1e285d6356489e75f383b430f740d1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36c65900edc5bd77fd3920b240973797"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a36c65900edc5bd77fd3920b240973797">FP2_BN254CX_div2</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a36c65900edc5bd77fd3920b240973797"><td class="mdescLeft">&#160;</td><td class="mdescRight">Divide an FP2 by 2. <a href="#a36c65900edc5bd77fd3920b240973797">More...</a><br /></td></tr>
<tr class="separator:a36c65900edc5bd77fd3920b240973797"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbe829666f2cbabc478f1199305814bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#afbe829666f2cbabc478f1199305814bb">FP2_BN254CX_mul_ip</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:afbe829666f2cbabc478f1199305814bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiply an FP2 by (1+sqrt(-1)) <a href="#afbe829666f2cbabc478f1199305814bb">More...</a><br /></td></tr>
<tr class="separator:afbe829666f2cbabc478f1199305814bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ff042c532e12e703a8927003e29851f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a7ff042c532e12e703a8927003e29851f">FP2_BN254CX_div_ip2</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a7ff042c532e12e703a8927003e29851f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Divide an FP2 by (1+sqrt(-1))/2 -. <a href="#a7ff042c532e12e703a8927003e29851f">More...</a><br /></td></tr>
<tr class="separator:a7ff042c532e12e703a8927003e29851f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d124e85f7f5a8dd9eb3b0d8520e97bb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a5d124e85f7f5a8dd9eb3b0d8520e97bb">FP2_BN254CX_div_ip</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a5d124e85f7f5a8dd9eb3b0d8520e97bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Divide an FP2 by (1+sqrt(-1)) <a href="#a5d124e85f7f5a8dd9eb3b0d8520e97bb">More...</a><br /></td></tr>
<tr class="separator:a5d124e85f7f5a8dd9eb3b0d8520e97bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2385bedd710e75c655c74ba43956490b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a2385bedd710e75c655c74ba43956490b">FP2_BN254CX_norm</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a2385bedd710e75c655c74ba43956490b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalises the components of an FP2. <a href="#a2385bedd710e75c655c74ba43956490b">More...</a><br /></td></tr>
<tr class="separator:a2385bedd710e75c655c74ba43956490b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab930d13c7b061f11bbd615cb1cc89374"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#ab930d13c7b061f11bbd615cb1cc89374">FP2_BN254CX_reduce</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:ab930d13c7b061f11bbd615cb1cc89374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces all components of possibly unreduced FP2 mod Modulus. <a href="#ab930d13c7b061f11bbd615cb1cc89374">More...</a><br /></td></tr>
<tr class="separator:ab930d13c7b061f11bbd615cb1cc89374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae2025a3cc00a170118877b419e599fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#aae2025a3cc00a170118877b419e599fc">FP2_BN254CX_pow</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:aae2025a3cc00a170118877b419e599fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP2 to the power of a BIG. <a href="#aae2025a3cc00a170118877b419e599fc">More...</a><br /></td></tr>
<tr class="separator:aae2025a3cc00a170118877b419e599fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a823b90a6cc24cea6e283441855613937"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#a823b90a6cc24cea6e283441855613937">FP2_BN254CX_sqrt</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a823b90a6cc24cea6e283441855613937"><td class="mdescLeft">&#160;</td><td class="mdescRight">Square root of an FP2. <a href="#a823b90a6cc24cea6e283441855613937">More...</a><br /></td></tr>
<tr class="separator:a823b90a6cc24cea6e283441855613937"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8909a043cb54e6eeca817f8d95eddd2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp2__BN254CX_8h.html#ae8909a043cb54e6eeca817f8d95eddd2">FP2_BN254CX_times_i</a> (<a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *x)</td></tr>
<tr class="memdesc:ae8909a043cb54e6eeca817f8d95eddd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiply an FP2 by sqrt(-1) <a href="#ae8909a043cb54e6eeca817f8d95eddd2">More...</a><br /></td></tr>
<tr class="separator:ae8909a043cb54e6eeca817f8d95eddd2"><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="a7dc540eec31f929aebca3814189d1d22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dc540eec31f929aebca3814189d1d22">&#9670;&nbsp;</a></span>FP2_BN254CX_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a827c447bc41fdfeb035b6c44ad83106c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a827c447bc41fdfeb035b6c44ad83106c">&#9670;&nbsp;</a></span>FP2_BN254CX_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a2a1e1bee9342d6ed58229414489b48ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a1e1bee9342d6ed58229414489b48ec">&#9670;&nbsp;</a></span>FP2_BN254CX_conj()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_conj </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a4a325a64ff570fa3b7d79e0bc7ad4d55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a325a64ff570fa3b7d79e0bc7ad4d55">&#9670;&nbsp;</a></span>FP2_BN254CX_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a36c65900edc5bd77fd3920b240973797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36c65900edc5bd77fd3920b240973797">&#9670;&nbsp;</a></span>FP2_BN254CX_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a5d124e85f7f5a8dd9eb3b0d8520e97bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d124e85f7f5a8dd9eb3b0d8520e97bb">&#9670;&nbsp;</a></span>FP2_BN254CX_div_ip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_div_ip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</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="a7ff042c532e12e703a8927003e29851f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ff042c532e12e703a8927003e29851f">&#9670;&nbsp;</a></span>FP2_BN254CX_div_ip2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_div_ip2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</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="a4d77dbdf208964a63b2176fd156095d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d77dbdf208964a63b2176fd156095d9">&#9670;&nbsp;</a></span>FP2_BN254CX_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254CX_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a437dc0867373ceeabfa54583117f7d16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a437dc0867373ceeabfa54583117f7d16">&#9670;&nbsp;</a></span>FP2_BN254CX_from_BIG()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_from_BIG </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="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="acbba403075d51eafdd978e3e619d9d85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbba403075d51eafdd978e3e619d9d85">&#9670;&nbsp;</a></span>FP2_BN254CX_from_BIGs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_from_BIGs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="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="a68039be55a087b9b81a2388fdb05c9d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68039be55a087b9b81a2388fdb05c9d1">&#9670;&nbsp;</a></span>FP2_BN254CX_from_FP()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_from_FP </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>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="ae4743b00fe7feaa02e15e92b5dd749f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4743b00fe7feaa02e15e92b5dd749f5">&#9670;&nbsp;</a></span>FP2_BN254CX_from_FPs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_from_FPs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>a</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>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="a5313e8d037d4175e79f602b6f2bf41e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5313e8d037d4175e79f602b6f2bf41e2">&#9670;&nbsp;</a></span>FP2_BN254CX_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="ab1e285d6356489e75f383b430f740d1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1e285d6356489e75f383b430f740d1f">&#9670;&nbsp;</a></span>FP2_BN254CX_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a0cfbcd132234e9675daaa7995ac36362"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cfbcd132234e9675daaa7995ac36362">&#9670;&nbsp;</a></span>FP2_BN254CX_isunity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254CX_isunity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>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="a214af8ebd86c773a13d77ee667aa903c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a214af8ebd86c773a13d77ee667aa903c">&#9670;&nbsp;</a></span>FP2_BN254CX_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254CX_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>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="ad5546e623124af9c1cd297c8384b7f2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5546e623124af9c1cd297c8384b7f2b">&#9670;&nbsp;</a></span>FP2_BN254CX_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="afbe829666f2cbabc478f1199305814bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbe829666f2cbabc478f1199305814bb">&#9670;&nbsp;</a></span>FP2_BN254CX_mul_ip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_mul_ip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</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="a60ee4ffbd9ba9dec701d70bbac1b97a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60ee4ffbd9ba9dec701d70bbac1b97a2">&#9670;&nbsp;</a></span>FP2_BN254CX_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a2385bedd710e75c655c74ba43956490b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2385bedd710e75c655c74ba43956490b">&#9670;&nbsp;</a></span>FP2_BN254CX_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>FP2 instance to be normalised </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acb20335e53d01fc1c0769955159ae02f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb20335e53d01fc1c0769955159ae02f">&#9670;&nbsp;</a></span>FP2_BN254CX_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>FP2 instance to be set to one </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2aea520ed3894269e7aa24b00e0d1f43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2aea520ed3894269e7aa24b00e0d1f43">&#9670;&nbsp;</a></span>FP2_BN254CX_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acbd4677e6f63a149ff0d5a6bfa42c5a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbd4677e6f63a149ff0d5a6bfa42c5a9">&#9670;&nbsp;</a></span>FP2_BN254CX_pmul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_pmul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="aae2025a3cc00a170118877b419e599fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae2025a3cc00a170118877b419e599fc">&#9670;&nbsp;</a></span>FP2_BN254CX_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a2ba773ac51820722360d46d7e0e19b33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ba773ac51820722360d46d7e0e19b33">&#9670;&nbsp;</a></span>FP2_BN254CX_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab930d13c7b061f11bbd615cb1cc89374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab930d13c7b061f11bbd615cb1cc89374">&#9670;&nbsp;</a></span>FP2_BN254CX_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>FP2 instance, on exit reduced mod Modulus </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8fa6a2a2f06eb9c50de17823db16fad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fa6a2a2f06eb9c50de17823db16fad1">&#9670;&nbsp;</a></span>FP2_BN254CX_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a823b90a6cc24cea6e283441855613937"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a823b90a6cc24cea6e283441855613937">&#9670;&nbsp;</a></span>FP2_BN254CX_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP2_BN254CX_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="a17bd9e44d4fd76ad3c327e231587486f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17bd9e44d4fd76ad3c327e231587486f">&#9670;&nbsp;</a></span>FP2_BN254CX_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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="structFP2__BN254CX.html">FP2_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>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="ae8909a043cb54e6eeca817f8d95eddd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8909a043cb54e6eeca817f8d95eddd2">&#9670;&nbsp;</a></span>FP2_BN254CX_times_i()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_times_i </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</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="ab62590b488de2022d993d6f81e139886"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab62590b488de2022d993d6f81e139886">&#9670;&nbsp;</a></span>FP2_BN254CX_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP2_BN254CX_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254CX.html">FP2_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>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.15
</small></address>
</body>
</html>