Skip to content

Commit 724be2d

Browse files
Documentation for 8541bb3
1 parent 444bd9e commit 724be2d

File tree

6 files changed

+108
-92
lines changed

6 files changed

+108
-92
lines changed

da/db8/count__of__set__bits_8cpp.html

Lines changed: 53 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@
139139
</table><table class="memberdecls">
140140
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
141141
Functions</h2></td></tr>
142-
<tr class="memitem:a86c98dc299e4db28b73e08309d977e62" id="r_a86c98dc299e4db28b73e08309d977e62"><td class="memItemLeft" align="right" valign="top">std::uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a> (std ::int64_t n)</td></tr>
143-
<tr class="memdesc:a86c98dc299e4db28b73e08309d977e62"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main function implements set bit count. <br /></td></tr>
142+
<tr class="memitem:aea9e56e21fc34d417d702319303a285a" id="r_aea9e56e21fc34d417d702319303a285a"><td class="memItemLeft" align="right" valign="top">std::uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a> (std ::uint64_t n)</td></tr>
143+
<tr class="memdesc:aea9e56e21fc34d417d702319303a285a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main function implements set bit count. <br /></td></tr>
144144
<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>
145145
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
146146
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function. <br /></td></tr>
@@ -154,16 +154,16 @@
154154

155155
<p class="definition">Definition in file <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html">count_of_set_bits.cpp</a>.</p>
156156
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
157-
<a id="a86c98dc299e4db28b73e08309d977e62" name="a86c98dc299e4db28b73e08309d977e62"></a>
158-
<h2 class="memtitle"><span class="permalink"><a href="#a86c98dc299e4db28b73e08309d977e62">&#9670;&#160;</a></span>countSetBits()</h2>
157+
<a id="aea9e56e21fc34d417d702319303a285a" name="aea9e56e21fc34d417d702319303a285a"></a>
158+
<h2 class="memtitle"><span class="permalink"><a href="#aea9e56e21fc34d417d702319303a285a">&#9670;&#160;</a></span>countSetBits()</h2>
159159

160160
<div class="memitem">
161161
<div class="memproto">
162162
<table class="memname">
163163
<tr>
164164
<td class="memname">std::uint64_t bit_manipulation::count_of_set_bits::countSetBits </td>
165165
<td>(</td>
166-
<td class="paramtype">std ::int64_t</td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
166+
<td class="paramtype">std ::uint64_t</td> <td class="paramname"><span class="paramname"><em>n</em></span></td><td>)</td>
167167
<td></td>
168168
</tr>
169169
</table>
@@ -179,21 +179,29 @@ <h2 class="memtitle"><span class="permalink"><a href="#a86c98dc299e4db28b73e0830
179179
<dl class="section return"><dt>Returns</dt><dd>total number of set-bits in the binary representation of number <span class="tt">n</span> </dd></dl>
180180

