blob: ede998e9f7adbfacc17bdf56f58ffbf1f7a54ab7 [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_HIFIVE.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_HIFIVE.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__336__60_8h_source.html">big_336_60.h</a>&quot;</code><br />
<code>#include &quot;config_field_HIFIVE.h&quot;</code><br />
</div>
<p><a href="fp__HIFIVE_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__HIFIVE.html">FP_HIFIVE</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__HIFIVE.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:a08c92de6c797e0836192a06cdf68c674"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a08c92de6c797e0836192a06cdf68c674">MODBITS_HIFIVE</a>&#160;&#160;&#160;MBITS_HIFIVE</td></tr>
<tr class="separator:a08c92de6c797e0836192a06cdf68c674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19f19da79f660598a9963bcc19174fa1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a19f19da79f660598a9963bcc19174fa1">TBITS_HIFIVE</a>&#160;&#160;&#160;(MBITS_HIFIVE%<a class="el" href="config__big__336__60_8h.html#aafc3fab89520932a6ddf0486adb1e988">BASEBITS_336_60</a>)</td></tr>
<tr class="separator:a19f19da79f660598a9963bcc19174fa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a027ca9deb396cf742b0888dac9863374"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a027ca9deb396cf742b0888dac9863374">TMASK_HIFIVE</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__HIFIVE_8h.html#a19f19da79f660598a9963bcc19174fa1">TBITS_HIFIVE</a>)-1)</td></tr>
<tr class="separator:a027ca9deb396cf742b0888dac9863374"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17ffc867f3aa99310db749a7ba510f7d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a17ffc867f3aa99310db749a7ba510f7d">FEXCESS_HIFIVE</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_HIFIVE)-1)</td></tr>
<tr class="separator:a17ffc867f3aa99310db749a7ba510f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f6ef0baec26453c5925ff0da0b27bde"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a3f6ef0baec26453c5925ff0da0b27bde">OMASK_HIFIVE</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__HIFIVE_8h.html#a19f19da79f660598a9963bcc19174fa1">TBITS_HIFIVE</a>))</td></tr>
<tr class="separator:a3f6ef0baec26453c5925ff0da0b27bde"><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:a95cbe5d3b00a19bf81c9e02498cb72bd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a95cbe5d3b00a19bf81c9e02498cb72bd">FP_HIFIVE_iszilch</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:a95cbe5d3b00a19bf81c9e02498cb72bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#a95cbe5d3b00a19bf81c9e02498cb72bd">More...</a><br /></td></tr>
<tr class="separator:a95cbe5d3b00a19bf81c9e02498cb72bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1ffcfbad020b7ef0efc376f2a3c791c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#ad1ffcfbad020b7ef0efc376f2a3c791c">FP_HIFIVE_zero</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:ad1ffcfbad020b7ef0efc376f2a3c791c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#ad1ffcfbad020b7ef0efc376f2a3c791c">More...</a><br /></td></tr>
<tr class="separator:ad1ffcfbad020b7ef0efc376f2a3c791c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d2486b559be8c6f736dd8d8f4d2ee1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a2d2486b559be8c6f736dd8d8f4d2ee1b">FP_HIFIVE_copy</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:a2d2486b559be8c6f736dd8d8f4d2ee1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#a2d2486b559be8c6f736dd8d8f4d2ee1b">More...</a><br /></td></tr>
<tr class="separator:a2d2486b559be8c6f736dd8d8f4d2ee1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4a2d7b9fd9505fa3062c835fb1924ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#ab4a2d7b9fd9505fa3062c835fb1924ca">FP_HIFIVE_rcopy</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, const <a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a> x)</td></tr>
<tr class="memdesc:ab4a2d7b9fd9505fa3062c835fb1924ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#ab4a2d7b9fd9505fa3062c835fb1924ca">More...</a><br /></td></tr>
<tr class="separator:ab4a2d7b9fd9505fa3062c835fb1924ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22559c6e048ecc3624a0ff501127f835"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a22559c6e048ecc3624a0ff501127f835">FP_HIFIVE_equals</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y)</td></tr>
<tr class="memdesc:a22559c6e048ecc3624a0ff501127f835"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a22559c6e048ecc3624a0ff501127f835">More...</a><br /></td></tr>
<tr class="separator:a22559c6e048ecc3624a0ff501127f835"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7906551bdced9625871c178b0ca6b5b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#ae7906551bdced9625871c178b0ca6b5b">FP_HIFIVE_cswap</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, int s)</td></tr>
<tr class="memdesc:ae7906551bdced9625871c178b0ca6b5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#ae7906551bdced9625871c178b0ca6b5b">More...</a><br /></td></tr>
<tr class="separator:ae7906551bdced9625871c178b0ca6b5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9b444b604c2576ca18b9585f60a5fa3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#af9b444b604c2576ca18b9585f60a5fa3">FP_HIFIVE_cmove</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, int s)</td></tr>
<tr class="memdesc:af9b444b604c2576ca18b9585f60a5fa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#af9b444b604c2576ca18b9585f60a5fa3">More...</a><br /></td></tr>
<tr class="separator:af9b444b604c2576ca18b9585f60a5fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0026e951ef78de41a8804730ee55049"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#ab0026e951ef78de41a8804730ee55049">FP_HIFIVE_nres</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, <a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a> x)</td></tr>
<tr class="memdesc:ab0026e951ef78de41a8804730ee55049"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#ab0026e951ef78de41a8804730ee55049">More...</a><br /></td></tr>
<tr class="separator:ab0026e951ef78de41a8804730ee55049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c158a790b3d9e109ec69662e7a7fa68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a1c158a790b3d9e109ec69662e7a7fa68">FP_HIFIVE_redc</a> (<a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a> x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y)</td></tr>
<tr class="memdesc:a1c158a790b3d9e109ec69662e7a7fa68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#a1c158a790b3d9e109ec69662e7a7fa68">More...</a><br /></td></tr>
<tr class="separator:a1c158a790b3d9e109ec69662e7a7fa68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17dd95c3e5df305d65e270e82fa95c5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a17dd95c3e5df305d65e270e82fa95c5f">FP_HIFIVE_one</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:a17dd95c3e5df305d65e270e82fa95c5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a17dd95c3e5df305d65e270e82fa95c5f">More...</a><br /></td></tr>
<tr class="separator:a17dd95c3e5df305d65e270e82fa95c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c47748d27117c7e3fbd04f40f65f621"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a8c47748d27117c7e3fbd04f40f65f621">FP_HIFIVE_mod</a> (<a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a> r, <a class="el" href="big__336__60_8h.html#a70c432ae6e91b20f991bec94badb11d6">DBIG_336_60</a> d)</td></tr>
<tr class="memdesc:a8c47748d27117c7e3fbd04f40f65f621"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#a8c47748d27117c7e3fbd04f40f65f621">More...</a><br /></td></tr>
<tr class="separator:a8c47748d27117c7e3fbd04f40f65f621"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c8f3fd99d6cc3f5151835efce3163f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a6c8f3fd99d6cc3f5151835efce3163f4">FP_HIFIVE_mul</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *z)</td></tr>
<tr class="memdesc:a6c8f3fd99d6cc3f5151835efce3163f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#a6c8f3fd99d6cc3f5151835efce3163f4">More...</a><br /></td></tr>
<tr class="separator:a6c8f3fd99d6cc3f5151835efce3163f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d8492eb567d02323cbfe55e79bf2141"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a6d8492eb567d02323cbfe55e79bf2141">FP_HIFIVE_imul</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, int i)</td></tr>
<tr class="memdesc:a6d8492eb567d02323cbfe55e79bf2141"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#a6d8492eb567d02323cbfe55e79bf2141">More...</a><br /></td></tr>
<tr class="separator:a6d8492eb567d02323cbfe55e79bf2141"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a389261777fbf33bbf5d19e8a490fe62e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a389261777fbf33bbf5d19e8a490fe62e">FP_HIFIVE_sqr</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y)</td></tr>
<tr class="memdesc:a389261777fbf33bbf5d19e8a490fe62e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#a389261777fbf33bbf5d19e8a490fe62e">More...</a><br /></td></tr>
<tr class="separator:a389261777fbf33bbf5d19e8a490fe62e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c77035cfa5c245ff7f7a820af42bacd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a3c77035cfa5c245ff7f7a820af42bacd">FP_HIFIVE_add</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *z)</td></tr>
<tr class="memdesc:a3c77035cfa5c245ff7f7a820af42bacd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#a3c77035cfa5c245ff7f7a820af42bacd">More...</a><br /></td></tr>
<tr class="separator:a3c77035cfa5c245ff7f7a820af42bacd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21747d8103599945c6e10ce5178f3691"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a21747d8103599945c6e10ce5178f3691">FP_HIFIVE_sub</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *z)</td></tr>
<tr class="memdesc:a21747d8103599945c6e10ce5178f3691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#a21747d8103599945c6e10ce5178f3691">More...</a><br /></td></tr>
<tr class="separator:a21747d8103599945c6e10ce5178f3691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a106b2cca3fcbe6e56d2dbcc840a219c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a106b2cca3fcbe6e56d2dbcc840a219c7">FP_HIFIVE_div2</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y)</td></tr>
<tr class="memdesc:a106b2cca3fcbe6e56d2dbcc840a219c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#a106b2cca3fcbe6e56d2dbcc840a219c7">More...</a><br /></td></tr>
<tr class="separator:a106b2cca3fcbe6e56d2dbcc840a219c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdc3fbf388d76dddfe40d0f85f8abc6f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#abdc3fbf388d76dddfe40d0f85f8abc6f">FP_HIFIVE_pow</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y, <a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a> z)</td></tr>
<tr class="memdesc:abdc3fbf388d76dddfe40d0f85f8abc6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#abdc3fbf388d76dddfe40d0f85f8abc6f">More...</a><br /></td></tr>
<tr class="separator:abdc3fbf388d76dddfe40d0f85f8abc6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab04e954ce9b3b0e08ef727bbb8d1d676"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#ab04e954ce9b3b0e08ef727bbb8d1d676">FP_HIFIVE_sqrt</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y)</td></tr>
<tr class="memdesc:ab04e954ce9b3b0e08ef727bbb8d1d676"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#ab04e954ce9b3b0e08ef727bbb8d1d676">More...</a><br /></td></tr>
<tr class="separator:ab04e954ce9b3b0e08ef727bbb8d1d676"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae113a4564922e19f17838f7d93cf7234"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#ae113a4564922e19f17838f7d93cf7234">FP_HIFIVE_neg</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y)</td></tr>
<tr class="memdesc:ae113a4564922e19f17838f7d93cf7234"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#ae113a4564922e19f17838f7d93cf7234">More...</a><br /></td></tr>
<tr class="separator:ae113a4564922e19f17838f7d93cf7234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29926ceff76d7235889c3be685916274"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a29926ceff76d7235889c3be685916274">FP_HIFIVE_output</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:a29926ceff76d7235889c3be685916274"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#a29926ceff76d7235889c3be685916274">More...</a><br /></td></tr>
<tr class="separator:a29926ceff76d7235889c3be685916274"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a757c4c186626dcaa5f47fdb1f3751d99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a757c4c186626dcaa5f47fdb1f3751d99">FP_HIFIVE_rawoutput</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:a757c4c186626dcaa5f47fdb1f3751d99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#a757c4c186626dcaa5f47fdb1f3751d99">More...</a><br /></td></tr>
<tr class="separator:a757c4c186626dcaa5f47fdb1f3751d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a2d8805efdb06fd94466736037b82e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a6a2d8805efdb06fd94466736037b82e8">FP_HIFIVE_reduce</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:a6a2d8805efdb06fd94466736037b82e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#a6a2d8805efdb06fd94466736037b82e8">More...</a><br /></td></tr>
<tr class="separator:a6a2d8805efdb06fd94466736037b82e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d516903cc385879db40d5d4e2331bde"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a4d516903cc385879db40d5d4e2331bde">FP_HIFIVE_norm</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:a4d516903cc385879db40d5d4e2331bde"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#a4d516903cc385879db40d5d4e2331bde">More...</a><br /></td></tr>
<tr class="separator:a4d516903cc385879db40d5d4e2331bde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2eb0050bc2c77f12ed07e5a13812089"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#ae2eb0050bc2c77f12ed07e5a13812089">FP_HIFIVE_qr</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x)</td></tr>
<tr class="memdesc:ae2eb0050bc2c77f12ed07e5a13812089"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#ae2eb0050bc2c77f12ed07e5a13812089">More...</a><br /></td></tr>
<tr class="separator:ae2eb0050bc2c77f12ed07e5a13812089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1784d5b50d9f341d13fc4bc6cd880ebe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a1784d5b50d9f341d13fc4bc6cd880ebe">FP_HIFIVE_inv</a> (<a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *x, <a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</a> *y)</td></tr>
<tr class="memdesc:a1784d5b50d9f341d13fc4bc6cd880ebe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#a1784d5b50d9f341d13fc4bc6cd880ebe">More...</a><br /></td></tr>
<tr class="separator:a1784d5b50d9f341d13fc4bc6cd880ebe"><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:a189aaec49cb36c79a03ee076e3ffab87"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a189aaec49cb36c79a03ee076e3ffab87">Modulus_HIFIVE</a></td></tr>
<tr class="separator:a189aaec49cb36c79a03ee076e3ffab87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72bdadf107db2d6cdce7fc687d37ad18"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__HIFIVE_8h.html#a72bdadf107db2d6cdce7fc687d37ad18">R2modp_HIFIVE</a></td></tr>
<tr class="separator:a72bdadf107db2d6cdce7fc687d37ad18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b8f32b6cc4c981e7986b4a543e840fa"><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__HIFIVE_8h.html#a9b8f32b6cc4c981e7986b4a543e840fa">MConst_HIFIVE</a></td></tr>
<tr class="separator:a9b8f32b6cc4c981e7986b4a543e840fa"><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="a17ffc867f3aa99310db749a7ba510f7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17ffc867f3aa99310db749a7ba510f7d">&#9670;&nbsp;</a></span>FEXCESS_HIFIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_HIFIVE&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_HIFIVE)-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="a08c92de6c797e0836192a06cdf68c674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08c92de6c797e0836192a06cdf68c674">&#9670;&nbsp;</a></span>MODBITS_HIFIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_HIFIVE&#160;&#160;&#160;MBITS_HIFIVE</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="a3f6ef0baec26453c5925ff0da0b27bde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f6ef0baec26453c5925ff0da0b27bde">&#9670;&nbsp;</a></span>OMASK_HIFIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_HIFIVE&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__HIFIVE_8h.html#a19f19da79f660598a9963bcc19174fa1">TBITS_HIFIVE</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="a19f19da79f660598a9963bcc19174fa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19f19da79f660598a9963bcc19174fa1">&#9670;&nbsp;</a></span>TBITS_HIFIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_HIFIVE&#160;&#160;&#160;(MBITS_HIFIVE%<a class="el" href="config__big__336__60_8h.html#aafc3fab89520932a6ddf0486adb1e988">BASEBITS_336_60</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of active bits in top word </p>
</div>
</div>
<a id="a027ca9deb396cf742b0888dac9863374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a027ca9deb396cf742b0888dac9863374">&#9670;&nbsp;</a></span>TMASK_HIFIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_HIFIVE&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__HIFIVE_8h.html#a19f19da79f660598a9963bcc19174fa1">TBITS_HIFIVE</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="a3c77035cfa5c245ff7f7a820af42bacd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c77035cfa5c245ff7f7a820af42bacd">&#9670;&nbsp;</a></span>FP_HIFIVE_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="af9b444b604c2576ca18b9585f60a5fa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9b444b604c2576ca18b9585f60a5fa3">&#9670;&nbsp;</a></span>FP_HIFIVE_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a2d2486b559be8c6f736dd8d8f4d2ee1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d2486b559be8c6f736dd8d8f4d2ee1b">&#9670;&nbsp;</a></span>FP_HIFIVE_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="ae7906551bdced9625871c178b0ca6b5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7906551bdced9625871c178b0ca6b5b">&#9670;&nbsp;</a></span>FP_HIFIVE_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a106b2cca3fcbe6e56d2dbcc840a219c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a106b2cca3fcbe6e56d2dbcc840a219c7">&#9670;&nbsp;</a></span>FP_HIFIVE_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a22559c6e048ecc3624a0ff501127f835"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22559c6e048ecc3624a0ff501127f835">&#9670;&nbsp;</a></span>FP_HIFIVE_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_HIFIVE_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a6d8492eb567d02323cbfe55e79bf2141"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d8492eb567d02323cbfe55e79bf2141">&#9670;&nbsp;</a></span>FP_HIFIVE_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a1784d5b50d9f341d13fc4bc6cd880ebe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1784d5b50d9f341d13fc4bc6cd880ebe">&#9670;&nbsp;</a></span>FP_HIFIVE_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a95cbe5d3b00a19bf81c9e02498cb72bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95cbe5d3b00a19bf81c9e02498cb72bd">&#9670;&nbsp;</a></span>FP_HIFIVE_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_HIFIVE_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="a8c47748d27117c7e3fbd04f40f65f621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c47748d27117c7e3fbd04f40f65f621">&#9670;&nbsp;</a></span>FP_HIFIVE_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_mod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</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__336__60_8h.html#a70c432ae6e91b20f991bec94badb11d6">DBIG_336_60</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="a6c8f3fd99d6cc3f5151835efce3163f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c8f3fd99d6cc3f5151835efce3163f4">&#9670;&nbsp;</a></span>FP_HIFIVE_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="ae113a4564922e19f17838f7d93cf7234"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae113a4564922e19f17838f7d93cf7234">&#9670;&nbsp;</a></span>FP_HIFIVE_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a4d516903cc385879db40d5d4e2331bde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d516903cc385879db40d5d4e2331bde">&#9670;&nbsp;</a></span>FP_HIFIVE_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="ab0026e951ef78de41a8804730ee55049"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0026e951ef78de41a8804730ee55049">&#9670;&nbsp;</a></span>FP_HIFIVE_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</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="a17dd95c3e5df305d65e270e82fa95c5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17dd95c3e5df305d65e270e82fa95c5f">&#9670;&nbsp;</a></span>FP_HIFIVE_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="a29926ceff76d7235889c3be685916274"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29926ceff76d7235889c3be685916274">&#9670;&nbsp;</a></span>FP_HIFIVE_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="abdc3fbf388d76dddfe40d0f85f8abc6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdc3fbf388d76dddfe40d0f85f8abc6f">&#9670;&nbsp;</a></span>FP_HIFIVE_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</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="ae2eb0050bc2c77f12ed07e5a13812089"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2eb0050bc2c77f12ed07e5a13812089">&#9670;&nbsp;</a></span>FP_HIFIVE_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_HIFIVE_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="a757c4c186626dcaa5f47fdb1f3751d99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a757c4c186626dcaa5f47fdb1f3751d99">&#9670;&nbsp;</a></span>FP_HIFIVE_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="ab4a2d7b9fd9505fa3062c835fb1924ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4a2d7b9fd9505fa3062c835fb1924ca">&#9670;&nbsp;</a></span>FP_HIFIVE_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</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="a1c158a790b3d9e109ec69662e7a7fa68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c158a790b3d9e109ec69662e7a7fa68">&#9670;&nbsp;</a></span>FP_HIFIVE_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_redc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</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__HIFIVE.html">FP_HIFIVE</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="a6a2d8805efdb06fd94466736037b82e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a2d8805efdb06fd94466736037b82e8">&#9670;&nbsp;</a></span>FP_HIFIVE_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="a389261777fbf33bbf5d19e8a490fe62e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a389261777fbf33bbf5d19e8a490fe62e">&#9670;&nbsp;</a></span>FP_HIFIVE_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="ab04e954ce9b3b0e08ef727bbb8d1d676"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab04e954ce9b3b0e08ef727bbb8d1d676">&#9670;&nbsp;</a></span>FP_HIFIVE_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="a21747d8103599945c6e10ce5178f3691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21747d8103599945c6e10ce5178f3691">&#9670;&nbsp;</a></span>FP_HIFIVE_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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__HIFIVE.html">FP_HIFIVE</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="ad1ffcfbad020b7ef0efc376f2a3c791c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1ffcfbad020b7ef0efc376f2a3c791c">&#9670;&nbsp;</a></span>FP_HIFIVE_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_HIFIVE_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__HIFIVE.html">FP_HIFIVE</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="a9b8f32b6cc4c981e7986b4a543e840fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b8f32b6cc4c981e7986b4a543e840fa">&#9670;&nbsp;</a></span>MConst_HIFIVE</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_HIFIVE</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="a189aaec49cb36c79a03ee076e3ffab87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a189aaec49cb36c79a03ee076e3ffab87">&#9670;&nbsp;</a></span>Modulus_HIFIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a> Modulus_HIFIVE</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="a72bdadf107db2d6cdce7fc687d37ad18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72bdadf107db2d6cdce7fc687d37ad18">&#9670;&nbsp;</a></span>R2modp_HIFIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="big__336__60_8h.html#a43cd5984d14e5bce79a1dd36a17ec7e1">BIG_336_60</a> R2modp_HIFIVE</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>