blob: 56184f3614cc99822341ff66099f214da1389b53 [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: fp_SECP256K1.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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">fp_SECP256K1.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>FP Header File.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="big__256__56_8h_source.html">big_256_56.h</a>&quot;</code><br />
<code>#include &quot;config_field_SECP256K1.h&quot;</code><br />
</div>
<p><a href="fp__SECP256K1_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="structFP__SECP256K1.html">FP_SECP256K1</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__SECP256K1.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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a7821992562b3f74c125bb8c7e8e4da19"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a7821992562b3f74c125bb8c7e8e4da19">MODBITS_SECP256K1</a>&#160;&#160;&#160;MBITS_SECP256K1</td></tr>
<tr class="separator:a7821992562b3f74c125bb8c7e8e4da19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0c0488953ee1a6bc0678f480f93cf0b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#ab0c0488953ee1a6bc0678f480f93cf0b">TBITS_SECP256K1</a>&#160;&#160;&#160;(MBITS_SECP256K1%<a class="el" href="config__big__256__56_8h.html#ac6cb0299279eb5c9a07bccfd297f1b40">BASEBITS_256_56</a>)</td></tr>
<tr class="separator:ab0c0488953ee1a6bc0678f480f93cf0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b5e1c05c60ae97ff3de135fe203f44f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a6b5e1c05c60ae97ff3de135fe203f44f">TMASK_SECP256K1</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__SECP256K1_8h.html#ab0c0488953ee1a6bc0678f480f93cf0b">TBITS_SECP256K1</a>)-1)</td></tr>
<tr class="separator:a6b5e1c05c60ae97ff3de135fe203f44f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2ec0536f260d035a05201ef89b20d49"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#ad2ec0536f260d035a05201ef89b20d49">FEXCESS_SECP256K1</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_SECP256K1)-1)</td></tr>
<tr class="separator:ad2ec0536f260d035a05201ef89b20d49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5ef913e46aa9e34e7864b8a8fedc9f1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#af5ef913e46aa9e34e7864b8a8fedc9f1">OMASK_SECP256K1</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__SECP256K1_8h.html#ab0c0488953ee1a6bc0678f480f93cf0b">TBITS_SECP256K1</a>))</td></tr>
<tr class="separator:af5ef913e46aa9e34e7864b8a8fedc9f1"><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:a886c73f714951b5aec6fb314ff2a3ab7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a886c73f714951b5aec6fb314ff2a3ab7">FP_SECP256K1_iszilch</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:a886c73f714951b5aec6fb314ff2a3ab7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#a886c73f714951b5aec6fb314ff2a3ab7">More...</a><br /></td></tr>
<tr class="separator:a886c73f714951b5aec6fb314ff2a3ab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdaf7c7a5c45c781a4d6d451d24af41d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#afdaf7c7a5c45c781a4d6d451d24af41d">FP_SECP256K1_zero</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:afdaf7c7a5c45c781a4d6d451d24af41d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#afdaf7c7a5c45c781a4d6d451d24af41d">More...</a><br /></td></tr>
<tr class="separator:afdaf7c7a5c45c781a4d6d451d24af41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b7301a777d12723c0f45c57e4a0ff6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a6b7301a777d12723c0f45c57e4a0ff6d">FP_SECP256K1_copy</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:a6b7301a777d12723c0f45c57e4a0ff6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#a6b7301a777d12723c0f45c57e4a0ff6d">More...</a><br /></td></tr>
<tr class="separator:a6b7301a777d12723c0f45c57e4a0ff6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b4af541bb58c9c3995c73fe5a57655e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a2b4af541bb58c9c3995c73fe5a57655e">FP_SECP256K1_rcopy</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:a2b4af541bb58c9c3995c73fe5a57655e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#a2b4af541bb58c9c3995c73fe5a57655e">More...</a><br /></td></tr>
<tr class="separator:a2b4af541bb58c9c3995c73fe5a57655e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f2fa7eaa880dffb42ef91ca2f2321b9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a1f2fa7eaa880dffb42ef91ca2f2321b9">FP_SECP256K1_equals</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y)</td></tr>
<tr class="memdesc:a1f2fa7eaa880dffb42ef91ca2f2321b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a1f2fa7eaa880dffb42ef91ca2f2321b9">More...</a><br /></td></tr>
<tr class="separator:a1f2fa7eaa880dffb42ef91ca2f2321b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0213885618d5a4a603efcb230c9208f0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a0213885618d5a4a603efcb230c9208f0">FP_SECP256K1_cswap</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, int s)</td></tr>
<tr class="memdesc:a0213885618d5a4a603efcb230c9208f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#a0213885618d5a4a603efcb230c9208f0">More...</a><br /></td></tr>
<tr class="separator:a0213885618d5a4a603efcb230c9208f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d00f1674d7b125a525ab9aa4034dfe4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a8d00f1674d7b125a525ab9aa4034dfe4">FP_SECP256K1_cmove</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, int s)</td></tr>
<tr class="memdesc:a8d00f1674d7b125a525ab9aa4034dfe4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#a8d00f1674d7b125a525ab9aa4034dfe4">More...</a><br /></td></tr>
<tr class="separator:a8d00f1674d7b125a525ab9aa4034dfe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a247c33d9528a7dcc2e3eabd31c4ee455"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a247c33d9528a7dcc2e3eabd31c4ee455">FP_SECP256K1_nres</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:a247c33d9528a7dcc2e3eabd31c4ee455"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#a247c33d9528a7dcc2e3eabd31c4ee455">More...</a><br /></td></tr>
<tr class="separator:a247c33d9528a7dcc2e3eabd31c4ee455"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a300871512e18ed6a7fed0dbca0ca7b72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a300871512e18ed6a7fed0dbca0ca7b72">FP_SECP256K1_redc</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y)</td></tr>
<tr class="memdesc:a300871512e18ed6a7fed0dbca0ca7b72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#a300871512e18ed6a7fed0dbca0ca7b72">More...</a><br /></td></tr>
<tr class="separator:a300871512e18ed6a7fed0dbca0ca7b72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18ae1d6f8b33b72a517957ab0ef9d2ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a18ae1d6f8b33b72a517957ab0ef9d2ba">FP_SECP256K1_one</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:a18ae1d6f8b33b72a517957ab0ef9d2ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a18ae1d6f8b33b72a517957ab0ef9d2ba">More...</a><br /></td></tr>
<tr class="separator:a18ae1d6f8b33b72a517957ab0ef9d2ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c252d413f4a885a761bf7bed5c31c96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a1c252d413f4a885a761bf7bed5c31c96">FP_SECP256K1_mod</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> r, <a class="el" href="big__256__56_8h.html#a6183570cd770f0ce6be0d94a42ee465a">DBIG_256_56</a> d)</td></tr>
<tr class="memdesc:a1c252d413f4a885a761bf7bed5c31c96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#a1c252d413f4a885a761bf7bed5c31c96">More...</a><br /></td></tr>
<tr class="separator:a1c252d413f4a885a761bf7bed5c31c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a18b76222b42d282b3662c06d5d0fb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a0a18b76222b42d282b3662c06d5d0fb8">FP_SECP256K1_mul</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *z)</td></tr>
<tr class="memdesc:a0a18b76222b42d282b3662c06d5d0fb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#a0a18b76222b42d282b3662c06d5d0fb8">More...</a><br /></td></tr>
<tr class="separator:a0a18b76222b42d282b3662c06d5d0fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa522b83e4a94812b48f65355235e53b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#aaa522b83e4a94812b48f65355235e53b">FP_SECP256K1_imul</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, int i)</td></tr>
<tr class="memdesc:aaa522b83e4a94812b48f65355235e53b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#aaa522b83e4a94812b48f65355235e53b">More...</a><br /></td></tr>
<tr class="separator:aaa522b83e4a94812b48f65355235e53b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22eb8f739cd609242d4589c9968db90f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a22eb8f739cd609242d4589c9968db90f">FP_SECP256K1_sqr</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y)</td></tr>
<tr class="memdesc:a22eb8f739cd609242d4589c9968db90f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#a22eb8f739cd609242d4589c9968db90f">More...</a><br /></td></tr>
<tr class="separator:a22eb8f739cd609242d4589c9968db90f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a11ebc91370333aceb18ade6fbbd816"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a1a11ebc91370333aceb18ade6fbbd816">FP_SECP256K1_add</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *z)</td></tr>
<tr class="memdesc:a1a11ebc91370333aceb18ade6fbbd816"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#a1a11ebc91370333aceb18ade6fbbd816">More...</a><br /></td></tr>
<tr class="separator:a1a11ebc91370333aceb18ade6fbbd816"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6770c2d8856b696e866514e5d175f87a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a6770c2d8856b696e866514e5d175f87a">FP_SECP256K1_sub</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *z)</td></tr>
<tr class="memdesc:a6770c2d8856b696e866514e5d175f87a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#a6770c2d8856b696e866514e5d175f87a">More...</a><br /></td></tr>
<tr class="separator:a6770c2d8856b696e866514e5d175f87a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdc9a1095de1d1b2a72e92544484cd40"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#acdc9a1095de1d1b2a72e92544484cd40">FP_SECP256K1_div2</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y)</td></tr>
<tr class="memdesc:acdc9a1095de1d1b2a72e92544484cd40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#acdc9a1095de1d1b2a72e92544484cd40">More...</a><br /></td></tr>
<tr class="separator:acdc9a1095de1d1b2a72e92544484cd40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a771b1c29659536bc8e1dd5753eac5c1e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a771b1c29659536bc8e1dd5753eac5c1e">FP_SECP256K1_pow</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> z)</td></tr>
<tr class="memdesc:a771b1c29659536bc8e1dd5753eac5c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#a771b1c29659536bc8e1dd5753eac5c1e">More...</a><br /></td></tr>
<tr class="separator:a771b1c29659536bc8e1dd5753eac5c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5778cead75e4aeb912a8d6e0ab231b71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a5778cead75e4aeb912a8d6e0ab231b71">FP_SECP256K1_sqrt</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y)</td></tr>
<tr class="memdesc:a5778cead75e4aeb912a8d6e0ab231b71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#a5778cead75e4aeb912a8d6e0ab231b71">More...</a><br /></td></tr>
<tr class="separator:a5778cead75e4aeb912a8d6e0ab231b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5227684c4e131976e745f412d5cf88b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a5227684c4e131976e745f412d5cf88b2">FP_SECP256K1_neg</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y)</td></tr>
<tr class="memdesc:a5227684c4e131976e745f412d5cf88b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#a5227684c4e131976e745f412d5cf88b2">More...</a><br /></td></tr>
<tr class="separator:a5227684c4e131976e745f412d5cf88b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a510d0d3a6d526df06b744b526f45d8b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a510d0d3a6d526df06b744b526f45d8b0">FP_SECP256K1_output</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:a510d0d3a6d526df06b744b526f45d8b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a510d0d3a6d526df06b744b526f45d8b0">More...</a><br /></td></tr>
<tr class="separator:a510d0d3a6d526df06b744b526f45d8b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a154fb9e7874ca23ff0a76c5626a124c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a154fb9e7874ca23ff0a76c5626a124c4">FP_SECP256K1_rawoutput</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:a154fb9e7874ca23ff0a76c5626a124c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#a154fb9e7874ca23ff0a76c5626a124c4">More...</a><br /></td></tr>
<tr class="separator:a154fb9e7874ca23ff0a76c5626a124c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af31843afce60f78804eaaad8c9a0e529"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#af31843afce60f78804eaaad8c9a0e529">FP_SECP256K1_reduce</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:af31843afce60f78804eaaad8c9a0e529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#af31843afce60f78804eaaad8c9a0e529">More...</a><br /></td></tr>
<tr class="separator:af31843afce60f78804eaaad8c9a0e529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af62fce6edfb87d40a1b7426173f5bfe5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#af62fce6edfb87d40a1b7426173f5bfe5">FP_SECP256K1_norm</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:af62fce6edfb87d40a1b7426173f5bfe5"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#af62fce6edfb87d40a1b7426173f5bfe5">More...</a><br /></td></tr>
<tr class="separator:af62fce6edfb87d40a1b7426173f5bfe5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a18a8216344073fdb2a4107a740b4ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a9a18a8216344073fdb2a4107a740b4ef">FP_SECP256K1_qr</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x)</td></tr>
<tr class="memdesc:a9a18a8216344073fdb2a4107a740b4ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#a9a18a8216344073fdb2a4107a740b4ef">More...</a><br /></td></tr>
<tr class="separator:a9a18a8216344073fdb2a4107a740b4ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f1ecdc561021aaafdb7110e81f15a7b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#a8f1ecdc561021aaafdb7110e81f15a7b">FP_SECP256K1_inv</a> (<a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *x, <a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *y)</td></tr>
<tr class="memdesc:a8f1ecdc561021aaafdb7110e81f15a7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#a8f1ecdc561021aaafdb7110e81f15a7b">More...</a><br /></td></tr>
<tr class="separator:a8f1ecdc561021aaafdb7110e81f15a7b"><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:a16483b07b42fa4c69f9fba84c7eee4a5"><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="fp__SECP256K1_8h.html#a16483b07b42fa4c69f9fba84c7eee4a5">Modulus_SECP256K1</a></td></tr>
<tr class="separator:a16483b07b42fa4c69f9fba84c7eee4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac00e9bf66bee9c6142a20a59376c041f"><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="fp__SECP256K1_8h.html#ac00e9bf66bee9c6142a20a59376c041f">R2modp_SECP256K1</a></td></tr>
<tr class="separator:ac00e9bf66bee9c6142a20a59376c041f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afac121c59e8c286214a91329da896954"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__SECP256K1_8h.html#afac121c59e8c286214a91329da896954">MConst_SECP256K1</a></td></tr>
<tr class="separator:afac121c59e8c286214a91329da896954"><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">Macro Definition Documentation</h2>
<a id="ad2ec0536f260d035a05201ef89b20d49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2ec0536f260d035a05201ef89b20d49">&#9670;&nbsp;</a></span>FEXCESS_SECP256K1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_SECP256K1&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_SECP256K1)-1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>2^(BASEBITS*NLEN-MODBITS)-1 - normalised BIG can be multiplied by less than this before reduction </p>
</div>
</div>
<a id="a7821992562b3f74c125bb8c7e8e4da19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7821992562b3f74c125bb8c7e8e4da19">&#9670;&nbsp;</a></span>MODBITS_SECP256K1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_SECP256K1&#160;&#160;&#160;MBITS_SECP256K1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="af5ef913e46aa9e34e7864b8a8fedc9f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5ef913e46aa9e34e7864b8a8fedc9f1">&#9670;&nbsp;</a></span>OMASK_SECP256K1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_SECP256K1&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__SECP256K1_8h.html#ab0c0488953ee1a6bc0678f480f93cf0b">TBITS_SECP256K1</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="ab0c0488953ee1a6bc0678f480f93cf0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0c0488953ee1a6bc0678f480f93cf0b">&#9670;&nbsp;</a></span>TBITS_SECP256K1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_SECP256K1&#160;&#160;&#160;(MBITS_SECP256K1%<a class="el" href="config__big__256__56_8h.html#ac6cb0299279eb5c9a07bccfd297f1b40">BASEBITS_256_56</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of active bits in top word </p>
</div>
</div>
<a id="a6b5e1c05c60ae97ff3de135fe203f44f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b5e1c05c60ae97ff3de135fe203f44f">&#9670;&nbsp;</a></span>TMASK_SECP256K1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_SECP256K1&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__SECP256K1_8h.html#ab0c0488953ee1a6bc0678f480f93cf0b">TBITS_SECP256K1</a>)-1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mask for active bits in top word </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1a11ebc91370333aceb18ade6fbbd816"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a11ebc91370333aceb18ade6fbbd816">&#9670;&nbsp;</a></span>FP_SECP256K1_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular sum = y+z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
<tr><td class="paramname">z</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8d00f1674d7b125a525ab9aa4034dfe4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d00f1674d7b125a525ab9aa4034dfe4">&#9670;&nbsp;</a></span>FP_SECP256K1_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>an FP number </td></tr>
<tr><td class="paramname">y</td><td>another FP number </td></tr>
<tr><td class="paramname">s</td><td>copy takes place if not equal to 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6b7301a777d12723c0f45c57e4a0ff6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b7301a777d12723c0f45c57e4a0ff6d">&#9670;&nbsp;</a></span>FP_SECP256K1_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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">y</td><td>FP number to be copied to </td></tr>
<tr><td class="paramname">x</td><td>FP to be copied from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0213885618d5a4a603efcb230c9208f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0213885618d5a4a603efcb230c9208f0">&#9670;&nbsp;</a></span>FP_SECP256K1_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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 swaps parameters in constant time (without branching) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>an FP number </td></tr>
<tr><td class="paramname">y</td><td>another FP number </td></tr>
<tr><td class="paramname">s</td><td>swap takes place if not equal to 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acdc9a1095de1d1b2a72e92544484cd40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdc9a1095de1d1b2a72e92544484cd40">&#9670;&nbsp;</a></span>FP_SECP256K1_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number, on exit =y/2 mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1f2fa7eaa880dffb42ef91ca2f2321b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f2fa7eaa880dffb42ef91ca2f2321b9">&#9670;&nbsp;</a></span>FP_SECP256K1_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_SECP256K1_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if equal, else returns 0 </dd></dl>
</div>
</div>
<a id="aaa522b83e4a94812b48f65355235e53b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa522b83e4a94812b48f65355235e53b">&#9670;&nbsp;</a></span>FP_SECP256K1_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular product = y*i mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the multiplicand </td></tr>
<tr><td class="paramname">i</td><td>a small number, the multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8f1ecdc561021aaafdb7110e81f15a7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f1ecdc561021aaafdb7110e81f15a7b">&#9670;&nbsp;</a></span>FP_SECP256K1_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number, on exit = 1/y mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a886c73f714951b5aec6fb314ff2a3ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a886c73f714951b5aec6fb314ff2a3ab7">&#9670;&nbsp;</a></span>FP_SECP256K1_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_SECP256K1_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>BIG 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="a1c252d413f4a885a761bf7bed5c31c96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c252d413f4a885a761bf7bed5c31c96">&#9670;&nbsp;</a></span>FP_SECP256K1_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_mod </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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="big__256__56_8h.html#a6183570cd770f0ce6be0d94a42ee465a">DBIG_256_56</a>&#160;</td>
<td class="paramname"><em>d</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function comes in different flavours depending on the form of Modulus that is currently in use. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">r</td><td>BIG number, on exit = d mod Modulus </td></tr>
<tr><td class="paramname">d</td><td>DBIG number to be reduced </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0a18b76222b42d282b3662c06d5d0fb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a18b76222b42d282b3662c06d5d0fb8">&#9670;&nbsp;</a></span>FP_SECP256K1_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses appropriate fast modular reduction method </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular product = y*z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the multiplicand </td></tr>
<tr><td class="paramname">z</td><td>FP number, the multiplier </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5227684c4e131976e745f412d5cf88b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5227684c4e131976e745f412d5cf88b2">&#9670;&nbsp;</a></span>FP_SECP256K1_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number, on exit = -y mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af62fce6edfb87d40a1b7426173f5bfe5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af62fce6edfb87d40a1b7426173f5bfe5">&#9670;&nbsp;</a></span>FP_SECP256K1_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number, on exit normalized </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a247c33d9528a7dcc2e3eabd31c4ee455"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a247c33d9528a7dcc2e3eabd31c4ee455">&#9670;&nbsp;</a></span>FP_SECP256K1_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td>
<td class="paramname"><em>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">x</td><td>BIG number to be converted </td></tr>
<tr><td class="paramname">y</td><td>FP result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a18ae1d6f8b33b72a517957ab0ef9d2ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18ae1d6f8b33b72a517957ab0ef9d2ba">&#9670;&nbsp;</a></span>FP_SECP256K1_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number to be set equal to unity. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a510d0d3a6d526df06b744b526f45d8b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a510d0d3a6d526df06b744b526f45d8b0">&#9670;&nbsp;</a></span>FP_SECP256K1_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts from residue form before output </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>an FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a771b1c29659536bc8e1dd5753eac5c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a771b1c29659536bc8e1dd5753eac5c1e">&#9670;&nbsp;</a></span>FP_SECP256K1_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a>&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit = y^z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
<tr><td class="paramname">z</td><td>BIG number exponent </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9a18a8216344073fdb2a4107a740b4ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a18a8216344073fdb2a4107a740b4ef">&#9670;&nbsp;</a></span>FP_SECP256K1_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_SECP256K1_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if quadratic residue, else returns 0 if quadratic non-residue </dd></dl>
</div>
</div>
<a id="a154fb9e7874ca23ff0a76c5626a124c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a154fb9e7874ca23ff0a76c5626a124c4">&#9670;&nbsp;</a></span>FP_SECP256K1_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>a BIG number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2b4af541bb58c9c3995c73fe5a57655e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b4af541bb58c9c3995c73fe5a57655e">&#9670;&nbsp;</a></span>FP_SECP256K1_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</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">y</td><td>FP number to be copied to </td></tr>
<tr><td class="paramname">x</td><td>BIG to be copied from ROM </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a300871512e18ed6a7fed0dbca0ca7b72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a300871512e18ed6a7fed0dbca0ca7b72">&#9670;&nbsp;</a></span>FP_SECP256K1_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_redc </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>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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">y</td><td>FP number to be converted to BIG </td></tr>
<tr><td class="paramname">x</td><td>BIG result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af31843afce60f78804eaaad8c9a0e529"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af31843afce60f78804eaaad8c9a0e529">&#9670;&nbsp;</a></span>FP_SECP256K1_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number, on exit reduced mod Modulus </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a22eb8f739cd609242d4589c9968db90f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22eb8f739cd609242d4589c9968db90f">&#9670;&nbsp;</a></span>FP_SECP256K1_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>Uses appropriate fast modular reduction method </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular product = y^2 mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the number to be squared </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5778cead75e4aeb912a8d6e0ab231b71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5778cead75e4aeb912a8d6e0ab231b71">&#9670;&nbsp;</a></span>FP_SECP256K1_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number, on exit = sqrt(y) mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number, the number whose square root is calculated </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6770c2d8856b696e866514e5d175f87a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6770c2d8856b696e866514e5d175f87a">&#9670;&nbsp;</a></span>FP_SECP256K1_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</a> *&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>FP number, on exit the modular difference = y-z mod Modulus </td></tr>
<tr><td class="paramname">y</td><td>FP number </td></tr>
<tr><td class="paramname">z</td><td>FP number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afdaf7c7a5c45c781a4d6d451d24af41d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdaf7c7a5c45c781a4d6d451d24af41d">&#9670;&nbsp;</a></span>FP_SECP256K1_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_SECP256K1_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__SECP256K1.html">FP_SECP256K1</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>FP number to be set to 0 </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="afac121c59e8c286214a91329da896954"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afac121c59e8c286214a91329da896954">&#9670;&nbsp;</a></span>MConst_SECP256K1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a> MConst_SECP256K1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="a16483b07b42fa4c69f9fba84c7eee4a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16483b07b42fa4c69f9fba84c7eee4a5">&#9670;&nbsp;</a></span>Modulus_SECP256K1</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> Modulus_SECP256K1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="ac00e9bf66bee9c6142a20a59376c041f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac00e9bf66bee9c6142a20a59376c041f">&#9670;&nbsp;</a></span>R2modp_SECP256K1</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> R2modp_SECP256K1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Montgomery 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>