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++: strings/duval.cpp File Reference</title>
<title>TheAlgorithms/C++: strings/duval.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 duval.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d0/d52/duval_8cpp__incl.svg" width="572" height="111"><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="../../db/d09/duval_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="../../d6/dd6/namespacestring.html">string</a></td></tr>
@@ -151,6 +170,8 @@ Functions</h2></td></tr>
<p>Duval's algorithm works by iterating over the string and finding the smallest rotation of the string that is a Lyndon word. This is done by comparing the string with its suffixes and finding the smallest suffix that is lexicographically smaller than the string. This suffix is then added to the result and the process is repeated with the remaining string. The algorithm has a time complexity of O(n) where n is the length of the string.</p>
<dl class="section note"><dt>Note</dt><dd>While Lyndon words are described in the context of strings, Duval's algorithm can be used to find the lexicographically smallest cyclic shift of any sequence of comparable elements.</dd></dl>
<dl class="section author"><dt>Author</dt><dd><a href="https://github.com/aminegh20" target="_blank">Amine Ghoussaini</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../db/d09/duval_8cpp_source.html">duval.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,17 +190,14 @@ Functions</h2></td></tr>
<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="../../db/d09/duval_8cpp_source.html#l00115">115</a> of file <a class="el" href="../../db/d09/duval_8cpp_source.html">duval.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 115</span> {</div>
<div class="line"><span class="lineno"> 116</span> <a class="code hl_function" href="#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self test implementations</span></div>
<div class="line"><span class="lineno"> 117</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 118</span>}</div>
<div class="ttc" id="aduval_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">self test implementation returns void</div><div class="ttdef"><b>Definition</b> duval.cpp:77</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="../../db/d09/duval_8cpp_ae66f6b31b5ad750f1fe042a706a4e3d4_cgraph.svg" width="271" height="36"><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="aduval_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">self test implementation returns void</div><div class="ttdef"><b>Definition</b> <a href="../../db/d09/duval_8cpp_source.html#l00077">duval.cpp:77</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aa8dca7b867074164d5f45b0f3851269d" name="aa8dca7b867074164d5f45b0f3851269d"></a>
@@ -206,53 +224,44 @@ Here is the call graph for this function:</div>
</div><div class="memdoc">
<p>self test implementation returns void </p>
<p class="definition">Definition at line <a class="el" href="../../db/d09/duval_8cpp_source.html#l00077">77</a> of file <a class="el" href="../../db/d09/duval_8cpp_source.html">duval.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 77</span> {</div>
<div class="line"><span class="lineno"> 78</span> <span class="keyword">using namespace </span><a class="code hl_namespace" href="../../d6/dd6/namespacestring.html">string</a>;</div>
<div class="line"><span class="lineno"> 79</span> </div>
<div class="line"><span class="lineno"> 80</span> <span class="comment">// Test 1</span></div>
<div class="line"><span class="lineno"> 81</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> s1 = <span class="stringliteral">&quot;abcab&quot;</span>;</div>
<div class="line"><span class="lineno"> 81</span> std::string s1 = <span class="stringliteral">&quot;abcab&quot;</span>;</div>
<div class="line"><span class="lineno"> 82</span> assert(<a class="code hl_function" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">duval</a>(s1) == 3);</div>
<div class="line"><span class="lineno"> 83</span> </div>
<div class="line"><span class="lineno"> 84</span> <span class="comment">// Test 2</span></div>
<div class="line"><span class="lineno"> 85</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> s2 = <span class="stringliteral">&quot;011100&quot;</span>;</div>
<div class="line"><span class="lineno"> 85</span> std::string s2 = <span class="stringliteral">&quot;011100&quot;</span>;</div>
<div class="line"><span class="lineno"> 86</span> assert(<a class="code hl_function" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">duval</a>(s2) == 4);</div>
<div class="line"><span class="lineno"> 87</span> </div>
<div class="line"><span class="lineno"> 88</span> <span class="comment">// Test 3</span></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;int&gt;</a> v = {5, 2, 1, 3, 4};</div>
<div class="line"><span class="lineno"> 89</span> std::vector&lt;int&gt; v = {5, 2, 1, 3, 4};</div>
<div class="line"><span class="lineno"> 90</span> assert(<a class="code hl_function" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">duval</a>(v) == 2);</div>
<div class="line"><span class="lineno"> 91</span> </div>
<div class="line"><span class="lineno"> 92</span> <span class="comment">// Test 4</span></div>
<div class="line"><span class="lineno"> 93</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/array.html">std::array&lt;int, 5&gt;</a> a = {1, 2, 3, 4, 5};</div>
<div class="line"><span class="lineno"> 93</span> std::array&lt;int, 5&gt; a = {1, 2, 3, 4, 5};</div>
<div class="line"><span class="lineno"> 94</span> assert(<a class="code hl_function" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">duval</a>(a) == 0);</div>
<div class="line"><span class="lineno"> 95</span> </div>
<div class="line"><span class="lineno"> 96</span> <span class="comment">// Test 5</span></div>
<div class="line"><span class="lineno"> 97</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/deque.html">std::deque&lt;char&gt;</a> d = {<span class="charliteral">&#39;a&#39;</span>, <span class="charliteral">&#39;z&#39;</span>, <span class="charliteral">&#39;c&#39;</span>, <span class="charliteral">&#39;a&#39;</span>, <span class="charliteral">&#39;b&#39;</span>};</div>
<div class="line"><span class="lineno"> 97</span> std::deque&lt;char&gt; d = {<span class="charliteral">&#39;a&#39;</span>, <span class="charliteral">&#39;z&#39;</span>, <span class="charliteral">&#39;c&#39;</span>, <span class="charliteral">&#39;a&#39;</span>, <span class="charliteral">&#39;b&#39;</span>};</div>
<div class="line"><span class="lineno"> 98</span> assert(<a class="code hl_function" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">duval</a>(d) == 3);</div>
<div class="line"><span class="lineno"> 99</span> </div>
<div class="line"><span class="lineno"> 100</span> <span class="comment">// Test 6</span></div>
<div class="line"><span class="lineno"> 101</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> s3;</div>
<div class="line"><span class="lineno"> 101</span> std::string s3;</div>
<div class="line"><span class="lineno"> 102</span> assert(<a class="code hl_function" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">duval</a>(s3) == 0);</div>
<div class="line"><span class="lineno"> 103</span> </div>
<div class="line"><span class="lineno"> 104</span> <span class="comment">// Test 7</span></div>
<div class="line"><span class="lineno"> 105</span> <a class="code hl_classRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;int&gt;</a> v2 = {5, 2, 1, 3, -4};</div>
<div class="line"><span class="lineno"> 105</span> std::vector&lt;int&gt; v2 = {5, 2, 1, 3, -4};</div>
<div class="line"><span class="lineno"> 106</span> assert(<a class="code hl_function" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">duval</a>(v2) == 4);</div>
<div class="line"><span class="lineno"> 107</span> </div>
<div class="line"><span class="lineno"> 108</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;All tests passed!&quot;</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> std::cout &lt;&lt; <span class="stringliteral">&quot;All tests passed!&quot;</span> &lt;&lt; std::endl;</div>
<div class="line"><span class="lineno"> 109</span>}</div>
<div class="ttc" id="aarray_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a></div></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="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="adeque_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/deque.html">std::deque</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="anamespacestring_html"><div class="ttname"><a href="../../d6/dd6/namespacestring.html">string</a></div><div class="ttdoc">string manipulation algorithms</div><div class="ttdef"><b>Definition</b> duval.cpp:41</div></div>
<div class="ttc" id="anamespacestring_html_ac2a35302e6bed93c4b2c6f55a21a5632"><div class="ttname"><a href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">string::duval</a></div><div class="ttdeci">size_t duval(const T &amp;s)</div><div class="ttdoc">Find the lexicographically smallest cyclic shift of a sequence.</div><div class="ttdef"><b>Definition</b> duval.cpp:49</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="../../db/d09/duval_8cpp_aa8dca7b867074164d5f45b0f3851269d_cgraph.svg" width="174" height="36"><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="anamespacestring_html"><div class="ttname"><a href="../../d6/dd6/namespacestring.html">string</a></div><div class="ttdoc">string manipulation algorithms</div><div class="ttdef"><b>Definition</b> <a href="../../db/d09/duval_8cpp_source.html#l00041">duval.cpp:41</a></div></div>
<div class="ttc" id="anamespacestring_html_ac2a35302e6bed93c4b2c6f55a21a5632"><div class="ttname"><a href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">string::duval</a></div><div class="ttdeci">size_t duval(const T &amp;s)</div><div class="ttdoc">Find the lexicographically smallest cyclic shift of a sequence.</div><div class="ttdef"><b>Definition</b> <a href="../../db/d09/duval_8cpp_source.html#l00049">duval.cpp:49</a></div></div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->