blob: 026a28074e6727305cea5f5148d03aac29df38ad [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_NIST256.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_NIST256.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_NIST256.h&quot;</code><br />
</div>
<p><a href="fp__NIST256_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__NIST256.html">FP_NIST256</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">FP Structure - quadratic extension field. <a href="structFP__NIST256.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:ab23e4500717e2ed9e2e9734bd14898a7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#ab23e4500717e2ed9e2e9734bd14898a7">MODBITS_NIST256</a>&#160;&#160;&#160;MBITS_NIST256</td></tr>
<tr class="separator:ab23e4500717e2ed9e2e9734bd14898a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a163254dd428afeb6080c9c75e34811e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a163254dd428afeb6080c9c75e34811e5">TBITS_NIST256</a>&#160;&#160;&#160;(MBITS_NIST256%<a class="el" href="config__big__256__56_8h.html#ac6cb0299279eb5c9a07bccfd297f1b40">BASEBITS_256_56</a>)</td></tr>
<tr class="separator:a163254dd428afeb6080c9c75e34811e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd8d5f140fa66f68f63fbbbed34da288"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#acd8d5f140fa66f68f63fbbbed34da288">TMASK_NIST256</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__NIST256_8h.html#a163254dd428afeb6080c9c75e34811e5">TBITS_NIST256</a>)-1)</td></tr>
<tr class="separator:acd8d5f140fa66f68f63fbbbed34da288"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d2c2670a232a846467501e143b3363b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a4d2c2670a232a846467501e143b3363b">FEXCESS_NIST256</a>&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_NIST256)-1)</td></tr>
<tr class="separator:a4d2c2670a232a846467501e143b3363b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae4d7e3db16f3a886f7c03ac2491665a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#aae4d7e3db16f3a886f7c03ac2491665a">OMASK_NIST256</a>&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__NIST256_8h.html#a163254dd428afeb6080c9c75e34811e5">TBITS_NIST256</a>))</td></tr>
<tr class="separator:aae4d7e3db16f3a886f7c03ac2491665a"><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:acc63d1f1a0c14bc67e46ce7296ea7027"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#acc63d1f1a0c14bc67e46ce7296ea7027">FP_NIST256_iszilch</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:acc63d1f1a0c14bc67e46ce7296ea7027"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP equal to zero mod Modulus. <a href="#acc63d1f1a0c14bc67e46ce7296ea7027">More...</a><br /></td></tr>
<tr class="separator:acc63d1f1a0c14bc67e46ce7296ea7027"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add76b9339c606fee4081bbbb277942fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#add76b9339c606fee4081bbbb277942fc">FP_NIST256_zero</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:add76b9339c606fee4081bbbb277942fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set FP to zero. <a href="#add76b9339c606fee4081bbbb277942fc">More...</a><br /></td></tr>
<tr class="separator:add76b9339c606fee4081bbbb277942fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e890a6504bd1f74eec2e0c90d882c88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a5e890a6504bd1f74eec2e0c90d882c88">FP_NIST256_copy</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:a5e890a6504bd1f74eec2e0c90d882c88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an FP. <a href="#a5e890a6504bd1f74eec2e0c90d882c88">More...</a><br /></td></tr>
<tr class="separator:a5e890a6504bd1f74eec2e0c90d882c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14b970347025c17a50c2762c68e715c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a14b970347025c17a50c2762c68e715c8">FP_NIST256_rcopy</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, const <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:a14b970347025c17a50c2762c68e715c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy from ROM to an FP. <a href="#a14b970347025c17a50c2762c68e715c8">More...</a><br /></td></tr>
<tr class="separator:a14b970347025c17a50c2762c68e715c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98ea44149511fa1bb2ad4ef35186e90b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a98ea44149511fa1bb2ad4ef35186e90b">FP_NIST256_equals</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y)</td></tr>
<tr class="memdesc:a98ea44149511fa1bb2ad4ef35186e90b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two FPs. <a href="#a98ea44149511fa1bb2ad4ef35186e90b">More...</a><br /></td></tr>
<tr class="separator:a98ea44149511fa1bb2ad4ef35186e90b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c7dd935ddc0f6090d1a4ded2136a58d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a6c7dd935ddc0f6090d1a4ded2136a58d">FP_NIST256_cswap</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, int s)</td></tr>
<tr class="memdesc:a6c7dd935ddc0f6090d1a4ded2136a58d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional constant time swap of two FP numbers. <a href="#a6c7dd935ddc0f6090d1a4ded2136a58d">More...</a><br /></td></tr>
<tr class="separator:a6c7dd935ddc0f6090d1a4ded2136a58d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f75aa46d3d67176463bdaec38cca111"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a7f75aa46d3d67176463bdaec38cca111">FP_NIST256_cmove</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, int s)</td></tr>
<tr class="memdesc:a7f75aa46d3d67176463bdaec38cca111"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditional copy of FP number. <a href="#a7f75aa46d3d67176463bdaec38cca111">More...</a><br /></td></tr>
<tr class="separator:a7f75aa46d3d67176463bdaec38cca111"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17e4d91b05ff8312012a001cee0ce96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#ad17e4d91b05ff8312012a001cee0ce96">FP_NIST256_nres</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x)</td></tr>
<tr class="memdesc:ad17e4d91b05ff8312012a001cee0ce96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from BIG integer to residue form mod Modulus. <a href="#ad17e4d91b05ff8312012a001cee0ce96">More...</a><br /></td></tr>
<tr class="separator:ad17e4d91b05ff8312012a001cee0ce96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac266e9c71c3ae3c261c778c14eb9f0b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#ac266e9c71c3ae3c261c778c14eb9f0b4">FP_NIST256_redc</a> (<a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y)</td></tr>
<tr class="memdesc:ac266e9c71c3ae3c261c778c14eb9f0b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts from residue form back to BIG integer form. <a href="#ac266e9c71c3ae3c261c778c14eb9f0b4">More...</a><br /></td></tr>
<tr class="separator:ac266e9c71c3ae3c261c778c14eb9f0b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a931d0d3ad9ce57763d0f521dd6c4b911"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a931d0d3ad9ce57763d0f521dd6c4b911">FP_NIST256_one</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:a931d0d3ad9ce57763d0f521dd6c4b911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets FP to representation of unity in residue form. <a href="#a931d0d3ad9ce57763d0f521dd6c4b911">More...</a><br /></td></tr>
<tr class="separator:a931d0d3ad9ce57763d0f521dd6c4b911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a360b79149fe4c8460a7cdbf0ac8e248f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a360b79149fe4c8460a7cdbf0ac8e248f">FP_NIST256_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:a360b79149fe4c8460a7cdbf0ac8e248f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces DBIG to BIG exploiting special form of the modulus. <a href="#a360b79149fe4c8460a7cdbf0ac8e248f">More...</a><br /></td></tr>
<tr class="separator:a360b79149fe4c8460a7cdbf0ac8e248f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef8637c1b2906303fa9a77661c4541a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#aef8637c1b2906303fa9a77661c4541a4">FP_NIST256_mul</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *z)</td></tr>
<tr class="memdesc:aef8637c1b2906303fa9a77661c4541a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of two FPs, mod Modulus. <a href="#aef8637c1b2906303fa9a77661c4541a4">More...</a><br /></td></tr>
<tr class="separator:aef8637c1b2906303fa9a77661c4541a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bf3d4429724f5c5aae46e4b6de375aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a6bf3d4429724f5c5aae46e4b6de375aa">FP_NIST256_imul</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, int i)</td></tr>
<tr class="memdesc:a6bf3d4429724f5c5aae46e4b6de375aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular multiplication of an FP, by a small integer, mod Modulus. <a href="#a6bf3d4429724f5c5aae46e4b6de375aa">More...</a><br /></td></tr>
<tr class="separator:a6bf3d4429724f5c5aae46e4b6de375aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a833dc32b90230e9879d382d948b5db8d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a833dc32b90230e9879d382d948b5db8d">FP_NIST256_sqr</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y)</td></tr>
<tr class="memdesc:a833dc32b90230e9879d382d948b5db8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular squaring of an FP, mod Modulus. <a href="#a833dc32b90230e9879d382d948b5db8d">More...</a><br /></td></tr>
<tr class="separator:a833dc32b90230e9879d382d948b5db8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31ddd93e5a56037f28a42445b8e9019f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a31ddd93e5a56037f28a42445b8e9019f">FP_NIST256_add</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *z)</td></tr>
<tr class="memdesc:a31ddd93e5a56037f28a42445b8e9019f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular addition of two FPs, mod Modulus. <a href="#a31ddd93e5a56037f28a42445b8e9019f">More...</a><br /></td></tr>
<tr class="separator:a31ddd93e5a56037f28a42445b8e9019f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a538430954863b17ee7de569412ab1136"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a538430954863b17ee7de569412ab1136">FP_NIST256_sub</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *z)</td></tr>
<tr class="memdesc:a538430954863b17ee7de569412ab1136"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular subtraction of two FPs, mod Modulus. <a href="#a538430954863b17ee7de569412ab1136">More...</a><br /></td></tr>
<tr class="separator:a538430954863b17ee7de569412ab1136"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9758e8b7c1fa10cb91126f35e5895d3d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a9758e8b7c1fa10cb91126f35e5895d3d">FP_NIST256_div2</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y)</td></tr>
<tr class="memdesc:a9758e8b7c1fa10cb91126f35e5895d3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular division by 2 of an FP, mod Modulus. <a href="#a9758e8b7c1fa10cb91126f35e5895d3d">More...</a><br /></td></tr>
<tr class="separator:a9758e8b7c1fa10cb91126f35e5895d3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade1eee40e39cf57d24100cb3ca5580dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#ade1eee40e39cf57d24100cb3ca5580dd">FP_NIST256_pow</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y, <a class="el" href="big__256__56_8h.html#abea3e70a8a87f28329ed8e48af7bb244">BIG_256_56</a> z)</td></tr>
<tr class="memdesc:ade1eee40e39cf57d24100cb3ca5580dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular exponentiation of an FP, to the power of a BIG, mod Modulus. <a href="#ade1eee40e39cf57d24100cb3ca5580dd">More...</a><br /></td></tr>
<tr class="separator:ade1eee40e39cf57d24100cb3ca5580dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19539e255bc32da5ddb62dd8084d4f92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a19539e255bc32da5ddb62dd8084d4f92">FP_NIST256_sqrt</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y)</td></tr>
<tr class="memdesc:a19539e255bc32da5ddb62dd8084d4f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast Modular square root of a an FP, mod Modulus. <a href="#a19539e255bc32da5ddb62dd8084d4f92">More...</a><br /></td></tr>
<tr class="separator:a19539e255bc32da5ddb62dd8084d4f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec47a44f1444c92105cf8d378cbd1939"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#aec47a44f1444c92105cf8d378cbd1939">FP_NIST256_neg</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y)</td></tr>
<tr class="memdesc:aec47a44f1444c92105cf8d378cbd1939"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular negation of a an FP, mod Modulus. <a href="#aec47a44f1444c92105cf8d378cbd1939">More...</a><br /></td></tr>
<tr class="separator:aec47a44f1444c92105cf8d378cbd1939"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afca9ca17ef14231d6ef687d835ab5290"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#afca9ca17ef14231d6ef687d835ab5290">FP_NIST256_output</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:afca9ca17ef14231d6ef687d835ab5290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console. <a href="#afca9ca17ef14231d6ef687d835ab5290">More...</a><br /></td></tr>
<tr class="separator:afca9ca17ef14231d6ef687d835ab5290"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee8ee1e1ed4be1f5e031a96ef4175760"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#aee8ee1e1ed4be1f5e031a96ef4175760">FP_NIST256_rawoutput</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:aee8ee1e1ed4be1f5e031a96ef4175760"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs an FP number to the console, in raw form. <a href="#aee8ee1e1ed4be1f5e031a96ef4175760">More...</a><br /></td></tr>
<tr class="separator:aee8ee1e1ed4be1f5e031a96ef4175760"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f1b3f20548f1efd928a0df2df35b607"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a2f1b3f20548f1efd928a0df2df35b607">FP_NIST256_reduce</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:a2f1b3f20548f1efd928a0df2df35b607"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reduces possibly unreduced FP mod Modulus. <a href="#a2f1b3f20548f1efd928a0df2df35b607">More...</a><br /></td></tr>
<tr class="separator:a2f1b3f20548f1efd928a0df2df35b607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b2cbf94803681c261290c6c1b0abe10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#a4b2cbf94803681c261290c6c1b0abe10">FP_NIST256_norm</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:a4b2cbf94803681c261290c6c1b0abe10"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes FP <a href="#a4b2cbf94803681c261290c6c1b0abe10">More...</a><br /></td></tr>
<tr class="separator:a4b2cbf94803681c261290c6c1b0abe10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd41f2972300cfe2cca42d3124ad36ec"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#afd41f2972300cfe2cca42d3124ad36ec">FP_NIST256_qr</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x)</td></tr>
<tr class="memdesc:afd41f2972300cfe2cca42d3124ad36ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests for FP a quadratic residue mod Modulus. <a href="#afd41f2972300cfe2cca42d3124ad36ec">More...</a><br /></td></tr>
<tr class="separator:afd41f2972300cfe2cca42d3124ad36ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad425620e1f38ab930256bb0d3b94c919"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fp__NIST256_8h.html#ad425620e1f38ab930256bb0d3b94c919">FP_NIST256_inv</a> (<a class="el" href="structFP__NIST256.html">FP_NIST256</a> *x, <a class="el" href="structFP__NIST256.html">FP_NIST256</a> *y)</td></tr>
<tr class="memdesc:ad425620e1f38ab930256bb0d3b94c919"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modular inverse of a an FP, mod Modulus. <a href="#ad425620e1f38ab930256bb0d3b94c919">More...</a><br /></td></tr>
<tr class="separator:ad425620e1f38ab930256bb0d3b94c919"><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:a325c1d7a187eded1d3697e6e0ab55451"><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__NIST256_8h.html#a325c1d7a187eded1d3697e6e0ab55451">Modulus_NIST256</a></td></tr>
<tr class="separator:a325c1d7a187eded1d3697e6e0ab55451"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d20794d232bdcaa5a6a03454e5b2241"><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__NIST256_8h.html#a7d20794d232bdcaa5a6a03454e5b2241">R2modp_NIST256</a></td></tr>
<tr class="separator:a7d20794d232bdcaa5a6a03454e5b2241"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab72c8101619750a46a92aa103a590551"><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__NIST256_8h.html#ab72c8101619750a46a92aa103a590551">MConst_NIST256</a></td></tr>
<tr class="separator:ab72c8101619750a46a92aa103a590551"><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="a4d2c2670a232a846467501e143b3363b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2c2670a232a846467501e143b3363b">&#9670;&nbsp;</a></span>FEXCESS_NIST256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FEXCESS_NIST256&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#af31fcb3b74c4bcf6507f62d801277492">sign32</a>)1&lt;&lt;MAXXES_NIST256)-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="ab23e4500717e2ed9e2e9734bd14898a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab23e4500717e2ed9e2e9734bd14898a7">&#9670;&nbsp;</a></span>MODBITS_NIST256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MODBITS_NIST256&#160;&#160;&#160;MBITS_NIST256</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bits in Modulus for selected curve </p>
</div>
</div>
<a id="aae4d7e3db16f3a886f7c03ac2491665a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae4d7e3db16f3a886f7c03ac2491665a">&#9670;&nbsp;</a></span>OMASK_NIST256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OMASK_NIST256&#160;&#160;&#160;(-((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)(1)&lt;&lt;<a class="el" href="fp__NIST256_8h.html#a163254dd428afeb6080c9c75e34811e5">TBITS_NIST256</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>for masking out overflow bits </p>
</div>
</div>
<a id="a163254dd428afeb6080c9c75e34811e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a163254dd428afeb6080c9c75e34811e5">&#9670;&nbsp;</a></span>TBITS_NIST256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TBITS_NIST256&#160;&#160;&#160;(MBITS_NIST256%<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="acd8d5f140fa66f68f63fbbbed34da288"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd8d5f140fa66f68f63fbbbed34da288">&#9670;&nbsp;</a></span>TMASK_NIST256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TMASK_NIST256&#160;&#160;&#160;(((<a class="el" href="arch_8h.html#a0dd4b8ab353c587b22c6acb0809323aa">chunk</a>)1&lt;&lt;<a class="el" href="fp__NIST256_8h.html#a163254dd428afeb6080c9c75e34811e5">TBITS_NIST256</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="a31ddd93e5a56037f28a42445b8e9019f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31ddd93e5a56037f28a42445b8e9019f">&#9670;&nbsp;</a></span>FP_NIST256_add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a7f75aa46d3d67176463bdaec38cca111"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f75aa46d3d67176463bdaec38cca111">&#9670;&nbsp;</a></span>FP_NIST256_cmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_cmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a5e890a6504bd1f74eec2e0c90d882c88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e890a6504bd1f74eec2e0c90d882c88">&#9670;&nbsp;</a></span>FP_NIST256_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a6c7dd935ddc0f6090d1a4ded2136a58d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c7dd935ddc0f6090d1a4ded2136a58d">&#9670;&nbsp;</a></span>FP_NIST256_cswap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_cswap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a9758e8b7c1fa10cb91126f35e5895d3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9758e8b7c1fa10cb91126f35e5895d3d">&#9670;&nbsp;</a></span>FP_NIST256_div2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_div2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a98ea44149511fa1bb2ad4ef35186e90b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98ea44149511fa1bb2ad4ef35186e90b">&#9670;&nbsp;</a></span>FP_NIST256_equals()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_NIST256_equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a6bf3d4429724f5c5aae46e4b6de375aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bf3d4429724f5c5aae46e4b6de375aa">&#9670;&nbsp;</a></span>FP_NIST256_imul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_imul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="ad425620e1f38ab930256bb0d3b94c919"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad425620e1f38ab930256bb0d3b94c919">&#9670;&nbsp;</a></span>FP_NIST256_inv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_inv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="acc63d1f1a0c14bc67e46ce7296ea7027"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc63d1f1a0c14bc67e46ce7296ea7027">&#9670;&nbsp;</a></span>FP_NIST256_iszilch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_NIST256_iszilch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="a360b79149fe4c8460a7cdbf0ac8e248f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a360b79149fe4c8460a7cdbf0ac8e248f">&#9670;&nbsp;</a></span>FP_NIST256_mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_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="aef8637c1b2906303fa9a77661c4541a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef8637c1b2906303fa9a77661c4541a4">&#9670;&nbsp;</a></span>FP_NIST256_mul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_mul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="aec47a44f1444c92105cf8d378cbd1939"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec47a44f1444c92105cf8d378cbd1939">&#9670;&nbsp;</a></span>FP_NIST256_neg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_neg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a4b2cbf94803681c261290c6c1b0abe10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b2cbf94803681c261290c6c1b0abe10">&#9670;&nbsp;</a></span>FP_NIST256_norm()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="ad17e4d91b05ff8312012a001cee0ce96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad17e4d91b05ff8312012a001cee0ce96">&#9670;&nbsp;</a></span>FP_NIST256_nres()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_nres </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="a931d0d3ad9ce57763d0f521dd6c4b911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a931d0d3ad9ce57763d0f521dd6c4b911">&#9670;&nbsp;</a></span>FP_NIST256_one()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_one </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="afca9ca17ef14231d6ef687d835ab5290"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afca9ca17ef14231d6ef687d835ab5290">&#9670;&nbsp;</a></span>FP_NIST256_output()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="ade1eee40e39cf57d24100cb3ca5580dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade1eee40e39cf57d24100cb3ca5580dd">&#9670;&nbsp;</a></span>FP_NIST256_pow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_pow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="afd41f2972300cfe2cca42d3124ad36ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd41f2972300cfe2cca42d3124ad36ec">&#9670;&nbsp;</a></span>FP_NIST256_qr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FP_NIST256_qr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="aee8ee1e1ed4be1f5e031a96ef4175760"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee8ee1e1ed4be1f5e031a96ef4175760">&#9670;&nbsp;</a></span>FP_NIST256_rawoutput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_rawoutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="a14b970347025c17a50c2762c68e715c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14b970347025c17a50c2762c68e715c8">&#9670;&nbsp;</a></span>FP_NIST256_rcopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_rcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="ac266e9c71c3ae3c261c778c14eb9f0b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac266e9c71c3ae3c261c778c14eb9f0b4">&#9670;&nbsp;</a></span>FP_NIST256_redc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_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__NIST256.html">FP_NIST256</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="a2f1b3f20548f1efd928a0df2df35b607"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f1b3f20548f1efd928a0df2df35b607">&#9670;&nbsp;</a></span>FP_NIST256_reduce()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_reduce </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="a833dc32b90230e9879d382d948b5db8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a833dc32b90230e9879d382d948b5db8d">&#9670;&nbsp;</a></span>FP_NIST256_sqr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_sqr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a19539e255bc32da5ddb62dd8084d4f92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19539e255bc32da5ddb62dd8084d4f92">&#9670;&nbsp;</a></span>FP_NIST256_sqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_sqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="a538430954863b17ee7de569412ab1136"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a538430954863b17ee7de569412ab1136">&#9670;&nbsp;</a></span>FP_NIST256_sub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_sub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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__NIST256.html">FP_NIST256</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="add76b9339c606fee4081bbbb277942fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add76b9339c606fee4081bbbb277942fc">&#9670;&nbsp;</a></span>FP_NIST256_zero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FP_NIST256_zero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structFP__NIST256.html">FP_NIST256</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="ab72c8101619750a46a92aa103a590551"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab72c8101619750a46a92aa103a590551">&#9670;&nbsp;</a></span>MConst_NIST256</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_NIST256</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant associated with Modulus - for Montgomery = 1/p mod 2^BASEBITS </p>
</div>
</div>
<a id="a325c1d7a187eded1d3697e6e0ab55451"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a325c1d7a187eded1d3697e6e0ab55451">&#9670;&nbsp;</a></span>Modulus_NIST256</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_NIST256</td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual Modulus set in romf_yyy.c </p>
</div>
</div>
<a id="a7d20794d232bdcaa5a6a03454e5b2241"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d20794d232bdcaa5a6a03454e5b2241">&#9670;&nbsp;</a></span>R2modp_NIST256</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_NIST256</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>