blob: d0c244e9780c36784363a99a3c358aebe11d40a6 [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: ecp2_BN254.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<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">ecp2_BN254.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>ECP2 Header File.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="fp2__BN254_8h_source.html">fp2_BN254.h</a>&quot;</code><br />
<code>#include &quot;config_curve_BN254.h&quot;</code><br />
</div>
<p><a href="ecp2__BN254_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">ECP2 Structure - Elliptic Curve Point over quadratic extension field. <a href="structECP2__BN254.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a33085074d0751b05853f167d3db8d147"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a33085074d0751b05853f167d3db8d147">ECP2_BN254_isinf</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a33085074d0751b05853f167d3db8d147"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for ECP2 point equal to infinity. <a href="#a33085074d0751b05853f167d3db8d147">More...</a><br /></td></tr>
<tr class="separator:a33085074d0751b05853f167d3db8d147"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8874e2a045c086ff06378f411bdea2c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#ad8874e2a045c086ff06378f411bdea2c">ECP2_BN254_copy</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *Q)</td></tr>
<tr class="memdesc:ad8874e2a045c086ff06378f411bdea2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy ECP2 point to another ECP2 point. <a href="#ad8874e2a045c086ff06378f411bdea2c">More...</a><br /></td></tr>
<tr class="separator:ad8874e2a045c086ff06378f411bdea2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b8b66f30bf8180c9b9ce13cabef8ed5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a1b8b66f30bf8180c9b9ce13cabef8ed5">ECP2_BN254_inf</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a1b8b66f30bf8180c9b9ce13cabef8ed5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set ECP2 to point-at-infinity. <a href="#a1b8b66f30bf8180c9b9ce13cabef8ed5">More...</a><br /></td></tr>
<tr class="separator:a1b8b66f30bf8180c9b9ce13cabef8ed5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab658828ec441b7eb2ba3f0bb91e22f81"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#ab658828ec441b7eb2ba3f0bb91e22f81">ECP2_BN254_equals</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *Q)</td></tr>
<tr class="memdesc:ab658828ec441b7eb2ba3f0bb91e22f81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for equality of two ECP2s. <a href="#ab658828ec441b7eb2ba3f0bb91e22f81">More...</a><br /></td></tr>
<tr class="separator:ab658828ec441b7eb2ba3f0bb91e22f81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2e84b0df8d7a0d047e6df8f9139a406"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#ad2e84b0df8d7a0d047e6df8f9139a406">ECP2_BN254_affine</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:ad2e84b0df8d7a0d047e6df8f9139a406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an ECP2 point from Projective (x,y,z) coordinates to affine (x,y) coordinates. <a href="#ad2e84b0df8d7a0d047e6df8f9139a406">More...</a><br /></td></tr>
<tr class="separator:ad2e84b0df8d7a0d047e6df8f9139a406"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35c106e8fe281774fa98c87d2d45083c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a35c106e8fe281774fa98c87d2d45083c">ECP2_BN254_get</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y, <a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a35c106e8fe281774fa98c87d2d45083c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract x and y coordinates of an ECP2 point P. <a href="#a35c106e8fe281774fa98c87d2d45083c">More...</a><br /></td></tr>
<tr class="separator:a35c106e8fe281774fa98c87d2d45083c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ed476f4bbbaa8127ca0ca031048c04d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a4ed476f4bbbaa8127ca0ca031048c04d">ECP2_BN254_output</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a4ed476f4bbbaa8127ca0ca031048c04d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an ECP2 point to the console, converted to affine coordinates. <a href="#a4ed476f4bbbaa8127ca0ca031048c04d">More...</a><br /></td></tr>
<tr class="separator:a4ed476f4bbbaa8127ca0ca031048c04d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7848eccea1a8b56906a979cda7c3c0c9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a7848eccea1a8b56906a979cda7c3c0c9">ECP2_BN254_outputxyz</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a7848eccea1a8b56906a979cda7c3c0c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an ECP2 point to the console, in projective coordinates. <a href="#a7848eccea1a8b56906a979cda7c3c0c9">More...</a><br /></td></tr>
<tr class="separator:a7848eccea1a8b56906a979cda7c3c0c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a7d59f3d5012616915282f8029e823a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a8a7d59f3d5012616915282f8029e823a">ECP2_BN254_toOctet</a> (<a class="el" href="structoctet.html">octet</a> *S, <a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a8a7d59f3d5012616915282f8029e823a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats and outputs an ECP2 point to an octet string. <a href="#a8a7d59f3d5012616915282f8029e823a">More...</a><br /></td></tr>
<tr class="separator:a8a7d59f3d5012616915282f8029e823a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a407091af8011693640727e5ee15ada96"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a407091af8011693640727e5ee15ada96">ECP2_BN254_fromOctet</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structoctet.html">octet</a> *S)</td></tr>
<tr class="memdesc:a407091af8011693640727e5ee15ada96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an ECP2 point from an octet string. <a href="#a407091af8011693640727e5ee15ada96">More...</a><br /></td></tr>
<tr class="separator:a407091af8011693640727e5ee15ada96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cf3f2bf367499bb8b9897deebbb1809"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a6cf3f2bf367499bb8b9897deebbb1809">ECP2_BN254_rhs</a> (<a class="el" href="structFP2__BN254.html">FP2_BN254</a> *r, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a6cf3f2bf367499bb8b9897deebbb1809"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate Right Hand Side of curve equation y^2=f(x) <a href="#a6cf3f2bf367499bb8b9897deebbb1809">More...</a><br /></td></tr>
<tr class="separator:a6cf3f2bf367499bb8b9897deebbb1809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46360b68aacd3e91e7fa741afba6072f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a46360b68aacd3e91e7fa741afba6072f">ECP2_BN254_set</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *y)</td></tr>
<tr class="memdesc:a46360b68aacd3e91e7fa741afba6072f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set ECP2 to point(x,y) given x and y. <a href="#a46360b68aacd3e91e7fa741afba6072f">More...</a><br /></td></tr>
<tr class="separator:a46360b68aacd3e91e7fa741afba6072f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06918d1705760b4b067e3265a3415924"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a06918d1705760b4b067e3265a3415924">ECP2_BN254_setx</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *x)</td></tr>
<tr class="memdesc:a06918d1705760b4b067e3265a3415924"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set ECP to point(x,[y]) given x. <a href="#a06918d1705760b4b067e3265a3415924">More...</a><br /></td></tr>
<tr class="separator:a06918d1705760b4b067e3265a3415924"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b07cb8e5b2c708db3e83c045ac71a30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a6b07cb8e5b2c708db3e83c045ac71a30">ECP2_BN254_neg</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a6b07cb8e5b2c708db3e83c045ac71a30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Negation of an ECP2 point. <a href="#a6b07cb8e5b2c708db3e83c045ac71a30">More...</a><br /></td></tr>
<tr class="separator:a6b07cb8e5b2c708db3e83c045ac71a30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8121a4f4f8d449069905cb4ebfe9ca84"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a8121a4f4f8d449069905cb4ebfe9ca84">ECP2_BN254_dbl</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P)</td></tr>
<tr class="memdesc:a8121a4f4f8d449069905cb4ebfe9ca84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Doubles an ECP2 instance P. <a href="#a8121a4f4f8d449069905cb4ebfe9ca84">More...</a><br /></td></tr>
<tr class="separator:a8121a4f4f8d449069905cb4ebfe9ca84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a936f6bb068aa0ce533e6dc51b56f7786"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a936f6bb068aa0ce533e6dc51b56f7786">ECP2_BN254_add</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *Q)</td></tr>
<tr class="memdesc:a936f6bb068aa0ce533e6dc51b56f7786"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds ECP2 instance Q to ECP2 instance P. <a href="#a936f6bb068aa0ce533e6dc51b56f7786">More...</a><br /></td></tr>
<tr class="separator:a936f6bb068aa0ce533e6dc51b56f7786"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a645aa7bbf498d23b31c8dcb64621146c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a645aa7bbf498d23b31c8dcb64621146c">ECP2_BN254_sub</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *Q)</td></tr>
<tr class="memdesc:a645aa7bbf498d23b31c8dcb64621146c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subtracts ECP instance Q from ECP2 instance P. <a href="#a645aa7bbf498d23b31c8dcb64621146c">More...</a><br /></td></tr>
<tr class="separator:a645aa7bbf498d23b31c8dcb64621146c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab6d595eee28622b5e6ae9012ae669a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#aab6d595eee28622b5e6ae9012ae669a0">ECP2_BN254_mul</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:aab6d595eee28622b5e6ae9012ae669a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplies an ECP2 instance P by a BIG, side-channel resistant. <a href="#aab6d595eee28622b5e6ae9012ae669a0">More...</a><br /></td></tr>
<tr class="separator:aab6d595eee28622b5e6ae9012ae669a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a211e966c3b60d75f3ffc37bd0275aae0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a211e966c3b60d75f3ffc37bd0275aae0">ECP2_BN254_frob</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structFP2__BN254.html">FP2_BN254</a> *f)</td></tr>
<tr class="memdesc:a211e966c3b60d75f3ffc37bd0275aae0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplies an ECP2 instance P by the internal modulus p, using precalculated Frobenius constant f. <a href="#a211e966c3b60d75f3ffc37bd0275aae0">More...</a><br /></td></tr>
<tr class="separator:a211e966c3b60d75f3ffc37bd0275aae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1680fe55ba7f579a15dcd00e4191c2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#ab1680fe55ba7f579a15dcd00e4191c2f">ECP2_BN254_mul4</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *Q, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> *b)</td></tr>
<tr class="memdesc:ab1680fe55ba7f579a15dcd00e4191c2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates P=b[0]*Q[0]+b[1]*Q[1]+b[2]*Q[2]+b[3]*Q[3]. <a href="#ab1680fe55ba7f579a15dcd00e4191c2f">More...</a><br /></td></tr>
<tr class="separator:ab1680fe55ba7f579a15dcd00e4191c2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e5df7fb6c349319280abd3d8ebf1be2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a7e5df7fb6c349319280abd3d8ebf1be2">ECP2_BN254_mapit</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *P, <a class="el" href="structoctet.html">octet</a> *w)</td></tr>
<tr class="memdesc:a7e5df7fb6c349319280abd3d8ebf1be2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps random BIG to curve point of correct order. <a href="#a7e5df7fb6c349319280abd3d8ebf1be2">More...</a><br /></td></tr>
<tr class="separator:a7e5df7fb6c349319280abd3d8ebf1be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ff46dbafe3bd6d23311134697672f10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a1ff46dbafe3bd6d23311134697672f10">ECP2_BN254_generator</a> (<a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *G)</td></tr>
<tr class="memdesc:a1ff46dbafe3bd6d23311134697672f10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Group Generator from ROM. <a href="#a1ff46dbafe3bd6d23311134697672f10">More...</a><br /></td></tr>
<tr class="separator:a1ff46dbafe3bd6d23311134697672f10"><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:a17e7d485f5ec421e3f67ff3b94788479"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#a17e7d485f5ec421e3f67ff3b94788479">CURVE_A_BN254</a></td></tr>
<tr class="separator:a17e7d485f5ec421e3f67ff3b94788479"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9fb62302ecdbc0e758515f5eb949ab4"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ecp2__BN254_8h.html#ae9fb62302ecdbc0e758515f5eb949ab4">CURVE_B_I_BN254</a></td></tr>
<tr class="separator:ae9fb62302ecdbc0e758515f5eb949ab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74273c1fde193ac042ae38d12554ea22"><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="ecp2__BN254_8h.html#a74273c1fde193ac042ae38d12554ea22">CURVE_B_BN254</a></td></tr>
<tr class="separator:a74273c1fde193ac042ae38d12554ea22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb2d701c7552c970f25f8047c105d25b"><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="ecp2__BN254_8h.html#abb2d701c7552c970f25f8047c105d25b">CURVE_Order_BN254</a></td></tr>
<tr class="separator:abb2d701c7552c970f25f8047c105d25b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4efa5228d54f90b5476fa92e1548538"><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="ecp2__BN254_8h.html#ab4efa5228d54f90b5476fa92e1548538">CURVE_Cof_BN254</a></td></tr>
<tr class="separator:ab4efa5228d54f90b5476fa92e1548538"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a891b9fda048e66408bd6d66bf41d67ea"><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="ecp2__BN254_8h.html#a891b9fda048e66408bd6d66bf41d67ea">CURVE_Bnx_BN254</a></td></tr>
<tr class="separator:a891b9fda048e66408bd6d66bf41d67ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf41342afa7230d0288d37a140d4ee9d"><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="ecp2__BN254_8h.html#abf41342afa7230d0288d37a140d4ee9d">Fra_BN254</a></td></tr>
<tr class="separator:abf41342afa7230d0288d37a140d4ee9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85fadba81a01e0c26213ed65cbbe7471"><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="ecp2__BN254_8h.html#a85fadba81a01e0c26213ed65cbbe7471">Frb_BN254</a></td></tr>
<tr class="separator:a85fadba81a01e0c26213ed65cbbe7471"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17a02d1c46592b601745f60eee50305f"><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="ecp2__BN254_8h.html#a17a02d1c46592b601745f60eee50305f">CURVE_Gx_BN254</a></td></tr>
<tr class="separator:a17a02d1c46592b601745f60eee50305f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a952fba8aa78ec6c68fbfa44ad59f330c"><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="ecp2__BN254_8h.html#a952fba8aa78ec6c68fbfa44ad59f330c">CURVE_Gy_BN254</a></td></tr>
<tr class="separator:a952fba8aa78ec6c68fbfa44ad59f330c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c193b9c65acb159adea021f1bb59e1d"><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="ecp2__BN254_8h.html#a1c193b9c65acb159adea021f1bb59e1d">CURVE_Pxa_BN254</a></td></tr>
<tr class="separator:a1c193b9c65acb159adea021f1bb59e1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a836b37b410224115373eef28412171d1"><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="ecp2__BN254_8h.html#a836b37b410224115373eef28412171d1">CURVE_Pxb_BN254</a></td></tr>
<tr class="separator:a836b37b410224115373eef28412171d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a564168fc10e24cad9f57bab976a0e3d4"><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="ecp2__BN254_8h.html#a564168fc10e24cad9f57bab976a0e3d4">CURVE_Pya_BN254</a></td></tr>
<tr class="separator:a564168fc10e24cad9f57bab976a0e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09da60900ce4878f1ddbe298cc77042f"><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="ecp2__BN254_8h.html#a09da60900ce4878f1ddbe298cc77042f">CURVE_Pyb_BN254</a></td></tr>
<tr class="separator:a09da60900ce4878f1ddbe298cc77042f"><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="a936f6bb068aa0ce533e6dc51b56f7786"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a936f6bb068aa0ce533e6dc51b56f7786">&#9670;&nbsp;</a></span>ECP2_BN254_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>Q</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">P</td><td>ECP2 instance, on exit =P+Q </td></tr>
<tr><td class="paramname">Q</td><td>ECP2 instance to be added to P </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad2e84b0df8d7a0d047e6df8f9139a406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2e84b0df8d7a0d047e6df8f9139a406">&#9670;&nbsp;</a></span>ECP2_BN254_affine()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_affine </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">P</td><td>ECP2 instance to be converted to affine form </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad8874e2a045c086ff06378f411bdea2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8874e2a045c086ff06378f411bdea2c">&#9670;&nbsp;</a></span>ECP2_BN254_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>Q</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">P</td><td>ECP2 instance, on exit = Q </td></tr>
<tr><td class="paramname">Q</td><td>ECP2 instance to be copied </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8121a4f4f8d449069905cb4ebfe9ca84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8121a4f4f8d449069905cb4ebfe9ca84">&#9670;&nbsp;</a></span>ECP2_BN254_dbl()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_dbl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">P</td><td>ECP2 instance, on exit =2*P </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab658828ec441b7eb2ba3f0bb91e22f81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab658828ec441b7eb2ba3f0bb91e22f81">&#9670;&nbsp;</a></span>ECP2_BN254_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>Q</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">P</td><td>ECP2 instance to be compared </td></tr>
<tr><td class="paramname">Q</td><td>ECP2 instance to be compared </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if P=Q, else returns 0 </dd></dl>
</div>
</div>
<a id="a211e966c3b60d75f3ffc37bd0275aae0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a211e966c3b60d75f3ffc37bd0275aae0">&#9670;&nbsp;</a></span>ECP2_BN254_frob()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_frob </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>f</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fast point multiplication using Frobenius </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">P</td><td>ECP2 instance, on exit = p*P </td></tr>
<tr><td class="paramname">f</td><td>FP2 precalculated Frobenius constant </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a407091af8011693640727e5ee15ada96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a407091af8011693640727e5ee15ada96">&#9670;&nbsp;</a></span>ECP2_BN254_fromOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_fromOctet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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>The octet string is in the form x|y The real and imaginary parts of the x and y coordinates are in big-endian base 256 form. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">P</td><td>ECP2 instance to be created from the octet string </td></tr>
<tr><td class="paramname">S</td><td>input octet string return 1 if octet string corresponds to a point on the curve, else 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1ff46dbafe3bd6d23311134697672f10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ff46dbafe3bd6d23311134697672f10">&#9670;&nbsp;</a></span>ECP2_BN254_generator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_generator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>G</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">G</td><td>ECP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a35c106e8fe281774fa98c87d2d45083c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35c106e8fe281774fa98c87d2d45083c">&#9670;&nbsp;</a></span>ECP2_BN254_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If x=y, returns only x </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP2 on exit = x coordinate of point </td></tr>
<tr><td class="paramname">y</td><td>FP2 on exit = y coordinate of point (unless x=y) </td></tr>
<tr><td class="paramname">P</td><td>ECP2 instance (x,y) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 if P is point-at-infinity, else 0 </dd></dl>
</div>
</div>
<a id="a1b8b66f30bf8180c9b9ce13cabef8ed5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b8b66f30bf8180c9b9ce13cabef8ed5">&#9670;&nbsp;</a></span>ECP2_BN254_inf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_inf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">P</td><td>ECP2 instance to be set to infinity </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a33085074d0751b05853f167d3db8d147"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33085074d0751b05853f167d3db8d147">&#9670;&nbsp;</a></span>ECP2_BN254_isinf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_isinf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">P</td><td>ECP2 point to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if infinity, else returns 0 </dd></dl>
</div>
</div>
<a id="a7e5df7fb6c349319280abd3d8ebf1be2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e5df7fb6c349319280abd3d8ebf1be2">&#9670;&nbsp;</a></span>ECP2_BN254_mapit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_mapit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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>w</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">P</td><td>ECP2 instance of correct order </td></tr>
<tr><td class="paramname">w</td><td>OCTET byte array to be mapped </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aab6d595eee28622b5e6ae9012ae669a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab6d595eee28622b5e6ae9012ae669a0">&#9670;&nbsp;</a></span>ECP2_BN254_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">
<p>Uses fixed sized windows. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">P</td><td>ECP2 instance, on exit =b*P </td></tr>
<tr><td class="paramname">b</td><td>BIG number multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab1680fe55ba7f579a15dcd00e4191c2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1680fe55ba7f579a15dcd00e4191c2f">&#9670;&nbsp;</a></span>ECP2_BN254_mul4()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_mul4 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>Q</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">P</td><td>ECP2 instance, on exit = b[0]*Q[0]+b[1]*Q[1]+b[2]*Q[2]+b[3]*Q[3] </td></tr>
<tr><td class="paramname">Q</td><td>ECP2 array of 4 points </td></tr>
<tr><td class="paramname">b</td><td>BIG array of 4 multipliers </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6b07cb8e5b2c708db3e83c045ac71a30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b07cb8e5b2c708db3e83c045ac71a30">&#9670;&nbsp;</a></span>ECP2_BN254_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">P</td><td>ECP2 instance, on exit = -P </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4ed476f4bbbaa8127ca0ca031048c04d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ed476f4bbbaa8127ca0ca031048c04d">&#9670;&nbsp;</a></span>ECP2_BN254_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">P</td><td>ECP2 instance to be printed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7848eccea1a8b56906a979cda7c3c0c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7848eccea1a8b56906a979cda7c3c0c9">&#9670;&nbsp;</a></span>ECP2_BN254_outputxyz()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_outputxyz </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</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">P</td><td>ECP2 instance to be printed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6cf3f2bf367499bb8b9897deebbb1809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cf3f2bf367499bb8b9897deebbb1809">&#9670;&nbsp;</a></span>ECP2_BN254_rhs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_rhs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</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="structFP2__BN254.html">FP2_BN254</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>Function f(x)=x^3+Ax+B Used internally. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>FP2 value of f(x) </td></tr>
<tr><td class="paramname">x</td><td>FP2 instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a46360b68aacd3e91e7fa741afba6072f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46360b68aacd3e91e7fa741afba6072f">&#9670;&nbsp;</a></span>ECP2_BN254_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Point P set to infinity if no such point on the curve. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">P</td><td>ECP2 instance to be set (x,y) </td></tr>
<tr><td class="paramname">x</td><td>FP2 x coordinate of point </td></tr>
<tr><td class="paramname">y</td><td>FP2 y coordinate of point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if point exists, else 0 </dd></dl>
</div>
</div>
<a id="a06918d1705760b4b067e3265a3415924"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06918d1705760b4b067e3265a3415924">&#9670;&nbsp;</a></span>ECP2_BN254_setx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ECP2_BN254_setx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP2__BN254.html">FP2_BN254</a> *&#160;</td>
<td class="paramname"><em>x</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Point P set to infinity if no such point on the curve. Otherwise y coordinate is calculated from x. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">P</td><td>ECP instance to be set (x,[y]) </td></tr>
<tr><td class="paramname">x</td><td>BIG x coordinate of point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if point exists, else 0 </dd></dl>
</div>
</div>
<a id="a645aa7bbf498d23b31c8dcb64621146c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a645aa7bbf498d23b31c8dcb64621146c">&#9670;&nbsp;</a></span>ECP2_BN254_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>Q</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">P</td><td>ECP2 instance, on exit =P-Q </td></tr>
<tr><td class="paramname">Q</td><td>ECP2 instance to be subtracted from P </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8a7d59f3d5012616915282f8029e823a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a7d59f3d5012616915282f8029e823a">&#9670;&nbsp;</a></span>ECP2_BN254_toOctet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ECP2_BN254_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="structECP2__BN254.html">ECP2_BN254</a> *&#160;</td>
<td class="paramname"><em>P</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The octet string is created in the form x|y. Convert the real and imaginary parts of the x and y coordinates 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">P</td><td>ECP2 instance to be converted to an octet string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a17e7d485f5ec421e3f67ff3b94788479"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17e7d485f5ec421e3f67ff3b94788479">&#9670;&nbsp;</a></span>CURVE_A_BN254</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int CURVE_A_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Elliptic curve A parameter </p>
</div>
</div>
<a id="a74273c1fde193ac042ae38d12554ea22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74273c1fde193ac042ae38d12554ea22">&#9670;&nbsp;</a></span>CURVE_B_BN254</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> CURVE_B_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Elliptic curve B parameter </p>
</div>
</div>
<a id="ae9fb62302ecdbc0e758515f5eb949ab4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9fb62302ecdbc0e758515f5eb949ab4">&#9670;&nbsp;</a></span>CURVE_B_I_BN254</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int CURVE_B_I_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Elliptic curve B parameter </p>
</div>
</div>
<a id="a891b9fda048e66408bd6d66bf41d67ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a891b9fda048e66408bd6d66bf41d67ea">&#9670;&nbsp;</a></span>CURVE_Bnx_BN254</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> CURVE_Bnx_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Elliptic curve parameter </p>
</div>
</div>
<a id="ab4efa5228d54f90b5476fa92e1548538"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4efa5228d54f90b5476fa92e1548538">&#9670;&nbsp;</a></span>CURVE_Cof_BN254</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> CURVE_Cof_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Elliptic curve cofactor </p>
</div>
</div>
<a id="a17a02d1c46592b601745f60eee50305f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17a02d1c46592b601745f60eee50305f">&#9670;&nbsp;</a></span>CURVE_Gx_BN254</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> CURVE_Gx_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>x-coordinate of generator point in group G1 </p>
</div>
</div>
<a id="a952fba8aa78ec6c68fbfa44ad59f330c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a952fba8aa78ec6c68fbfa44ad59f330c">&#9670;&nbsp;</a></span>CURVE_Gy_BN254</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> CURVE_Gy_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>y-coordinate of generator point in group G1 </p>
</div>
</div>
<a id="abb2d701c7552c970f25f8047c105d25b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb2d701c7552c970f25f8047c105d25b">&#9670;&nbsp;</a></span>CURVE_Order_BN254</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> CURVE_Order_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>Elliptic curve group order </p>
</div>
</div>
<a id="a1c193b9c65acb159adea021f1bb59e1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c193b9c65acb159adea021f1bb59e1d">&#9670;&nbsp;</a></span>CURVE_Pxa_BN254</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> CURVE_Pxa_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>real part of x-coordinate of generator point in group G2 </p>
</div>
</div>
<a id="a836b37b410224115373eef28412171d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a836b37b410224115373eef28412171d1">&#9670;&nbsp;</a></span>CURVE_Pxb_BN254</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> CURVE_Pxb_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>imaginary part of x-coordinate of generator point in group G2 </p>
</div>
</div>
<a id="a564168fc10e24cad9f57bab976a0e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a564168fc10e24cad9f57bab976a0e3d4">&#9670;&nbsp;</a></span>CURVE_Pya_BN254</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> CURVE_Pya_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>real part of y-coordinate of generator point in group G2 </p>
</div>
</div>
<a id="a09da60900ce4878f1ddbe298cc77042f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09da60900ce4878f1ddbe298cc77042f">&#9670;&nbsp;</a></span>CURVE_Pyb_BN254</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> CURVE_Pyb_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>imaginary part of y-coordinate of generator point in group G2 </p>
</div>
</div>
<a id="abf41342afa7230d0288d37a140d4ee9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf41342afa7230d0288d37a140d4ee9d">&#9670;&nbsp;</a></span>Fra_BN254</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_BN254</td>
</tr>
</table>
</div><div class="memdoc">
<p>real part of BN curve Frobenius Constant </p>
</div>
</div>
<a id="a85fadba81a01e0c26213ed65cbbe7471"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85fadba81a01e0c26213ed65cbbe7471">&#9670;&nbsp;</a></span>Frb_BN254</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_BN254</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>