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/knuth_morris_pratt.cpp File Reference</title>
<title>TheAlgorithms/C++: strings/knuth_morris_pratt.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>
@@ -122,7 +139,9 @@ Include dependency graph for knuth_morris_pratt.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../de/d69/knuth__morris__pratt_8cpp__incl.svg" width="331" 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="../../de/d6a/knuth__morris__pratt_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="../../d9/d03/namespacestring__search.html">string_search</a></td></tr>
@@ -131,10 +150,10 @@ Namespaces</h2></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:a83c72ff237cdf623e42d4295e0029bf9" id="r_a83c72ff237cdf623e42d4295e0029bf9"><td class="memItemLeft" align="right" valign="top"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d03/namespacestring__search.html#a83c72ff237cdf623e42d4295e0029bf9">string_search::getFailureArray</a> (const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;pattern)</td></tr>
<tr class="memitem:a83c72ff237cdf623e42d4295e0029bf9" id="r_a83c72ff237cdf623e42d4295e0029bf9"><td class="memItemLeft" align="right" valign="top">std::vector&lt; size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d03/namespacestring__search.html#a83c72ff237cdf623e42d4295e0029bf9">string_search::getFailureArray</a> (const std::string &amp;pattern)</td></tr>
<tr class="memdesc:a83c72ff237cdf623e42d4295e0029bf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate the partial match table aka failure function for a pattern to search. <br /></td></tr>
<tr class="separator:a83c72ff237cdf623e42d4295e0029bf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e37af2f023495129cb57338c801209e" id="r_a1e37af2f023495129cb57338c801209e"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d03/namespacestring__search.html#a1e37af2f023495129cb57338c801209e">string_search::kmp</a> (const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;pattern, const <a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> &amp;text)</td></tr>
<tr class="memitem:a1e37af2f023495129cb57338c801209e" id="r_a1e37af2f023495129cb57338c801209e"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d03/namespacestring__search.html#a1e37af2f023495129cb57338c801209e">string_search::kmp</a> (const std::string &amp;pattern, const std::string &amp;text)</td></tr>
<tr class="memdesc:a1e37af2f023495129cb57338c801209e"><td class="mdescLeft">&#160;</td><td class="mdescRight">KMP algorithm to find a pattern in a text. <br /></td></tr>
<tr class="separator:a1e37af2f023495129cb57338c801209e"><td class="memSeparator" colspan="2">&#160;</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>
@@ -150,6 +169,8 @@ Functions</h2></td></tr>
<li>Step through the text one character at a time and compare it to a character in the pattern updating our location within the pattern if necessary <dl class="section author"><dt>Author</dt><dd><a href="https://github.com/Yancey2023" target="_blank">Yancey</a> </dd></dl>
</li>
</ol>
<p class="definition">Definition in file <a class="el" href="../../de/d6a/knuth__morris__pratt_8cpp_source.html">knuth_morris_pratt.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>
@@ -165,11 +186,13 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/d6a/knuth__morris__pratt_8cpp_source.html#l00095">95</a> of file <a class="el" href="../../de/d6a/knuth__morris__pratt_8cpp_source.html">knuth_morris_pratt.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 95</span> {</div>
<div class="line"><span class="lineno"> 96</span> <a class="code hl_function" href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a>();</div>
<div class="line"><span class="lineno"> 97</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 98</span>}</div>
<div class="ttc" id="aknuth__morris__pratt_8cpp_html_a483bb8ccf42aaf7375a83e91490eda1e"><div class="ttname"><a href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a></div><div class="ttdeci">static void tests()</div><div class="ttdoc">self-test implementations</div><div class="ttdef"><b>Definition</b> knuth_morris_pratt.cpp:79</div></div>
<div class="ttc" id="aknuth__morris__pratt_8cpp_html_a483bb8ccf42aaf7375a83e91490eda1e"><div class="ttname"><a href="#a483bb8ccf42aaf7375a83e91490eda1e">tests</a></div><div class="ttdeci">static void tests()</div><div class="ttdoc">self-test implementations</div><div class="ttdef"><b>Definition</b> <a href="../../de/d6a/knuth__morris__pratt_8cpp_source.html#l00079">knuth_morris_pratt.cpp:79</a></div></div>
</div><!-- fragment -->
</div>
</div>
@@ -198,6 +221,8 @@ Functions</h2></td></tr>
<p>self-test implementations </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/d6a/knuth__morris__pratt_8cpp_source.html#l00079">79</a> of file <a class="el" href="../../de/d6a/knuth__morris__pratt_8cpp_source.html">knuth_morris_pratt.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 79</span> {</div>
<div class="line"><span class="lineno"> 80</span> assert(kmp(<span class="stringliteral">&quot;abc1abc12l&quot;</span>, <span class="stringliteral">&quot;alskfjaldsabc1abc1abc12k2&quot;</span>) == std::string::npos);</div>
<div class="line"><span class="lineno"> 81</span> assert(kmp(<span class="stringliteral">&quot;bca&quot;</span>, <span class="stringliteral">&quot;abcabc&quot;</span>) == 1);</div>
@@ -207,9 +232,8 @@ Functions</h2></td></tr>
<div class="line"><span class="lineno"> 85</span> assert(kmp(<span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;pattern is empty&quot;</span>) == 0);</div>
<div class="line"><span class="lineno"> 86</span> </div>
<div class="line"><span class="lineno"> 87</span> <span class="comment">// this lets the user know that the tests have passed</span></div>
<div class="line"><span class="lineno"> 88</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 KMP algorithm tests have successfully passed!\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 88</span> std::cout &lt;&lt; <span class="stringliteral">&quot;All KMP algorithm tests have successfully passed!\n&quot;</span>;</div>
<div class="line"><span class="lineno"> 89</span>}</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><!-- fragment -->
</div>
</div>