backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-03-24 05:42:59 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for 05bb23ca27

Browse Source
This commit is contained in:
github-actions
2020-07-10 16:50:36 +00:00
parent 2936d28962
commit fc46f441ae
172 changed files with 6067 additions and 3376 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html
View File

@@ -142,7 +142,7 @@ Test</h3>
<ul>
<li>Make sure to add examples and test cases in your <a class="el" href="../../d7/db9/hill__cipher_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a> function.</li>
<li>If you find any algorithm or document without tests, please feel free to create a pull request or issue describing suggested changes.</li>
<li>Please try to add one or more <code><a class="el" href="../../d4/d5d/math_2armstrong__number_8cpp.html#ae1a3968e7947464bee7714f6d43b7002">test()</a></code> functions that will invoke the algorithm implementation on random test data with expected output. Use <code>assert()</code> function to confirm that the tests will pass.</li>
<li>Please try to add one or more <code><a class="el" href="../../da/dd3/namespacespirograph.html#a8e83a64e8443fff1e5ffdc1c299c1e99" title="Test function to save resulting points to a CSV file.">test()</a></code> functions that will invoke the algorithm implementation on random test data with expected output. Use <code>assert()</code> function to confirm that the tests will pass.</li>
</ul>
<h3><a class="anchor" id="autotoc_md8"></a>
Typical structure of a program:</h3>
@@ -194,7 +194,7 @@ Typical structure of a program:</h3>
<div class="line">}</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment">/** Test function */</span></div>
<div class="line"><span class="keywordtype">void</span> <a class="code" href="../../d4/d5d/math_2armstrong__number_8cpp.html#ae1a3968e7947464bee7714f6d43b7002">test</a>() {</div>
<div class="line"><span class="keywordtype">void</span> <a class="code" href="../../da/dd3/namespacespirograph.html#a8e83a64e8443fff1e5ffdc1c299c1e99">test</a>() {</div>
<div class="line"> <span class="comment">/* some statements */</span></div>
<div class="line"> assert(func(...) == ...); <span class="comment">// this ensures that the algorithm works as expected </span></div>
<div class="line"> </div>
@@ -269,7 +269,7 @@ cpplint</h3>
</div><!-- PageDoc -->
</div><!-- doc-content -->
<div class="ttc" id="ahill__cipher_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../d7/db9/hill__cipher_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition:</b> hill_cipher.cpp:532</div></div>
<div class="ttc" id="amath_2armstrong__number_8cpp_html_ae1a3968e7947464bee7714f6d43b7002"><div class="ttname"><a href="../../d4/d5d/math_2armstrong__number_8cpp.html#ae1a3968e7947464bee7714f6d43b7002">test</a></div><div class="ttdeci">void test()</div><div class="ttdef"><b>Definition:</b> armstrong_number.cpp:59</div></div>
<div class="ttc" id="anamespacespirograph_html_a8e83a64e8443fff1e5ffdc1c299c1e99"><div class="ttname"><a href="../../da/dd3/namespacespirograph.html#a8e83a64e8443fff1e5ffdc1c299c1e99">spirograph::test</a></div><div class="ttdeci">void test()</div><div class="ttdoc">Test function to save resulting points to a CSV file.</div><div class="ttdef"><b>Definition:</b> spirograph.cpp:93</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>