backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-05-01 22:13:03 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for 8b1eab204b

Browse Source
This commit is contained in:
realstealthninja
2024-11-04 12:43:05 +00:00
parent 4fb6e622e9
commit a7bccf7d01
6732 changed files with 153919 additions and 365711 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
d4/d48/hamming__distance_8cpp.html
View File

@@ -1,3 +1,4 @@
<!-- HTML header for doxygen 1.12.0-->
<!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>
@@ -5,10 +6,15 @@
<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/hamming_distance.cpp File Reference</title>
<title>TheAlgorithms/C++: bit_manipulation/hamming_distance.cpp File Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
<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="https://cdn.jsdelivr.net/npm/@xpack-3rd-party/doxygen-awesome-css@2.2.0-1/doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</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>
@@ -18,14 +24,24 @@
<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 type="text/javascript">
window.MathJax = {
options: {
ignoreHtmlClass: 'tex2jax_ignore',
processHtmlClass: 'tex2jax_process'
},
loader: {
load: ['[tex]/ams']
},
tex: {
macros: {},
packages: ['base','configmacros','ams']
}
};
</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>
<script type="text/javascript" id="MathJax-script" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
@@ -33,10 +49,11 @@ MathJax.Hub.Config({
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../project_logo.png"/></td>
<td id="projectalign">
<div id="projectname">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
<div id="projectname">TheAlgorithms/C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
<div id="projectbrief">All the algorithms implemented in C++</div>
</td>
</tr>
</tbody>
@@ -121,7 +138,9 @@ 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="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">
</div>
<p><a href="../../d4/d48/hamming__distance_8cpp_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 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>
@@ -137,7 +156,7 @@ Functions</h2></td></tr>
<tr class="separator:a65d845df3fecff7087a2126c7b72030b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe6fbb2f3460a2623c96f283178a07a" id="r_abfe6fbb2f3460a2623c96f283178a07a"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abfe6fbb2f3460a2623c96f283178a07a">bit_manipulation::hamming_distance::hamming_distance</a> (uint64_t a, uint64_t b)</td></tr>
<tr class="separator:abfe6fbb2f3460a2623c96f283178a07a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40ba9fe8b5df5c268f0c7d677ff2fe80" id="r_a40ba9fe8b5df5c268f0c7d677ff2fe80"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40ba9fe8b5df5c268f0c7d677ff2fe80">bit_manipulation::hamming_distance::hamming_distance</a> (const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;a, const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;b)</td></tr>
<tr class="memitem:a40ba9fe8b5df5c268f0c7d677ff2fe80" id="r_a40ba9fe8b5df5c268f0c7d677ff2fe80"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a40ba9fe8b5df5c268f0c7d677ff2fe80">bit_manipulation::hamming_distance::hamming_distance</a> (const std::string &amp;a, const std::string &amp;b)</td></tr>
<tr class="separator:a40ba9fe8b5df5c268f0c7d677ff2fe80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8dca7b867074164d5f45b0f3851269d" id="r_aa8dca7b867074164d5f45b0f3851269d"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8dca7b867074164d5f45b0f3851269d">test</a> ()</td></tr>
<tr class="memdesc:aa8dca7b867074164d5f45b0f3851269d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to the test hamming distance. <br /></td></tr>
@@ -150,6 +169,8 @@ Functions</h2></td></tr>
<div class="textblock"><p>Returns the <a href="https://en.wikipedia.org/wiki/Hamming_distance" target="_blank">Hamming distance</a> between two integers. </p>
<p>To find hamming distance between two integers, we take their xor, which will have a set bit iff those bits differ in the two numbers. Hence, we return the number of such set bits.</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/ravibitsgoa" target="_blank">Ravishankar Joshi</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html">hamming_distance.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a65d845df3fecff7087a2126c7b72030b" name="a65d845df3fecff7087a2126c7b72030b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65d845df3fecff7087a2126c7b72030b">&#9670;&#160;</a></span>bitCount()</h2>
@@ -172,6 +193,8 @@ 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>
<p class="definition">Definition at line <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html#l00035">35</a> of file <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html">hamming_distance.cpp</a>.</p>
<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>
@@ -182,12 +205,7 @@ Functions</h2></td></tr>
<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">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/d48/hamming__distance_8cpp_a65d845df3fecff7087a2126c7b72030b_cgraph.svg" width="187" height="76"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><!-- fragment -->
</div>
</div>
<a id="a40ba9fe8b5df5c268f0c7d677ff2fe80" name="a40ba9fe8b5df5c268f0c7d677ff2fe80"></a>
@@ -199,12 +217,12 @@ Here is the call graph for this function:</div>
<tr>
<td class="memname">uint64_t bit_manipulation::hamming_distance::hamming_distance </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;</td> <td class="paramname"><span class="paramname"><em>b</em></span>&#160;)</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>b</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
@@ -216,8 +234,10 @@ 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>
<p class="definition">Definition at line <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html#l00060">60</a> of file <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html">hamming_distance.cpp</a>.</p>
<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"> 61</span> assert(a.size() == b.size());</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>
@@ -225,13 +245,7 @@ Here is the call graph for this function:</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>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/d48/hamming__distance_8cpp_a40ba9fe8b5df5c268f0c7d677ff2fe80_cgraph.svg" width="364" height="52"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><!-- fragment -->
</div>
</div>
<a id="abfe6fbb2f3460a2623c96f283178a07a" name="abfe6fbb2f3460a2623c96f283178a07a"></a>
@@ -260,14 +274,11 @@ 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"> 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">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/d48/hamming__distance_8cpp_abfe6fbb2f3460a2623c96f283178a07a_cgraph.svg" width="430" height="76"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<p class="definition">Definition at line <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html#l00052">52</a> of file <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html">hamming_distance.cpp</a>.</p>
<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> <a href="../../d4/d48/hamming__distance_8cpp_source.html#l00035">hamming_distance.cpp:35</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
@@ -287,25 +298,20 @@ 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>
<p class="definition">Definition at line <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html#l00100">100</a> of file <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html">hamming_distance.cpp</a>.</p>
<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"> 105</span> std::cout &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"> 107</span> &lt;&lt; std::endl;</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: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">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d4/d48/hamming__distance_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="180" height="86"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></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> <a href="../../d4/d48/hamming__distance_8cpp_source.html#l00076">hamming_distance.cpp:76</a></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> <a href="../../d4/d48/hamming__distance_8cpp_source.html#l00052">hamming_distance.cpp:52</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
@@ -333,6 +339,8 @@ 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>
<p class="definition">Definition at line <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html#l00076">76</a> of file <a class="el" href="../../d4/d48/hamming__distance_8cpp_source.html">hamming_distance.cpp</a>.</p>
<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>