Documentation for 8b1eab204b

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

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++: greedy_algorithms/digit_separation.cpp File Reference</title>
<title>TheAlgorithms/C++: greedy_algorithms/digit_separation.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>
@@ -125,7 +142,9 @@ Include dependency graph for digit_separation.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d9/d47/digit__separation_8cpp__incl.svg" width="515" 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="../../d3/d36/digit__separation_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="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html">greedy_algorithms::DigitSeparation</a></td></tr>
@@ -151,6 +170,8 @@ Functions</h2></td></tr>
<div class="textblock"><p>Separates digits from numbers in forward and reverse order. </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://www.log2base2.com/c-examples/loop/split-a-number-into-digits-in-c.html">https://www.log2base2.com/c-examples/loop/split-a-number-into-digits-in-c.html</a></dd></dl>
<p>The DigitSeparation class provides two methods to separate the digits of large integers: digitSeparationReverseOrder and digitSeparationForwardOrder. The digitSeparationReverseOrder method extracts digits by repeatedly applying the modulus operation (% 10) to isolate the last digit, then divides the number by 10 to remove it. This process continues until the entire number is broken down into its digits, which are stored in reverse order. If the number is zero, the method directly returns a vector containing {0} to handle this edge case. Negative numbers are handled by taking the absolute value, ensuring consistent behavior regardless of the sign. </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="../../d3/d36/digit__separation_8cpp_source.html">digit_separation.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>
@@ -169,18 +190,15 @@ Functions</h2></td></tr>
<p>main function </p>
<dl class="section return"><dt>Returns</dt><dd>0 on successful exit </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d3/d36/digit__separation_8cpp_source.html#l00138">138</a> of file <a class="el" href="../../d3/d36/digit__separation_8cpp_source.html">digit_separation.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 138</span> {</div>
<div class="line"><span class="lineno"> 139</span> <a class="code hl_function" href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a>(); <span class="comment">// run self test implementation</span></div>
<div class="line"><span class="lineno"> 140</span> </div>
<div class="line"><span class="lineno"> 141</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 142</span>}</div>
<div class="ttc" id="adigit__separation_8cpp_html_a483bb8ccf42aaf7375a83e91490eda1e"><div class="ttname"><a href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a></div><div class="ttdeci">static void tests()</div><div class="ttdoc">self test implementation</div><div class="ttdef"><b>Definition</b> digit_separation.cpp:83</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="../../d3/d36/digit__separation_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="663" height="132"><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="adigit__separation_8cpp_html_a483bb8ccf42aaf7375a83e91490eda1e"><div class="ttname"><a href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a></div><div class="ttdeci">static void tests()</div><div class="ttdoc">self test implementation</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d36/digit__separation_8cpp_source.html#l00083">digit_separation.cpp:83</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a483bb8ccf42aaf7375a83e91490eda1e" name="a483bb8ccf42aaf7375a83e91490eda1e"></a>
@@ -208,17 +226,19 @@ Here is the call graph for this function:</div>
<p>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="../../d3/d36/digit__separation_8cpp_source.html#l00083">83</a> of file <a class="el" href="../../d3/d36/digit__separation_8cpp_source.html">digit_separation.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 83</span> {</div>
<div class="line"><span class="lineno"> 84</span> <a class="code hl_class" href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html">greedy_algorithms::DigitSeparation</a> ds;</div>
<div class="line"><span class="lineno"> 85</span> </div>
<div class="line"><span class="lineno"> 86</span> <span class="comment">// Test case: Positive number</span></div>
<div class="line"><span class="lineno"> 87</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a> number = 1234567890;</div>
<div class="line"><span class="lineno"> 88</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;std::int64_t&gt;</a> expectedReverse = {0, 9, 8, 7, 6, 5, 4, 3, 2, 1};</div>
<div class="line"><span class="lineno"> 89</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;std::int64_t&gt;</a> expectedForward = {1, 2, 3, 4, 5, 6, 7, 8, 9, 0};</div>
<div class="line"><span class="lineno"> 90</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;std::int64_t&gt;</a> reverseOrder =</div>
<div class="line"><span class="lineno"> 87</span> std::int64_t number = 1234567890;</div>
<div class="line"><span class="lineno"> 88</span> std::vector&lt;std::int64_t&gt; expectedReverse = {0, 9, 8, 7, 6, 5, 4, 3, 2, 1};</div>
<div class="line"><span class="lineno"> 89</span> std::vector&lt;std::int64_t&gt; expectedForward = {1, 2, 3, 4, 5, 6, 7, 8, 9, 0};</div>
<div class="line"><span class="lineno"> 90</span> std::vector&lt;std::int64_t&gt; reverseOrder =</div>
<div class="line"><span class="lineno"> 91</span> ds.<a class="code hl_function" href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html#a34769a780845e9d4279152899bd3bf79">digitSeparationReverseOrder</a>(number);</div>
<div class="line"><span class="lineno"> 92</span> assert(reverseOrder == expectedReverse);</div>
<div class="line"><span class="lineno"> 93</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;std::int64_t&gt;</a> forwardOrder =</div>
<div class="line"><span class="lineno"> 93</span> std::vector&lt;std::int64_t&gt; forwardOrder =</div>
<div class="line"><span class="lineno"> 94</span> ds.<a class="code hl_function" href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html#a1809ae6828223999374bde5b197a59c8">digitSeparationForwardOrder</a>(number);</div>
<div class="line"><span class="lineno"> 95</span> assert(forwardOrder == expectedForward);</div>
<div class="line"><span class="lineno"> 96</span> </div>
@@ -258,17 +278,10 @@ Here is the call graph for this function:</div>
<div class="line"><span class="lineno"> 130</span> forwardOrder = ds.<a class="code hl_function" href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html#a1809ae6828223999374bde5b197a59c8">digitSeparationForwardOrder</a>(number);</div>
<div class="line"><span class="lineno"> 131</span> assert(forwardOrder == expectedForward);</div>
<div class="line"><span class="lineno"> 132</span>}</div>
<div class="ttc" id="aclassgreedy__algorithms_1_1_digit_separation_html"><div class="ttname"><a href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html">greedy_algorithms::DigitSeparation</a></div><div class="ttdoc">A class that provides methods to separate the digits of a large positive number.</div><div class="ttdef"><b>Definition</b> digit_separation.cpp:35</div></div>
<div class="ttc" id="aclassgreedy__algorithms_1_1_digit_separation_html_a1809ae6828223999374bde5b197a59c8"><div class="ttname"><a href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html#a1809ae6828223999374bde5b197a59c8">greedy_algorithms::DigitSeparation::digitSeparationForwardOrder</a></div><div class="ttdeci">std::vector&lt; std::int64_t &gt; digitSeparationForwardOrder(std::int64_t largeNumber) const</div><div class="ttdoc">Implementation of digitSeparationForwardOrder method.</div><div class="ttdef"><b>Definition</b> digit_separation.cpp:68</div></div>
<div class="ttc" id="aclassgreedy__algorithms_1_1_digit_separation_html_a34769a780845e9d4279152899bd3bf79"><div class="ttname"><a href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html#a34769a780845e9d4279152899bd3bf79">greedy_algorithms::DigitSeparation::digitSeparationReverseOrder</a></div><div class="ttdeci">std::vector&lt; std::int64_t &gt; digitSeparationReverseOrder(std::int64_t largeNumber) const</div><div class="ttdoc">Implementation of digitSeparationReverseOrder method.</div><div class="ttdef"><b>Definition</b> digit_separation.cpp:48</div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a></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="../../d3/d36/digit__separation_8cpp_a483bb8ccf42aaf7375a83e91490eda1e_cgraph.svg" width="566" height="132"><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="aclassgreedy__algorithms_1_1_digit_separation_html"><div class="ttname"><a href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html">greedy_algorithms::DigitSeparation</a></div><div class="ttdoc">A class that provides methods to separate the digits of a large positive number.</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d36/digit__separation_8cpp_source.html#l00035">digit_separation.cpp:35</a></div></div>
<div class="ttc" id="aclassgreedy__algorithms_1_1_digit_separation_html_a1809ae6828223999374bde5b197a59c8"><div class="ttname"><a href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html#a1809ae6828223999374bde5b197a59c8">greedy_algorithms::DigitSeparation::digitSeparationForwardOrder</a></div><div class="ttdeci">std::vector&lt; std::int64_t &gt; digitSeparationForwardOrder(std::int64_t largeNumber) const</div><div class="ttdoc">Implementation of digitSeparationForwardOrder method.</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d36/digit__separation_8cpp_source.html#l00068">digit_separation.cpp:68</a></div></div>
<div class="ttc" id="aclassgreedy__algorithms_1_1_digit_separation_html_a34769a780845e9d4279152899bd3bf79"><div class="ttname"><a href="../../da/d49/classgreedy__algorithms_1_1_digit_separation.html#a34769a780845e9d4279152899bd3bf79">greedy_algorithms::DigitSeparation::digitSeparationReverseOrder</a></div><div class="ttdeci">std::vector&lt; std::int64_t &gt; digitSeparationReverseOrder(std::int64_t largeNumber) const</div><div class="ttdoc">Implementation of digitSeparationReverseOrder method.</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d36/digit__separation_8cpp_source.html#l00048">digit_separation.cpp:48</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->