blob: ddd04bb2d43af9f06cc4049c725a7b35f16c2273 [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: pair_BN254CX.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AMCL
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df7310d1a865926cc859bcfb1880083f.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">pair_BN254CX.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>PAIR Header File.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="fp12__BN254CX_8h_source.html">fp12_BN254CX.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ecp2__BN254CX_8h_source.html">ecp2_BN254CX.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ecp__BN254CX_8h_source.html">ecp_BN254CX.h</a>&quot;</code><br />
</div>
<p><a href="pair__BN254CX_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad0a87940b5ea6360baa74d0aaa9f934f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#ad0a87940b5ea6360baa74d0aaa9f934f">PAIR_BN254CX_another</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> r[], <a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</a> *PV, <a class="el" href="structECP__BN254CX.html">ECP_BN254CX</a> *QV)</td></tr>
<tr class="memdesc:ad0a87940b5ea6360baa74d0aaa9f934f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Precompute line functions for n-pairing. <a href="#ad0a87940b5ea6360baa74d0aaa9f934f">More...</a><br /></td></tr>
<tr class="separator:ad0a87940b5ea6360baa74d0aaa9f934f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ea4efe2c2efce2c857ec095436242a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#a9ea4efe2c2efce2c857ec095436242a2">PAIR_BN254CX_ate</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *r, <a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</a> *P, <a class="el" href="structECP__BN254CX.html">ECP_BN254CX</a> *Q)</td></tr>
<tr class="memdesc:a9ea4efe2c2efce2c857ec095436242a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate Miller loop for Optimal ATE pairing e(P,Q) <a href="#a9ea4efe2c2efce2c857ec095436242a2">More...</a><br /></td></tr>
<tr class="separator:a9ea4efe2c2efce2c857ec095436242a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35a2e77a79c134cf34bf254a72e6327d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#a35a2e77a79c134cf34bf254a72e6327d">PAIR_BN254CX_double_ate</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *r, <a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</a> *P, <a class="el" href="structECP__BN254CX.html">ECP_BN254CX</a> *Q, <a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</a> *R, <a class="el" href="structECP__BN254CX.html">ECP_BN254CX</a> *S)</td></tr>
<tr class="memdesc:a35a2e77a79c134cf34bf254a72e6327d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate Miller loop for Optimal ATE double-pairing e(P,Q).e(R,S) <a href="#a35a2e77a79c134cf34bf254a72e6327d">More...</a><br /></td></tr>
<tr class="separator:a35a2e77a79c134cf34bf254a72e6327d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1fb5cc2e47268643c694f09cbaf811b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#ab1fb5cc2e47268643c694f09cbaf811b">PAIR_BN254CX_fexp</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:ab1fb5cc2e47268643c694f09cbaf811b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Final exponentiation of pairing, converts output of Miller loop to element in GT. <a href="#ab1fb5cc2e47268643c694f09cbaf811b">More...</a><br /></td></tr>
<tr class="separator:ab1fb5cc2e47268643c694f09cbaf811b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1be3c8736ccc5c1d48b08a93dc034cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#aa1be3c8736ccc5c1d48b08a93dc034cd">PAIR_BN254CX_G1mul</a> (<a class="el" href="structECP__BN254CX.html">ECP_BN254CX</a> *Q, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:aa1be3c8736ccc5c1d48b08a93dc034cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast point multiplication of a member of the group G1 by a BIG number. <a href="#aa1be3c8736ccc5c1d48b08a93dc034cd">More...</a><br /></td></tr>
<tr class="separator:aa1be3c8736ccc5c1d48b08a93dc034cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2c99beb9c8cb729da18c08160f313d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#ae2c99beb9c8cb729da18c08160f313d9">PAIR_BN254CX_G2mul</a> (<a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</a> *P, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:ae2c99beb9c8cb729da18c08160f313d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast point multiplication of a member of the group G2 by a BIG number. <a href="#ae2c99beb9c8cb729da18c08160f313d9">More...</a><br /></td></tr>
<tr class="separator:ae2c99beb9c8cb729da18c08160f313d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f50ba60c4ba8e756c12ca6f2121d66c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#a4f50ba60c4ba8e756c12ca6f2121d66c">PAIR_BN254CX_GTpow</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> b)</td></tr>
<tr class="memdesc:a4f50ba60c4ba8e756c12ca6f2121d66c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast raising of a member of GT to a BIG power. <a href="#a4f50ba60c4ba8e756c12ca6f2121d66c">More...</a><br /></td></tr>
<tr class="separator:a4f50ba60c4ba8e756c12ca6f2121d66c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a714a7830d1ab9fda7d73baac2aa2303d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#a714a7830d1ab9fda7d73baac2aa2303d">PAIR_BN254CX_GTmember</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *x)</td></tr>
<tr class="memdesc:a714a7830d1ab9fda7d73baac2aa2303d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests FP12 for membership of GT. <a href="#a714a7830d1ab9fda7d73baac2aa2303d">More...</a><br /></td></tr>
<tr class="separator:a714a7830d1ab9fda7d73baac2aa2303d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb3898c4a3c32d77899e7345d0480895"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#adb3898c4a3c32d77899e7345d0480895">PAIR_BN254CX_nbits</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> n3, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> n)</td></tr>
<tr class="memdesc:adb3898c4a3c32d77899e7345d0480895"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare Ate parameter. <a href="#adb3898c4a3c32d77899e7345d0480895">More...</a><br /></td></tr>
<tr class="separator:adb3898c4a3c32d77899e7345d0480895"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5f08bd391c2937d9195cd0b647bfd73"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#af5f08bd391c2937d9195cd0b647bfd73">PAIR_BN254CX_initmp</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> r[])</td></tr>
<tr class="memdesc:af5f08bd391c2937d9195cd0b647bfd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise structure for multi-pairing. <a href="#af5f08bd391c2937d9195cd0b647bfd73">More...</a><br /></td></tr>
<tr class="separator:af5f08bd391c2937d9195cd0b647bfd73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad27ca9ed2140201136b85b2631e9f15d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pair__BN254CX_8h.html#ad27ca9ed2140201136b85b2631e9f15d">PAIR_BN254CX_miller</a> (<a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *res, <a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> r[])</td></tr>
<tr class="memdesc:ad27ca9ed2140201136b85b2631e9f15d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Miller loop. <a href="#ad27ca9ed2140201136b85b2631e9f15d">More...</a><br /></td></tr>
<tr class="separator:ad27ca9ed2140201136b85b2631e9f15d"><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:a7deaf9d8c32aa462bc43f85a3a360c05"><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="pair__BN254CX_8h.html#a7deaf9d8c32aa462bc43f85a3a360c05">CURVE_Bnx_BN254CX</a></td></tr>
<tr class="separator:a7deaf9d8c32aa462bc43f85a3a360c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae96e4bddc2c2e24813b3a5f90cb4d80d"><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="pair__BN254CX_8h.html#ae96e4bddc2c2e24813b3a5f90cb4d80d">CURVE_Cru_BN254CX</a></td></tr>
<tr class="separator:ae96e4bddc2c2e24813b3a5f90cb4d80d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9e422e0ac192a2dec3263d0e08d25a7"><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="pair__BN254CX_8h.html#aa9e422e0ac192a2dec3263d0e08d25a7">CURVE_W_BN254CX</a> [2]</td></tr>
<tr class="separator:aa9e422e0ac192a2dec3263d0e08d25a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7511c37ed68f07cfeb3709d28e139f0"><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="pair__BN254CX_8h.html#ae7511c37ed68f07cfeb3709d28e139f0">CURVE_SB_BN254CX</a> [2][2]</td></tr>
<tr class="separator:ae7511c37ed68f07cfeb3709d28e139f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a424f1e4a7a66eea1edee443fc306f673"><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="pair__BN254CX_8h.html#a424f1e4a7a66eea1edee443fc306f673">CURVE_WB_BN254CX</a> [4]</td></tr>
<tr class="separator:a424f1e4a7a66eea1edee443fc306f673"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c995862d7d0aa82d7fa5a59605628db"><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="pair__BN254CX_8h.html#a0c995862d7d0aa82d7fa5a59605628db">CURVE_BB_BN254CX</a> [4][4]</td></tr>
<tr class="separator:a0c995862d7d0aa82d7fa5a59605628db"><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="ad0a87940b5ea6360baa74d0aaa9f934f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0a87940b5ea6360baa74d0aaa9f934f">&#9670;&nbsp;</a></span>PAIR_BN254CX_another()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_another </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a>&#160;</td>
<td class="paramname"><em>r</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</a> *&#160;</td>
<td class="paramname"><em>PV</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP__BN254CX.html">ECP_BN254CX</a> *&#160;</td>
<td class="paramname"><em>QV</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>array of precomputed FP12 products of line functions </td></tr>
<tr><td class="paramname">PV</td><td>ECP2 instance, an element of G2 </td></tr>
<tr><td class="paramname">QV</td><td>ECP instance, an element of G1 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9ea4efe2c2efce2c857ec095436242a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ea4efe2c2efce2c857ec095436242a2">&#9670;&nbsp;</a></span>PAIR_BN254CX_ate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_ate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</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="structECP__BN254CX.html">ECP_BN254CX</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">r</td><td>FP12 result of the pairing calculation e(P,Q) </td></tr>
<tr><td class="paramname">P</td><td>ECP2 instance, an element of G2 </td></tr>
<tr><td class="paramname">Q</td><td>ECP instance, an element of G1 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a35a2e77a79c134cf34bf254a72e6327d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35a2e77a79c134cf34bf254a72e6327d">&#9670;&nbsp;</a></span>PAIR_BN254CX_double_ate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_double_ate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</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="structECP__BN254CX.html">ECP_BN254CX</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="structECP2__BN254CX.html">ECP2_BN254CX</a> *&#160;</td>
<td class="paramname"><em>R</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structECP__BN254CX.html">ECP_BN254CX</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>Faster than calculating two separate pairings </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>FP12 result of the pairing calculation e(P,Q).e(R,S), an element of GT </td></tr>
<tr><td class="paramname">P</td><td>ECP2 instance, an element of G2 </td></tr>
<tr><td class="paramname">Q</td><td>ECP instance, an element of G1 </td></tr>
<tr><td class="paramname">R</td><td>ECP2 instance, an element of G2 </td></tr>
<tr><td class="paramname">S</td><td>ECP instance, an element of G1 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab1fb5cc2e47268643c694f09cbaf811b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1fb5cc2e47268643c694f09cbaf811b">&#9670;&nbsp;</a></span>PAIR_BN254CX_fexp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_fexp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Here p is the internal modulus, and r is the group order </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP12, on exit = x^((p^12-1)/r) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa1be3c8736ccc5c1d48b08a93dc034cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1be3c8736ccc5c1d48b08a93dc034cd">&#9670;&nbsp;</a></span>PAIR_BN254CX_G1mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_G1mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP__BN254CX.html">ECP_BN254CX</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">
<p>May exploit endomorphism for speed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Q</td><td>ECP member of G1. </td></tr>
<tr><td class="paramname">b</td><td>BIG multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae2c99beb9c8cb729da18c08160f313d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2c99beb9c8cb729da18c08160f313d9">&#9670;&nbsp;</a></span>PAIR_BN254CX_G2mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_G2mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structECP2__BN254CX.html">ECP2_BN254CX</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>May exploit endomorphism for speed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">P</td><td>ECP2 member of G1. </td></tr>
<tr><td class="paramname">b</td><td>BIG multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a714a7830d1ab9fda7d73baac2aa2303d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a714a7830d1ab9fda7d73baac2aa2303d">&#9670;&nbsp;</a></span>PAIR_BN254CX_GTmember()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PAIR_BN254CX_GTmember </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP12 instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if x is in GT, else return 0 </dd></dl>
</div>
</div>
<a id="a4f50ba60c4ba8e756c12ca6f2121d66c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f50ba60c4ba8e756c12ca6f2121d66c">&#9670;&nbsp;</a></span>PAIR_BN254CX_GTpow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_GTpow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>May exploit endomorphism for speed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP12 member of GT. </td></tr>
<tr><td class="paramname">b</td><td>BIG exponent </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af5f08bd391c2937d9195cd0b647bfd73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5f08bd391c2937d9195cd0b647bfd73">&#9670;&nbsp;</a></span>PAIR_BN254CX_initmp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_initmp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a>&#160;</td>
<td class="paramname"><em>r</em>[]</td><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 array, to be initialised to 1 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad27ca9ed2140201136b85b2631e9f15d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad27ca9ed2140201136b85b2631e9f15d">&#9670;&nbsp;</a></span>PAIR_BN254CX_miller()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PAIR_BN254CX_miller </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a> *&#160;</td>
<td class="paramname"><em>res</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP12__BN254CX.html">FP12_BN254CX</a>&#160;</td>
<td class="paramname"><em>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">res</td><td>FP12 result </td></tr>
<tr><td class="paramname">r</td><td>FP12 precomputed array of accumulated line functions </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adb3898c4a3c32d77899e7345d0480895"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb3898c4a3c32d77899e7345d0480895">&#9670;&nbsp;</a></span>PAIR_BN254CX_nbits()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PAIR_BN254CX_nbits </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>n3</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>n</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">n</td><td>BIG parameter </td></tr>
<tr><td class="paramname">n3</td><td>BIG paramter = 3*n </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of nits in n3 </dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a0c995862d7d0aa82d7fa5a59605628db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c995862d7d0aa82d7fa5a59605628db">&#9670;&nbsp;</a></span>CURVE_BB_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> CURVE_BB_BN254CX[4][4]</td>
</tr>
</table>
</div><div class="memdoc">
<p>BN curve constant for GS decomposition </p>
</div>
</div>
<a id="a7deaf9d8c32aa462bc43f85a3a360c05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7deaf9d8c32aa462bc43f85a3a360c05">&#9670;&nbsp;</a></span>CURVE_Bnx_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> CURVE_Bnx_BN254CX</td>
</tr>
</table>
</div><div class="memdoc">
<p>BN curve x parameter </p>
</div>
</div>
<a id="ae96e4bddc2c2e24813b3a5f90cb4d80d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae96e4bddc2c2e24813b3a5f90cb4d80d">&#9670;&nbsp;</a></span>CURVE_Cru_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> CURVE_Cru_BN254CX</td>
</tr>
</table>
</div><div class="memdoc">
<p>BN curve Cube Root of Unity </p>
</div>
</div>
<a id="ae7511c37ed68f07cfeb3709d28e139f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7511c37ed68f07cfeb3709d28e139f0">&#9670;&nbsp;</a></span>CURVE_SB_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> CURVE_SB_BN254CX[2][2]</td>
</tr>
</table>
</div><div class="memdoc">
<p>BN curve constant for GLV decomposition </p>
</div>
</div>
<a id="aa9e422e0ac192a2dec3263d0e08d25a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9e422e0ac192a2dec3263d0e08d25a7">&#9670;&nbsp;</a></span>CURVE_W_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> CURVE_W_BN254CX[2]</td>
</tr>
</table>
</div><div class="memdoc">
<p>BN curve constant for GLV decomposition </p>
</div>
</div>
<a id="a424f1e4a7a66eea1edee443fc306f673"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a424f1e4a7a66eea1edee443fc306f673">&#9670;&nbsp;</a></span>CURVE_WB_BN254CX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> CURVE_WB_BN254CX[4]</td>
</tr>
</table>
</div><div class="memdoc">
<p>BN curve constant for GS decomposition </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>