Files
C-Plus-Plus/de/d6a/knuth__morris__pratt_8cpp.html
2025-05-19 11:38:33 +00:00

310 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!-- 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/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>
<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('de/d6a/knuth__morris__pratt_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">knuth_morris_pratt.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The <a href="https://en.wikipedia.org/wiki/KnuthMorrisPratt_algorithm" target="_blank">Knuth-Morris-Pratt Algorithm</a> for finding a pattern within a piece of text with complexity O(n + m)
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cassert&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 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>
<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>
<tr class="memdesc:d9/d03/namespacestring__search"><td class="mdescLeft">&#160;</td><td class="mdescRight">String search 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: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 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>
<tr class="memdesc:a483bb8ccf42aaf7375a83e91490eda1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">self-test implementations <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="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><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="#a1e37af2f023495129cb57338c801209e">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>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a href="https://en.wikipedia.org/wiki/KnuthMorrisPratt_algorithm" target="_blank">Knuth-Morris-Pratt Algorithm</a> for finding a pattern within a piece of text with complexity O(n + m) </p>
<ol type="1">
<li>Preprocess pattern to identify any suffixes that are identical to prefixes. This tells us where to continue from if we get a mismatch between a character in our pattern and the text.</li>
<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="a1e37af2f023495129cb57338c801209e" name="a1e37af2f023495129cb57338c801209e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e37af2f023495129cb57338c801209e">&#9670;&#160;</a></span>kmp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t string_search::kmp </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>pattern</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>text</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>KMP algorithm to find a pattern in a text. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pattern</td><td>string pattern to search </td></tr>
<tr><td class="paramname">text</td><td>text in which to search </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the starting index of the pattern if found </dd>
<dd>
<code>std::string::npos</code> if not found </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/d6a/knuth__morris__pratt_8cpp_source.html#l00053">53</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"> 53</span> {</div>
<div class="line"><span class="lineno"> 54</span> <span class="keywordflow">if</span> (pattern.empty()) {</div>
<div class="line"><span class="lineno"> 55</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 56</span> }</div>
<div class="line"><span class="lineno"> 57</span> std::vector&lt;size_t&gt; failure = <a class="code hl_function" href="../../d9/d03/namespacestring__search.html#a83c72ff237cdf623e42d4295e0029bf9">getFailureArray</a>(pattern);</div>
<div class="line"><span class="lineno"> 58</span> <span class="keywordtype">size_t</span> text_length = text.size();</div>
<div class="line"><span class="lineno"> 59</span> <span class="keywordtype">size_t</span> pattern_length = pattern.size();</div>
<div class="line"><span class="lineno"> 60</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="../../d4/d18/composite__simpson__rule_8cpp.html#a1b74d828b33760094906797042b89442">k</a> = 0;</div>
<div class="line"><span class="lineno"> 61</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> j = 0; j &lt; text_length; j++) {</div>
<div class="line"><span class="lineno"> 62</span> <span class="keywordflow">while</span> (k != std::string::npos &amp;&amp; pattern[k] != text[j]) {</div>
<div class="line"><span class="lineno"> 63</span> <a class="code hl_function" href="../../d4/d18/composite__simpson__rule_8cpp.html#a1b74d828b33760094906797042b89442">k</a> = failure[<a class="code hl_function" href="../../d4/d18/composite__simpson__rule_8cpp.html#a1b74d828b33760094906797042b89442">k</a>];</div>
<div class="line"><span class="lineno"> 64</span> }</div>
<div class="line"><span class="lineno"> 65</span> <span class="keywordflow">if</span> (++k == pattern_length) {</div>
<div class="line"><span class="lineno"> 66</span> <span class="keywordflow">return</span> j - <a class="code hl_function" href="../../d4/d18/composite__simpson__rule_8cpp.html#a1b74d828b33760094906797042b89442">k</a> + 1;</div>
<div class="line"><span class="lineno"> 67</span> }</div>
<div class="line"><span class="lineno"> 68</span> }</div>
<div class="line"><span class="lineno"> 69</span> <span class="keywordflow">return</span> std::string::npos;</div>
<div class="line"><span class="lineno"> 70</span>}</div>
<div class="ttc" id="acomposite__simpson__rule_8cpp_html_a1b74d828b33760094906797042b89442"><div class="ttname"><a href="../../d4/d18/composite__simpson__rule_8cpp.html#a1b74d828b33760094906797042b89442">numerical_methods::simpson_method::k</a></div><div class="ttdeci">double k(double x)</div><div class="ttdoc">Another test function.</div><div class="ttdef"><b>Definition</b> <a href="../../d4/d18/composite__simpson__rule_8cpp_source.html#l00117">composite_simpson_rule.cpp:117</a></div></div>
<div class="ttc" id="anamespacestring__search_html_a83c72ff237cdf623e42d4295e0029bf9"><div class="ttname"><a href="../../d9/d03/namespacestring__search.html#a83c72ff237cdf623e42d4295e0029bf9">string_search::getFailureArray</a></div><div class="ttdeci">std::vector&lt; size_t &gt; getFailureArray(const std::string &amp;pattern)</div><div class="ttdoc">Generate the partial match table aka failure function for a pattern to search.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d6a/knuth__morris__pratt_8cpp_source.html#l00032">knuth_morris_pratt.cpp:32</a></div></div>
</div><!-- fragment -->
</div>
</div>
<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 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> <a href="../../de/d6a/knuth__morris__pratt_8cpp_source.html#l00079">knuth_morris_pratt.cpp:79</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<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(<a class="code hl_function" href="#a1e37af2f023495129cb57338c801209e">kmp</a>(<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(<a class="code hl_function" href="#a1e37af2f023495129cb57338c801209e">kmp</a>(<span class="stringliteral">&quot;bca&quot;</span>, <span class="stringliteral">&quot;abcabc&quot;</span>) == 1);</div>
<div class="line"><span class="lineno"> 82</span> assert(<a class="code hl_function" href="#a1e37af2f023495129cb57338c801209e">kmp</a>(<span class="stringliteral">&quot;World&quot;</span>, <span class="stringliteral">&quot;helloWorld&quot;</span>) == 5);</div>
<div class="line"><span class="lineno"> 83</span> assert(<a class="code hl_function" href="#a1e37af2f023495129cb57338c801209e">kmp</a>(<span class="stringliteral">&quot;c++&quot;</span>, <span class="stringliteral">&quot;his_is_c++&quot;</span>) == 7);</div>
<div class="line"><span class="lineno"> 84</span> assert(<a class="code hl_function" href="#a1e37af2f023495129cb57338c801209e">kmp</a>(<span class="stringliteral">&quot;happy&quot;</span>, <span class="stringliteral">&quot;happy_coding&quot;</span>) == 0);</div>
<div class="line"><span class="lineno"> 85</span> assert(<a class="code hl_function" href="#a1e37af2f023495129cb57338c801209e">kmp</a>(<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> 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="aknuth__morris__pratt_8cpp_html_a1e37af2f023495129cb57338c801209e"><div class="ttname"><a href="#a1e37af2f023495129cb57338c801209e">kmp</a></div><div class="ttdeci">size_t kmp(const std::string &amp;pattern, const std::string &amp;text)</div><div class="ttdoc">KMP algorithm to find a pattern in a text.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d6a/knuth__morris__pratt_8cpp_source.html#l00053">knuth_morris_pratt.cpp:53</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="../../de/d6a/knuth__morris__pratt_8cpp.html">knuth_morris_pratt.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>