Google Git
Sign in
apache / incubator-milagro / 0f9f3486eeb44998c679da951836f726c8e0773d / . / website / static / cdocs / fp12__BN254CX_8h.html
blob: b28a39dd4e7f1822c1c2c54614df54d210bb9bad [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: fp12_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>
<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> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">fp12_BN254CX.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>FP12 Header File.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="fp4__BN254CX_8h_source.html">fp4_BN254CX.h</a>&quot;</code><br />
</div>
<p><a href="fp12__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="structFP12__BN254CX.html">FP12_BN254CX</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP12 Structure - towered over three FP4. <a href="structFP12__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:a3f06687cfe5b2096991ed3a05d05bfcb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a3f06687cfe5b2096991ed3a05d05bfcb">FP12_BN254CX_iszilch</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a3f06687cfe5b2096991ed3a05d05bfcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP12 equal to zero. <a href="#a3f06687cfe5b2096991ed3a05d05bfcb">More...</a><br /></td></tr>
<tr class="separator:a3f06687cfe5b2096991ed3a05d05bfcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33c6b196a1129e47497d25dc75168196"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a33c6b196a1129e47497d25dc75168196">FP12_BN254CX_isunity</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a33c6b196a1129e47497d25dc75168196"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP12 equal to unity. <a href="#a33c6b196a1129e47497d25dc75168196">More...</a><br /></td></tr>
<tr class="separator:a33c6b196a1129e47497d25dc75168196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dfcacd92e055a164bb04436de415569"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a9dfcacd92e055a164bb04436de415569">FP12_BN254CX_copy</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a9dfcacd92e055a164bb04436de415569"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy FP12 to another FP12. <a href="#a9dfcacd92e055a164bb04436de415569">More...</a><br /></td></tr>
<tr class="separator:a9dfcacd92e055a164bb04436de415569"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd404682b03b385eb712aced79bc9993"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#afd404682b03b385eb712aced79bc9993">FP12_BN254CX_one</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:afd404682b03b385eb712aced79bc9993"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP12 to unity. <a href="#afd404682b03b385eb712aced79bc9993">More...</a><br /></td></tr>
<tr class="separator:afd404682b03b385eb712aced79bc9993"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f6a0918b1c06943ffa07d016f256b59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a3f6a0918b1c06943ffa07d016f256b59">FP12_BN254CX_zero</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a3f6a0918b1c06943ffa07d016f256b59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP12 to zero. <a href="#a3f6a0918b1c06943ffa07d016f256b59">More...</a><br /></td></tr>
<tr class="separator:a3f6a0918b1c06943ffa07d016f256b59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a038cc63f3849780d38d5b8417810e334"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a038cc63f3849780d38d5b8417810e334">FP12_BN254CX_equals</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a038cc63f3849780d38d5b8417810e334"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for equality of two FP12s. <a href="#a038cc63f3849780d38d5b8417810e334">More...</a><br /></td></tr>
<tr class="separator:a038cc63f3849780d38d5b8417810e334"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9622f54f9f3d2c134039afc806e9b8d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a9622f54f9f3d2c134039afc806e9b8d4">FP12_BN254CX_conj</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a9622f54f9f3d2c134039afc806e9b8d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conjugation of FP12. <a href="#a9622f54f9f3d2c134039afc806e9b8d4">More...</a><br /></td></tr>
<tr class="separator:a9622f54f9f3d2c134039afc806e9b8d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a229277145ef3750739c7d7854c6ad99e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a229277145ef3750739c7d7854c6ad99e">FP12_BN254CX_from_FP4</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *a)</td></tr>
<tr class="memdesc:a229277145ef3750739c7d7854c6ad99e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP12 from single FP4. <a href="#a229277145ef3750739c7d7854c6ad99e">More...</a><br /></td></tr>
<tr class="separator:a229277145ef3750739c7d7854c6ad99e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8b4d5493df72b955531eefbb441f99d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#ae8b4d5493df72b955531eefbb441f99d">FP12_BN254CX_from_FP4s</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *a, <a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *b, <a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *c)</td></tr>
<tr class="memdesc:ae8b4d5493df72b955531eefbb441f99d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP12 from three FP4s. <a href="#ae8b4d5493df72b955531eefbb441f99d">More...</a><br /></td></tr>
<tr class="separator:ae8b4d5493df72b955531eefbb441f99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe51f34d41c0c34338c4d2a615e9f661"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#afe51f34d41c0c34338c4d2a615e9f661">FP12_BN254CX_usqr</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:afe51f34d41c0c34338c4d2a615e9f661"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Squaring of an FP12 in "unitary" form. <a href="#afe51f34d41c0c34338c4d2a615e9f661">More...</a><br /></td></tr>
<tr class="separator:afe51f34d41c0c34338c4d2a615e9f661"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98f8df4044b548abe01499c928a9df9f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a98f8df4044b548abe01499c928a9df9f">FP12_BN254CX_sqr</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a98f8df4044b548abe01499c928a9df9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Squaring an FP12. <a href="#a98f8df4044b548abe01499c928a9df9f">More...</a><br /></td></tr>
<tr class="separator:a98f8df4044b548abe01499c928a9df9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e9d0ad2c27f88469eb4270214e1aed0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a6e9d0ad2c27f88469eb4270214e1aed0">FP12_BN254CX_smul</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a6e9d0ad2c27f88469eb4270214e1aed0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast multiplication of two sparse FP12s that arises from ATE pairing line functions. <a href="#a6e9d0ad2c27f88469eb4270214e1aed0">More...</a><br /></td></tr>
<tr class="separator:a6e9d0ad2c27f88469eb4270214e1aed0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf58575e12f7c4fef0ad2f6ee6091321"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#abf58575e12f7c4fef0ad2f6ee6091321">FP12_BN254CX_ssmul</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:abf58575e12f7c4fef0ad2f6ee6091321"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast multiplication of what may be sparse multiplicands. <a href="#abf58575e12f7c4fef0ad2f6ee6091321">More...</a><br /></td></tr>
<tr class="separator:abf58575e12f7c4fef0ad2f6ee6091321"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ed6c8256139ec7dcdb96a1c993d7d25"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a1ed6c8256139ec7dcdb96a1c993d7d25">FP12_BN254CX_mul</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:a1ed6c8256139ec7dcdb96a1c993d7d25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full unconditional Multiplication of two FP12s. <a href="#a1ed6c8256139ec7dcdb96a1c993d7d25">More...</a><br /></td></tr>
<tr class="separator:a1ed6c8256139ec7dcdb96a1c993d7d25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdbf1fc16acb5dae4435e46e99bae4be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#afdbf1fc16acb5dae4435e46e99bae4be">FP12_BN254CX_inv</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y)</td></tr>
<tr class="memdesc:afdbf1fc16acb5dae4435e46e99bae4be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverting an FP12. <a href="#afdbf1fc16acb5dae4435e46e99bae4be">More...</a><br /></td></tr>
<tr class="separator:afdbf1fc16acb5dae4435e46e99bae4be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf362e192badd85c5df50d36aacd183a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#aaf362e192badd85c5df50d36aacd183a">FP12_BN254CX_pow</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *r, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:aaf362e192badd85c5df50d36aacd183a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 to the power of a BIG. <a href="#aaf362e192badd85c5df50d36aacd183a">More...</a><br /></td></tr>
<tr class="separator:aaf362e192badd85c5df50d36aacd183a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7db04864699b37fec47566f88d7aea92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a7db04864699b37fec47566f88d7aea92">FP12_BN254CX_pinpow</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, int i, int b)</td></tr>
<tr class="memdesc:a7db04864699b37fec47566f88d7aea92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 instance x to a small integer power, side-channel resistant. <a href="#a7db04864699b37fec47566f88d7aea92">More...</a><br /></td></tr>
<tr class="separator:a7db04864699b37fec47566f88d7aea92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8afff56eb643aff310eeede416c8344d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a8afff56eb643aff310eeede416c8344d">FP12_BN254CX_compow</a> (<a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *c, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> e, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> r)</td></tr>
<tr class="memdesc:a8afff56eb643aff310eeede416c8344d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 instance x to a BIG power, compressed to FP4. <a href="#a8afff56eb643aff310eeede416c8344d">More...</a><br /></td></tr>
<tr class="separator:a8afff56eb643aff310eeede416c8344d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16b252eda76f36d20aba57239f4cdffd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a16b252eda76f36d20aba57239f4cdffd">FP12_BN254CX_pow4</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *r, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> *b)</td></tr>
<tr class="memdesc:a16b252eda76f36d20aba57239f4cdffd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate x[0]^b[0].x[1]^b[1].x[2]^b[2].x[3]^b[3], side-channel resistant. <a href="#a16b252eda76f36d20aba57239f4cdffd">More...</a><br /></td></tr>
<tr class="separator:a16b252eda76f36d20aba57239f4cdffd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab564c5908da65319c6fc1ab4cdb69a02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#ab564c5908da65319c6fc1ab4cdb69a02">FP12_BN254CX_frob</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP2__BN254CX.html">FP2_BN254CX</a> *f)</td></tr>
<tr class="memdesc:ab564c5908da65319c6fc1ab4cdb69a02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 to the power of the internal modulus p, using the Frobenius. <a href="#ab564c5908da65319c6fc1ab4cdb69a02">More...</a><br /></td></tr>
<tr class="separator:ab564c5908da65319c6fc1ab4cdb69a02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea6e8b840d8904b3ff889e53f28b141f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#aea6e8b840d8904b3ff889e53f28b141f">FP12_BN254CX_reduce</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:aea6e8b840d8904b3ff889e53f28b141f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces all components of possibly unreduced FP12 mod Modulus. <a href="#aea6e8b840d8904b3ff889e53f28b141f">More...</a><br /></td></tr>
<tr class="separator:aea6e8b840d8904b3ff889e53f28b141f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae49d1e41a322ab3f79979d156a322aa0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#ae49d1e41a322ab3f79979d156a322aa0">FP12_BN254CX_norm</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:ae49d1e41a322ab3f79979d156a322aa0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalises the components of an FP12. <a href="#ae49d1e41a322ab3f79979d156a322aa0">More...</a><br /></td></tr>
<tr class="separator:ae49d1e41a322ab3f79979d156a322aa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7936143113cbe7579a419b3015aa2c03"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a7936143113cbe7579a419b3015aa2c03">FP12_BN254CX_output</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a7936143113cbe7579a419b3015aa2c03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP12 to the console. <a href="#a7936143113cbe7579a419b3015aa2c03">More...</a><br /></td></tr>
<tr class="separator:a7936143113cbe7579a419b3015aa2c03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a853ab74929e11fd8f5fabf31807ae711"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a853ab74929e11fd8f5fabf31807ae711">FP12_BN254CX_toOctet</a> (<a class="el" href="structoctet.html">octet</a> *S, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a853ab74929e11fd8f5fabf31807ae711"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP12 instance to an octet string. <a href="#a853ab74929e11fd8f5fabf31807ae711">More...</a><br /></td></tr>
<tr class="separator:a853ab74929e11fd8f5fabf31807ae711"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0391c8e990d3de42fcb24d23cacdf8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#af0391c8e990d3de42fcb24d23cacdf8a">FP12_BN254CX_fromOctet</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structoctet.html">octet</a> *S)</td></tr>
<tr class="memdesc:af0391c8e990d3de42fcb24d23cacdf8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an FP12 instance from an octet string. <a href="#af0391c8e990d3de42fcb24d23cacdf8a">More...</a><br /></td></tr>
<tr class="separator:af0391c8e990d3de42fcb24d23cacdf8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6078ec7d87f32b8da324638534a0986"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#ad6078ec7d87f32b8da324638534a0986">FP12_BN254CX_trace</a> (<a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *t, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:ad6078ec7d87f32b8da324638534a0986"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the trace of an FP12. <a href="#ad6078ec7d87f32b8da324638534a0986">More...</a><br /></td></tr>
<tr class="separator:ad6078ec7d87f32b8da324638534a0986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a045659409044c34a9710e16823f593ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a045659409044c34a9710e16823f593ae">FP12_BN254CX_cmove</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *y, int s)</td></tr>
<tr class="memdesc:a045659409044c34a9710e16823f593ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP12 number. <a href="#a045659409044c34a9710e16823f593ae">More...</a><br /></td></tr>
<tr class="separator:a045659409044c34a9710e16823f593ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a6faf844be96d5ff48e3ae1d8b0c75830"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a6faf844be96d5ff48e3ae1d8b0c75830">Fra_BN254CX</a></td></tr>
<tr class="separator:a6faf844be96d5ff48e3ae1d8b0c75830"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17fa2a380fb640a2993fabf146be444b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__BN254CX_8h.html#a17fa2a380fb640a2993fabf146be444b">Frb_BN254CX</a></td></tr>
<tr class="separator:a17fa2a380fb640a2993fabf146be444b"><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="a045659409044c34a9710e16823f593ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a045659409044c34a9710e16823f593ae">&#9670;&nbsp;</a></span>FP12_BN254CX_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, set to y if s!=0 </td></tr>
<tr><td class="paramname">y</td><td>another FP12 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="a8afff56eb643aff310eeede416c8344d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8afff56eb643aff310eeede416c8344d">&#9670;&nbsp;</a></span>FP12_BN254CX_compow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_compow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>e</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>r</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">c</td><td>FP4 instance, on exit = x^(e mod r) as FP4 </td></tr>
<tr><td class="paramname">x</td><td>FP12 input </td></tr>
<tr><td class="paramname">e</td><td>BIG exponent </td></tr>
<tr><td class="paramname">r</td><td>BIG group order </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9622f54f9f3d2c134039afc806e9b8d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9622f54f9f3d2c134039afc806e9b8d4">&#9670;&nbsp;</a></span>FP12_BN254CX_conj()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_conj </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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,c) (where a,b,c are its three FP4 components) on exit x=(conj(a),-conj(b),conj(c)) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP12 instance, on exit = conj(y) </td></tr>
<tr><td class="paramname">y</td><td>FP12 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9dfcacd92e055a164bb04436de415569"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dfcacd92e055a164bb04436de415569">&#9670;&nbsp;</a></span>FP12_BN254CX_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit = y </td></tr>
<tr><td class="paramname">y</td><td>FP12 instance to be copied </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a038cc63f3849780d38d5b8417810e334"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a038cc63f3849780d38d5b8417810e334">&#9670;&nbsp;</a></span>FP12_BN254CX_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP12_BN254CX_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance to be compared </td></tr>
<tr><td class="paramname">y</td><td>FP12 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="ab564c5908da65319c6fc1ab4cdb69a02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab564c5908da65319c6fc1ab4cdb69a02">&#9670;&nbsp;</a></span>FP12_BN254CX_frob()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_frob </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>f</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>FP12 instance, on exit = x^p </td></tr>
<tr><td class="paramname">f</td><td>FP2 precalculated Frobenius constant </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a229277145ef3750739c7d7854c6ad99e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a229277145ef3750739c7d7854c6ad99e">&#9670;&nbsp;</a></span>FP12_BN254CX_from_FP4()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_from_FP4 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP4__BN254CX.html">FP4_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>Sets first FP4 component of an FP12, other components set to zero </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP12 instance to be initialised </td></tr>
<tr><td class="paramname">a</td><td>FP4 to form first part of FP4 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae8b4d5493df72b955531eefbb441f99d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8b4d5493df72b955531eefbb441f99d">&#9670;&nbsp;</a></span>FP12_BN254CX_from_FP4s()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_from_FP4s </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP4__BN254CX.html">FP4_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="structFP4__BN254CX.html">FP4_BN254CX</a> *&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *&#160;</td>
<td class="paramname"><em>c</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>FP12 instance to be initialised </td></tr>
<tr><td class="paramname">a</td><td>FP4 to form first part of FP12 </td></tr>
<tr><td class="paramname">b</td><td>FP4 to form second part of FP12 </td></tr>
<tr><td class="paramname">c</td><td>FP4 to form third part of FP12 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af0391c8e990d3de42fcb24d23cacdf8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0391c8e990d3de42fcb24d23cacdf8a">&#9670;&nbsp;</a></span>FP12_BN254CX_fromOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_fromOctet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structoctet.html">octet</a> *&#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>De-serializes the components of an FP12 to create an FP12 from big-endian base 256 components. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP12 instance to be created from an octet string </td></tr>
<tr><td class="paramname">S</td><td>input octet string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afdbf1fc16acb5dae4435e46e99bae4be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdbf1fc16acb5dae4435e46e99bae4be">&#9670;&nbsp;</a></span>FP12_BN254CX_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit = 1/y </td></tr>
<tr><td class="paramname">y</td><td>FP12 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a33c6b196a1129e47497d25dc75168196"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33c6b196a1129e47497d25dc75168196">&#9670;&nbsp;</a></span>FP12_BN254CX_isunity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP12_BN254CX_isunity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>FP12 number to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if unity, else returns 0 </dd></dl>
</div>
</div>
<a id="a3f06687cfe5b2096991ed3a05d05bfcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f06687cfe5b2096991ed3a05d05bfcb">&#9670;&nbsp;</a></span>FP12_BN254CX_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP12_BN254CX_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>FP12 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="a1ed6c8256139ec7dcdb96a1c993d7d25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ed6c8256139ec7dcdb96a1c993d7d25">&#9670;&nbsp;</a></span>FP12_BN254CX_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit = x*y </td></tr>
<tr><td class="paramname">y</td><td>FP12 instance, the multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae49d1e41a322ab3f79979d156a322aa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae49d1e41a322ab3f79979d156a322aa0">&#9670;&nbsp;</a></span>FP12_BN254CX_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>FP12 instance to be normalised </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afd404682b03b385eb712aced79bc9993"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd404682b03b385eb712aced79bc9993">&#9670;&nbsp;</a></span>FP12_BN254CX_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>FP12 instance to be set to one </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7936143113cbe7579a419b3015aa2c03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7936143113cbe7579a419b3015aa2c03">&#9670;&nbsp;</a></span>FP12_BN254CX_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>FP12 instance to be printed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7db04864699b37fec47566f88d7aea92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7db04864699b37fec47566f88d7aea92">&#9670;&nbsp;</a></span>FP12_BN254CX_pinpow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_pinpow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#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>FP12 instance, on exit = x^i </td></tr>
<tr><td class="paramname">i</td><td>small integer exponent </td></tr>
<tr><td class="paramname">b</td><td>maximum number of bits in exponent </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaf362e192badd85c5df50d36aacd183a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf362e192badd85c5df50d36aacd183a">&#9670;&nbsp;</a></span>FP12_BN254CX_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>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">r</td><td>FP12 instance, on exit = y^b </td></tr>
<tr><td class="paramname">x</td><td>FP12 instance </td></tr>
<tr><td class="paramname">b</td><td>BIG number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a16b252eda76f36d20aba57239f4cdffd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16b252eda76f36d20aba57239f4cdffd">&#9670;&nbsp;</a></span>FP12_BN254CX_pow4()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_pow4 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>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">r</td><td>FP12 instance, on exit = x[0]^b[0].x[1]^b[1].x[2]^b[2].x[3]^b[3] </td></tr>
<tr><td class="paramname">x</td><td>FP12 array with 4 FP12s </td></tr>
<tr><td class="paramname">b</td><td>BIG array of 4 exponents </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aea6e8b840d8904b3ff889e53f28b141f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea6e8b840d8904b3ff889e53f28b141f">&#9670;&nbsp;</a></span>FP12_BN254CX_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit reduced mod Modulus </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6e9d0ad2c27f88469eb4270214e1aed0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e9d0ad2c27f88469eb4270214e1aed0">&#9670;&nbsp;</a></span>FP12_BN254CX_smul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_smul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit = x*y </td></tr>
<tr><td class="paramname">y</td><td>FP12 instance, of special form </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a98f8df4044b548abe01499c928a9df9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98f8df4044b548abe01499c928a9df9f">&#9670;&nbsp;</a></span>FP12_BN254CX_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit = y^2 </td></tr>
<tr><td class="paramname">y</td><td>FP12 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abf58575e12f7c4fef0ad2f6ee6091321"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf58575e12f7c4fef0ad2f6ee6091321">&#9670;&nbsp;</a></span>FP12_BN254CX_ssmul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_ssmul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit = x*y </td></tr>
<tr><td class="paramname">y</td><td>FP12 instance, of special form </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a853ab74929e11fd8f5fabf31807ae711"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a853ab74929e11fd8f5fabf31807ae711">&#9670;&nbsp;</a></span>FP12_BN254CX_toOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_toOctet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structoctet.html">octet</a> *&#160;</td>
<td class="paramname"><em>S</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Serializes the components of an FP12 to big-endian base 256 form. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">S</td><td>output octet string </td></tr>
<tr><td class="paramname">x</td><td>FP12 instance to be converted to an octet string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad6078ec7d87f32b8da324638534a0986"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6078ec7d87f32b8da324638534a0986">&#9670;&nbsp;</a></span>FP12_BN254CX_trace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_trace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP4__BN254CX.html">FP4_BN254CX</a> *&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td>FP4 trace of x, on exit = tr(x) </td></tr>
<tr><td class="paramname">x</td><td>FP12 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afe51f34d41c0c34338c4d2a615e9f661"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe51f34d41c0c34338c4d2a615e9f661">&#9670;&nbsp;</a></span>FP12_BN254CX_usqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_usqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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="structFP12__BN254CX.html">FP12_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>FP12 instance, on exit = y^2 </td></tr>
<tr><td class="paramname">y</td><td>FP4 instance, must be unitary </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3f6a0918b1c06943ffa07d016f256b59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f6a0918b1c06943ffa07d016f256b59">&#9670;&nbsp;</a></span>FP12_BN254CX_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_BN254CX_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_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>FP12 instance to be set to zero </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a6faf844be96d5ff48e3ae1d8b0c75830"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6faf844be96d5ff48e3ae1d8b0c75830">&#9670;&nbsp;</a></span>Fra_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> Fra_BN254CX</td>
</tr>
</table>
</div><div class="memdoc">
<p>real part of BN curve Frobenius Constant </p>
</div>
</div>
<a id="a17fa2a380fb640a2993fabf146be444b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17fa2a380fb640a2993fabf146be444b">&#9670;&nbsp;</a></span>Frb_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> Frb_BN254CX</td>
</tr>
</table>
</div><div class="memdoc">
<p>imaginary part of BN curve Frobenius Constant </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>