blob: 4652fe60e1b4dbee23d1d0134d60f421f20b3639 [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: fp12_FP256BN.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> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">fp12_FP256BN.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__FP256BN_8h_source.html">fp4_FP256BN.h</a>&quot;</code><br />
</div>
<p><a href="fp12__FP256BN_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__FP256BN.html">FP12_FP256BN</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP12 Structure - towered over three FP4. <a href="structFP12__FP256BN.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:a7ed184f168cb8468f645dc2ce322141e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a7ed184f168cb8468f645dc2ce322141e">FP12_FP256BN_iszilch</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:a7ed184f168cb8468f645dc2ce322141e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP12 equal to zero. <a href="#a7ed184f168cb8468f645dc2ce322141e">More...</a><br /></td></tr>
<tr class="separator:a7ed184f168cb8468f645dc2ce322141e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7055de65a24ad9e497d963298e6fa86"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ad7055de65a24ad9e497d963298e6fa86">FP12_FP256BN_isunity</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ad7055de65a24ad9e497d963298e6fa86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP12 equal to unity. <a href="#ad7055de65a24ad9e497d963298e6fa86">More...</a><br /></td></tr>
<tr class="separator:ad7055de65a24ad9e497d963298e6fa86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed2909f75f0fe4dfa5bbaf598ec8a2ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#aed2909f75f0fe4dfa5bbaf598ec8a2ae">FP12_FP256BN_copy</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:aed2909f75f0fe4dfa5bbaf598ec8a2ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy FP12 to another FP12. <a href="#aed2909f75f0fe4dfa5bbaf598ec8a2ae">More...</a><br /></td></tr>
<tr class="separator:aed2909f75f0fe4dfa5bbaf598ec8a2ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00ad6e0d4a9f57a95f45a99b0247b719"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a00ad6e0d4a9f57a95f45a99b0247b719">FP12_FP256BN_one</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:a00ad6e0d4a9f57a95f45a99b0247b719"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP12 to unity. <a href="#a00ad6e0d4a9f57a95f45a99b0247b719">More...</a><br /></td></tr>
<tr class="separator:a00ad6e0d4a9f57a95f45a99b0247b719"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17efe133c8bd07123a8bc6abf63d342"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ad17efe133c8bd07123a8bc6abf63d342">FP12_FP256BN_zero</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ad17efe133c8bd07123a8bc6abf63d342"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP12 to zero. <a href="#ad17efe133c8bd07123a8bc6abf63d342">More...</a><br /></td></tr>
<tr class="separator:ad17efe133c8bd07123a8bc6abf63d342"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86e3615517fb8fdce97bd385f50e9e2e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a86e3615517fb8fdce97bd385f50e9e2e">FP12_FP256BN_equals</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a86e3615517fb8fdce97bd385f50e9e2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for equality of two FP12s. <a href="#a86e3615517fb8fdce97bd385f50e9e2e">More...</a><br /></td></tr>
<tr class="separator:a86e3615517fb8fdce97bd385f50e9e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a0e66aebef94948bc659447ea9c62ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a3a0e66aebef94948bc659447ea9c62ec">FP12_FP256BN_conj</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a3a0e66aebef94948bc659447ea9c62ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conjugation of FP12. <a href="#a3a0e66aebef94948bc659447ea9c62ec">More...</a><br /></td></tr>
<tr class="separator:a3a0e66aebef94948bc659447ea9c62ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0faf95928f1f91b9ee8a64e898ceec5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ae0faf95928f1f91b9ee8a64e898ceec5">FP12_FP256BN_from_FP4</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</a> *a)</td></tr>
<tr class="memdesc:ae0faf95928f1f91b9ee8a64e898ceec5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP12 from single FP4. <a href="#ae0faf95928f1f91b9ee8a64e898ceec5">More...</a><br /></td></tr>
<tr class="separator:ae0faf95928f1f91b9ee8a64e898ceec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5ea7bf1368bfba902bdcd69c84cdba1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ad5ea7bf1368bfba902bdcd69c84cdba1">FP12_FP256BN_from_FP4s</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</a> *a, <a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</a> *b, <a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</a> *c)</td></tr>
<tr class="memdesc:ad5ea7bf1368bfba902bdcd69c84cdba1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise FP12 from three FP4s. <a href="#ad5ea7bf1368bfba902bdcd69c84cdba1">More...</a><br /></td></tr>
<tr class="separator:ad5ea7bf1368bfba902bdcd69c84cdba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b82bd9b19c1e4bde37285e9bf4123d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a2b82bd9b19c1e4bde37285e9bf4123d0">FP12_FP256BN_usqr</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a2b82bd9b19c1e4bde37285e9bf4123d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Squaring of an FP12 in "unitary" form. <a href="#a2b82bd9b19c1e4bde37285e9bf4123d0">More...</a><br /></td></tr>
<tr class="separator:a2b82bd9b19c1e4bde37285e9bf4123d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaedf95e7146f4291f9e3671899015131"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#aaedf95e7146f4291f9e3671899015131">FP12_FP256BN_sqr</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:aaedf95e7146f4291f9e3671899015131"><td class="mdescLeft">&#160;</td><td class="mdescRight">Squaring an FP12. <a href="#aaedf95e7146f4291f9e3671899015131">More...</a><br /></td></tr>
<tr class="separator:aaedf95e7146f4291f9e3671899015131"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcec9f5e6a3351b41fb4dd7fe29092ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#abcec9f5e6a3351b41fb4dd7fe29092ba">FP12_FP256BN_smul</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:abcec9f5e6a3351b41fb4dd7fe29092ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast multiplication of two sparse FP12s that arises from ATE pairing line functions. <a href="#abcec9f5e6a3351b41fb4dd7fe29092ba">More...</a><br /></td></tr>
<tr class="separator:abcec9f5e6a3351b41fb4dd7fe29092ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87bf2b55be8123161f8db176b3b4683e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a87bf2b55be8123161f8db176b3b4683e">FP12_FP256BN_ssmul</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a87bf2b55be8123161f8db176b3b4683e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast multiplication of what may be sparse multiplicands. <a href="#a87bf2b55be8123161f8db176b3b4683e">More...</a><br /></td></tr>
<tr class="separator:a87bf2b55be8123161f8db176b3b4683e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a37913bde3a60c1a3eb0ff45e29160d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a7a37913bde3a60c1a3eb0ff45e29160d">FP12_FP256BN_mul</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:a7a37913bde3a60c1a3eb0ff45e29160d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full unconditional Multiplication of two FP12s. <a href="#a7a37913bde3a60c1a3eb0ff45e29160d">More...</a><br /></td></tr>
<tr class="separator:a7a37913bde3a60c1a3eb0ff45e29160d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6d45c47e4c5dc983809304a9603ab3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ae6d45c47e4c5dc983809304a9603ab3a">FP12_FP256BN_inv</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y)</td></tr>
<tr class="memdesc:ae6d45c47e4c5dc983809304a9603ab3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverting an FP12. <a href="#ae6d45c47e4c5dc983809304a9603ab3a">More...</a><br /></td></tr>
<tr class="separator:ae6d45c47e4c5dc983809304a9603ab3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf0d66cc8ac7f14a36da92bc9ddfa03e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#aaf0d66cc8ac7f14a36da92bc9ddfa03e">FP12_FP256BN_pow</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *r, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:aaf0d66cc8ac7f14a36da92bc9ddfa03e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 to the power of a BIG. <a href="#aaf0d66cc8ac7f14a36da92bc9ddfa03e">More...</a><br /></td></tr>
<tr class="separator:aaf0d66cc8ac7f14a36da92bc9ddfa03e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18144f8f7c6195f14d67c1587615277f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a18144f8f7c6195f14d67c1587615277f">FP12_FP256BN_pinpow</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, int i, int b)</td></tr>
<tr class="memdesc:a18144f8f7c6195f14d67c1587615277f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 instance x to a small integer power, side-channel resistant. <a href="#a18144f8f7c6195f14d67c1587615277f">More...</a><br /></td></tr>
<tr class="separator:a18144f8f7c6195f14d67c1587615277f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3536761aec1ffebecd5530ebb7660957"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a3536761aec1ffebecd5530ebb7660957">FP12_FP256BN_compow</a> (<a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</a> *c, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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:a3536761aec1ffebecd5530ebb7660957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 instance x to a BIG power, compressed to FP4. <a href="#a3536761aec1ffebecd5530ebb7660957">More...</a><br /></td></tr>
<tr class="separator:a3536761aec1ffebecd5530ebb7660957"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bc832c279da28250b84bb6be4d095ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a4bc832c279da28250b84bb6be4d095ec">FP12_FP256BN_pow4</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *r, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> *b)</td></tr>
<tr class="memdesc:a4bc832c279da28250b84bb6be4d095ec"><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="#a4bc832c279da28250b84bb6be4d095ec">More...</a><br /></td></tr>
<tr class="separator:a4bc832c279da28250b84bb6be4d095ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c2ce854ebeebeea9d3a5f566e227672"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a1c2ce854ebeebeea9d3a5f566e227672">FP12_FP256BN_frob</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP2__FP256BN.html">FP2_FP256BN</a> *f)</td></tr>
<tr class="memdesc:a1c2ce854ebeebeea9d3a5f566e227672"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raises an FP12 to the power of the internal modulus p, using the Frobenius. <a href="#a1c2ce854ebeebeea9d3a5f566e227672">More...</a><br /></td></tr>
<tr class="separator:a1c2ce854ebeebeea9d3a5f566e227672"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0721b58391f89f716fbaf1f56c9e0ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ae0721b58391f89f716fbaf1f56c9e0ae">FP12_FP256BN_reduce</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ae0721b58391f89f716fbaf1f56c9e0ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces all components of possibly unreduced FP12 mod Modulus. <a href="#ae0721b58391f89f716fbaf1f56c9e0ae">More...</a><br /></td></tr>
<tr class="separator:ae0721b58391f89f716fbaf1f56c9e0ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac552cbff5268b3df3b65699da7ff5ceb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ac552cbff5268b3df3b65699da7ff5ceb">FP12_FP256BN_norm</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ac552cbff5268b3df3b65699da7ff5ceb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalises the components of an FP12. <a href="#ac552cbff5268b3df3b65699da7ff5ceb">More...</a><br /></td></tr>
<tr class="separator:ac552cbff5268b3df3b65699da7ff5ceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a312614bdf4d82a1caa6cfd644ec8cca5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a312614bdf4d82a1caa6cfd644ec8cca5">FP12_FP256BN_output</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:a312614bdf4d82a1caa6cfd644ec8cca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP12 to the console. <a href="#a312614bdf4d82a1caa6cfd644ec8cca5">More...</a><br /></td></tr>
<tr class="separator:a312614bdf4d82a1caa6cfd644ec8cca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab087a155b3f6d21b1f83f0a44ec4a563"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#ab087a155b3f6d21b1f83f0a44ec4a563">FP12_FP256BN_toOctet</a> (<a class="el" href="structoctet.html">octet</a> *S, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:ab087a155b3f6d21b1f83f0a44ec4a563"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an FP12 instance to an octet string. <a href="#ab087a155b3f6d21b1f83f0a44ec4a563">More...</a><br /></td></tr>
<tr class="separator:ab087a155b3f6d21b1f83f0a44ec4a563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70f0ca2f79c3a78d6b1c4b9789d776b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a70f0ca2f79c3a78d6b1c4b9789d776b7">FP12_FP256BN_fromOctet</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structoctet.html">octet</a> *S)</td></tr>
<tr class="memdesc:a70f0ca2f79c3a78d6b1c4b9789d776b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an FP12 instance from an octet string. <a href="#a70f0ca2f79c3a78d6b1c4b9789d776b7">More...</a><br /></td></tr>
<tr class="separator:a70f0ca2f79c3a78d6b1c4b9789d776b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a756cdc5821e391ab4dea11e6367df013"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a756cdc5821e391ab4dea11e6367df013">FP12_FP256BN_trace</a> (<a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</a> *t, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x)</td></tr>
<tr class="memdesc:a756cdc5821e391ab4dea11e6367df013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the trace of an FP12. <a href="#a756cdc5821e391ab4dea11e6367df013">More...</a><br /></td></tr>
<tr class="separator:a756cdc5821e391ab4dea11e6367df013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cdfbd9dcf3b1022831c0c31650599fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp12__FP256BN_8h.html#a9cdfbd9dcf3b1022831c0c31650599fa">FP12_FP256BN_cmove</a> (<a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *x, <a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</a> *y, int s)</td></tr>
<tr class="memdesc:a9cdfbd9dcf3b1022831c0c31650599fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP12 number. <a href="#a9cdfbd9dcf3b1022831c0c31650599fa">More...</a><br /></td></tr>
<tr class="separator:a9cdfbd9dcf3b1022831c0c31650599fa"><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:a682906829e5ad5c597e675693c5bd8e4"><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__FP256BN_8h.html#a682906829e5ad5c597e675693c5bd8e4">Fra_FP256BN</a></td></tr>
<tr class="separator:a682906829e5ad5c597e675693c5bd8e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8a72f4c35da61849fac206d83565394"><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__FP256BN_8h.html#ad8a72f4c35da61849fac206d83565394">Frb_FP256BN</a></td></tr>
<tr class="separator:ad8a72f4c35da61849fac206d83565394"><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="a9cdfbd9dcf3b1022831c0c31650599fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cdfbd9dcf3b1022831c0c31650599fa">&#9670;&nbsp;</a></span>FP12_FP256BN_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="a3536761aec1ffebecd5530ebb7660957"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3536761aec1ffebecd5530ebb7660957">&#9670;&nbsp;</a></span>FP12_FP256BN_compow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_compow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</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__FP256BN.html">FP12_FP256BN</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="a3a0e66aebef94948bc659447ea9c62ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a0e66aebef94948bc659447ea9c62ec">&#9670;&nbsp;</a></span>FP12_FP256BN_conj()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_conj </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="aed2909f75f0fe4dfa5bbaf598ec8a2ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed2909f75f0fe4dfa5bbaf598ec8a2ae">&#9670;&nbsp;</a></span>FP12_FP256BN_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="a86e3615517fb8fdce97bd385f50e9e2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86e3615517fb8fdce97bd385f50e9e2e">&#9670;&nbsp;</a></span>FP12_FP256BN_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP12_FP256BN_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="a1c2ce854ebeebeea9d3a5f566e227672"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c2ce854ebeebeea9d3a5f566e227672">&#9670;&nbsp;</a></span>FP12_FP256BN_frob()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_frob </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP2_FP256BN</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="ae0faf95928f1f91b9ee8a64e898ceec5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0faf95928f1f91b9ee8a64e898ceec5">&#9670;&nbsp;</a></span>FP12_FP256BN_from_FP4()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_from_FP4 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP4_FP256BN</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="ad5ea7bf1368bfba902bdcd69c84cdba1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5ea7bf1368bfba902bdcd69c84cdba1">&#9670;&nbsp;</a></span>FP12_FP256BN_from_FP4s()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_from_FP4s </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP4_FP256BN</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__FP256BN.html">FP4_FP256BN</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__FP256BN.html">FP4_FP256BN</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="a70f0ca2f79c3a78d6b1c4b9789d776b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70f0ca2f79c3a78d6b1c4b9789d776b7">&#9670;&nbsp;</a></span>FP12_FP256BN_fromOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_fromOctet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="ae6d45c47e4c5dc983809304a9603ab3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6d45c47e4c5dc983809304a9603ab3a">&#9670;&nbsp;</a></span>FP12_FP256BN_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="ad7055de65a24ad9e497d963298e6fa86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7055de65a24ad9e497d963298e6fa86">&#9670;&nbsp;</a></span>FP12_FP256BN_isunity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP12_FP256BN_isunity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="a7ed184f168cb8468f645dc2ce322141e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ed184f168cb8468f645dc2ce322141e">&#9670;&nbsp;</a></span>FP12_FP256BN_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP12_FP256BN_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="a7a37913bde3a60c1a3eb0ff45e29160d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a37913bde3a60c1a3eb0ff45e29160d">&#9670;&nbsp;</a></span>FP12_FP256BN_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="ac552cbff5268b3df3b65699da7ff5ceb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac552cbff5268b3df3b65699da7ff5ceb">&#9670;&nbsp;</a></span>FP12_FP256BN_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="a00ad6e0d4a9f57a95f45a99b0247b719"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00ad6e0d4a9f57a95f45a99b0247b719">&#9670;&nbsp;</a></span>FP12_FP256BN_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="a312614bdf4d82a1caa6cfd644ec8cca5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a312614bdf4d82a1caa6cfd644ec8cca5">&#9670;&nbsp;</a></span>FP12_FP256BN_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="a18144f8f7c6195f14d67c1587615277f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18144f8f7c6195f14d67c1587615277f">&#9670;&nbsp;</a></span>FP12_FP256BN_pinpow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_pinpow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="aaf0d66cc8ac7f14a36da92bc9ddfa03e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf0d66cc8ac7f14a36da92bc9ddfa03e">&#9670;&nbsp;</a></span>FP12_FP256BN_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="a4bc832c279da28250b84bb6be4d095ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bc832c279da28250b84bb6be4d095ec">&#9670;&nbsp;</a></span>FP12_FP256BN_pow4()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_pow4 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="ae0721b58391f89f716fbaf1f56c9e0ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0721b58391f89f716fbaf1f56c9e0ae">&#9670;&nbsp;</a></span>FP12_FP256BN_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="abcec9f5e6a3351b41fb4dd7fe29092ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcec9f5e6a3351b41fb4dd7fe29092ba">&#9670;&nbsp;</a></span>FP12_FP256BN_smul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_smul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="aaedf95e7146f4291f9e3671899015131"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaedf95e7146f4291f9e3671899015131">&#9670;&nbsp;</a></span>FP12_FP256BN_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="a87bf2b55be8123161f8db176b3b4683e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87bf2b55be8123161f8db176b3b4683e">&#9670;&nbsp;</a></span>FP12_FP256BN_ssmul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_ssmul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="ab087a155b3f6d21b1f83f0a44ec4a563"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab087a155b3f6d21b1f83f0a44ec4a563">&#9670;&nbsp;</a></span>FP12_FP256BN_toOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_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__FP256BN.html">FP12_FP256BN</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="a756cdc5821e391ab4dea11e6367df013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a756cdc5821e391ab4dea11e6367df013">&#9670;&nbsp;</a></span>FP12_FP256BN_trace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_trace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP4__FP256BN.html">FP4_FP256BN</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__FP256BN.html">FP12_FP256BN</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="a2b82bd9b19c1e4bde37285e9bf4123d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b82bd9b19c1e4bde37285e9bf4123d0">&#9670;&nbsp;</a></span>FP12_FP256BN_usqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_usqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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__FP256BN.html">FP12_FP256BN</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="ad17efe133c8bd07123a8bc6abf63d342"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad17efe133c8bd07123a8bc6abf63d342">&#9670;&nbsp;</a></span>FP12_FP256BN_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP12_FP256BN_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__FP256BN.html">FP12_FP256BN</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="a682906829e5ad5c597e675693c5bd8e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a682906829e5ad5c597e675693c5bd8e4">&#9670;&nbsp;</a></span>Fra_FP256BN</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_FP256BN</td>
</tr>
</table>
</div><div class="memdoc">
<p>real part of BN curve Frobenius Constant </p>
</div>
</div>
<a id="ad8a72f4c35da61849fac206d83565394"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8a72f4c35da61849fac206d83565394">&#9670;&nbsp;</a></span>Frb_FP256BN</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_FP256BN</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.15
</small></address>
</body>
</html>