Files
C-Plus-Plus/d9/d1f/binary__addition_8cpp.html
2024-11-04 12:43:05 +00:00

269 lines
21 KiB
HTML

<!-- 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>
<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>TheAlgorithms/C++: greedy_algorithms/binary_addition.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>
<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/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" 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! -->
<div id="titlearea">
<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">TheAlgorithms/C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">All the 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('d9/d1f/binary__addition_8cpp.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="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">binary_addition.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Adds two binary numbers and outputs resulting string.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for binary_addition.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d5/d95/binary__addition_8cpp__incl.svg" width="347" 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>
<p><a href="../../d9/d1f/binary__addition_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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html">greedy_algorithms::BinaryAddition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A class to perform binary addition of two binary strings. <a href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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="../../d2/d90/namespacegreedy__algorithms.html">greedy_algorithms</a></td></tr>
<tr class="memdesc:d2/d90/namespacegreedy__algorithms"><td class="mdescLeft">&#160;</td><td class="mdescRight">for string class <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a483bb8ccf42aaf7375a83e91490eda1e" id="r_a483bb8ccf42aaf7375a83e91490eda1e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a> ()</td></tr>
<tr class="memdesc:a483bb8ccf42aaf7375a83e91490eda1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">run self test implementation. <br /></td></tr>
<tr class="separator:a483bb8ccf42aaf7375a83e91490eda1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">main function <br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><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>Adds two binary numbers and outputs resulting string. </p>
<p>The algorithm for adding two binary strings works by processing them from right to left, similar to manual addition. It starts by determining the longer string's length to ensure both strings are fully traversed. For each pair of corresponding bits and any carry from the previous addition, it calculates the sum. If the sum exceeds 1, a carry is generated for the next bit. The results for each bit are collected in a result string, which is reversed at the end to present the final binary sum correctly. Additionally, the function validates the input to ensure that only valid binary strings (containing only '0' and '1') are processed. If invalid input is detected, it returns an empty string. </p><dl class="section author"><dt>Author</dt><dd><a href="https://github.com/mjk22071998" target="_blank">Muhammad Junaid Khalid</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../d9/d1f/binary__addition_8cpp_source.html">binary_addition.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&#160;</a></span>main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>main function </p>
<dl class="section return"><dt>Returns</dt><dd>0 on successful exit </dd></dl>
<p>To execute tests</p>
<p class="definition">Definition at line <a class="el" href="../../d9/d1f/binary__addition_8cpp_source.html#l00116">116</a> of file <a class="el" href="../../d9/d1f/binary__addition_8cpp_source.html">binary_addition.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 116</span> {</div>
<div class="line"><span class="lineno"> 117</span> <a class="code hl_function" href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a>(); </div>
<div class="line"><span class="lineno"> 118</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 119</span>}</div>
<div class="ttc" id="abinary__addition_8cpp_html_a483bb8ccf42aaf7375a83e91490eda1e"><div class="ttname"><a href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a></div><div class="ttdeci">static void tests()</div><div class="ttdoc">run self test implementation.</div><div class="ttdef"><b>Definition</b> <a href="../../d9/d1f/binary__addition_8cpp_source.html#l00086">binary_addition.cpp:86</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a483bb8ccf42aaf7375a83e91490eda1e" name="a483bb8ccf42aaf7375a83e91490eda1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a483bb8ccf42aaf7375a83e91490eda1e">&#9670;&#160;</a></span>tests()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void tests </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>run self test implementation. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d9/d1f/binary__addition_8cpp_source.html#l00086">86</a> of file <a class="el" href="../../d9/d1f/binary__addition_8cpp_source.html">binary_addition.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 86</span> {</div>
<div class="line"><span class="lineno"> 87</span> <a class="code hl_class" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html">greedy_algorithms::BinaryAddition</a> binaryAddition;</div>
<div class="line"><span class="lineno"> 88</span> </div>
<div class="line"><span class="lineno"> 89</span> <span class="comment">// Valid binary string tests</span></div>
<div class="line"><span class="lineno"> 90</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;1010&quot;</span>, <span class="stringliteral">&quot;1101&quot;</span>) == <span class="stringliteral">&quot;10111&quot;</span>);</div>
<div class="line"><span class="lineno"> 91</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;1111&quot;</span>, <span class="stringliteral">&quot;1111&quot;</span>) == <span class="stringliteral">&quot;11110&quot;</span>);</div>
<div class="line"><span class="lineno"> 92</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;101&quot;</span>, <span class="stringliteral">&quot;11&quot;</span>) == <span class="stringliteral">&quot;1000&quot;</span>);</div>
<div class="line"><span class="lineno"> 93</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;0&quot;</span>, <span class="stringliteral">&quot;0&quot;</span>) == <span class="stringliteral">&quot;0&quot;</span>);</div>
<div class="line"><span class="lineno"> 94</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;1111&quot;</span>, <span class="stringliteral">&quot;1111&quot;</span>) == <span class="stringliteral">&quot;11110&quot;</span>);</div>
<div class="line"><span class="lineno"> 95</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;0&quot;</span>, <span class="stringliteral">&quot;10101&quot;</span>) == <span class="stringliteral">&quot;10101&quot;</span>);</div>
<div class="line"><span class="lineno"> 96</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;10101&quot;</span>, <span class="stringliteral">&quot;0&quot;</span>) == <span class="stringliteral">&quot;10101&quot;</span>);</div>
<div class="line"><span class="lineno"> 97</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;101010101010101010101010101010&quot;</span>,</div>
<div class="line"><span class="lineno"> 98</span> <span class="stringliteral">&quot;110110110110110110110110110110&quot;</span>) ==</div>
<div class="line"><span class="lineno"> 99</span> <span class="stringliteral">&quot;1100001100001100001100001100000&quot;</span>);</div>
<div class="line"><span class="lineno"> 100</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;1&quot;</span>, <span class="stringliteral">&quot;11111111&quot;</span>) == <span class="stringliteral">&quot;100000000&quot;</span>);</div>
<div class="line"><span class="lineno"> 101</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;10101010&quot;</span>, <span class="stringliteral">&quot;01010101&quot;</span>) == <span class="stringliteral">&quot;11111111&quot;</span>);</div>
<div class="line"><span class="lineno"> 102</span> </div>
<div class="line"><span class="lineno"> 103</span> <span class="comment">// Invalid binary string tests (should return empty string)</span></div>
<div class="line"><span class="lineno"> 104</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;10102&quot;</span>, <span class="stringliteral">&quot;1101&quot;</span>) == <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><span class="lineno"> 105</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;ABC&quot;</span>, <span class="stringliteral">&quot;1101&quot;</span>) == <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><span class="lineno"> 106</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;1010&quot;</span>, <span class="stringliteral">&quot;1102&quot;</span>) == <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><span class="lineno"> 107</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;111&quot;</span>, <span class="stringliteral">&quot;1x1&quot;</span>) == <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><span class="lineno"> 108</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;1x1&quot;</span>, <span class="stringliteral">&quot;111&quot;</span>) == <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><span class="lineno"> 109</span> assert(binaryAddition.<a class="code hl_function" href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">addBinary</a>(<span class="stringliteral">&quot;1234&quot;</span>, <span class="stringliteral">&quot;1101&quot;</span>) == <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><span class="lineno"> 110</span>}</div>
<div class="ttc" id="aclassgreedy__algorithms_1_1_binary_addition_html"><div class="ttname"><a href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html">greedy_algorithms::BinaryAddition</a></div><div class="ttdoc">A class to perform binary addition of two binary strings.</div><div class="ttdef"><b>Definition</b> <a href="../../d9/d1f/binary__addition_8cpp_source.html#l00031">binary_addition.cpp:31</a></div></div>
<div class="ttc" id="aclassgreedy__algorithms_1_1_binary_addition_html_a801fd1ec5cda76b0bb82cbf23ed4d527"><div class="ttname"><a href="../../de/df6/classgreedy__algorithms_1_1_binary_addition.html#a801fd1ec5cda76b0bb82cbf23ed4d527">greedy_algorithms::BinaryAddition::addBinary</a></div><div class="ttdeci">std::string addBinary(const std::string &amp;a, const std::string &amp;b)</div><div class="ttdoc">Adds two binary strings and returns the result as a binary string.</div><div class="ttdef"><b>Definition</b> <a href="../../d9/d1f/binary__addition_8cpp_source.html#l00040">binary_addition.cpp:40</a></div></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="../../dir_0eaa691bd54ab0922ca7f50599de6d22.html">greedy_algorithms</a></li><li class="navelem"><a class="el" href="../../d9/d1f/binary__addition_8cpp.html">binary_addition.cpp</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>