<!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>Crypto++: misc.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="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">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">misc.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Utility functions for the Crypto++ library.
<a href="#details">More...</a></p>
<p><a href="misc_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>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_empty.html">Empty</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An <a class="el" href="class_empty.html" title="An Empty class.">Empty</a> class. <a href="class_empty.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_object_holder.html">ObjectHolder< T ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Uses encapsulation to hide an object in derived classes. <a href="class_object_holder.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_not_copyable.html">NotCopyable</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Ensures an object is not copyable. <a href="class_not_copyable.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_new_object.html">NewObject< T ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An object factory function. <a href="struct_new_object.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_singleton.html">Singleton< T, F, instance ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Restricts the instantiation of a class to one static object without locks. <a href="class_singleton.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_get_block.html">GetBlock< T, B, A ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Access a block of memory. <a href="class_get_block.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_put_block.html">PutBlock< T, B, A ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Access a block of memory. <a href="class_put_block.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_get_and_put.html">BlockGetAndPut< T, B, GA, PA ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Access a block of memory. <a href="struct_block_get_and_put.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_safe_shifter.html">SafeShifter< overflow ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Safely shift values when undefined behavior could occur. <a href="struct_safe_shifter.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_safe_shifter_3_01true_01_4.html">SafeShifter< true ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Shifts a value in the presence of overflow. <a href="struct_safe_shifter_3_01true_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_safe_shifter_3_01false_01_4.html">SafeShifter< false ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Shifts a value in the absence of overflow. <a href="struct_safe_shifter_3_01false_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a3c75bb398badb69c7577b21486f9963f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a3c75bb398badb69c7577b21486f9963f">SIZE_MAX</a>   ...</td></tr>
<tr class="memdesc:a3c75bb398badb69c7577b21486f9963f"><td class="mdescLeft"> </td><td class="mdescRight">The maximum value of a machine word. <a href="#a3c75bb398badb69c7577b21486f9963f">More...</a><br /></td></tr>
<tr class="separator:a3c75bb398badb69c7577b21486f9963f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b378b1b9b2d4654cc852c088742ba70"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a6b378b1b9b2d4654cc852c088742ba70">CRYPTOPP_COMPILE_ASSERT</a>(expr)   { ... }</td></tr>
<tr class="memdesc:a6b378b1b9b2d4654cc852c088742ba70"><td class="mdescLeft"> </td><td class="mdescRight">Compile time assertion. <a href="#a6b378b1b9b2d4654cc852c088742ba70">More...</a><br /></td></tr>
<tr class="separator:a6b378b1b9b2d4654cc852c088742ba70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d7e4464ea73d6393ebe78f952253426"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426">COUNTOF</a>(arr)</td></tr>
<tr class="memdesc:a2d7e4464ea73d6393ebe78f952253426"><td class="mdescLeft"> </td><td class="mdescRight">Counts elements in an array. <a href="#a2d7e4464ea73d6393ebe78f952253426">More...</a><br /></td></tr>
<tr class="separator:a2d7e4464ea73d6393ebe78f952253426"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80492499834e30e0109e1e4a69efee29"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a80492499834e30e0109e1e4a69efee29">MEMORY_BARRIER</a>   ...</td></tr>
<tr class="memdesc:a80492499834e30e0109e1e4a69efee29"><td class="mdescLeft"> </td><td class="mdescRight">A memory barrier. <a href="#a80492499834e30e0109e1e4a69efee29">More...</a><br /></td></tr>
<tr class="separator:a80492499834e30e0109e1e4a69efee29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff336cfe214604ffdd1075d94a11f8c5"><td class="memItemLeft" align="right" valign="top"><a id="aff336cfe214604ffdd1075d94a11f8c5"></a>
#define </td><td class="memItemRight" valign="bottom"><b>RETURN_IF_NONZERO</b>(x)   size_t returnedValue = x; if (returnedValue) return returnedValue</td></tr>
<tr class="separator:aff336cfe214604ffdd1075d94a11f8c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb5d495902796a542084124233281265"><td class="memItemLeft" align="right" valign="top"><a id="afb5d495902796a542084124233281265"></a>
#define </td><td class="memItemRight" valign="bottom"><b>GETBYTE</b>(x, y)   (unsigned int)byte((x)>>(8*(y)))</td></tr>
<tr class="separator:afb5d495902796a542084124233281265"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb110e20bd83872104cf1b5a0d19ff1e"><td class="memItemLeft" align="right" valign="top"><a id="afb110e20bd83872104cf1b5a0d19ff1e"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_GET_BYTE_AS_BYTE</b>(x, y)   byte((x)>>(8*(y)))</td></tr>
<tr class="separator:afb110e20bd83872104cf1b5a0d19ff1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab44245f76e0fc08ab8ba76771ef3d9f5"><td class="memItemLeft" align="right" valign="top"><a id="ab44245f76e0fc08ab8ba76771ef3d9f5"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_1</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+0);} size_t SS1() {return sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:ab44245f76e0fc08ab8ba76771ef3d9f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca956e0abd7368e25cebeb9513616eca"><td class="memItemLeft" align="right" valign="top"><a id="aca956e0abd7368e25cebeb9513616eca"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_2</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+SS1());} size_t SS2() {return SS1()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:aca956e0abd7368e25cebeb9513616eca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48a4e24d34c37d65a379bd06a4bf12d2"><td class="memItemLeft" align="right" valign="top"><a id="a48a4e24d34c37d65a379bd06a4bf12d2"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_3</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+SS2());} size_t SS3() {return SS2()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:a48a4e24d34c37d65a379bd06a4bf12d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e8366a854dd78fbaba4da6ace69b3b4"><td class="memItemLeft" align="right" valign="top"><a id="a5e8366a854dd78fbaba4da6ace69b3b4"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_4</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+SS3());} size_t SS4() {return SS3()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:a5e8366a854dd78fbaba4da6ace69b3b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d00455e80e440dde3572996227bf0f0"><td class="memItemLeft" align="right" valign="top"><a id="a3d00455e80e440dde3572996227bf0f0"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_5</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+SS4());} size_t SS5() {return SS4()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:a3d00455e80e440dde3572996227bf0f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11940604e7e44c16170ab0bc89e4e8f6"><td class="memItemLeft" align="right" valign="top"><a id="a11940604e7e44c16170ab0bc89e4e8f6"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_6</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+SS5());} size_t SS6() {return SS5()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:a11940604e7e44c16170ab0bc89e4e8f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fee2fd43faebed6eac61f1f3d8bc423"><td class="memItemLeft" align="right" valign="top"><a id="a4fee2fd43faebed6eac61f1f3d8bc423"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_7</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+SS6());} size_t SS7() {return SS6()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:a4fee2fd43faebed6eac61f1f3d8bc423"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ac56e108366ccfa9c5ecf923b52e936"><td class="memItemLeft" align="right" valign="top"><a id="a4ac56e108366ccfa9c5ecf923b52e936"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCK_8</b>(n, t, s)   t* m_##n() {return (t *)(void *)(m_aggregate+SS7());} size_t SS8() {return SS7()+sizeof(t)*(s);} size_t m_##n##Size() {return (s);}</td></tr>
<tr class="separator:a4ac56e108366ccfa9c5ecf923b52e936"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade27627ae9dfbc2bee30153a513e229c"><td class="memItemLeft" align="right" valign="top"><a id="ade27627ae9dfbc2bee30153a513e229c"></a>
#define </td><td class="memItemRight" valign="bottom"><b>CRYPTOPP_BLOCKS_END</b>(i)   size_t SST() {return SS##i();} void AllocateBlocks() {m_aggregate.New(SST());} <a class="el" href="class_aligned_sec_byte_block.html">AlignedSecByteBlock</a> m_aggregate;</td></tr>
<tr class="separator:ade27627ae9dfbc2bee30153a513e229c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a108a15557c06bfa449e87879f283a268"><td class="memItemLeft" align="right" valign="top"><a id="a108a15557c06bfa449e87879f283a268"></a>
typedef <a class="el" href="cryptlib_8h.html#ad00625e1e5e96656feaf83fd53c1ab4e">LittleEndian</a> </td><td class="memItemRight" valign="bottom"><b>NativeByteOrder</b></td></tr>
<tr class="separator:a108a15557c06bfa449e87879f283a268"><td class="memSeparator" colspan="2"> </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:a5f6fcbaaf6f72fe46a6d911b033dfea0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a5f6fcbaaf6f72fe46a6d911b033dfea0">memcpy_s</a> (void *dest, size_t sizeInBytes, const void *src, size_t count)</td></tr>
<tr class="memdesc:a5f6fcbaaf6f72fe46a6d911b033dfea0"><td class="mdescLeft"> </td><td class="mdescRight">Bounds checking replacement for memcpy() <a href="#a5f6fcbaaf6f72fe46a6d911b033dfea0">More...</a><br /></td></tr>
<tr class="separator:a5f6fcbaaf6f72fe46a6d911b033dfea0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb296eab4ca31ab5c0cf4a932488a8de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#adb296eab4ca31ab5c0cf4a932488a8de">memmove_s</a> (void *dest, size_t sizeInBytes, const void *src, size_t count)</td></tr>
<tr class="memdesc:adb296eab4ca31ab5c0cf4a932488a8de"><td class="mdescLeft"> </td><td class="mdescRight">Bounds checking replacement for memmove() <a href="#adb296eab4ca31ab5c0cf4a932488a8de">More...</a><br /></td></tr>
<tr class="separator:adb296eab4ca31ab5c0cf4a932488a8de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a810542d642def73fd278c08092417e11"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a810542d642def73fd278c08092417e11"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a810542d642def73fd278c08092417e11">vec_swap</a> (T &a, T &b)</td></tr>
<tr class="memdesc:a810542d642def73fd278c08092417e11"><td class="mdescLeft"> </td><td class="mdescRight">Swaps two variables which are arrays. <a href="#a810542d642def73fd278c08092417e11">More...</a><br /></td></tr>
<tr class="separator:a810542d642def73fd278c08092417e11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8804f66768d757773489cde7738df1e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#ab8804f66768d757773489cde7738df1e">memset_z</a> (void *ptr, int value, size_t num)</td></tr>
<tr class="memdesc:ab8804f66768d757773489cde7738df1e"><td class="mdescLeft"> </td><td class="mdescRight">Memory block initializer and eraser that attempts to survive optimizations. <a href="#ab8804f66768d757773489cde7738df1e">More...</a><br /></td></tr>
<tr class="separator:ab8804f66768d757773489cde7738df1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe412b0409249cb54899e97bc7d86424"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:abe412b0409249cb54899e97bc7d86424"><td class="memTemplItemLeft" align="right" valign="top">const T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#abe412b0409249cb54899e97bc7d86424">STDMIN</a> (const T &a, const T &b)</td></tr>
<tr class="memdesc:abe412b0409249cb54899e97bc7d86424"><td class="mdescLeft"> </td><td class="mdescRight">Replacement function for std::min. <a href="#abe412b0409249cb54899e97bc7d86424">More...</a><br /></td></tr>
<tr class="separator:abe412b0409249cb54899e97bc7d86424"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1490597cb11989e78d5ba5b5f21266b"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:af1490597cb11989e78d5ba5b5f21266b"><td class="memTemplItemLeft" align="right" valign="top">const T & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#af1490597cb11989e78d5ba5b5f21266b">STDMAX</a> (const T &a, const T &b)</td></tr>
<tr class="memdesc:af1490597cb11989e78d5ba5b5f21266b"><td class="mdescLeft"> </td><td class="mdescRight">Replacement function for std::max. <a href="#af1490597cb11989e78d5ba5b5f21266b">More...</a><br /></td></tr>
<tr class="separator:af1490597cb11989e78d5ba5b5f21266b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8391e7d9d613a6c401787d2cdab1f51"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr>
<tr class="memitem:ac8391e7d9d613a6c401787d2cdab1f51"><td class="memTemplItemLeft" align="right" valign="top">const T1 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ac8391e7d9d613a6c401787d2cdab1f51">UnsignedMin</a> (const T1 &a, const T2 &b)</td></tr>
<tr class="memdesc:ac8391e7d9d613a6c401787d2cdab1f51"><td class="mdescLeft"> </td><td class="mdescRight">Safe comparison of values that could be neagtive and incorrectly promoted. <a href="#ac8391e7d9d613a6c401787d2cdab1f51">More...</a><br /></td></tr>
<tr class="separator:ac8391e7d9d613a6c401787d2cdab1f51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a2ce94589bb74164d809f4675bd23dd"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr>
<tr class="memitem:a8a2ce94589bb74164d809f4675bd23dd"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a8a2ce94589bb74164d809f4675bd23dd">SafeConvert</a> (T1 from, T2 &to)</td></tr>
<tr class="memdesc:a8a2ce94589bb74164d809f4675bd23dd"><td class="mdescLeft"> </td><td class="mdescRight">Tests whether a conversion from -> to is safe to perform. <a href="#a8a2ce94589bb74164d809f4675bd23dd">More...</a><br /></td></tr>
<tr class="separator:a8a2ce94589bb74164d809f4675bd23dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cd7decd035cc4e144cd3d395e834106"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a6cd7decd035cc4e144cd3d395e834106"><td class="memTemplItemLeft" align="right" valign="top">std::string </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a> (T value, unsigned int base=10)</td></tr>
<tr class="memdesc:a6cd7decd035cc4e144cd3d395e834106"><td class="mdescLeft"> </td><td class="mdescRight">Converts a value to a string. <a href="#a6cd7decd035cc4e144cd3d395e834106">More...</a><br /></td></tr>
<tr class="separator:a6cd7decd035cc4e144cd3d395e834106"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a8d39a883e1358d7d0195f7710be901"><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr class="memitem:a2a8d39a883e1358d7d0195f7710be901"><td class="memTemplItemLeft" align="right" valign="top">std::string </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a2a8d39a883e1358d7d0195f7710be901">IntToString< word64 ></a> (word64 value, unsigned int base)</td></tr>
<tr class="memdesc:a2a8d39a883e1358d7d0195f7710be901"><td class="mdescLeft"> </td><td class="mdescRight">Converts an unsigned value to a string. <a href="#a2a8d39a883e1358d7d0195f7710be901">More...</a><br /></td></tr>
<tr class="separator:a2a8d39a883e1358d7d0195f7710be901"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e4b1386ea739d43e280e5601045315b"><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr class="memitem:a2e4b1386ea739d43e280e5601045315b"><td class="memTemplItemLeft" align="right" valign="top">std::string </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a2e4b1386ea739d43e280e5601045315b">IntToString< Integer ></a> (<a class="el" href="class_integer.html">Integer</a> value, unsigned int base)</td></tr>
<tr class="memdesc:a2e4b1386ea739d43e280e5601045315b"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="class_integer.html" title="Multiple precision integer with arithmetic operations.">Integer</a> to a string. <a href="#a2e4b1386ea739d43e280e5601045315b">More...</a><br /></td></tr>
<tr class="separator:a2e4b1386ea739d43e280e5601045315b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c63a5683602db0ff8975746a414797f"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a6c63a5683602db0ff8975746a414797f"><td class="memTemplItemLeft" align="right" valign="top">unsigned int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a6c63a5683602db0ff8975746a414797f">Parity</a> (T value)</td></tr>
<tr class="memdesc:a6c63a5683602db0ff8975746a414797f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parity of a value. <a href="#a6c63a5683602db0ff8975746a414797f">More...</a><br /></td></tr>
<tr class="separator:a6c63a5683602db0ff8975746a414797f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e22fbd4b8f95aa01bde93ea32e44e82"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a3e22fbd4b8f95aa01bde93ea32e44e82"><td class="memTemplItemLeft" align="right" valign="top">unsigned int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a3e22fbd4b8f95aa01bde93ea32e44e82">BytePrecision</a> (const T &value)</td></tr>
<tr class="memdesc:a3e22fbd4b8f95aa01bde93ea32e44e82"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of 8-bit bytes or octets required for a value. <a href="#a3e22fbd4b8f95aa01bde93ea32e44e82">More...</a><br /></td></tr>
<tr class="separator:a3e22fbd4b8f95aa01bde93ea32e44e82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c5964768bc94670ad2bc3f218d9367f"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a3c5964768bc94670ad2bc3f218d9367f"><td class="memTemplItemLeft" align="right" valign="top">unsigned int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a3c5964768bc94670ad2bc3f218d9367f">BitPrecision</a> (const T &value)</td></tr>
<tr class="memdesc:a3c5964768bc94670ad2bc3f218d9367f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bits required for a value. <a href="#a3c5964768bc94670ad2bc3f218d9367f">More...</a><br /></td></tr>
<tr class="separator:a3c5964768bc94670ad2bc3f218d9367f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a495acbd6f3cdabbb4dd863c09b378df4"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a495acbd6f3cdabbb4dd863c09b378df4">TrailingZeros</a> (word32 v)</td></tr>
<tr class="memdesc:a495acbd6f3cdabbb4dd863c09b378df4"><td class="mdescLeft"> </td><td class="mdescRight">Determines the number of trailing 0-bits in a value. <a href="#a495acbd6f3cdabbb4dd863c09b378df4">More...</a><br /></td></tr>
<tr class="separator:a495acbd6f3cdabbb4dd863c09b378df4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:addb4df9b2f1e119d89a1573338c4eda6"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#addb4df9b2f1e119d89a1573338c4eda6">TrailingZeros</a> (word64 v)</td></tr>
<tr class="memdesc:addb4df9b2f1e119d89a1573338c4eda6"><td class="mdescLeft"> </td><td class="mdescRight">Determines the number of trailing 0-bits in a value. <a href="#addb4df9b2f1e119d89a1573338c4eda6">More...</a><br /></td></tr>
<tr class="separator:addb4df9b2f1e119d89a1573338c4eda6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a616a7f0365c4947b0c8a44606c525a62"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a616a7f0365c4947b0c8a44606c525a62"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a616a7f0365c4947b0c8a44606c525a62">Crop</a> (T value, size_t bits)</td></tr>
<tr class="memdesc:a616a7f0365c4947b0c8a44606c525a62"><td class="mdescLeft"> </td><td class="mdescRight">Truncates the value to the specified number of bits. <a href="#a616a7f0365c4947b0c8a44606c525a62">More...</a><br /></td></tr>
<tr class="separator:a616a7f0365c4947b0c8a44606c525a62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c5d30b17c9d4869fdc3458dd05c500d"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a7c5d30b17c9d4869fdc3458dd05c500d">BitsToBytes</a> (size_t bitCount)</td></tr>
<tr class="memdesc:a7c5d30b17c9d4869fdc3458dd05c500d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of 8-bit bytes or octets required for the specified number of bits. <a href="#a7c5d30b17c9d4869fdc3458dd05c500d">More...</a><br /></td></tr>
<tr class="separator:a7c5d30b17c9d4869fdc3458dd05c500d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a886cc7ce76578c6df939f564f676e71a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a886cc7ce76578c6df939f564f676e71a">BytesToWords</a> (size_t byteCount)</td></tr>
<tr class="memdesc:a886cc7ce76578c6df939f564f676e71a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of words required for the specified number of bytes. <a href="#a886cc7ce76578c6df939f564f676e71a">More...</a><br /></td></tr>
<tr class="separator:a886cc7ce76578c6df939f564f676e71a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45c56601a8c94b6a37a21657929fe928"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a45c56601a8c94b6a37a21657929fe928">BitsToWords</a> (size_t bitCount)</td></tr>
<tr class="memdesc:a45c56601a8c94b6a37a21657929fe928"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of words required for the specified number of bits. <a href="#a45c56601a8c94b6a37a21657929fe928">More...</a><br /></td></tr>
<tr class="separator:a45c56601a8c94b6a37a21657929fe928"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a778d13f3d45915e1bc5c0ab1801ea6ad"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a778d13f3d45915e1bc5c0ab1801ea6ad">BitsToDwords</a> (size_t bitCount)</td></tr>
<tr class="memdesc:a778d13f3d45915e1bc5c0ab1801ea6ad"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of double words required for the specified number of bits. <a href="#a778d13f3d45915e1bc5c0ab1801ea6ad">More...</a><br /></td></tr>
<tr class="separator:a778d13f3d45915e1bc5c0ab1801ea6ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6aaae7768600b9d735a5e1b8192035f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a6aaae7768600b9d735a5e1b8192035f8">xorbuf</a> (byte *buf, const byte *mask, size_t count)</td></tr>
<tr class="memdesc:a6aaae7768600b9d735a5e1b8192035f8"><td class="mdescLeft"> </td><td class="mdescRight">Performs an XOR of a buffer with a mask. <a href="#a6aaae7768600b9d735a5e1b8192035f8">More...</a><br /></td></tr>
<tr class="separator:a6aaae7768600b9d735a5e1b8192035f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22041a75d170772ab003b9b238327c9b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a22041a75d170772ab003b9b238327c9b">xorbuf</a> (byte *output, const byte *input, const byte *mask, size_t count)</td></tr>
<tr class="memdesc:a22041a75d170772ab003b9b238327c9b"><td class="mdescLeft"> </td><td class="mdescRight">Performs an XOR of an input buffer with a mask and stores the result in an output buffer. <a href="#a22041a75d170772ab003b9b238327c9b">More...</a><br /></td></tr>
<tr class="separator:a22041a75d170772ab003b9b238327c9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e14b85d64aa63e5ba80471716837c74"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a8e14b85d64aa63e5ba80471716837c74">VerifyBufsEqual</a> (const byte *buf1, const byte *buf2, size_t count)</td></tr>
<tr class="memdesc:a8e14b85d64aa63e5ba80471716837c74"><td class="mdescLeft"> </td><td class="mdescRight">Performs a near constant-time comparison of two equally sized buffers. <a href="#a8e14b85d64aa63e5ba80471716837c74">More...</a><br /></td></tr>
<tr class="separator:a8e14b85d64aa63e5ba80471716837c74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65531618a7eca8803fa9e9287c43aafc"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a65531618a7eca8803fa9e9287c43aafc"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a65531618a7eca8803fa9e9287c43aafc">IsPowerOf2</a> (const T &value)</td></tr>
<tr class="memdesc:a65531618a7eca8803fa9e9287c43aafc"><td class="mdescLeft"> </td><td class="mdescRight">Tests whether a value is a power of 2. <a href="#a65531618a7eca8803fa9e9287c43aafc">More...</a><br /></td></tr>
<tr class="separator:a65531618a7eca8803fa9e9287c43aafc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30712a90999ad9d9152975f2e92d46b8"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr>
<tr class="memitem:a30712a90999ad9d9152975f2e92d46b8"><td class="memTemplItemLeft" align="right" valign="top">T1 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a30712a90999ad9d9152975f2e92d46b8">SaturatingSubtract</a> (const T1 &a, const T2 &b)</td></tr>
<tr class="memdesc:a30712a90999ad9d9152975f2e92d46b8"><td class="mdescLeft"> </td><td class="mdescRight">Performs a saturating subtract clamped at 0. <a href="#a30712a90999ad9d9152975f2e92d46b8">More...</a><br /></td></tr>
<tr class="separator:a30712a90999ad9d9152975f2e92d46b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd39d67faef904dbb474981762b7ebe1"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr>
<tr class="memitem:afd39d67faef904dbb474981762b7ebe1"><td class="memTemplItemLeft" align="right" valign="top">T1 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#afd39d67faef904dbb474981762b7ebe1">SaturatingSubtract1</a> (const T1 &a, const T2 &b)</td></tr>
<tr class="memdesc:afd39d67faef904dbb474981762b7ebe1"><td class="mdescLeft"> </td><td class="mdescRight">Performs a saturating subtract clamped at 1. <a href="#afd39d67faef904dbb474981762b7ebe1">More...</a><br /></td></tr>
<tr class="separator:afd39d67faef904dbb474981762b7ebe1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a621695f6346d6a745e340513d917b31a"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr>
<tr class="memitem:a621695f6346d6a745e340513d917b31a"><td class="memTemplItemLeft" align="right" valign="top">T2 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a621695f6346d6a745e340513d917b31a">ModPowerOf2</a> (const T1 &a, const T2 &b)</td></tr>
<tr class="memdesc:a621695f6346d6a745e340513d917b31a"><td class="mdescLeft"> </td><td class="mdescRight">Reduces a value to a power of 2. <a href="#a621695f6346d6a745e340513d917b31a">More...</a><br /></td></tr>
<tr class="separator:a621695f6346d6a745e340513d917b31a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2ac57210cb6796eced074e6d2e294fb"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr>
<tr class="memitem:aa2ac57210cb6796eced074e6d2e294fb"><td class="memTemplItemLeft" align="right" valign="top">T1 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#aa2ac57210cb6796eced074e6d2e294fb">RoundDownToMultipleOf</a> (const T1 &n, const T2 &m)</td></tr>
<tr class="memdesc:aa2ac57210cb6796eced074e6d2e294fb"><td class="mdescLeft"> </td><td class="mdescRight">Rounds a value down to a multiple of a second value. <a href="#aa2ac57210cb6796eced074e6d2e294fb">More...</a><br /></td></tr>
<tr class="separator:aa2ac57210cb6796eced074e6d2e294fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57a219d44f45272a1f3b3f17a656000a"><td class="memTemplParams" colspan="2">template<class T1 , class T2 > </td></tr>
<tr class="memitem:a57a219d44f45272a1f3b3f17a656000a"><td class="memTemplItemLeft" align="right" valign="top">T1 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a57a219d44f45272a1f3b3f17a656000a">RoundUpToMultipleOf</a> (const T1 &n, const T2 &m)</td></tr>
<tr class="memdesc:a57a219d44f45272a1f3b3f17a656000a"><td class="mdescLeft"> </td><td class="mdescRight">Rounds a value up to a multiple of a second value. <a href="#a57a219d44f45272a1f3b3f17a656000a">More...</a><br /></td></tr>
<tr class="separator:a57a219d44f45272a1f3b3f17a656000a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4e438054095c88f0c4d9eda7efc584d"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ab4e438054095c88f0c4d9eda7efc584d"><td class="memTemplItemLeft" align="right" valign="top">unsigned int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ab4e438054095c88f0c4d9eda7efc584d">GetAlignmentOf</a> ()</td></tr>
<tr class="memdesc:ab4e438054095c88f0c4d9eda7efc584d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the minimum alignment requirements of a type. <a href="#ab4e438054095c88f0c4d9eda7efc584d">More...</a><br /></td></tr>
<tr class="separator:ab4e438054095c88f0c4d9eda7efc584d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a726c3b76265182681f5d5fd173ab5676"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a726c3b76265182681f5d5fd173ab5676">IsAlignedOn</a> (const void *ptr, unsigned int alignment)</td></tr>
<tr class="memdesc:a726c3b76265182681f5d5fd173ab5676"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether ptr is aligned to a minimum value. <a href="#a726c3b76265182681f5d5fd173ab5676">More...</a><br /></td></tr>
<tr class="separator:a726c3b76265182681f5d5fd173ab5676"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b2c95659d16a971941622625c9102ae"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a8b2c95659d16a971941622625c9102ae"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a8b2c95659d16a971941622625c9102ae">IsAligned</a> (const void *ptr)</td></tr>
<tr class="memdesc:a8b2c95659d16a971941622625c9102ae"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether ptr is minimally aligned. <a href="#a8b2c95659d16a971941622625c9102ae">More...</a><br /></td></tr>
<tr class="separator:a8b2c95659d16a971941622625c9102ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed8336b0d98f2469441837be6cbbebf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#aed8336b0d98f2469441837be6cbbebf9">GetNativeByteOrder</a> ()</td></tr>
<tr class="memdesc:aed8336b0d98f2469441837be6cbbebf9"><td class="mdescLeft"> </td><td class="mdescRight">Returns NativeByteOrder as an enumerated ByteOrder value. <a href="#aed8336b0d98f2469441837be6cbbebf9">More...</a><br /></td></tr>
<tr class="separator:aed8336b0d98f2469441837be6cbbebf9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c2da0dd866619761e63c3b5da58c477"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a6c2da0dd866619761e63c3b5da58c477">NativeByteOrderIs</a> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order)</td></tr>
<tr class="memdesc:a6c2da0dd866619761e63c3b5da58c477"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether order follows native byte ordering. <a href="#a6c2da0dd866619761e63c3b5da58c477">More...</a><br /></td></tr>
<tr class="separator:a6c2da0dd866619761e63c3b5da58c477"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade22f7ed542b3db2912c917f8e3d6067"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ade22f7ed542b3db2912c917f8e3d6067"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="cryptlib_8h.html#a353ccabf5ddc119a6a33e92f7b9961c7">CipherDir</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ade22f7ed542b3db2912c917f8e3d6067">GetCipherDir</a> (const T &obj)</td></tr>
<tr class="memdesc:ade22f7ed542b3db2912c917f8e3d6067"><td class="mdescLeft"> </td><td class="mdescRight">Returns the direction the cipher is being operated. <a href="#ade22f7ed542b3db2912c917f8e3d6067">More...</a><br /></td></tr>
<tr class="separator:ade22f7ed542b3db2912c917f8e3d6067"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71af89664aab380fe936b21db0a7dff7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a71af89664aab380fe936b21db0a7dff7">CallNewHandler</a> ()</td></tr>
<tr class="memdesc:a71af89664aab380fe936b21db0a7dff7"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to reclaim unused memory. <a href="#a71af89664aab380fe936b21db0a7dff7">More...</a><br /></td></tr>
<tr class="separator:a71af89664aab380fe936b21db0a7dff7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44fad9d8c25e8aca3a7ee29345516f0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a44fad9d8c25e8aca3a7ee29345516f0a">IncrementCounterByOne</a> (byte *inout, unsigned int size)</td></tr>
<tr class="memdesc:a44fad9d8c25e8aca3a7ee29345516f0a"><td class="mdescLeft"> </td><td class="mdescRight">Performs an addition with carry on a block of bytes. <a href="#a44fad9d8c25e8aca3a7ee29345516f0a">More...</a><br /></td></tr>
<tr class="separator:a44fad9d8c25e8aca3a7ee29345516f0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f852960b51e106a849781341cb2055c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a2f852960b51e106a849781341cb2055c">IncrementCounterByOne</a> (byte *output, const byte *input, unsigned int size)</td></tr>
<tr class="memdesc:a2f852960b51e106a849781341cb2055c"><td class="mdescLeft"> </td><td class="mdescRight">Performs an addition with carry on a block of bytes. <a href="#a2f852960b51e106a849781341cb2055c">More...</a><br /></td></tr>
<tr class="separator:a2f852960b51e106a849781341cb2055c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae71e5659910553da22f9b1e877cddc07"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ae71e5659910553da22f9b1e877cddc07"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ae71e5659910553da22f9b1e877cddc07">ConditionalSwap</a> (bool c, T &a, T &b)</td></tr>
<tr class="memdesc:ae71e5659910553da22f9b1e877cddc07"><td class="mdescLeft"> </td><td class="mdescRight">Performs a branchless swap of values a and b if condition c is true. <a href="#ae71e5659910553da22f9b1e877cddc07">More...</a><br /></td></tr>
<tr class="separator:ae71e5659910553da22f9b1e877cddc07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a513e4522b268f9ee2e188606c2101d5a"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a513e4522b268f9ee2e188606c2101d5a"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a513e4522b268f9ee2e188606c2101d5a">ConditionalSwapPointers</a> (bool c, T &a, T &b)</td></tr>
<tr class="memdesc:a513e4522b268f9ee2e188606c2101d5a"><td class="mdescLeft"> </td><td class="mdescRight">Performs a branchless swap of pointers a and b if condition c is true. <a href="#a513e4522b268f9ee2e188606c2101d5a">More...</a><br /></td></tr>
<tr class="separator:a513e4522b268f9ee2e188606c2101d5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a656f38b8d0440981f5f013ada782018c"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a656f38b8d0440981f5f013ada782018c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a656f38b8d0440981f5f013ada782018c">SecureWipeBuffer</a> (T *buf, size_t n)</td></tr>
<tr class="memdesc:a656f38b8d0440981f5f013ada782018c"><td class="mdescLeft"> </td><td class="mdescRight">Sets each element of an array to 0. <a href="#a656f38b8d0440981f5f013ada782018c">More...</a><br /></td></tr>
<tr class="separator:a656f38b8d0440981f5f013ada782018c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4994f3480634e5f1435fd71f9b652c38"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a4994f3480634e5f1435fd71f9b652c38"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a4994f3480634e5f1435fd71f9b652c38">SecureWipeArray</a> (T *buf, size_t n)</td></tr>
<tr class="memdesc:a4994f3480634e5f1435fd71f9b652c38"><td class="mdescLeft"> </td><td class="mdescRight">Sets each element of an array to 0. <a href="#a4994f3480634e5f1435fd71f9b652c38">More...</a><br /></td></tr>
<tr class="separator:a4994f3480634e5f1435fd71f9b652c38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba2ed56f8a15d6dabbef74390eda4352"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#aba2ed56f8a15d6dabbef74390eda4352">StringNarrow</a> (const wchar_t *str, bool throwOnError=true)</td></tr>
<tr class="memdesc:aba2ed56f8a15d6dabbef74390eda4352"><td class="mdescLeft"> </td><td class="mdescRight">Converts a wide character C-string to a multibyte string. <a href="#aba2ed56f8a15d6dabbef74390eda4352">More...</a><br /></td></tr>
<tr class="separator:aba2ed56f8a15d6dabbef74390eda4352"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac95ff706a83782e3d18a3d14817db932"><td class="memItemLeft" align="right" valign="top">std::wstring </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#ac95ff706a83782e3d18a3d14817db932">StringWiden</a> (const char *str, bool throwOnError=true)</td></tr>
<tr class="memdesc:ac95ff706a83782e3d18a3d14817db932"><td class="mdescLeft"> </td><td class="mdescRight">Converts a multibyte C-string to a wide character string. <a href="#ac95ff706a83782e3d18a3d14817db932">More...</a><br /></td></tr>
<tr class="separator:ac95ff706a83782e3d18a3d14817db932"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c6a1835a713cab0c3ac3fb3b6051f53"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a0c6a1835a713cab0c3ac3fb3b6051f53">AlignedAllocate</a> (size_t size)</td></tr>
<tr class="memdesc:a0c6a1835a713cab0c3ac3fb3b6051f53"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a buffer on 16-byte boundary. <a href="#a0c6a1835a713cab0c3ac3fb3b6051f53">More...</a><br /></td></tr>
<tr class="separator:a0c6a1835a713cab0c3ac3fb3b6051f53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa355b22ae65ea94af7c7a567b266974d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#aa355b22ae65ea94af7c7a567b266974d">AlignedDeallocate</a> (void *ptr)</td></tr>
<tr class="memdesc:aa355b22ae65ea94af7c7a567b266974d"><td class="mdescLeft"> </td><td class="mdescRight">Frees a buffer allocated with AlignedAllocate. <a href="#aa355b22ae65ea94af7c7a567b266974d">More...</a><br /></td></tr>
<tr class="separator:aa355b22ae65ea94af7c7a567b266974d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1035c615a0c101227ac6f75c8bc519ed"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a1035c615a0c101227ac6f75c8bc519ed">UnalignedAllocate</a> (size_t size)</td></tr>
<tr class="memdesc:a1035c615a0c101227ac6f75c8bc519ed"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a buffer. <a href="#a1035c615a0c101227ac6f75c8bc519ed">More...</a><br /></td></tr>
<tr class="separator:a1035c615a0c101227ac6f75c8bc519ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83d3eab0253c5e95a89a58a45f49142c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a83d3eab0253c5e95a89a58a45f49142c">UnalignedDeallocate</a> (void *ptr)</td></tr>
<tr class="memdesc:a83d3eab0253c5e95a89a58a45f49142c"><td class="mdescLeft"> </td><td class="mdescRight">Frees a buffer allocated with UnalignedAllocate. <a href="#a83d3eab0253c5e95a89a58a45f49142c">More...</a><br /></td></tr>
<tr class="separator:a83d3eab0253c5e95a89a58a45f49142c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ab6928faa40f6e56e7f4817d5d65a38"><td class="memTemplParams" colspan="2">template<unsigned int R, class T > </td></tr>
<tr class="memitem:a0ab6928faa40f6e56e7f4817d5d65a38"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38">rotlConstant</a> (T x)</td></tr>
<tr class="memdesc:a0ab6928faa40f6e56e7f4817d5d65a38"><td class="mdescLeft"> </td><td class="mdescRight">Performs a left rotate. <a href="#a0ab6928faa40f6e56e7f4817d5d65a38">More...</a><br /></td></tr>
<tr class="separator:a0ab6928faa40f6e56e7f4817d5d65a38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d777068849add4c7ab87f7b0683ef65"><td class="memTemplParams" colspan="2">template<unsigned int R, class T > </td></tr>
<tr class="memitem:a7d777068849add4c7ab87f7b0683ef65"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65">rotrConstant</a> (T x)</td></tr>
<tr class="memdesc:a7d777068849add4c7ab87f7b0683ef65"><td class="mdescLeft"> </td><td class="mdescRight">Performs a right rotate. <a href="#a7d777068849add4c7ab87f7b0683ef65">More...</a><br /></td></tr>
<tr class="separator:a7d777068849add4c7ab87f7b0683ef65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf7b80a08d25ab9d62693c9e4798ef98"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:aaf7b80a08d25ab9d62693c9e4798ef98"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98">rotlFixed</a> (T x, unsigned int y)</td></tr>
<tr class="memdesc:aaf7b80a08d25ab9d62693c9e4798ef98"><td class="mdescLeft"> </td><td class="mdescRight">Performs a left rotate. <a href="#aaf7b80a08d25ab9d62693c9e4798ef98">More...</a><br /></td></tr>
<tr class="separator:aaf7b80a08d25ab9d62693c9e4798ef98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf88e95400925b89c94641916535b6da"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:abf88e95400925b89c94641916535b6da"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da">rotrFixed</a> (T x, unsigned int y)</td></tr>
<tr class="memdesc:abf88e95400925b89c94641916535b6da"><td class="mdescLeft"> </td><td class="mdescRight">Performs a right rotate. <a href="#abf88e95400925b89c94641916535b6da">More...</a><br /></td></tr>
<tr class="separator:abf88e95400925b89c94641916535b6da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0de05253683b27a221e6465b3a7453b2"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a0de05253683b27a221e6465b3a7453b2"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2">rotlVariable</a> (T x, unsigned int y)</td></tr>
<tr class="memdesc:a0de05253683b27a221e6465b3a7453b2"><td class="mdescLeft"> </td><td class="mdescRight">Performs a left rotate. <a href="#a0de05253683b27a221e6465b3a7453b2">More...</a><br /></td></tr>
<tr class="separator:a0de05253683b27a221e6465b3a7453b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd053d245fe902fe55bfd8a335634110"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:abd053d245fe902fe55bfd8a335634110"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110">rotrVariable</a> (T x, unsigned int y)</td></tr>
<tr class="memdesc:abd053d245fe902fe55bfd8a335634110"><td class="mdescLeft"> </td><td class="mdescRight">Performs a right rotate. <a href="#abd053d245fe902fe55bfd8a335634110">More...</a><br /></td></tr>
<tr class="separator:abd053d245fe902fe55bfd8a335634110"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad31fe5d559d014085c6a49594b817196"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ad31fe5d559d014085c6a49594b817196"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ad31fe5d559d014085c6a49594b817196">rotlMod</a> (T x, unsigned int y)</td></tr>
<tr class="memdesc:ad31fe5d559d014085c6a49594b817196"><td class="mdescLeft"> </td><td class="mdescRight">Performs a left rotate. <a href="#ad31fe5d559d014085c6a49594b817196">More...</a><br /></td></tr>
<tr class="separator:ad31fe5d559d014085c6a49594b817196"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8fc34eb834dd2424407d5e4d729594e"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ae8fc34eb834dd2424407d5e4d729594e"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ae8fc34eb834dd2424407d5e4d729594e">rotrMod</a> (T x, unsigned int y)</td></tr>
<tr class="memdesc:ae8fc34eb834dd2424407d5e4d729594e"><td class="mdescLeft"> </td><td class="mdescRight">Performs a right rotate. <a href="#ae8fc34eb834dd2424407d5e4d729594e">More...</a><br /></td></tr>
<tr class="separator:ae8fc34eb834dd2424407d5e4d729594e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a2ceb73851e757cb436cdbaa0242219"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a9a2ceb73851e757cb436cdbaa0242219"><td class="memTemplItemLeft" align="right" valign="top">unsigned int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a9a2ceb73851e757cb436cdbaa0242219">GetByte</a> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, T value, unsigned int index)</td></tr>
<tr class="memdesc:a9a2ceb73851e757cb436cdbaa0242219"><td class="mdescLeft"> </td><td class="mdescRight">Gets a byte from a value. <a href="#a9a2ceb73851e757cb436cdbaa0242219">More...</a><br /></td></tr>
<tr class="separator:a9a2ceb73851e757cb436cdbaa0242219"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d8d5adca8384ebedc699760ce217b08"><td class="memItemLeft" align="right" valign="top">byte </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a1d8d5adca8384ebedc699760ce217b08">ByteReverse</a> (byte value)</td></tr>
<tr class="memdesc:a1d8d5adca8384ebedc699760ce217b08"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bytes in a 8-bit value. <a href="#a1d8d5adca8384ebedc699760ce217b08">More...</a><br /></td></tr>
<tr class="separator:a1d8d5adca8384ebedc699760ce217b08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa179e009cf5c74bb431b3c112d7ee444"><td class="memItemLeft" align="right" valign="top">word16 </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#aa179e009cf5c74bb431b3c112d7ee444">ByteReverse</a> (word16 value)</td></tr>
<tr class="memdesc:aa179e009cf5c74bb431b3c112d7ee444"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bytes in a 16-bit value. <a href="#aa179e009cf5c74bb431b3c112d7ee444">More...</a><br /></td></tr>
<tr class="separator:aa179e009cf5c74bb431b3c112d7ee444"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf65f4a9edb6224d01e900aa7205a4f4"><td class="memItemLeft" align="right" valign="top">word32 </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#acf65f4a9edb6224d01e900aa7205a4f4">ByteReverse</a> (word32 value)</td></tr>
<tr class="memdesc:acf65f4a9edb6224d01e900aa7205a4f4"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bytes in a 32-bit value. <a href="#acf65f4a9edb6224d01e900aa7205a4f4">More...</a><br /></td></tr>
<tr class="separator:acf65f4a9edb6224d01e900aa7205a4f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47686f3b4957541a58a3b280d1a89d4c"><td class="memItemLeft" align="right" valign="top">word64 </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a47686f3b4957541a58a3b280d1a89d4c">ByteReverse</a> (word64 value)</td></tr>
<tr class="memdesc:a47686f3b4957541a58a3b280d1a89d4c"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bytes in a 64-bit value. <a href="#a47686f3b4957541a58a3b280d1a89d4c">More...</a><br /></td></tr>
<tr class="separator:a47686f3b4957541a58a3b280d1a89d4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1746e70bf831f0cbf8ad73d8c15bc921"><td class="memItemLeft" align="right" valign="top">byte </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a1746e70bf831f0cbf8ad73d8c15bc921">BitReverse</a> (byte value)</td></tr>
<tr class="memdesc:a1746e70bf831f0cbf8ad73d8c15bc921"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bits in a 8-bit value. <a href="#a1746e70bf831f0cbf8ad73d8c15bc921">More...</a><br /></td></tr>
<tr class="separator:a1746e70bf831f0cbf8ad73d8c15bc921"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a699c24d7013f20ee03076576984c875e"><td class="memItemLeft" align="right" valign="top">word16 </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a699c24d7013f20ee03076576984c875e">BitReverse</a> (word16 value)</td></tr>
<tr class="memdesc:a699c24d7013f20ee03076576984c875e"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bits in a 16-bit value. <a href="#a699c24d7013f20ee03076576984c875e">More...</a><br /></td></tr>
<tr class="separator:a699c24d7013f20ee03076576984c875e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad87ebeafa7de2c11c19453f3b3cfea7"><td class="memItemLeft" align="right" valign="top">word32 </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#aad87ebeafa7de2c11c19453f3b3cfea7">BitReverse</a> (word32 value)</td></tr>
<tr class="memdesc:aad87ebeafa7de2c11c19453f3b3cfea7"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bits in a 32-bit value. <a href="#aad87ebeafa7de2c11c19453f3b3cfea7">More...</a><br /></td></tr>
<tr class="separator:aad87ebeafa7de2c11c19453f3b3cfea7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a336c0289dcd2670e6b4079fa98018d7a"><td class="memItemLeft" align="right" valign="top">word64 </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a336c0289dcd2670e6b4079fa98018d7a">BitReverse</a> (word64 value)</td></tr>
<tr class="memdesc:a336c0289dcd2670e6b4079fa98018d7a"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bits in a 64-bit value. <a href="#a336c0289dcd2670e6b4079fa98018d7a">More...</a><br /></td></tr>
<tr class="separator:a336c0289dcd2670e6b4079fa98018d7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a641ecc1d620ac8c04bc43661a2bbba71"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a641ecc1d620ac8c04bc43661a2bbba71"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a641ecc1d620ac8c04bc43661a2bbba71">BitReverse</a> (T value)</td></tr>
<tr class="memdesc:a641ecc1d620ac8c04bc43661a2bbba71"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bits in a value. <a href="#a641ecc1d620ac8c04bc43661a2bbba71">More...</a><br /></td></tr>
<tr class="separator:a641ecc1d620ac8c04bc43661a2bbba71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e499ded4f2e7e7705c3cfd39cdf137f"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a8e499ded4f2e7e7705c3cfd39cdf137f"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a8e499ded4f2e7e7705c3cfd39cdf137f">ConditionalByteReverse</a> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, T value)</td></tr>
<tr class="memdesc:a8e499ded4f2e7e7705c3cfd39cdf137f"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bytes in a value depending upon endianness. <a href="#a8e499ded4f2e7e7705c3cfd39cdf137f">More...</a><br /></td></tr>
<tr class="separator:a8e499ded4f2e7e7705c3cfd39cdf137f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab95e030e0abd33ea360d75cd9c4c8bbe"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:ab95e030e0abd33ea360d75cd9c4c8bbe"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ab95e030e0abd33ea360d75cd9c4c8bbe">ByteReverse</a> (T *out, const T *in, size_t byteCount)</td></tr>
<tr class="memdesc:ab95e030e0abd33ea360d75cd9c4c8bbe"><td class="mdescLeft"> </td><td class="mdescRight">Reverses bytes in an element from an array of elements. <a href="#ab95e030e0abd33ea360d75cd9c4c8bbe">More...</a><br /></td></tr>
<tr class="separator:ab95e030e0abd33ea360d75cd9c4c8bbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae0de65c1758668440f71a8ff6534ad9"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:aae0de65c1758668440f71a8ff6534ad9"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#aae0de65c1758668440f71a8ff6534ad9">ConditionalByteReverse</a> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, T *out, const T *in, size_t byteCount)</td></tr>
<tr class="memdesc:aae0de65c1758668440f71a8ff6534ad9"><td class="mdescLeft"> </td><td class="mdescRight">Conditionally reverses bytes in an element from an array of elements. <a href="#aae0de65c1758668440f71a8ff6534ad9">More...</a><br /></td></tr>
<tr class="separator:aae0de65c1758668440f71a8ff6534ad9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a929e347e6efedee4099dac8b3956350e"><td class="memTemplParams" colspan="2"><a id="a929e347e6efedee4099dac8b3956350e"></a>
template<class T > </td></tr>
<tr class="memitem:a929e347e6efedee4099dac8b3956350e"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>GetUserKey</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, T *out, size_t outlen, const byte *in, size_t inlen)</td></tr>
<tr class="separator:a929e347e6efedee4099dac8b3956350e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ee7b3ac15dde684911fb0358d72539b"><td class="memItemLeft" align="right" valign="top"><a id="a5ee7b3ac15dde684911fb0358d72539b"></a>
byte </td><td class="memItemRight" valign="bottom"><b>UnalignedGetWordNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, const byte *block, const byte *)</td></tr>
<tr class="separator:a5ee7b3ac15dde684911fb0358d72539b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeca0a65d7e2525ef590fa40323cd896a"><td class="memItemLeft" align="right" valign="top"><a id="aeca0a65d7e2525ef590fa40323cd896a"></a>
word16 </td><td class="memItemRight" valign="bottom"><b>UnalignedGetWordNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, const byte *block, const word16 *)</td></tr>
<tr class="separator:aeca0a65d7e2525ef590fa40323cd896a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba08e8808a65a1d19f383f700d9dd85d"><td class="memItemLeft" align="right" valign="top"><a id="aba08e8808a65a1d19f383f700d9dd85d"></a>
word32 </td><td class="memItemRight" valign="bottom"><b>UnalignedGetWordNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, const byte *block, const word32 *)</td></tr>
<tr class="separator:aba08e8808a65a1d19f383f700d9dd85d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad41371a8bd7ba794fc7d4fe58234f00"><td class="memItemLeft" align="right" valign="top"><a id="aad41371a8bd7ba794fc7d4fe58234f00"></a>
word64 </td><td class="memItemRight" valign="bottom"><b>UnalignedGetWordNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, const byte *block, const word64 *)</td></tr>
<tr class="separator:aad41371a8bd7ba794fc7d4fe58234f00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8184a77f9a4c8ffbda9622b1cee7a148"><td class="memItemLeft" align="right" valign="top"><a id="a8184a77f9a4c8ffbda9622b1cee7a148"></a>
void </td><td class="memItemRight" valign="bottom"><b>UnalignedbyteNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, byte *block, byte value, const byte *xorBlock)</td></tr>
<tr class="separator:a8184a77f9a4c8ffbda9622b1cee7a148"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac26b43699857ac54a8f4624c89bb6ab9"><td class="memItemLeft" align="right" valign="top"><a id="ac26b43699857ac54a8f4624c89bb6ab9"></a>
void </td><td class="memItemRight" valign="bottom"><b>UnalignedbyteNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, byte *block, word16 value, const byte *xorBlock)</td></tr>
<tr class="separator:ac26b43699857ac54a8f4624c89bb6ab9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef9d0bbf3f776108244b5c36ff5041d5"><td class="memItemLeft" align="right" valign="top"><a id="aef9d0bbf3f776108244b5c36ff5041d5"></a>
void </td><td class="memItemRight" valign="bottom"><b>UnalignedbyteNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, byte *block, word32 value, const byte *xorBlock)</td></tr>
<tr class="separator:aef9d0bbf3f776108244b5c36ff5041d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36bf3fa1752839aa454537cd2d3ca935"><td class="memItemLeft" align="right" valign="top"><a id="a36bf3fa1752839aa454537cd2d3ca935"></a>
void </td><td class="memItemRight" valign="bottom"><b>UnalignedbyteNonTemplate</b> (<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, byte *block, word64 value, const byte *xorBlock)</td></tr>
<tr class="separator:a36bf3fa1752839aa454537cd2d3ca935"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a240e8e97f964626508362b59b78532d3"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a240e8e97f964626508362b59b78532d3"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a240e8e97f964626508362b59b78532d3">GetWord</a> (bool assumeAligned, <a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, const byte *block)</td></tr>
<tr class="memdesc:a240e8e97f964626508362b59b78532d3"><td class="mdescLeft"> </td><td class="mdescRight">Access a block of memory. <a href="#a240e8e97f964626508362b59b78532d3">More...</a><br /></td></tr>
<tr class="separator:a240e8e97f964626508362b59b78532d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4546cdeeecddedd3a0f784ea6b80c8bd"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a4546cdeeecddedd3a0f784ea6b80c8bd"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a4546cdeeecddedd3a0f784ea6b80c8bd">GetWord</a> (bool assumeAligned, <a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, T &result, const byte *block)</td></tr>
<tr class="memdesc:a4546cdeeecddedd3a0f784ea6b80c8bd"><td class="mdescLeft"> </td><td class="mdescRight">Access a block of memory. <a href="#a4546cdeeecddedd3a0f784ea6b80c8bd">More...</a><br /></td></tr>
<tr class="separator:a4546cdeeecddedd3a0f784ea6b80c8bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef6a8d35198f71ff68811bacd599c664"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:aef6a8d35198f71ff68811bacd599c664"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#aef6a8d35198f71ff68811bacd599c664">PutWord</a> (bool assumeAligned, <a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order, byte *block, T value, const byte *xorBlock=NULL)</td></tr>
<tr class="memdesc:aef6a8d35198f71ff68811bacd599c664"><td class="mdescLeft"> </td><td class="mdescRight">Access a block of memory. <a href="#aef6a8d35198f71ff68811bacd599c664">More...</a><br /></td></tr>
<tr class="separator:aef6a8d35198f71ff68811bacd599c664"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18a35b59a1f2e23b94ed2f74f0594613"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a18a35b59a1f2e23b94ed2f74f0594613"><td class="memTemplItemLeft" align="right" valign="top">std::string </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a18a35b59a1f2e23b94ed2f74f0594613">WordToString</a> (T value, <a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order=<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142baf0c3bb6c718cc7ff0bffef4e8f178c57">BIG_ENDIAN_ORDER</a>)</td></tr>
<tr class="memdesc:a18a35b59a1f2e23b94ed2f74f0594613"><td class="mdescLeft"> </td><td class="mdescRight">Convert a word to a string. <a href="#a18a35b59a1f2e23b94ed2f74f0594613">More...</a><br /></td></tr>
<tr class="separator:a18a35b59a1f2e23b94ed2f74f0594613"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23234e96107b28512db9467c33f67590"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr class="memitem:a23234e96107b28512db9467c33f67590"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a23234e96107b28512db9467c33f67590">StringToWord</a> (const std::string &str, <a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order=<a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142baf0c3bb6c718cc7ff0bffef4e8f178c57">BIG_ENDIAN_ORDER</a>)</td></tr>
<tr class="memdesc:a23234e96107b28512db9467c33f67590"><td class="mdescLeft"> </td><td class="mdescRight">Convert a string to a word. <a href="#a23234e96107b28512db9467c33f67590">More...</a><br /></td></tr>
<tr class="separator:a23234e96107b28512db9467c33f67590"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abda5071e4c754b612b6a4c42be421312"><td class="memTemplParams" colspan="2">template<unsigned int bits, class T > </td></tr>
<tr class="memitem:abda5071e4c754b612b6a4c42be421312"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#abda5071e4c754b612b6a4c42be421312">SafeRightShift</a> (T value)</td></tr>
<tr class="memdesc:abda5071e4c754b612b6a4c42be421312"><td class="mdescLeft"> </td><td class="mdescRight">Safely right shift values when undefined behavior could occur. <a href="#abda5071e4c754b612b6a4c42be421312">More...</a><br /></td></tr>
<tr class="separator:abda5071e4c754b612b6a4c42be421312"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45e2662974095094e345b2bc2b30ee4c"><td class="memTemplParams" colspan="2">template<unsigned int bits, class T > </td></tr>
<tr class="memitem:a45e2662974095094e345b2bc2b30ee4c"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#a45e2662974095094e345b2bc2b30ee4c">SafeLeftShift</a> (T value)</td></tr>
<tr class="memdesc:a45e2662974095094e345b2bc2b30ee4c"><td class="mdescLeft"> </td><td class="mdescRight">Safely left shift values when undefined behavior could occur. <a href="#a45e2662974095094e345b2bc2b30ee4c">More...</a><br /></td></tr>
<tr class="separator:a45e2662974095094e345b2bc2b30ee4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab29e4cf4553b1ff9f884df223a2abd6a"><td class="memTemplParams" colspan="2">template<typename InputIt , typename T > </td></tr>
<tr class="memitem:ab29e4cf4553b1ff9f884df223a2abd6a"><td class="memTemplItemLeft" align="right" valign="top">InputIt </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="misc_8h.html#ab29e4cf4553b1ff9f884df223a2abd6a">FindIfNot</a> (InputIt first, InputIt last, const T &value)</td></tr>
<tr class="memdesc:ab29e4cf4553b1ff9f884df223a2abd6a"><td class="mdescLeft"> </td><td class="mdescRight">Finds first element not in a range. <a href="#ab29e4cf4553b1ff9f884df223a2abd6a">More...</a><br /></td></tr>
<tr class="separator:ab29e4cf4553b1ff9f884df223a2abd6a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Utility functions for the Crypto++ library. </p>
<p class="definition">Definition in file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a3c75bb398badb69c7577b21486f9963f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c75bb398badb69c7577b21486f9963f">◆ </a></span>SIZE_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SIZE_MAX   ...</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum value of a machine word. </p>
<p>SIZE_MAX provides the maximum value of a machine word. The value is 0xffffffff on 32-bit machines, and 0xffffffffffffffff on 64-bit machines. Internally, SIZE_MAX is defined as __SIZE_MAX__ if __SIZE_MAX__ is defined. If not defined, then SIZE_T_MAX is tried. If neither __SIZE_MAX__ nor SIZE_T_MAX is is defined, the library uses std::numeric_limits<size_t>::max(). The library prefers __SIZE_MAX__ because its a constexpr that is optimized well by all compilers. std::numeric_limits<size_t>::max() is not a constexpr, and it is not always optimized well. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00085">85</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a6b378b1b9b2d4654cc852c088742ba70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b378b1b9b2d4654cc852c088742ba70">◆ </a></span>CRYPTOPP_COMPILE_ASSERT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CRYPTOPP_COMPILE_ASSERT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">expr</td><td>)</td>
<td>   { ... }</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compile time assertion. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">expr</td><td>the expression to evaluate</td></tr>
</table>
</dd>
</dl>
<p>Asserts the expression expr though a dummy struct. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00144">144</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a2d7e4464ea73d6393ebe78f952253426"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d7e4464ea73d6393ebe78f952253426">◆ </a></span>COUNTOF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COUNTOF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">arr</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Counts elements in an array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arr</td><td>an array of elements</td></tr>
</table>
</dd>
</dl>
<p>COUNTOF counts elements in an array. On Windows <a class="el" href="misc_8h.html#a2d7e4464ea73d6393ebe78f952253426" title="Counts elements in an array.">COUNTOF(x)</a> is defined to <code>_countof(x)</code> to ensure correct results for pointers. </p><dl class="section note"><dt>Note</dt><dd>COUNTOF does not produce correct results with pointers, and an array must be used. <code>sizeof(x)/sizeof(x[0])</code> suffers the same problem. The risk is eliminated by using <code>_countof(x)</code> on Windows. Windows will provide the immunity for other platforms. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00181">181</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a80492499834e30e0109e1e4a69efee29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80492499834e30e0109e1e4a69efee29">◆ </a></span>MEMORY_BARRIER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MEMORY_BARRIER   ...</td>
</tr>
</table>
</div><div class="memdoc">
<p>A memory barrier. </p>
<p>MEMORY_BARRIER attempts to ensure reads and writes are completed in the absence of a language synchronization point. It is used by the <a class="el" href="class_singleton.html" title="Restricts the instantiation of a class to one static object without locks.">Singleton</a> class if the compiler supports it. The barrier is provided at the customary places in a double-checked initialization.</p>
<p>Internally, MEMORY_BARRIER uses <code>std::atomic_thread_fence</code> if C++11 atomics are available. Otherwise, <code>intrinsic(_ReadWriteBarrier)</code>, <code>_ReadWriteBarrier()</code> or <code>__asm__("" ::: "memory")</code> is used. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00255">255</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a5f6fcbaaf6f72fe46a6d911b033dfea0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f6fcbaaf6f72fe46a6d911b033dfea0">◆ </a></span>memcpy_s()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void memcpy_s </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>sizeInBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Bounds checking replacement for memcpy() </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>pointer to the desination memory block </td></tr>
<tr><td class="paramname">sizeInBytes</td><td>size of the desination memory block, in bytes </td></tr>
<tr><td class="paramname">src</td><td>pointer to the source memory block </td></tr>
<tr><td class="paramname">count</td><td>the number of bytes to copy </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument</a></td><td></td></tr>
</table>
</dd>
</dl>
<p>ISO/IEC TR-24772 provides bounds checking interfaces for potentially unsafe functions like memcpy(), strcpy() and memmove(). However, not all standard libraries provides them, like Glibc. The library's <a class="el" href="misc_8h.html#a5f6fcbaaf6f72fe46a6d911b033dfea0" title="Bounds checking replacement for memcpy()">memcpy_s()</a> is a near-drop in replacement. Its only a near-replacement because the library's version throws an <a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument</a> on a bounds violation.</p>
<p><a class="el" href="misc_8h.html#a5f6fcbaaf6f72fe46a6d911b033dfea0" title="Bounds checking replacement for memcpy()">memcpy_s()</a> and <a class="el" href="misc_8h.html#adb296eab4ca31ab5c0cf4a932488a8de" title="Bounds checking replacement for memmove()">memmove_s()</a> are guarded by __STDC_WANT_SECURE_LIB__. If __STDC_WANT_SECURE_LIB__ is not defined or defined to 0, then the library makes <a class="el" href="misc_8h.html#a5f6fcbaaf6f72fe46a6d911b033dfea0" title="Bounds checking replacement for memcpy()">memcpy_s()</a> and <a class="el" href="misc_8h.html#adb296eab4ca31ab5c0cf4a932488a8de" title="Bounds checking replacement for memmove()">memmove_s()</a> available. The library will also optionally make the symbols available if <code>CRYPTOPP_WANT_SECURE_LIB</code> is defined. <code>CRYPTOPP_WANT_SECURE_LIB</code> is in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a>, but it is disabled by default.</p>
<p><a class="el" href="misc_8h.html#a5f6fcbaaf6f72fe46a6d911b033dfea0" title="Bounds checking replacement for memcpy()">memcpy_s()</a> will assert the pointers src and dest are not NULL in debug builds. Passing NULL for either pointer is undefined behavior. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00383">383</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="adb296eab4ca31ab5c0cf4a932488a8de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb296eab4ca31ab5c0cf4a932488a8de">◆ </a></span>memmove_s()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void memmove_s </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>sizeInBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Bounds checking replacement for memmove() </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>pointer to the desination memory block </td></tr>
<tr><td class="paramname">sizeInBytes</td><td>size of the desination memory block, in bytes </td></tr>
<tr><td class="paramname">src</td><td>pointer to the source memory block </td></tr>
<tr><td class="paramname">count</td><td>the number of bytes to copy </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument</a></td><td></td></tr>
</table>
</dd>
</dl>
<p>ISO/IEC TR-24772 provides bounds checking interfaces for potentially unsafe functions like memcpy(), strcpy() and memmove(). However, not all standard libraries provides them, like Glibc. The library's <a class="el" href="misc_8h.html#adb296eab4ca31ab5c0cf4a932488a8de" title="Bounds checking replacement for memmove()">memmove_s()</a> is a near-drop in replacement. Its only a near-replacement because the library's version throws an <a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument</a> on a bounds violation.</p>
<p><a class="el" href="misc_8h.html#a5f6fcbaaf6f72fe46a6d911b033dfea0" title="Bounds checking replacement for memcpy()">memcpy_s()</a> and <a class="el" href="misc_8h.html#adb296eab4ca31ab5c0cf4a932488a8de" title="Bounds checking replacement for memmove()">memmove_s()</a> are guarded by __STDC_WANT_SECURE_LIB__. If __STDC_WANT_SECURE_LIB__ is not defined or defined to 0, then the library makes <a class="el" href="misc_8h.html#a5f6fcbaaf6f72fe46a6d911b033dfea0" title="Bounds checking replacement for memcpy()">memcpy_s()</a> and <a class="el" href="misc_8h.html#adb296eab4ca31ab5c0cf4a932488a8de" title="Bounds checking replacement for memmove()">memmove_s()</a> available. The library will also optionally make the symbols available if <code>CRYPTOPP_WANT_SECURE_LIB</code> is defined. <code>CRYPTOPP_WANT_SECURE_LIB</code> is in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a>, but it is disabled by default.</p>
<p><a class="el" href="misc_8h.html#adb296eab4ca31ab5c0cf4a932488a8de" title="Bounds checking replacement for memmove()">memmove_s()</a> will assert the pointers src and dest are not NULL in debug builds. Passing NULL for either pointer is undefined behavior. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00428">428</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a810542d642def73fd278c08092417e11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a810542d642def73fd278c08092417e11">◆ </a></span>vec_swap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void vec_swap </td>
<td>(</td>
<td class="paramtype">T & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Swaps two variables which are arrays. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the first value </td></tr>
<tr><td class="paramname">b</td><td>the second value</td></tr>
</table>
</dd>
</dl>
<p>C++03 does not provide support for <code>std::swap(__m128i a, __m128i b)</code> because <code>__m128i</code> is an <code>unsigned long long[2]</code>. Most compilers support it out of the box, but Sun Studio C++ compilers 12.2 and 12.3 do not. </p><dl class="section see"><dt>See also</dt><dd><a href="http://stackoverflow.com/q/38417413">How to swap two __m128i variables in C++03 given its an opaque type and an array?</a> on Stack Overflow. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00471">471</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ab8804f66768d757773489cde7738df1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8804f66768d757773489cde7738df1e">◆ </a></span>memset_z()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* memset_z </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory block initializer and eraser that attempts to survive optimizations. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>pointer to the memory block being written </td></tr>
<tr><td class="paramname">value</td><td>the integer value to write for each byte </td></tr>
<tr><td class="paramname">num</td><td>the size of the source memory block, in bytes</td></tr>
</table>
</dd>
</dl>
<p>Internally the function calls memset with the value value, and receives the return value from memset as a <code>volatile</code> pointer. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00490">490</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="abe412b0409249cb54899e97bc7d86424"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe412b0409249cb54899e97bc7d86424">◆ </a></span>STDMIN()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T& STDMIN </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Replacement function for std::min. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the first value </td></tr>
<tr><td class="paramname">b</td><td>the second value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum value based on a comparison of <code>b < a</code> using <code>operator<</code></dd></dl>
<p>STDMIN was provided because the library could not easily use std::min or std::max in Windows or Cygwin 1.1.0 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00507">507</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="af1490597cb11989e78d5ba5b5f21266b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1490597cb11989e78d5ba5b5f21266b">◆ </a></span>STDMAX()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T& STDMAX </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Replacement function for std::max. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the first value </td></tr>
<tr><td class="paramname">b</td><td>the second value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum value based on a comparison of <code>a < b</code> using <code>operator<</code></dd></dl>
<p>STDMAX was provided because the library could not easily use std::min or std::max in Windows or Cygwin 1.1.0 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00518">518</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ac8391e7d9d613a6c401787d2cdab1f51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8391e7d9d613a6c401787d2cdab1f51">◆ </a></span>UnsignedMin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T1 , class T2 > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const T1 UnsignedMin </td>
<td>(</td>
<td class="paramtype">const T1 & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T2 & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Safe comparison of values that could be neagtive and incorrectly promoted. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T1</td><td>class or type </td></tr>
<tr><td class="paramname">T2</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the first value </td></tr>
<tr><td class="paramname">b</td><td>the second value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum value based on a comparison a and b using <code>operator<</code>.</dd></dl>
<p>The comparison <code>b < a</code> is performed and the value returned is a's type T1. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00546">546</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a8a2ce94589bb74164d809f4675bd23dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a2ce94589bb74164d809f4675bd23dd">◆ </a></span>SafeConvert()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T1 , class T2 > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool SafeConvert </td>
<td>(</td>
<td class="paramtype">T1 </td>
<td class="paramname"><em>from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T2 & </td>
<td class="paramname"><em>to</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests whether a conversion from -> to is safe to perform. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T1</td><td>class or type </td></tr>
<tr><td class="paramname">T2</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">from</td><td>the first value </td></tr>
<tr><td class="paramname">to</td><td>the second value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if its safe to convert from into to, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00562">562</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a6cd7decd035cc4e144cd3d395e834106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cd7decd035cc4e144cd3d395e834106">◆ </a></span>IntToString()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">std::string IntToString </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>base</em> = <code>10</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a value to a string. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to convert </td></tr>
<tr><td class="paramname">base</td><td>the base to use during the conversion </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the string representation of value in base. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00576">576</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a2a8d39a883e1358d7d0195f7710be901"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a8d39a883e1358d7d0195f7710be901">◆ </a></span>IntToString< word64 >()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>< word64 > </td>
<td>(</td>
<td class="paramtype">word64 </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>base</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts an unsigned value to a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to convert </td></tr>
<tr><td class="paramname">base</td><td>the base to use during the conversion </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the string representation of value in base.</dd></dl>
<p>this template function specialization was added to suppress Coverity findings on <a class="el" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106" title="Converts a value to a string.">IntToString()</a> with unsigned types. </p>
<p class="definition">Definition at line <a class="el" href="integer_8cpp_source.html#l04746">4746</a> of file <a class="el" href="integer_8cpp_source.html">integer.cpp</a>.</p>
</div>
</div>
<a id="a2e4b1386ea739d43e280e5601045315b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e4b1386ea739d43e280e5601045315b">◆ </a></span>IntToString< Integer >()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106">IntToString</a>< <a class="el" href="class_integer.html">Integer</a> > </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_integer.html">Integer</a> </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>base</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts an <a class="el" href="class_integer.html" title="Multiple precision integer with arithmetic operations.">Integer</a> to a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the <a class="el" href="class_integer.html" title="Multiple precision integer with arithmetic operations.">Integer</a> to convert </td></tr>
<tr><td class="paramname">base</td><td>the base to use during the conversion </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the string representation of value in base.</dd></dl>
<p>This is a template specialization of <a class="el" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106" title="Converts a value to a string.">IntToString()</a>. Use it like <a class="el" href="misc_8h.html#a6cd7decd035cc4e144cd3d395e834106" title="Converts a value to a string.">IntToString()</a>: </p><pre>
// Print integer in base 10
<a class="el" href="class_integer.html" title="Multiple precision integer with arithmetic operations.">Integer</a> n...
std::string s = IntToString(n, 10);
</pre><p>The string is presented with lowercase letters by default. A hack is available to switch to uppercase letters without modifying the function signature. </p><pre>
// Print integer in base 16, uppercase letters
<a class="el" href="class_integer.html" title="Multiple precision integer with arithmetic operations.">Integer</a> n...
const unsigned int UPPER = (1 << 31);
std::string s = IntToString(n, (UPPER | 16));</pre>
<p class="definition">Definition at line <a class="el" href="integer_8cpp_source.html#l04680">4680</a> of file <a class="el" href="integer_8cpp_source.html">integer.cpp</a>.</p>
</div>
</div>
<a id="a6c63a5683602db0ff8975746a414797f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c63a5683602db0ff8975746a414797f">◆ </a></span>Parity()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">unsigned int Parity </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the parity of a value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to provide the parity </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the number 1-bits in the value is odd, 0 otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00659">659</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a3e22fbd4b8f95aa01bde93ea32e44e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e22fbd4b8f95aa01bde93ea32e44e82">◆ </a></span>BytePrecision()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">unsigned int BytePrecision </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of 8-bit bytes or octets required for a value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum number of 8-bit bytes or octets required to represent a value </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00671">671</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a3c5964768bc94670ad2bc3f218d9367f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c5964768bc94670ad2bc3f218d9367f">◆ </a></span>BitPrecision()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">unsigned int BitPrecision </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of bits required for a value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the maximum number of bits required to represent a value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00694">694</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a495acbd6f3cdabbb4dd863c09b378df4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a495acbd6f3cdabbb4dd863c09b378df4">◆ </a></span>TrailingZeros() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int TrailingZeros </td>
<td>(</td>
<td class="paramtype">word32 </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the number of trailing 0-bits in a value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the 32-bit value to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of trailing 0-bits in v, starting at the least significant bit position</dd></dl>
<p>TrailingZeros returns the number of trailing 0-bits in v, starting at the least significant bit position. The return value is undefined if there are no 1-bits set in the value v. </p><dl class="section note"><dt>Note</dt><dd>The function does not return 0 if no 1-bits are set because 0 collides with a 1-bit at the 0-th position. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00719">719</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="addb4df9b2f1e119d89a1573338c4eda6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addb4df9b2f1e119d89a1573338c4eda6">◆ </a></span>TrailingZeros() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int TrailingZeros </td>
<td>(</td>
<td class="paramtype">word64 </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the number of trailing 0-bits in a value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the 64-bit value to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of trailing 0-bits in v, starting at the least significant bit position</dd></dl>
<p>TrailingZeros returns the number of trailing 0-bits in v, starting at the least significant bit position. The return value is undefined if there are no 1-bits set in the value v. </p><dl class="section note"><dt>Note</dt><dd>The function does not return 0 if no 1-bits are set because 0 collides with a 1-bit at the 0-th position. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00750">750</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a616a7f0365c4947b0c8a44606c525a62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a616a7f0365c4947b0c8a44606c525a62">◆ </a></span>Crop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T Crop </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bits</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Truncates the value to the specified number of bits. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to truncate or mask </td></tr>
<tr><td class="paramname">bits</td><td>the number of bits to truncate or mask </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value truncated to the specified number of bits, starting at the least significant bit position</dd></dl>
<p>This function masks the low-order bits of value and returns the result. The mask is created with <code>(1 << bits) - 1</code>. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00778">778</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a7c5d30b17c9d4869fdc3458dd05c500d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c5d30b17c9d4869fdc3458dd05c500d">◆ </a></span>BitsToBytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t BitsToBytes </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bitCount</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of 8-bit bytes or octets required for the specified number of bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bitCount</td><td>the number of bits </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum number of 8-bit bytes or octets required by bitCount</dd></dl>
<p>BitsToBytes is effectively a ceiling function based on 8-bit bytes. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00790">790</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a886cc7ce76578c6df939f564f676e71a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a886cc7ce76578c6df939f564f676e71a">◆ </a></span>BytesToWords()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t BytesToWords </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>byteCount</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of words required for the specified number of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byteCount</td><td>the number of bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum number of words required by byteCount</dd></dl>
<p>BytesToWords is effectively a ceiling function based on <code>WORD_SIZE</code>. <code>WORD_SIZE</code> is defined in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a> </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00800">800</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a45c56601a8c94b6a37a21657929fe928"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45c56601a8c94b6a37a21657929fe928">◆ </a></span>BitsToWords()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t BitsToWords </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bitCount</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of words required for the specified number of bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bitCount</td><td>the number of bits </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum number of words required by bitCount</dd></dl>
<p>BitsToWords is effectively a ceiling function based on <code>WORD_BITS</code>. <code>WORD_BITS</code> is defined in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a> </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00810">810</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a778d13f3d45915e1bc5c0ab1801ea6ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a778d13f3d45915e1bc5c0ab1801ea6ad">◆ </a></span>BitsToDwords()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t BitsToDwords </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bitCount</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of double words required for the specified number of bits. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bitCount</td><td>the number of bits </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum number of double words required by bitCount</dd></dl>
<p>BitsToDwords is effectively a ceiling function based on <code>2*WORD_BITS</code>. <code>WORD_BITS</code> is defined in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a> </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00820">820</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a6aaae7768600b9d735a5e1b8192035f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aaae7768600b9d735a5e1b8192035f8">◆ </a></span>xorbuf() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xorbuf </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs an XOR of a buffer with a mask. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>the buffer to XOR with the mask </td></tr>
<tr><td class="paramname">mask</td><td>the mask to XOR with the buffer </td></tr>
<tr><td class="paramname">count</td><td>the size of the buffers, in bytes</td></tr>
</table>
</dd>
</dl>
<p>The function effectively visits each element in the buffers and performs <code>buf[i] ^= mask[i]</code>. buf and mask must be of equal size. </p>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00032">32</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="a22041a75d170772ab003b9b238327c9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22041a75d170772ab003b9b238327c9b">◆ </a></span>xorbuf() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xorbuf </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs an XOR of an input buffer with a mask and stores the result in an output buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>the destination buffer </td></tr>
<tr><td class="paramname">input</td><td>the source buffer to XOR with the mask </td></tr>
<tr><td class="paramname">mask</td><td>the mask buffer to XOR with the input buffer </td></tr>
<tr><td class="paramname">count</td><td>the size of the buffers, in bytes</td></tr>
</table>
</dd>
</dl>
<p>The function effectively visits each element in the buffers and performs <code>output[i] = input[i] ^ mask[i]</code>. output, input and mask must be of equal size. </p>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00065">65</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="a8e14b85d64aa63e5ba80471716837c74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e14b85d64aa63e5ba80471716837c74">◆ </a></span>VerifyBufsEqual()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool VerifyBufsEqual </td>
<td>(</td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>buf1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>buf2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a near constant-time comparison of two equally sized buffers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf1</td><td>the first buffer </td></tr>
<tr><td class="paramname">buf2</td><td>the second buffer </td></tr>
<tr><td class="paramname">count</td><td>the size of the buffers, in bytes</td></tr>
</table>
</dd>
</dl>
<p>The function effectively performs an XOR of the elements in two equally sized buffers and retruns a result based on the XOR operation. The function is near constant-time because CPU micro-code timings could affect the "constant-ness". Calling code is responsible for mitigating timing attacks if the buffers are not equally sized. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a621695f6346d6a745e340513d917b31a" title="Reduces a value to a power of 2.">ModPowerOf2</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00100">100</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="a65531618a7eca8803fa9e9287c43aafc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65531618a7eca8803fa9e9287c43aafc">◆ </a></span>IsPowerOf2()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IsPowerOf2 </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests whether a value is a power of 2. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if value is a power of 2, false otherwise</dd></dl>
<p>The function creates a mask of <code>value - 1</code> and returns the result of an AND operation compared to 0. If value is 0 or less than 0, then the function returns false. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00859">859</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a30712a90999ad9d9152975f2e92d46b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30712a90999ad9d9152975f2e92d46b8">◆ </a></span>SaturatingSubtract()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T1 , class T2 > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T1 SaturatingSubtract </td>
<td>(</td>
<td class="paramtype">const T1 & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T2 & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a saturating subtract clamped at 0. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T1</td><td>class or type </td></tr>
<tr><td class="paramname">T2</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the minuend </td></tr>
<tr><td class="paramname">b</td><td>the subtrahend </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the difference produced by the saturating subtract</dd></dl>
<p>Saturating arithmetic restricts results to a fixed range. Results that are less than 0 are clamped at 0.</p>
<p>Use of saturating arithmetic in places can be advantageous because it can avoid a branch by using an instruction like a conditional move (<code>CMOVE</code>). </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00890">890</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="afd39d67faef904dbb474981762b7ebe1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd39d67faef904dbb474981762b7ebe1">◆ </a></span>SaturatingSubtract1()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T1 , class T2 > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T1 SaturatingSubtract1 </td>
<td>(</td>
<td class="paramtype">const T1 & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T2 & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a saturating subtract clamped at 1. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T1</td><td>class or type </td></tr>
<tr><td class="paramname">T2</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the minuend </td></tr>
<tr><td class="paramname">b</td><td>the subtrahend </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the difference produced by the saturating subtract</dd></dl>
<p>Saturating arithmetic restricts results to a fixed range. Results that are less than 1 are clamped at 1.</p>
<p>Use of saturating arithmetic in places can be advantageous because it can avoid a branch by using an instruction like a conditional move (<code>CMOVE</code>). </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00907">907</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a621695f6346d6a745e340513d917b31a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a621695f6346d6a745e340513d917b31a">◆ </a></span>ModPowerOf2()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T1 , class T2 > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T2 ModPowerOf2 </td>
<td>(</td>
<td class="paramtype">const T1 & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T2 & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reduces a value to a power of 2. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T1</td><td>class or type </td></tr>
<tr><td class="paramname">T2</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>the first value </td></tr>
<tr><td class="paramname">b</td><td>the second value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="misc_8h.html#a621695f6346d6a745e340513d917b31a" title="Reduces a value to a power of 2.">ModPowerOf2()</a> returns <code>a & (b-1)</code>. <code>b</code> must be a power of 2. Use <a class="el" href="misc_8h.html#a65531618a7eca8803fa9e9287c43aafc" title="Tests whether a value is a power of 2.">IsPowerOf2()</a> to determine if <code>b</code> is a suitable candidate. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a65531618a7eca8803fa9e9287c43aafc" title="Tests whether a value is a power of 2.">IsPowerOf2</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00922">922</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aa2ac57210cb6796eced074e6d2e294fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2ac57210cb6796eced074e6d2e294fb">◆ </a></span>RoundDownToMultipleOf()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T1 , class T2 > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T1 RoundDownToMultipleOf </td>
<td>(</td>
<td class="paramtype">const T1 & </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T2 & </td>
<td class="paramname"><em>m</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Rounds a value down to a multiple of a second value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T1</td><td>class or type </td></tr>
<tr><td class="paramname">T2</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>the value to reduce </td></tr>
<tr><td class="paramname">m</td><td>the value to reduce <br />
to to a multiple </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the possibly unmodified value <br />
</dd></dl>
<p>RoundDownToMultipleOf is effectively a floor function based on m. The function returns the value <code>n - n%m</code>. If n is a multiple of m, then the original value is returned. </p><dl class="section note"><dt>Note</dt><dd><code>T1</code> and <code>T2</code> should be usigned arithmetic types. If <code>T1</code> or <code>T2</code> is signed, then the value should be non-negative. The library asserts in debug builds when practical, but allows you to perform the operation in release builds. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00941">941</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a57a219d44f45272a1f3b3f17a656000a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57a219d44f45272a1f3b3f17a656000a">◆ </a></span>RoundUpToMultipleOf()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T1 , class T2 > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T1 RoundUpToMultipleOf </td>
<td>(</td>
<td class="paramtype">const T1 & </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T2 & </td>
<td class="paramname"><em>m</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Rounds a value up to a multiple of a second value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T1</td><td>class or type </td></tr>
<tr><td class="paramname">T2</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>the value to reduce </td></tr>
<tr><td class="paramname">m</td><td>the value to reduce <br />
to to a multiple </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the possibly unmodified value <br />
</dd></dl>
<p>RoundUpToMultipleOf is effectively a ceiling function based on m. The function returns the value <code>n + n%m</code>. If n is a multiple of m, then the original value is returned. If the value n would overflow, then an <a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument</a> exception is thrown. </p><dl class="section note"><dt>Note</dt><dd><code>T1</code> and <code>T2</code> should be usigned arithmetic types. If <code>T1</code> or <code>T2</code> is signed, then the value should be non-negative. The library asserts in debug builds when practical, but allows you to perform the operation in release builds. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00971">971</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ab4e438054095c88f0c4d9eda7efc584d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4e438054095c88f0c4d9eda7efc584d">◆ </a></span>GetAlignmentOf()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetAlignmentOf </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the minimum alignment requirements of a type. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the minimum alignment requirements of <code>T</code>, in bytes</dd></dl>
<p>Internally the function calls C++11's <code>alignof</code> if available. If not available, then the function uses compiler specific extensions such as <code>__alignof</code> and <code>_alignof_</code>. If an extension is not available, then the function uses <code>__BIGGEST_ALIGNMENT__</code> if <code>__BIGGEST_ALIGNMENT__</code> is smaller than <code>sizeof(T)</code>. <code>sizeof(T)</code> is used if all others are not available. In <em>all</em> cases, if <code>CRYPTOPP_ALLOW_UNALIGNED_DATA_ACCESS</code> is defined, then the function returns 1. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l00998">998</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a726c3b76265182681f5d5fd173ab5676"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a726c3b76265182681f5d5fd173ab5676">◆ </a></span>IsAlignedOn()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IsAlignedOn </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>alignment</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether ptr is aligned to a minimum value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>the pointer being checked for alignment </td></tr>
<tr><td class="paramname">alignment</td><td>the alignment value to test the pointer against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if <code>ptr</code> is aligned on at least <code>alignment</code> boundary, false otherwise</dd></dl>
<p>Internally the function tests whether alignment is 1. If so, the function returns true. If not, then the function effectively performs a modular reduction and returns true if the residue is 0 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01030">1030</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a8b2c95659d16a971941622625c9102ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b2c95659d16a971941622625c9102ae">◆ </a></span>IsAligned()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IsAligned </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether ptr is minimally aligned. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>the pointer to check for alignment </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if <code>ptr</code> is aligned to at least <code>T</code> boundary, false otherwise</dd></dl>
<p>Internally the function calls IsAlignedOn with a second parameter of GetAlignmentOf<T> </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01041">1041</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aed8336b0d98f2469441837be6cbbebf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed8336b0d98f2469441837be6cbbebf9">◆ </a></span>GetNativeByteOrder()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> GetNativeByteOrder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns NativeByteOrder as an enumerated ByteOrder value. </p>
<dl class="section return"><dt>Returns</dt><dd>LittleEndian if the native byte order is little-endian, and BigEndian if the native byte order is big-endian</dd></dl>
<p>NativeByteOrder is a typedef depending on the platform. If CRYPTOPP_LITTLE_ENDIAN is set in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a>, then GetNativeByteOrder returns LittleEndian. If CRYPTOPP_BIG_ENDIAN is set, then GetNativeByteOrder returns BigEndian. </p><dl class="section note"><dt>Note</dt><dd>There are other byte orders besides little- and big-endian, and they include bi-endian and PDP-endian. If a system is neither little-endian nor big-endian, then a compile time error occurs. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01063">1063</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a6c2da0dd866619761e63c3b5da58c477"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c2da0dd866619761e63c3b5da58c477">◆ </a></span>NativeByteOrderIs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NativeByteOrderIs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether order follows native byte ordering. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>the ordering being tested against native byte ordering </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if order follows native byte ordering, false otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01071">1071</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ade22f7ed542b3db2912c917f8e3d6067"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade22f7ed542b3db2912c917f8e3d6067">◆ </a></span>GetCipherDir()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="cryptlib_8h.html#a353ccabf5ddc119a6a33e92f7b9961c7">CipherDir</a> GetCipherDir </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the direction the cipher is being operated. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>the cipher object being queried </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ENCRYPTION if the cipher obj is being operated in its forward direction, DECRYPTION otherwise</dd></dl>
<p>A cipher can be operated in a "forward" direction (encryption) or a "reverse" direction (decryption). The operations do not have to be symmetric, meaning a second application of the transformation does not necessariy return the original message. That is, <code>E(D(m))</code> may not equal <code>E(E(m))</code>; and <code>D(E(m))</code> may not equal <code>D(D(m))</code>. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01087">1087</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a71af89664aab380fe936b21db0a7dff7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71af89664aab380fe936b21db0a7dff7">◆ </a></span>CallNewHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CallNewHandler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to reclaim unused memory. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">bad_alloc</td><td></td></tr>
</table>
</dd>
</dl>
<p>In the normal course of running a program, a request for memory normally succeeds. If a call to AlignedAllocate or UnalignedAllocate fails, then CallNewHandler is called in an effort to recover. Internally, CallNewHandler calls set_new_handler(NULLPTR) in an effort to free memory. There is no guarantee CallNewHandler will be able to procure more memory so an allocation succeeds. If the call to set_new_handler fails, then CallNewHandler throws a bad_alloc exception. </p>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00268">268</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="a44fad9d8c25e8aca3a7ee29345516f0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44fad9d8c25e8aca3a7ee29345516f0a">◆ </a></span>IncrementCounterByOne() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IncrementCounterByOne </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>inout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs an addition with carry on a block of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inout</td><td>the byte block </td></tr>
<tr><td class="paramname">size</td><td>the size of the block, in bytes</td></tr>
</table>
</dd>
</dl>
<p>Performs an addition with carry by adding 1 on a block of bytes starting at the least significant byte. Once carry is 0, the function terminates and returns to the caller. </p><dl class="section note"><dt>Note</dt><dd>The function is not constant time because it stops processing when the carry is 0. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01108">1108</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a2f852960b51e106a849781341cb2055c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f852960b51e106a849781341cb2055c">◆ </a></span>IncrementCounterByOne() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IncrementCounterByOne </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs an addition with carry on a block of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>the destination block of bytes </td></tr>
<tr><td class="paramname">input</td><td>the source block of bytes </td></tr>
<tr><td class="paramname">size</td><td>the size of the block</td></tr>
</table>
</dd>
</dl>
<p>Performs an addition with carry on a block of bytes starting at the least significant byte. Once carry is 0, the remaining bytes from input are copied to output using memcpy.</p>
<p>The function is close to near-constant time because it operates on all the bytes in the blocks. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01122">1122</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ae71e5659910553da22f9b1e877cddc07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae71e5659910553da22f9b1e877cddc07">◆ </a></span>ConditionalSwap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ConditionalSwap </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a branchless swap of values a and b if condition c is true. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>the condition to perform the swap </td></tr>
<tr><td class="paramname">a</td><td>the first value </td></tr>
<tr><td class="paramname">b</td><td>the second value </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01138">1138</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a513e4522b268f9ee2e188606c2101d5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a513e4522b268f9ee2e188606c2101d5a">◆ </a></span>ConditionalSwapPointers()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ConditionalSwapPointers </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a branchless swap of pointers a and b if condition c is true. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>the condition to perform the swap </td></tr>
<tr><td class="paramname">a</td><td>the first pointer </td></tr>
<tr><td class="paramname">b</td><td>the second pointer </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01151">1151</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a656f38b8d0440981f5f013ada782018c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a656f38b8d0440981f5f013ada782018c">◆ </a></span>SecureWipeBuffer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void SecureWipeBuffer </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets each element of an array to 0. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>an array of elements </td></tr>
<tr><td class="paramname">n</td><td>the number of elements in the array</td></tr>
</table>
</dd>
</dl>
<p>The operation performs a wipe or zeroization. The function attempts to survive optimizations and dead code removal </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01167">1167</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a4994f3480634e5f1435fd71f9b652c38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4994f3480634e5f1435fd71f9b652c38">◆ </a></span>SecureWipeArray()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SecureWipeArray </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets each element of an array to 0. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>an array of elements </td></tr>
<tr><td class="paramname">n</td><td>the number of elements in the array</td></tr>
</table>
</dd>
</dl>
<p>The operation performs a wipe or zeroization. The function attempts to survive optimizations and dead code removal. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01275">1275</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aba2ed56f8a15d6dabbef74390eda4352"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba2ed56f8a15d6dabbef74390eda4352">◆ </a></span>StringNarrow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string StringNarrow </td>
<td>(</td>
<td class="paramtype">const wchar_t * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>throwOnError</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a wide character C-string to a multibyte string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>C-string consisting of wide characters </td></tr>
<tr><td class="paramname">throwOnError</td><td>flag indicating the function should throw on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>str converted to a multibyte string or an empty string.</dd></dl>
<p><a class="el" href="misc_8h.html#aba2ed56f8a15d6dabbef74390eda4352" title="Converts a wide character C-string to a multibyte string.">StringNarrow()</a> converts a wide string to a narrow string using C++ std::wcstombs() under the executing thread's locale. A locale must be set before using this function, and it can be set with std::setlocale() if needed. Upon success, the converted string is returned.</p>
<p>Upon failure with throwOnError as false, the function returns an empty string. If throwOnError as true, the function throws an <a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument()</a> exception. </p><dl class="section note"><dt>Note</dt><dd>If you try to convert, say, the Chinese character for "bone" from UTF-16 (0x9AA8) to UTF-8 (0xE9 0xAA 0xA8), then you must ensure the locale is available. If the locale is not available, then a 0x21 error is returned on Windows which eventually results in an <a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument()</a> exception. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00140">140</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="ac95ff706a83782e3d18a3d14817db932"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac95ff706a83782e3d18a3d14817db932">◆ </a></span>StringWiden()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::wstring StringWiden </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>throwOnError</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a multibyte C-string to a wide character string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>C-string consisting of wide characters </td></tr>
<tr><td class="paramname">throwOnError</td><td>flag indicating the function should throw on error </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>str converted to a multibyte string or an empty string.</dd></dl>
<p><a class="el" href="misc_8h.html#ac95ff706a83782e3d18a3d14817db932" title="Converts a multibyte C-string to a wide character string.">StringWiden()</a> converts a narrow string to a wide string using C++ std::mbstowcs() under the executing thread's locale. A locale must be set before using this function, and it can be set with std::setlocale() if needed. Upon success, the converted string is returned.</p>
<p>Upon failure with throwOnError as false, the function returns an empty string. If throwOnError as true, the function throws an <a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument()</a> exception. </p><dl class="section note"><dt>Note</dt><dd>If you try to convert, say, the Chinese character for "bone" from UTF-8 (0xE9 0xAA 0xA8) to UTF-16 (0x9AA8), then you must ensure the locale is available. If the locale is not available, then a 0x21 error is returned on Windows which eventually results in an <a class="el" href="class_invalid_argument.html" title="An invalid argument was detected.">InvalidArgument()</a> exception. </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00204">204</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="a0c6a1835a713cab0c3ac3fb3b6051f53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c6a1835a713cab0c3ac3fb3b6051f53">◆ </a></span>AlignedAllocate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* AlignedAllocate </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates a buffer on 16-byte boundary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>the size of the buffer</td></tr>
</table>
</dd>
</dl>
<p>AlignedAllocate is primarily used when the data will be proccessed by MMX, SSE2 and NEON instructions. The assembly language routines rely on the alignment. If the alignment is not respected, then a SIGBUS could be generated on Unix and Linux, and an EXCEPTION_DATATYPE_MISALIGNMENT could be generated on Windows. </p><dl class="section note"><dt>Note</dt><dd>AlignedAllocate and AlignedDeallocate are available when CRYPTOPP_BOOL_ALIGN16 is defined. CRYPTOPP_BOOL_ALIGN16 is defined in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a> </dd></dl>
</div>
</div>
<a id="aa355b22ae65ea94af7c7a567b266974d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa355b22ae65ea94af7c7a567b266974d">◆ </a></span>AlignedDeallocate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AlignedDeallocate </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a buffer allocated with AlignedAllocate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>the buffer to free </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>AlignedAllocate and AlignedDeallocate are available when CRYPTOPP_BOOL_ALIGN16 is defined. CRYPTOPP_BOOL_ALIGN16 is defined in <a class="el" href="config_8h.html" title="Library configuration file.">config.h</a> </dd></dl>
</div>
</div>
<a id="a1035c615a0c101227ac6f75c8bc519ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1035c615a0c101227ac6f75c8bc519ed">◆ </a></span>UnalignedAllocate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* UnalignedAllocate </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates a buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>the size of the buffer </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00325">325</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="a83d3eab0253c5e95a89a58a45f49142c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83d3eab0253c5e95a89a58a45f49142c">◆ </a></span>UnalignedDeallocate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UnalignedDeallocate </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a buffer allocated with UnalignedAllocate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>the buffer to free </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="misc_8cpp_source.html#l00333">333</a> of file <a class="el" href="misc_8cpp_source.html">misc.cpp</a>.</p>
</div>
</div>
<a id="a0ab6928faa40f6e56e7f4817d5d65a38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ab6928faa40f6e56e7f4817d5d65a38">◆ </a></span>rotlConstant()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int R, class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotlConstant </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a left rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>the number of bit positions to rotate the value </td></tr>
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>R must be in the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. Use rotlMod if the rotate amount R is outside the range.</p>
<p>Use rotlConstant when the rotate amount is constant. The template function was added because Clang did not propagate the constant when passed as a function parameter. Clang's need for a constexpr meant rotlFixed failed to compile on occassion. </p><dl class="section note"><dt>Note</dt><dd>rotlConstant attempts to enlist a <code>rotate IMM</code> instruction because its often faster than a <code>rotate REG</code>. Immediate rotates can be up to three times faster than their register counterparts. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 6.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01365">1365</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a7d777068849add4c7ab87f7b0683ef65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d777068849add4c7ab87f7b0683ef65">◆ </a></span>rotrConstant()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int R, class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotrConstant </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a right rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">R</td><td>the number of bit positions to rotate the value </td></tr>
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>R must be in the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. Use rotrMod if the rotate amount R is outside the range.</p>
<p>Use rotrConstant when the rotate amount is constant. The template function was added because Clang did not propagate the constant when passed as a function parameter. Clang's need for a constexpr meant rotrFixed failed to compile on occassion. </p><dl class="section note"><dt>Note</dt><dd>rotrConstant attempts to enlist a <code>rotate IMM</code> instruction because its often faster than a <code>rotate REG</code>. Immediate rotates can be up to three times faster than their register counterparts. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01391">1391</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aaf7b80a08d25ab9d62693c9e4798ef98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf7b80a08d25ab9d62693c9e4798ef98">◆ </a></span>rotlFixed()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotlFixed </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a left rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate </td></tr>
<tr><td class="paramname">y</td><td>the number of bit positions to rotate the value</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>y must be in the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. Use rotlMod if the rotate amount y is outside the range. </p><dl class="section note"><dt>Note</dt><dd>rotlFixed attempts to enlist a <code>rotate IMM</code> instruction because its often faster than a <code>rotate REG</code>. Immediate rotates can be up to three times faster than their register counterparts. New code should use <code>rotlConstant</code>, which accepts the rotate amount as a template parameter. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 6.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01416">1416</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="abf88e95400925b89c94641916535b6da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf88e95400925b89c94641916535b6da">◆ </a></span>rotrFixed()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotrFixed </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a right rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate </td></tr>
<tr><td class="paramname">y</td><td>the number of bit positions to rotate the value</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>y must be in the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. Use rotrMod if the rotate amount y is outside the range. </p><dl class="section note"><dt>Note</dt><dd>rotrFixed attempts to enlist a <code>rotate IMM</code> instruction because its often faster than a <code>rotate REG</code>. Immediate rotates can be up to three times faster than their register counterparts. New code should use <code>rotrConstant</code>, which accepts the rotate amount as a template parameter. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 3.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01441">1441</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a0de05253683b27a221e6465b3a7453b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0de05253683b27a221e6465b3a7453b2">◆ </a></span>rotlVariable()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotlVariable </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a left rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate </td></tr>
<tr><td class="paramname">y</td><td>the number of bit positions to rotate the value</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>y must be in the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. Use rotlMod if the rotate amount y is outside the range. </p><dl class="section note"><dt>Note</dt><dd>rotlVariable attempts to enlist a <code>rotate IMM</code> instruction because its often faster than a <code>rotate REG</code>. Immediate rotates can be up to three times faster than their register counterparts. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 3.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01465">1465</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="abd053d245fe902fe55bfd8a335634110"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd053d245fe902fe55bfd8a335634110">◆ </a></span>rotrVariable()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotrVariable </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a right rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate </td></tr>
<tr><td class="paramname">y</td><td>the number of bit positions to rotate the value</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>y must be in the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. Use rotrMod if the rotate amount y is outside the range. </p><dl class="section note"><dt>Note</dt><dd>rotrVariable attempts to enlist a <code>rotate IMM</code> instruction because its often faster than a <code>rotate REG</code>. Immediate rotates can be up to three times faster than their register counterparts. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 3.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01485">1485</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ad31fe5d559d014085c6a49594b817196"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad31fe5d559d014085c6a49594b817196">◆ </a></span>rotlMod()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotlMod </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a left rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate </td></tr>
<tr><td class="paramname">y</td><td>the number of bit positions to rotate the value</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>y is reduced to the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. </p><dl class="section note"><dt>Note</dt><dd>rotrVariable will use either <code>rotate IMM</code> or <code>rotate REG</code>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 3.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01502">1502</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ae8fc34eb834dd2424407d5e4d729594e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8fc34eb834dd2424407d5e4d729594e">◆ </a></span>rotrMod()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T rotrMod </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a right rotate. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the word type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the value to rotate </td></tr>
<tr><td class="paramname">y</td><td>the number of bit positions to rotate the value</td></tr>
</table>
</dd>
</dl>
<p>This is a portable C/C++ implementation. The value x to be rotated can be 8 to 64-bits wide.</p>
<p>y is reduced to the range <code>[0, sizeof(T)*8 - 1]</code> to avoid undefined behavior. </p><dl class="section note"><dt>Note</dt><dd>rotrVariable will use either <code>rotate IMM</code> or <code>rotate REG</code>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a0ab6928faa40f6e56e7f4817d5d65a38" title="Performs a left rotate.">rotlConstant</a>, <a class="el" href="misc_8h.html#a7d777068849add4c7ab87f7b0683ef65" title="Performs a right rotate.">rotrConstant</a>, <a class="el" href="misc_8h.html#aaf7b80a08d25ab9d62693c9e4798ef98" title="Performs a left rotate.">rotlFixed</a>, <a class="el" href="misc_8h.html#abf88e95400925b89c94641916535b6da" title="Performs a right rotate.">rotrFixed</a>, <a class="el" href="misc_8h.html#a0de05253683b27a221e6465b3a7453b2" title="Performs a left rotate.">rotlVariable</a>, <a class="el" href="misc_8h.html#abd053d245fe902fe55bfd8a335634110" title="Performs a right rotate.">rotrVariable</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 3.0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01518">1518</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a9a2ceb73851e757cb436cdbaa0242219"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a2ceb73851e757cb436cdbaa0242219">◆ </a></span>GetByte()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int GetByte </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a byte from a value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>the ByteOrder of the value </td></tr>
<tr><td class="paramname">value</td><td>the value to retrieve the byte </td></tr>
<tr><td class="paramname">index</td><td>the location of the byte to retrieve </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01827">1827</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a1d8d5adca8384ebedc699760ce217b08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d8d5adca8384ebedc699760ce217b08">◆ </a></span>ByteReverse() <span class="overload">[1/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte ByteReverse </td>
<td>(</td>
<td class="paramtype">byte </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bytes in a 8-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 8-bit value to reverse </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>ByteReverse returns the value passed to it since there is nothing to reverse </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01838">1838</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aa179e009cf5c74bb431b3c112d7ee444"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa179e009cf5c74bb431b3c112d7ee444">◆ </a></span>ByteReverse() <span class="overload">[2/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">word16 ByteReverse </td>
<td>(</td>
<td class="paramtype">word16 </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bytes in a 16-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 16-bit value to reverse</td></tr>
</table>
</dd>
</dl>
<p>ByteReverse calls bswap if available. Otherwise the function performs a 8-bit rotate on the word16 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01846">1846</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="acf65f4a9edb6224d01e900aa7205a4f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf65f4a9edb6224d01e900aa7205a4f4">◆ </a></span>ByteReverse() <span class="overload">[3/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">word32 ByteReverse </td>
<td>(</td>
<td class="paramtype">word32 </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bytes in a 32-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 32-bit value to reverse</td></tr>
</table>
</dd>
</dl>
<p>ByteReverse calls bswap if available. Otherwise the function uses a combination of rotates on the word32 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01860">1860</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a47686f3b4957541a58a3b280d1a89d4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47686f3b4957541a58a3b280d1a89d4c">◆ </a></span>ByteReverse() <span class="overload">[4/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">word64 ByteReverse </td>
<td>(</td>
<td class="paramtype">word64 </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bytes in a 64-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 64-bit value to reverse</td></tr>
</table>
</dd>
</dl>
<p>ByteReverse calls bswap if available. Otherwise the function uses a combination of rotates on the word64 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01884">1884</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a1746e70bf831f0cbf8ad73d8c15bc921"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1746e70bf831f0cbf8ad73d8c15bc921">◆ </a></span>BitReverse() <span class="overload">[1/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte BitReverse </td>
<td>(</td>
<td class="paramtype">byte </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bits in a 8-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 8-bit value to reverse</td></tr>
</table>
</dd>
</dl>
<p>BitReverse performs a combination of shifts on the byte </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01905">1905</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a699c24d7013f20ee03076576984c875e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a699c24d7013f20ee03076576984c875e">◆ </a></span>BitReverse() <span class="overload">[2/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">word16 BitReverse </td>
<td>(</td>
<td class="paramtype">word16 </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bits in a 16-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 16-bit value to reverse</td></tr>
</table>
</dd>
</dl>
<p>BitReverse performs a combination of shifts on the word16 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01915">1915</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aad87ebeafa7de2c11c19453f3b3cfea7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad87ebeafa7de2c11c19453f3b3cfea7">◆ </a></span>BitReverse() <span class="overload">[3/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">word32 BitReverse </td>
<td>(</td>
<td class="paramtype">word32 </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bits in a 32-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 32-bit value to reverse</td></tr>
</table>
</dd>
</dl>
<p>BitReverse performs a combination of shifts on the word32 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01926">1926</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a336c0289dcd2670e6b4079fa98018d7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a336c0289dcd2670e6b4079fa98018d7a">◆ </a></span>BitReverse() <span class="overload">[4/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">word64 BitReverse </td>
<td>(</td>
<td class="paramtype">word64 </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bits in a 64-bit value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the 64-bit value to reverse</td></tr>
</table>
</dd>
</dl>
<p>BitReverse performs a combination of shifts on the word64 </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01937">1937</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a641ecc1d620ac8c04bc43661a2bbba71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a641ecc1d620ac8c04bc43661a2bbba71">◆ </a></span>BitReverse() <span class="overload">[5/5]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T BitReverse </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bits in a value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to reverse</td></tr>
</table>
</dd>
</dl>
<p>The template overload of BitReverse operates on signed and unsigned values. Internally the size of T is checked, and then value is cast to a byte, word16, word32 or word64. After the cast, the appropriate BitReverse overload is called. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01956">1956</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a8e499ded4f2e7e7705c3cfd39cdf137f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e499ded4f2e7e7705c3cfd39cdf137f">◆ </a></span>ConditionalByteReverse() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T ConditionalByteReverse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bytes in a value depending upon endianness. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>the ByteOrder of the data </td></tr>
<tr><td class="paramname">value</td><td>the value to conditionally reverse</td></tr>
</table>
</dd>
</dl>
<p>Internally, the ConditionalByteReverse calls NativeByteOrderIs. If order matches native byte order, then the original value is returned. If not, then ByteReverse is called on the value before returning to the caller. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l01979">1979</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ab95e030e0abd33ea360d75cd9c4c8bbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab95e030e0abd33ea360d75cd9c4c8bbe">◆ </a></span>ByteReverse() <span class="overload">[5/5]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void ByteReverse </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>byteCount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reverses bytes in an element from an array of elements. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>the output array of elements </td></tr>
<tr><td class="paramname">in</td><td>the input array of elements </td></tr>
<tr><td class="paramname">byteCount</td><td>the total number of bytes in the array</td></tr>
</table>
</dd>
</dl>
<p>Internally, ByteReverse visits each element in the in array calls ByteReverse on it, and writes the result to out.</p>
<p>ByteReverse does not process tail byes, or bytes that are not part of a full element. If T is int (and int is 4 bytes), then <code>byteCount = 10</code> means only the first 2 elements or 8 bytes are reversed.</p>
<p>The follwoing program should help illustrate the behavior. </p><pre>vector<word32> v1, v2;</pre><pre>v1.push_back(1);
v1.push_back(2);
v1.push_back(3);
v1.push_back(4);</pre><pre>v2.resize(v1.size());
ByteReverse<word32>(&v2[0], &v1[0], 16);</pre><pre>cout << "V1: ";
for(unsigned int i = 0; i < v1.size(); i++)
cout << std::hex << v1[i] << " ";
cout << endl;</pre><pre>cout << "V2: ";
for(unsigned int i = 0; i < v2.size(); i++)
cout << std::hex << v2[i] << " ";
cout << endl;</pre><p> The program above results in the follwoing output. </p><pre>V1: 00000001 00000002 00000003 00000004
V2: 01000000 02000000 03000000 04000000</pre> <dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a8e499ded4f2e7e7705c3cfd39cdf137f" title="Reverses bytes in a value depending upon endianness.">ConditionalByteReverse</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02020">2020</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aae0de65c1758668440f71a8ff6534ad9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae0de65c1758668440f71a8ff6534ad9">◆ </a></span>ConditionalByteReverse() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ConditionalByteReverse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T * </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>byteCount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Conditionally reverses bytes in an element from an array of elements. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>the ByteOrder of the data </td></tr>
<tr><td class="paramname">out</td><td>the output array of elements </td></tr>
<tr><td class="paramname">in</td><td>the input array of elements </td></tr>
<tr><td class="paramname">byteCount</td><td>the byte count of the arrays</td></tr>
</table>
</dd>
</dl>
<p>Internally, ByteReverse visits each element in the in array calls ByteReverse on it depending on the desired endianness, and writes the result to out.</p>
<p>ByteReverse does not process tail byes, or bytes that are not part of a full element. If T is int (and int is 4 bytes), then <code>byteCount = 10</code> means only the first 2 elements or 8 bytes are reversed. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a1d8d5adca8384ebedc699760ce217b08" title="Reverses bytes in a 8-bit value.">ByteReverse</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02042">2042</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a240e8e97f964626508362b59b78532d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a240e8e97f964626508362b59b78532d3">◆ </a></span>GetWord() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T GetWord </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>assumeAligned</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>block</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a block of memory. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">assumeAligned</td><td>flag indicating alignment </td></tr>
<tr><td class="paramname">order</td><td>the ByteOrder of the data </td></tr>
<tr><td class="paramname">block</td><td>the byte buffer to be processed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the word in the specified byte order</dd></dl>
<p><a class="el" href="misc_8h.html#a240e8e97f964626508362b59b78532d3" title="Access a block of memory.">GetWord()</a> provides alternate read access to a block of memory. The flag assumeAligned indicates if the memory block is aligned for class or type T. The enumeration ByteOrder is BIG_ENDIAN_ORDER or LITTLE_ENDIAN_ORDER.</p>
<p>An example of reading two word32 values from a block of memory is shown below. <code>w</code> will be <code>0x03020100</code>. </p><pre>
word32 w;
byte buffer[4] = {0,1,2,3};
w = GetWord<word32>(false, LITTLE_ENDIAN_ORDER, buffer);
</pre>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02250">2250</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a4546cdeeecddedd3a0f784ea6b80c8bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4546cdeeecddedd3a0f784ea6b80c8bd">◆ </a></span>GetWord() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GetWord </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>assumeAligned</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T & </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>block</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a block of memory. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">assumeAligned</td><td>flag indicating alignment </td></tr>
<tr><td class="paramname">order</td><td>the ByteOrder of the data </td></tr>
<tr><td class="paramname">result</td><td>the word in the specified byte order </td></tr>
<tr><td class="paramname">block</td><td>the byte buffer to be processed</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="misc_8h.html#a240e8e97f964626508362b59b78532d3" title="Access a block of memory.">GetWord()</a> provides alternate read access to a block of memory. The flag assumeAligned indicates if the memory block is aligned for class or type T. The enumeration ByteOrder is BIG_ENDIAN_ORDER or LITTLE_ENDIAN_ORDER.</p>
<p>An example of reading two word32 values from a block of memory is shown below. <code>w</code> will be <code>0x03020100</code>. </p><pre>
word32 w;
byte buffer[4] = {0,1,2,3};
w = GetWord<word32>(false, LITTLE_ENDIAN_ORDER, buffer);
</pre>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02279">2279</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="aef6a8d35198f71ff68811bacd599c664"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef6a8d35198f71ff68811bacd599c664">◆ </a></span>PutWord()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PutWord </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>assumeAligned</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>block</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>xorBlock</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a block of memory. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">assumeAligned</td><td>flag indicating alignment </td></tr>
<tr><td class="paramname">order</td><td>the ByteOrder of the data </td></tr>
<tr><td class="paramname">block</td><td>the destination byte buffer </td></tr>
<tr><td class="paramname">value</td><td>the word in the specified byte order </td></tr>
<tr><td class="paramname">xorBlock</td><td>an optional byte buffer to xor</td></tr>
</table>
</dd>
</dl>
<p><a class="el" href="misc_8h.html#aef6a8d35198f71ff68811bacd599c664" title="Access a block of memory.">PutWord()</a> provides alternate write access to a block of memory. The flag assumeAligned indicates if the memory block is aligned for class or type T. The enumeration ByteOrder is BIG_ENDIAN_ORDER or LITTLE_ENDIAN_ORDER. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02295">2295</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a18a35b59a1f2e23b94ed2f74f0594613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18a35b59a1f2e23b94ed2f74f0594613">◆ </a></span>WordToString()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">std::string WordToString </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em> = <code><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142baf0c3bb6c718cc7ff0bffef4e8f178c57">BIG_ENDIAN_ORDER</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a word to a string. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the word to convert </td></tr>
<tr><td class="paramname">order</td><td>byte order </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string representing the value of the word </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02415">2415</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a23234e96107b28512db9467c33f67590"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23234e96107b28512db9467c33f67590">◆ </a></span>StringToWord()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T StringToWord </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> </td>
<td class="paramname"><em>order</em> = <code><a class="el" href="cryptlib_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142baf0c3bb6c718cc7ff0bffef4e8f178c57">BIG_ENDIAN_ORDER</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a string to a word. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>the string to convert </td></tr>
<tr><td class="paramname">order</td><td>byte order </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a word representing the value of the string </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02429">2429</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="abda5071e4c754b612b6a4c42be421312"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abda5071e4c754b612b6a4c42be421312">◆ </a></span>SafeRightShift()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int bits, class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T SafeRightShift </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Safely right shift values when undefined behavior could occur. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">bits</td><td>the number of bit positions to shift the value </td></tr>
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to right shift </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the shifted value or 0</dd></dl>
<p>SafeRightShift safely shifts the value to the right when undefined behavior could occur under C/C++ rules. SafeRightShift will return the shifted value or 0 if undefined behavior would occur. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02513">2513</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="a45e2662974095094e345b2bc2b30ee4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45e2662974095094e345b2bc2b30ee4c">◆ </a></span>SafeLeftShift()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int bits, class T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T SafeLeftShift </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Safely left shift values when undefined behavior could occur. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">bits</td><td>the number of bit positions to shift the value </td></tr>
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the value to left shift </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the shifted value or 0</dd></dl>
<p>SafeLeftShift safely shifts the value to the left when undefined behavior could occur under C/C++ rules. SafeLeftShift will return the shifted value or 0 if undefined behavior would occur. </p>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02527">2527</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
<a id="ab29e4cf4553b1ff9f884df223a2abd6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab29e4cf4553b1ff9f884df223a2abd6a">◆ </a></span>FindIfNot()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename InputIt , typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">InputIt FindIfNot </td>
<td>(</td>
<td class="paramtype">InputIt </td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InputIt </td>
<td class="paramname"><em>last</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds first element not in a range. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">InputIt</td><td>Input iterator type </td></tr>
<tr><td class="paramname">T</td><td>class or type </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">first</td><td>iterator to first element </td></tr>
<tr><td class="paramname">last</td><td>iterator to last element </td></tr>
<tr><td class="paramname">value</td><td>the value used as a predicate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>iterator to the first element in the range that is not value </dd></dl>
<p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02540">2540</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:03:51 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
2439