181181
<p class="definition">Definition at line <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html#l00038">38</a> of file <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html">count_of_set_bits.cpp</a>.</p>
182-
<div class="fragment"><div class="line"><span class="lineno"> 39</span> { <span class="comment">// int64_t is preferred over int so that</span></div>
182+
<div class="fragment"><div class="line"><span class="lineno"> 39</span> { <span class="comment">// uint64_t is preferred over int so that</span></div>
183183
<div class="line"><span class="lineno"> 40</span> <span class="comment">// no Overflow can be there.</span></div>
184-
<div class="line"><span class="lineno"> 41</span> </div>
185-
<div class="line"><span class="lineno"> 42</span> <span class="keywordtype">int</span> count = 0; <span class="comment">// &quot;count&quot; variable is used to count number of set-bits(&#39;1&#39;)</span></div>
186-
<div class="line"><span class="lineno"> 43</span> <span class="comment">// in binary representation of number &#39;n&#39;</span></div>
187-
<div class="line"><span class="lineno"> 44</span> <span class="keywordflow">while</span> (n != 0) {</div>
188-
<div class="line"><span class="lineno"> 45</span> ++count;</div>
189-
<div class="line"><span class="lineno"> 46</span> n = (n &amp; (n - 1));</div>
190-
<div class="line"><span class="lineno"> 47</span> }</div>
191-
<div class="line"><span class="lineno"> 48</span> <span class="keywordflow">return</span> count;</div>
192-
<div class="line"><span class="lineno"> 49</span> <span class="comment">// Why this algorithm is better than the standard one?</span></div>
193-
<div class="line"><span class="lineno"> 50</span> <span class="comment">// Because this algorithm runs the same number of times as the number of</span></div>
194-
<div class="line"><span class="lineno"> 51</span> <span class="comment">// set-bits in it. Means if my number is having &quot;3&quot; set bits, then this</span></div>
195-
<div class="line"><span class="lineno"> 52</span> <span class="comment">// while loop will run only &quot;3&quot; times!!</span></div>
196-
<div class="line"><span class="lineno"> 53</span>}</div>
184+
<div class="line"><span class="lineno"> 41</span> <span class="comment">//It&#39;s preferred over int64_t because it Guarantees that inputs are always non-negative, </span></div>
185+
<div class="line"><span class="lineno"> 42</span> <span class="comment">//which matches the algorithmic problem statement.</span></div>
186+
<div class="line"><span class="lineno"> 43</span> <span class="comment">//set bit counting is conceptually defined only for non-negative numbers.</span></div>
187+
<div class="line"><span class="lineno"> 44</span> <span class="comment">//Provides a type Safety: Using an unsigned type helps prevent accidental negative values,</span></div>
188+
<div class="line"><span class="lineno"> 45</span> </div>
189+
<div class="line"><span class="lineno"> 46</span> std::uint64_t count = 0; <span class="comment">// &quot;count&quot; variable is used to count number of set-bits(&#39;1&#39;)</span></div>
190+
<div class="line"><span class="lineno"> 47</span> <span class="comment">// in binary representation of number &#39;n&#39;</span></div>
191+
<div class="line"><span class="lineno"> 48</span> <span class="comment">//Count is uint64_t because it Prevents theoretical overflow if someone passes very large integers.</span></div>
192+
<div class="line"><span class="lineno"> 49</span> <span class="comment">// Behavior stays the same for all normal inputs.</span></div>
193+
<div class="line"><span class="lineno"> 50</span> <span class="comment">// Safer for edge cases.</span></div>
194+
<div class="line"><span class="lineno"> 51</span> </div>
195+
<div class="line"><span class="lineno"> 52</span> <span class="keywordflow">while</span> (n != 0) {</div>
196+
<div class="line"><span class="lineno"> 53</span> ++count;</div>
197+
<div class="line"><span class="lineno"> 54</span> n = (n &amp; (n - 1));</div>
198+
<div class="line"><span class="lineno"> 55</span> }</div>
199+
<div class="line"><span class="lineno"> 56</span> <span class="keywordflow">return</span> count;</div>
200+
<div class="line"><span class="lineno"> 57</span> <span class="comment">// Why this algorithm is better than the standard one?</span></div>
201+
<div class="line"><span class="lineno"> 58</span> <span class="comment">// Because this algorithm runs the same number of times as the number of</span></div>
202+
<div class="line"><span class="lineno"> 59</span> <span class="comment">// set-bits in it. Means if my number is having &quot;3&quot; set bits, then this</span></div>
203+
<div class="line"><span class="lineno"> 60</span> <span class="comment">// while loop will run only &quot;3&quot; times!!</span></div>
204+
<div class="line"><span class="lineno"> 61</span>}</div>
197205
</div><!-- fragment -->
198206
</div>
199207
</div>
@@ -215,11 +223,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a7
215223
<p>Main function. </p>
216224
<dl class="section return"><dt>Returns</dt><dd>0 on exit </dd></dl>
217225

218-
<p class="definition">Definition at line <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html#l00080">80</a> of file <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html">count_of_set_bits.cpp</a>.</p>
219-
<div class="fragment"><div class="line"><span class="lineno"> 80</span> {</div>
220-
<div class="line"><span class="lineno"> 81</span> <a class="code hl_function" href="../../dd/d1e/generate__parentheses_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
221-
<div class="line"><span class="lineno"> 82</span> <span class="keywordflow">return</span> 0;</div>
222-
<div class="line"><span class="lineno"> 83</span>}</div>
226+
<p class="definition">Definition at line <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html#l00088">88</a> of file <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html">count_of_set_bits.cpp</a>.</p>
227+
<div class="fragment"><div class="line"><span class="lineno"> 88</span> {</div>
228+
<div class="line"><span class="lineno"> 89</span> <a class="code hl_function" href="../../dd/d1e/generate__parentheses_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
229+
<div class="line"><span class="lineno"> 90</span> <span class="keywordflow">return</span> 0;</div>
230+
<div class="line"><span class="lineno"> 91</span>}</div>
223231
<div class="ttc" id="agenerate__parentheses_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../dd/d1e/generate__parentheses_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> <a href="../../dd/d1e/generate__parentheses_8cpp_source.html#l00082">generate_parentheses.cpp:82</a></div></div>
224232
</div><!-- fragment -->
225233
</div>
@@ -247,27 +255,27 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f
247255
</table>
248256
</div><div class="memdoc">
249257

