<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crypto++: SafeShifter< true > Struct Template 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.14 --> <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="#pub-static-methods">Static Public Member Functions</a> | <a href="struct_safe_shifter_3_01true_01_4-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">SafeShifter< true > Struct Template Reference</div> </div> </div><!--header--> <div class="contents"> <p>Shifts a value in the presence of overflow. <a href="struct_safe_shifter_3_01true_01_4.html#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a0e054d805e1e5a7e32a648266835082d"><td class="memTemplParams" colspan="2">template<class T > </td></tr> <tr class="memitem:a0e054d805e1e5a7e32a648266835082d"><td class="memTemplItemLeft" align="right" valign="top">static T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="struct_safe_shifter_3_01true_01_4.html#a0e054d805e1e5a7e32a648266835082d">RightShift</a> (T value, unsigned int bits)</td></tr> <tr class="memdesc:a0e054d805e1e5a7e32a648266835082d"><td class="mdescLeft"> </td><td class="mdescRight">Right shifts a value that overflows. <a href="#a0e054d805e1e5a7e32a648266835082d">More...</a><br /></td></tr> <tr class="separator:a0e054d805e1e5a7e32a648266835082d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a48479b291ad6a30c58fb54241e652dc1"><td class="memTemplParams" colspan="2">template<class T > </td></tr> <tr class="memitem:a48479b291ad6a30c58fb54241e652dc1"><td class="memTemplItemLeft" align="right" valign="top">static T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="struct_safe_shifter_3_01true_01_4.html#a48479b291ad6a30c58fb54241e652dc1">LeftShift</a> (T value, unsigned int bits)</td></tr> <tr class="memdesc:a48479b291ad6a30c58fb54241e652dc1"><td class="mdescLeft"> </td><td class="mdescRight">Left shifts a value that overflows. <a href="#a48479b291ad6a30c58fb54241e652dc1">More...</a><br /></td></tr> <tr class="separator:a48479b291ad6a30c58fb54241e652dc1"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<><br /> struct SafeShifter< true ></h3> <p>Shifts a value in the presence of overflow. </p> <p>the true template parameter indicates overflow would occur. In this case, <a class="el" href="struct_safe_shifter.html" title="Safely shift values when undefined behavior could occur. ">SafeShifter</a> clamps the value and returns 0. </p> <p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02449">2449</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a0e054d805e1e5a7e32a648266835082d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0e054d805e1e5a7e32a648266835082d">◆ </a></span>RightShift()</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">static T <a class="el" href="struct_safe_shifter.html">SafeShifter</a>< true >::RightShift </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>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 class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Right shifts a value that overflows. </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>0</dd></dl> <p>Since <code>overflow == true</code>, the value 0 is always returned. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#a45e2662974095094e345b2bc2b30ee4c" title="Safely left shift values when undefined behavior could occur. ">SafeLeftShift</a> </dd></dl> <p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02457">2457</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p> </div> </div> <a id="a48479b291ad6a30c58fb54241e652dc1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a48479b291ad6a30c58fb54241e652dc1">◆ </a></span>LeftShift()</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">static T <a class="el" href="struct_safe_shifter.html">SafeShifter</a>< true >::LeftShift </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>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 class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Left shifts a value that overflows. </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>0</dd></dl> <p>Since <code>overflow == true</code>, the value 0 is always returned. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="misc_8h.html#abda5071e4c754b612b6a4c42be421312" title="Safely right shift values when undefined behavior could occur. ">SafeRightShift</a> </dd></dl> <p class="definition">Definition at line <a class="el" href="misc_8h_source.html#l02469">2469</a> of file <a class="el" href="misc_8h_source.html">misc.h</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="misc_8h_source.html">misc.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:55 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>