Files
C-Plus-Plus/d7/d81/namespacebit__manipulation.html
2024-08-30 17:22:07 +00:00

246 lines
14 KiB
HTML

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: bit_manipulation Namespace 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>
<script type="text/javascript" src="../../clipboard.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d7/d81/namespacebit__manipulation.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">bit_manipulation Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>for IO operations
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4b76571a2a04fa99c30a96eca9997f0e" id="r_a4b76571a2a04fa99c30a96eca9997f0e"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b76571a2a04fa99c30a96eca9997f0e">next_higher_number</a> (uint64_t x)</td></tr>
<tr class="memdesc:a4b76571a2a04fa99c30a96eca9997f0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main function implements checking the next number. <br /></td></tr>
<tr class="separator:a4b76571a2a04fa99c30a96eca9997f0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5032470c9974bbd6ec254bf296530a5f" id="r_a5032470c9974bbd6ec254bf296530a5f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5032470c9974bbd6ec254bf296530a5f">isPowerOfTwo</a> (std ::int64_t n)</td></tr>
<tr class="memdesc:a5032470c9974bbd6ec254bf296530a5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main function implements check for power of 2. <br /></td></tr>
<tr class="separator:a5032470c9974bbd6ec254bf296530a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>for IO operations </p>
<p>Bit manipulation algorithms.</p>
<p>for io operations</p>
<p>storing the numbers</p>
<p>for assert</p>
<p>Bit manipulation algorithms</p>
<p>for assert for IO operations</p>
<p>Bit manipulation algorithms</p>
<p>for assert</p>
<p>Bit Manipulation algorithms</p>
<p>for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a> for assert for IO operations for limits of integral types for <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a> </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a5032470c9974bbd6ec254bf296530a5f" name="a5032470c9974bbd6ec254bf296530a5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5032470c9974bbd6ec254bf296530a5f">&#9670;&#160;</a></span>isPowerOfTwo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool bit_manipulation::isPowerOfTwo </td>
<td>(</td>
<td class="paramtype">std ::int64_t</td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The main function implements check for power of 2. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>is the number who will be checked </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>either true or false </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 31</span> { <span class="comment">// int64_t is preferred over int so that</span></div>
<div class="line"><span class="lineno"> 32</span> <span class="comment">// no Overflow can be there.</span></div>
<div class="line"><span class="lineno"> 33</span> </div>
<div class="line"><span class="lineno"> 34</span> <span class="keywordflow">return</span> n &gt; 0 &amp;&amp; !(n &amp; n - 1); <span class="comment">// If we subtract a power of 2 numbers by 1</span></div>
<div class="line"><span class="lineno"> 35</span> <span class="comment">// then all unset bits after the only set bit become set; and the set bit</span></div>
<div class="line"><span class="lineno"> 36</span> <span class="comment">// becomes unset.</span></div>
<div class="line"><span class="lineno"> 37</span> </div>
<div class="line"><span class="lineno"> 38</span> <span class="comment">// If a number n is a power of 2 then bitwise and of n-1 and n will be zero.</span></div>
<div class="line"><span class="lineno"> 39</span> <span class="comment">// The expression n&amp;(n-1) will not work when n is 0.</span></div>
<div class="line"><span class="lineno"> 40</span> <span class="comment">// To handle this case also, our expression will become n&amp; (!n&amp;(n-1))</span></div>
<div class="line"><span class="lineno"> 41</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a4b76571a2a04fa99c30a96eca9997f0e" name="a4b76571a2a04fa99c30a96eca9997f0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b76571a2a04fa99c30a96eca9997f0e">&#9670;&#160;</a></span>next_higher_number()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t bit_manipulation::next_higher_number </td>
<td>(</td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The main function implements checking the next number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the number that will be calculated </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a number </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 32</span> {</div>
<div class="line"><span class="lineno"> 33</span> uint64_t rightOne = 0;</div>
<div class="line"><span class="lineno"> 34</span> uint64_t nextHigherOneBit = 0;</div>
<div class="line"><span class="lineno"> 35</span> uint64_t rightOnesPattern = 0;</div>
<div class="line"><span class="lineno"> 36</span> </div>
<div class="line"><span class="lineno"> 37</span> uint64_t next = 0;</div>
<div class="line"><span class="lineno"> 38</span> </div>
<div class="line"><span class="lineno"> 39</span> <span class="keywordflow">if</span> (x) {</div>
<div class="line"><span class="lineno"> 40</span> <span class="comment">// right most set bit</span></div>
<div class="line"><span class="lineno"> 41</span> rightOne = x &amp; -<span class="keyword">static_cast&lt;</span><span class="keywordtype">signed</span><span class="keyword">&gt;</span>(x);</div>
<div class="line"><span class="lineno"> 42</span> </div>
<div class="line"><span class="lineno"> 43</span> <span class="comment">// reset the pattern and set next higher bit</span></div>
<div class="line"><span class="lineno"> 44</span> <span class="comment">// left part of x will be here</span></div>
<div class="line"><span class="lineno"> 45</span> nextHigherOneBit = x + rightOne;</div>
<div class="line"><span class="lineno"> 46</span> </div>
<div class="line"><span class="lineno"> 47</span> <span class="comment">// nextHigherOneBit is now part [D] of the above explanation.</span></div>
<div class="line"><span class="lineno"> 48</span> </div>
<div class="line"><span class="lineno"> 49</span> <span class="comment">// isolate the pattern</span></div>
<div class="line"><span class="lineno"> 50</span> rightOnesPattern = x ^ nextHigherOneBit;</div>
<div class="line"><span class="lineno"> 51</span> </div>
<div class="line"><span class="lineno"> 52</span> <span class="comment">// right adjust pattern</span></div>
<div class="line"><span class="lineno"> 53</span> rightOnesPattern = (rightOnesPattern) / rightOne;</div>
<div class="line"><span class="lineno"> 54</span> </div>
<div class="line"><span class="lineno"> 55</span> <span class="comment">// correction factor</span></div>
<div class="line"><span class="lineno"> 56</span> rightOnesPattern &gt;&gt;= 2;</div>
<div class="line"><span class="lineno"> 57</span> </div>
<div class="line"><span class="lineno"> 58</span> <span class="comment">// rightOnesPattern is now part [A] of the above explanation.</span></div>
<div class="line"><span class="lineno"> 59</span> </div>
<div class="line"><span class="lineno"> 60</span> <span class="comment">// integrate new pattern (Add [D] and [A])</span></div>
<div class="line"><span class="lineno"> 61</span> next = nextHigherOneBit | rightOnesPattern;</div>
<div class="line"><span class="lineno"> 62</span> }</div>
<div class="line"><span class="lineno"> 63</span> </div>
<div class="line"><span class="lineno"> 64</span> <span class="keywordflow">return</span> next;</div>
<div class="line"><span class="lineno"> 65</span>}</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d7/d81/namespacebit__manipulation.html">bit_manipulation</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>