250-
<p class="definition">Definition at line <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html#l00057">57</a> of file <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html">count_of_set_bits.cpp</a>.</p>
251-
<div class="fragment"><div class="line"><span class="lineno"> 57</span> {</div>
252-
<div class="line"><span class="lineno"> 58</span> <span class="comment">// n = 4 return 1</span></div>
253-
<div class="line"><span class="lineno"> 59</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(4) == 1);</div>
254-
<div class="line"><span class="lineno"> 60</span> <span class="comment">// n = 6 return 2</span></div>
255-
<div class="line"><span class="lineno"> 61</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(6) == 2);</div>
256-
<div class="line"><span class="lineno"> 62</span> <span class="comment">// n = 13 return 3</span></div>
257-
<div class="line"><span class="lineno"> 63</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(13) == 3);</div>
258-
<div class="line"><span class="lineno"> 64</span> <span class="comment">// n = 9 return 2</span></div>
259-
<div class="line"><span class="lineno"> 65</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(9) == 2);</div>
260-
<div class="line"><span class="lineno"> 66</span> <span class="comment">// n = 15 return 4</span></div>
261-
<div class="line"><span class="lineno"> 67</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(15) == 4);</div>
262-
<div class="line"><span class="lineno"> 68</span> <span class="comment">// n = 25 return 3</span></div>
263-
<div class="line"><span class="lineno"> 69</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(25) == 3);</div>
264-
<div class="line"><span class="lineno"> 70</span> <span class="comment">// n = 97 return 3</span></div>
265-
<div class="line"><span class="lineno"> 71</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(97) == 3);</div>
266-
<div class="line"><span class="lineno"> 72</span> <span class="comment">// n = 31 return 5</span></div>
267-
<div class="line"><span class="lineno"> 73</span> assert(<a class="code hl_function" href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a>(31) == 5);</div>
268-
<div class="line"><span class="lineno"> 74</span> std::cout &lt;&lt; <span class="stringliteral">&quot;All test cases successfully passed!&quot;</span> &lt;&lt; std::endl;</div>
269-
<div class="line"><span class="lineno"> 75</span>}</div>
270-
<div class="ttc" id="acount__of__set__bits_8cpp_html_a86c98dc299e4db28b73e08309d977e62"><div class="ttname"><a href="#a86c98dc299e4db28b73e08309d977e62">bit_manipulation::count_of_set_bits::countSetBits</a></div><div class="ttdeci">std::uint64_t countSetBits(std ::int64_t n)</div><div class="ttdoc">The main function implements set bit count.</div><div class="ttdef"><b>Definition</b> <a href="../../da/db8/count__of__set__bits_8cpp_source.html#l00038">count_of_set_bits.cpp:38</a></div></div>
258+
<p class="definition">Definition at line <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html#l00065">65</a> of file <a class="el" href="../../da/db8/count__of__set__bits_8cpp_source.html">count_of_set_bits.cpp</a>.</p>
259+
<div class="fragment"><div class="line"><span class="lineno"> 65</span> {</div>
260+
<div class="line"><span class="lineno"> 66</span> <span class="comment">// n = 4 return 1</span></div>
261+
<div class="line"><span class="lineno"> 67</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(4) == 1);</div>
262+
<div class="line"><span class="lineno"> 68</span> <span class="comment">// n = 6 return 2</span></div>
263+
<div class="line"><span class="lineno"> 69</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(6) == 2);</div>
264+
<div class="line"><span class="lineno"> 70</span> <span class="comment">// n = 13 return 3</span></div>
265+
<div class="line"><span class="lineno"> 71</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(13) == 3);</div>
266+
<div class="line"><span class="lineno"> 72</span> <span class="comment">// n = 9 return 2</span></div>
267+
<div class="line"><span class="lineno"> 73</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(9) == 2);</div>
268+
<div class="line"><span class="lineno"> 74</span> <span class="comment">// n = 15 return 4</span></div>
269+
<div class="line"><span class="lineno"> 75</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(15) == 4);</div>
270+
<div class="line"><span class="lineno"> 76</span> <span class="comment">// n = 25 return 3</span></div>
271+
<div class="line"><span class="lineno"> 77</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(25) == 3);</div>
272+
<div class="line"><span class="lineno"> 78</span> <span class="comment">// n = 97 return 3</span></div>
273+
<div class="line"><span class="lineno"> 79</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(97) == 3);</div>
274+
<div class="line"><span class="lineno"> 80</span> <span class="comment">// n = 31 return 5</span></div>
275+
<div class="line"><span class="lineno"> 81</span> assert(<a class="code hl_function" href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a>(31) == 5);</div>
276+
<div class="line"><span class="lineno"> 82</span> std::cout &lt;&lt; <span class="stringliteral">&quot;All test cases successfully passed!&quot;</span> &lt;&lt; std::endl;</div>
277+
<div class="line"><span class="lineno"> 83</span>}</div>
278+
<div class="ttc" id="acount__of__set__bits_8cpp_html_aea9e56e21fc34d417d702319303a285a"><div class="ttname"><a href="#aea9e56e21fc34d417d702319303a285a">bit_manipulation::count_of_set_bits::countSetBits</a></div><div class="ttdeci">std::uint64_t countSetBits(std ::uint64_t n)</div><div class="ttdoc">The main function implements set bit count.</div><div class="ttdef"><b>Definition</b> <a href="../../da/db8/count__of__set__bits_8cpp_source.html#l00038">count_of_set_bits.cpp:38</a></div></div>
271279
</div><!-- fragment -->
272280
</div>
273281
</div>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var count__of__set__bits_8cpp =
22
[
3-
[ "bit_manipulation::count_of_set_bits::countSetBits", "da/db8/count__of__set__bits_8cpp.html#a86c98dc299e4db28b73e08309d977e62", null ],
3+
[ "bit_manipulation::count_of_set_bits::countSetBits", "da/db8/count__of__set__bits_8cpp.html#aea9e56e21fc34d417d702319303a285a", null ],
44
[ "main", "da/db8/count__of__set__bits_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4", null ]
55
];

0 commit comments

Comments
 (0)