Skip to content

Commit

Permalink
Documentation for 769b3c7
Browse files Browse the repository at this point in the history
  • Loading branch information
@realstealthninja
realstealthninja committed Nov 17, 2024
1 parent bf38b9d commit dd58f60
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 14 deletions.
28 changes: 22 additions & 6 deletions d3/d80/z__function_8cpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a7
<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="../../d3/d80/z__function_8cpp_source.html#l00094">94</a> of file <a class="el" href="../../d3/d80/z__function_8cpp_source.html">z_function.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 94</span> {</div>
<div class="line"><span class="lineno"> 95</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"> 96</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 97</span>}</div>
<p class="definition">Definition at line <a class="el" href="../../d3/d80/z__function_8cpp_source.html#l00110">110</a> of file <a class="el" href="../../d3/d80/z__function_8cpp_source.html">z_function.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 110</span> {</div>
<div class="line"><span class="lineno"> 111</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"> 112</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><span class="lineno"> 113</span>}</div>
<div class="ttc" id="az__function_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d80/z__function_8cpp_source.html#l00072">z_function.cpp:72</a></div></div>
</div><!-- fragment -->
</div>
Expand Down Expand Up @@ -283,7 +283,23 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa8dca7b867074164d5f45b0f
<div class="line"><span class="lineno"> 85</span> <span class="comment">// matching_indexes2 gets the indexes where pattern2 exists in text2</span></div>
<div class="line"><span class="lineno"> 86</span> std::vector&lt;uint64_t&gt; matching_indexes2 = <a class="code hl_function" href="#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a>(pattern2, text2);</div>
<div class="line"><span class="lineno"> 87</span> assert((matching_indexes2 == std::vector&lt;uint64_t&gt;{}));</div>
<div class="line"><span class="lineno"> 88</span>}</div>
<div class="line"><span class="lineno"> 88</span> </div>
<div class="line"><span class="lineno"> 89</span> <span class="comment">// corner case - empty text</span></div>
<div class="line"><span class="lineno"> 90</span> std::string text3 = <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><span class="lineno"> 91</span> std::string pattern3 = <span class="stringliteral">&quot;abc&quot;</span>;</div>
<div class="line"><span class="lineno"> 92</span> </div>
<div class="line"><span class="lineno"> 93</span> <span class="comment">// matching_indexes3 gets the indexes where pattern3 exists in text3</span></div>
<div class="line"><span class="lineno"> 94</span> std::vector&lt;uint64_t&gt; matching_indexes3 = <a class="code hl_function" href="#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a>(pattern3, text3);</div>
<div class="line"><span class="lineno"> 95</span> assert((matching_indexes3 == std::vector&lt;uint64_t&gt;{}));</div>
<div class="line"><span class="lineno"> 96</span> </div>
<div class="line"><span class="lineno"> 97</span> <span class="comment">// corner case - empty pattern</span></div>
<div class="line"><span class="lineno"> 98</span> std::string text4 = <span class="stringliteral">&quot;redsand&quot;</span>;</div>
<div class="line"><span class="lineno"> 99</span> std::string pattern4 = <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><span class="lineno"> 100</span> </div>
<div class="line"><span class="lineno"> 101</span> <span class="comment">// matching_indexes4 gets the indexes where pattern4 exists in text4</span></div>
<div class="line"><span class="lineno"> 102</span> std::vector&lt;uint64_t&gt; matching_indexes4 = <a class="code hl_function" href="#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a>(pattern4, text4);</div>
<div class="line"><span class="lineno"> 103</span> assert((matching_indexes4 == std::vector&lt;uint64_t&gt;{0, 1, 2, 3, 4, 5, 6}));</div>
<div class="line"><span class="lineno"> 104</span>}</div>
<div class="ttc" id="az__function_8cpp_html_ac186ca3ac3a69b5e52543bb13fe46db8"><div class="ttname"><a href="#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a></div><div class="ttdeci">std::vector&lt; uint64_t &gt; find_pat_in_text(const std::string &amp;pattern, const std::string &amp;text)</div><div class="ttdoc">Using Z_function to find a pattern in a text.</div><div class="ttdef"><b>Definition</b> <a href="../../d3/d80/z__function_8cpp_source.html#l00054">z_function.cpp:54</a></div></div>
</div><!-- fragment -->
</div>
Expand Down
32 changes: 24 additions & 8 deletions d3/d80/z__function_8cpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,19 +189,35 @@
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// matching_indexes2 gets the indexes where pattern2 exists in text2</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> std::vector&lt;uint64_t&gt; matching_indexes2 = <a class="code hl_function" href="../../d3/d80/z__function_8cpp.html#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a>(pattern2, text2);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> assert((matching_indexes2 == std::vector&lt;uint64_t&gt;{}));</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>}</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// corner case - empty text</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> std::string text3 = <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> std::string pattern3 = <span class="stringliteral">&quot;abc&quot;</span>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="comment">// matching_indexes3 gets the indexes where pattern3 exists in text3</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> std::vector&lt;uint64_t&gt; matching_indexes3 = <a class="code hl_function" href="../../d3/d80/z__function_8cpp.html#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a>(pattern3, text3);</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> assert((matching_indexes3 == std::vector&lt;uint64_t&gt;{}));</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="comment">// corner case - empty pattern</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> std::string text4 = <span class="stringliteral">&quot;redsand&quot;</span>;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> std::string pattern4 = <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// matching_indexes4 gets the indexes where pattern4 exists in text4</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> std::vector&lt;uint64_t&gt; matching_indexes4 = <a class="code hl_function" href="../../d3/d80/z__function_8cpp.html#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a>(pattern4, text4);</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> assert((matching_indexes4 == std::vector&lt;uint64_t&gt;{0, 1, 2, 3, 4, 5, 6}));</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span>}</div>
</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="foldopen" id="foldopen00094" data-start="{" data-end="}">
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="../../d3/d80/z__function_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4"> 94</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="../../d3/d80/z__function_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_function" href="../../d3/d80/z__function_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>}</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="foldopen" id="foldopen00110" data-start="{" data-end="}">
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="../../d3/d80/z__function_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4"> 110</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="../../d3/d80/z__function_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <a class="code hl_function" href="../../d3/d80/z__function_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a>(); <span class="comment">// run self-test implementations</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keywordflow">return</span> 0;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span>}</div>
</div>
<div class="ttc" id="az__function_8cpp_html_aa8dca7b867074164d5f45b0f3851269d"><div class="ttname"><a href="../../d3/d80/z__function_8cpp.html#aa8dca7b867074164d5f45b0f3851269d">test</a></div><div class="ttdeci">static void test()</div><div class="ttdoc">Self-test implementations.</div><div class="ttdef"><b>Definition</b> <a href="#l00072">z_function.cpp:72</a></div></div>
<div class="ttc" id="az__function_8cpp_html_ac044c4794349a8cff6256b99950d5773"><div class="ttname"><a href="../../d3/d80/z__function_8cpp.html#ac044c4794349a8cff6256b99950d5773">Z_function</a></div><div class="ttdeci">std::vector&lt; uint64_t &gt; Z_function(const std::string &amp;pattern)</div><div class="ttdoc">for IO operations</div><div class="ttdef"><b>Definition</b> <a href="#l00029">z_function.cpp:29</a></div></div>
<div class="ttc" id="az__function_8cpp_html_ac186ca3ac3a69b5e52543bb13fe46db8"><div class="ttname"><a href="../../d3/d80/z__function_8cpp.html#ac186ca3ac3a69b5e52543bb13fe46db8">find_pat_in_text</a></div><div class="ttdeci">std::vector&lt; uint64_t &gt; find_pat_in_text(const std::string &amp;pattern, const std::string &amp;text)</div><div class="ttdoc">Using Z_function to find a pattern in a text.</div><div class="ttdef"><b>Definition</b> <a href="#l00054">z_function.cpp:54</a></div></div>
<div class="ttc" id="az__function_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../d3/d80/z__function_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdoc">Main function.</div><div class="ttdef"><b>Definition</b> <a href="#l00094">z_function.cpp:94</a></div></div>
<div class="ttc" id="az__function_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../d3/d80/z__function_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdoc">Main function.</div><div class="ttdef"><b>Definition</b> <a href="#l00110">z_function.cpp:110</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down

0 comments on commit dd58f60

Please sign in to comment.