backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-21 20:31:43 +08:00
Code Issues Projects Releases Wiki Activity
Files
14583a2f33720eba2e2786d75e8e2312b85fa667
C-Plus-Plus/db/d09/duval_8cpp.html
realstealthninja 14583a2f33 Documentation for c26eea874d
2025-05-19 11:38:33 +00:00

278 lines
18 KiB
HTML
Raw Blame History

<!-- 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<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>
<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.13.2 -->
<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('db/d09/duval_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="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">duval.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Implementation of <a href="https://en.wikipedia.org/wiki/Lyndon_word" target="_blank">Duval's algorithm</a>.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;array&gt;</code><br />
<code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cstddef&gt;</code><br />
<code>#include &lt;deque&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
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>
<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>
<tr class="memdesc:d6/dd6/namespacestring"><td class="mdescLeft">&#160;</td><td class="mdescRight">string manipulation algorithms <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:ac2a35302e6bed93c4b2c6f55a21a5632" id="r_ac2a35302e6bed93c4b2c6f55a21a5632"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
<tr class="memitem:ac2a35302e6bed93c4b2c6f55a21a5632"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d6/dd6/namespacestring.html#ac2a35302e6bed93c4b2c6f55a21a5632">string::duval</a> (const T &amp;s)</td></tr>
<tr class="memdesc:ac2a35302e6bed93c4b2c6f55a21a5632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the lexicographically smallest cyclic shift of a sequence. <br /></td></tr>
<tr class="separator:ac2a35302e6bed93c4b2c6f55a21a5632"><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">self test implementation returns void <br /></td></tr>
<tr class="separator:aa8dca7b867074164d5f45b0f3851269d"><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>Implementation of <a href="https://en.wikipedia.org/wiki/Lyndon_word" target="_blank">Duval's algorithm</a>. </p>
<p>Duval's algorithm is an algorithm to find the lexicographically smallest rotation of a string. It is based on the concept of Lyndon words. Lyndon words are defined as the lexicographically smallest string in a rotation equivalence class. A rotation equivalence class is a set of strings that can be obtained by rotating a string. For example, the rotation equivalence class of "abc" is {"abc", "bca", "cab"}. The lexicographically smallest string in this class is "abc".</p>
<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>
<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 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> <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>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f3851269d">&#9670;&#160;</a></span>test()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void test </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">static</span></span> </td>
</tr>
</table>
</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> 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> 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> 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> 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> 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> 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> 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> 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="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 -->
</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_73a3cc5065b223eb41b02873c0e19f0e.html">strings</a></li><li class="navelem"><a class="el" href="../../db/d09/duval_8cpp.html">duval.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.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink