Documentation for c6af943508

This commit is contained in:
realstealthninja
2024-11-04 12:10:37 +00:00
parent e97327bf4f
commit fb1d00ead7
518 changed files with 13882 additions and 10974 deletions

View File

@@ -114,17 +114,18 @@ $(function(){initNavTree('d4/d48/hamming__distance_8cpp.html','../../'); initRes
<p>Returns the <a href="https://en.wikipedia.org/wiki/Hamming_distance" target="_blank">Hamming distance</a> between two integers.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for hamming_distance.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/d4b/hamming__distance_8cpp__incl.svg" width="183" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/d4b/hamming__distance_8cpp__incl.svg" width="255" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d81/namespacebit__manipulation.html">bit_manipulation</a></td></tr>
<tr class="memdesc:d7/d81/namespacebit__manipulation"><td class="mdescLeft">&#160;</td><td class="mdescRight">for IO operations <br /></td></tr>
<tr class="memdesc:d7/d81/namespacebit__manipulation"><td class="mdescLeft">&#160;</td><td class="mdescRight">for assert <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d1c/namespacehamming__distance.html">hamming_distance</a></td></tr>
<tr class="memdesc:d4/d1c/namespacehamming__distance"><td class="mdescLeft">&#160;</td><td class="mdescRight">Functions for <a href="https://en.wikipedia.org/wiki/Hamming_distance" target="_blank">Hamming distance</a> implementation. <br /></td></tr>
@@ -171,16 +172,16 @@ Functions</h2></td></tr>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of set bits in the given number. </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 34</span> {</div>
<div class="line"><span class="lineno"> 35</span> uint64_t count = 0;</div>
<div class="line"><span class="lineno"> 36</span> <span class="keywordflow">while</span> (value) { <span class="comment">// until all bits are zero</span></div>
<div class="line"><span class="lineno"> 37</span> <span class="keywordflow">if</span> (value &amp; 1) { <span class="comment">// check lower bit</span></div>
<div class="line"><span class="lineno"> 38</span> count++;</div>
<div class="line"><span class="lineno"> 39</span> }</div>
<div class="line"><span class="lineno"> 40</span> value &gt;&gt;= 1; <span class="comment">// shift bits, removing lower bit</span></div>
<div class="line"><span class="lineno"> 41</span> }</div>
<div class="line"><span class="lineno"> 42</span> <span class="keywordflow">return</span> count;</div>
<div class="line"><span class="lineno"> 43</span>}</div>
<div class="fragment"><div class="line"><span class="lineno"> 35</span> {</div>
<div class="line"><span class="lineno"> 36</span> uint64_t count = 0;</div>
<div class="line"><span class="lineno"> 37</span> <span class="keywordflow">while</span> (value) { <span class="comment">// until all bits are zero</span></div>
<div class="line"><span class="lineno"> 38</span> <span class="keywordflow">if</span> (value &amp; 1) { <span class="comment">// check lower bit</span></div>
<div class="line"><span class="lineno"> 39</span> count++;</div>
<div class="line"><span class="lineno"> 40</span> }</div>
<div class="line"><span class="lineno"> 41</span> value &gt;&gt;= 1; <span class="comment">// shift bits, removing lower bit</span></div>
<div class="line"><span class="lineno"> 42</span> }</div>
<div class="line"><span class="lineno"> 43</span> <span class="keywordflow">return</span> count;</div>
<div class="line"><span class="lineno"> 44</span>}</div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -215,15 +216,15 @@ Here is the call graph for this function:</div>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of characters differing between the two strings. </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 59</span> {</div>
<div class="line"><span class="lineno"> 60</span> assert(a.size() == b.<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string/size.html">size</a>());</div>
<div class="line"><span class="lineno"> 61</span> <span class="keywordtype">size_t</span> n = a.size();</div>
<div class="line"><span class="lineno"> 62</span> uint64_t count = 0;</div>
<div class="line"><span class="lineno"> 63</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; n; i++) {</div>
<div class="line"><span class="lineno"> 64</span> count += (b[i] != a[i]);</div>
<div class="line"><span class="lineno"> 65</span> }</div>
<div class="line"><span class="lineno"> 66</span> <span class="keywordflow">return</span> count;</div>
<div class="line"><span class="lineno"> 67</span>}</div>
<div class="fragment"><div class="line"><span class="lineno"> 60</span> {</div>
<div class="line"><span class="lineno"> 61</span> assert(a.size() == b.<a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string/size.html">size</a>());</div>
<div class="line"><span class="lineno"> 62</span> <span class="keywordtype">size_t</span> n = a.size();</div>
<div class="line"><span class="lineno"> 63</span> uint64_t count = 0;</div>
<div class="line"><span class="lineno"> 64</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i &lt; n; i++) {</div>
<div class="line"><span class="lineno"> 65</span> count += (b[i] != a[i]);</div>
<div class="line"><span class="lineno"> 66</span> }</div>
<div class="line"><span class="lineno"> 67</span> <span class="keywordflow">return</span> count;</div>
<div class="line"><span class="lineno"> 68</span>}</div>
<div class="ttc" id="asize_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/size.html">std::string::size</a></div><div class="ttdeci">T size(T... args)</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
@@ -259,8 +260,8 @@ Here is the call graph for this function:</div>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bits differing between the two integers. </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 51</span>{ <span class="keywordflow">return</span> <a class="code hl_function" href="#a65d845df3fecff7087a2126c7b72030b">bitCount</a>(a ^ b); }</div>
<div class="ttc" id="ahamming__distance_8cpp_html_a65d845df3fecff7087a2126c7b72030b"><div class="ttname"><a href="#a65d845df3fecff7087a2126c7b72030b">bit_manipulation::hamming_distance::bitCount</a></div><div class="ttdeci">uint64_t bitCount(uint64_t value)</div><div class="ttdef"><b>Definition</b> hamming_distance.cpp:34</div></div>
<div class="fragment"><div class="line"><span class="lineno"> 52</span>{ <span class="keywordflow">return</span> <a class="code hl_function" href="#a65d845df3fecff7087a2126c7b72030b">bitCount</a>(a ^ b); }</div>
<div class="ttc" id="ahamming__distance_8cpp_html_a65d845df3fecff7087a2126c7b72030b"><div class="ttname"><a href="#a65d845df3fecff7087a2126c7b72030b">bit_manipulation::hamming_distance::bitCount</a></div><div class="ttdeci">uint64_t bitCount(uint64_t value)</div><div class="ttdef"><b>Definition</b> hamming_distance.cpp:35</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -286,19 +287,19 @@ Here is the call graph for this function:</div>
<p>Main function. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 99</span> {</div>
<div class="line"><span class="lineno"> 100</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// execute the tests</span></div>
<div class="line"><span class="lineno"> 101</span> uint64_t a = 11; <span class="comment">// 1011 in binary</span></div>
<div class="line"><span class="lineno"> 102</span> uint64_t b = 2; <span class="comment">// 0010 in binary</span></div>
<div class="line"><span class="lineno"> 103</span> </div>
<div class="line"><span class="lineno"> 104</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Hamming distance between &quot;</span> &lt;&lt; a &lt;&lt; <span class="stringliteral">&quot; and &quot;</span> &lt;&lt; b &lt;&lt; <span class="stringliteral">&quot; is &quot;</span></div>
<div class="line"><span class="lineno"> 105</span> &lt;&lt; <a class="code hl_function" href="#abfe6fbb2f3460a2623c96f283178a07a">bit_manipulation::hamming_distance::hamming_distance</a>(a, b)</div>
<div class="line"><span class="lineno"> 106</span> &lt;&lt; <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><span class="lineno"> 107</span>}</div>
<div class="fragment"><div class="line"><span class="lineno"> 100</span> {</div>
<div class="line"><span class="lineno"> 101</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// execute the tests</span></div>
<div class="line"><span class="lineno"> 102</span> uint64_t a = 11; <span class="comment">// 1011 in binary</span></div>
<div class="line"><span class="lineno"> 103</span> uint64_t b = 2; <span class="comment">// 0010 in binary</span></div>
<div class="line"><span class="lineno"> 104</span> </div>
<div class="line"><span class="lineno"> 105</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a> &lt;&lt; <span class="stringliteral">&quot;Hamming distance between &quot;</span> &lt;&lt; a &lt;&lt; <span class="stringliteral">&quot; and &quot;</span> &lt;&lt; b &lt;&lt; <span class="stringliteral">&quot; is &quot;</span></div>
<div class="line"><span class="lineno"> 106</span> &lt;&lt; <a class="code hl_function" href="#abfe6fbb2f3460a2623c96f283178a07a">bit_manipulation::hamming_distance::hamming_distance</a>(a, b)</div>
<div class="line"><span class="lineno"> 107</span> &lt;&lt; <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a>;</div>
<div class="line"><span class="lineno"> 108</span>}</div>
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::cout</a></div></div>
<div class="ttc" id="aendl_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/manip/endl.html">std::endl</a></div><div class="ttdeci">T endl(T... args)</div></div>
<div class="ttc" id="ahamming__distance_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Function to the test hamming distance.</div><div class="ttdef"><b>Definition</b> hamming_distance.cpp:75</div></div>
<div class="ttc" id="ahamming__distance_8cpp_html_abfe6fbb2f3460a2623c96f283178a07a"><div class="ttname"><a href="#abfe6fbb2f3460a2623c96f283178a07a">bit_manipulation::hamming_distance::hamming_distance</a></div><div class="ttdeci">uint64_t hamming_distance(uint64_t a, uint64_t b)</div><div class="ttdef"><b>Definition</b> hamming_distance.cpp:51</div></div>
<div class="ttc" id="ahamming__distance_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Function to the test hamming distance.</div><div class="ttdef"><b>Definition</b> hamming_distance.cpp:76</div></div>
<div class="ttc" id="ahamming__distance_8cpp_html_abfe6fbb2f3460a2623c96f283178a07a"><div class="ttname"><a href="#abfe6fbb2f3460a2623c96f283178a07a">bit_manipulation::hamming_distance::hamming_distance</a></div><div class="ttdeci">uint64_t hamming_distance(uint64_t a, uint64_t b)</div><div class="ttdef"><b>Definition</b> hamming_distance.cpp:52</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -332,25 +333,25 @@ Here is the call graph for this function:</div>
<p>Function to the test hamming distance. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<div class="fragment"><div class="line"><span class="lineno"> 75</span> {</div>
<div class="line"><span class="lineno"> 76</span> assert(bit_manipulation::hamming_distance::hamming_distance(11, 2) == 2);</div>
<div class="line"><span class="lineno"> 77</span> assert(bit_manipulation::hamming_distance::hamming_distance(2, 0) == 1);</div>
<div class="line"><span class="lineno"> 78</span> assert(bit_manipulation::hamming_distance::hamming_distance(11, 0) == 3);</div>
<div class="line"><span class="lineno"> 79</span> </div>
<div class="line"><span class="lineno"> 80</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;1101&quot;</span>,</div>
<div class="line"><span class="lineno"> 81</span> <span class="stringliteral">&quot;1111&quot;</span>) == 1);</div>
<div class="line"><span class="lineno"> 82</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;1111&quot;</span>,</div>
<div class="line"><span class="lineno"> 83</span> <span class="stringliteral">&quot;1111&quot;</span>) == 0);</div>
<div class="line"><span class="lineno"> 84</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;0000&quot;</span>,</div>
<div class="line"><span class="lineno"> 85</span> <span class="stringliteral">&quot;1111&quot;</span>) == 4);</div>
<div class="line"><span class="lineno"> 86</span> </div>
<div class="line"><span class="lineno"> 87</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;alpha&quot;</span>,</div>
<div class="line"><span class="lineno"> 88</span> <span class="stringliteral">&quot;alphb&quot;</span>) == 1);</div>
<div class="line"><span class="lineno"> 89</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;abcd&quot;</span>,</div>
<div class="line"><span class="lineno"> 90</span> <span class="stringliteral">&quot;abcd&quot;</span>) == 0);</div>
<div class="line"><span class="lineno"> 91</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;dcba&quot;</span>,</div>
<div class="line"><span class="lineno"> 92</span> <span class="stringliteral">&quot;abcd&quot;</span>) == 4);</div>
<div class="line"><span class="lineno"> 93</span>}</div>
<div class="fragment"><div class="line"><span class="lineno"> 76</span> {</div>
<div class="line"><span class="lineno"> 77</span> assert(bit_manipulation::hamming_distance::hamming_distance(11, 2) == 2);</div>
<div class="line"><span class="lineno"> 78</span> assert(bit_manipulation::hamming_distance::hamming_distance(2, 0) == 1);</div>
<div class="line"><span class="lineno"> 79</span> assert(bit_manipulation::hamming_distance::hamming_distance(11, 0) == 3);</div>
<div class="line"><span class="lineno"> 80</span> </div>
<div class="line"><span class="lineno"> 81</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;1101&quot;</span>,</div>
<div class="line"><span class="lineno"> 82</span> <span class="stringliteral">&quot;1111&quot;</span>) == 1);</div>
<div class="line"><span class="lineno"> 83</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;1111&quot;</span>,</div>
<div class="line"><span class="lineno"> 84</span> <span class="stringliteral">&quot;1111&quot;</span>) == 0);</div>
<div class="line"><span class="lineno"> 85</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;0000&quot;</span>,</div>
<div class="line"><span class="lineno"> 86</span> <span class="stringliteral">&quot;1111&quot;</span>) == 4);</div>
<div class="line"><span class="lineno"> 87</span> </div>
<div class="line"><span class="lineno"> 88</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;alpha&quot;</span>,</div>
<div class="line"><span class="lineno"> 89</span> <span class="stringliteral">&quot;alphb&quot;</span>) == 1);</div>
<div class="line"><span class="lineno"> 90</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;abcd&quot;</span>,</div>
<div class="line"><span class="lineno"> 91</span> <span class="stringliteral">&quot;abcd&quot;</span>) == 0);</div>
<div class="line"><span class="lineno"> 92</span> assert(bit_manipulation::hamming_distance::hamming_distance(<span class="stringliteral">&quot;dcba&quot;</span>,</div>
<div class="line"><span class="lineno"> 93</span> <span class="stringliteral">&quot;abcd&quot;</span>) == 4);</div>
<div class="line"><span class="lineno"> 94</span>}</div>
</div><!-- fragment -->
</div>
</div>