Documentation for cf562f2244

This commit is contained in:
github-actions
2020-07-20 17:54:05 +00:00
parent 503969d198
commit 280fc90fce
171 changed files with 3435 additions and 2637 deletions

View File

@@ -96,10 +96,10 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
<div class="contents">
<div class="textblock"><p><a class="anchor" id="mainpage"></a></p>
<p><a href="https://gitpod.io/#https://github.com/TheAlgorithms/C-Plus-Plus"><img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code" class="inline"/></a> <a href="https://lgtm.com/projects/g/TheAlgorithms/C-Plus-Plus/context:cpp"><img src="https://img.shields.io/lgtm/grade/cpp/g/TheAlgorithms/C-Plus-Plus.svg?logo=lgtm&amp;logoWidth=18" alt="Language grade: C/C++" style="pointer-events: none;" class="inline"/></a> <a href="https://gitter.im/TheAlgorithms"><img src="https://img.shields.io/badge/Chat-Gitter-ff69b4.svg?label=Chat&amp;logo=gitter&amp;style=flat-square" alt="Gitter chat" style="pointer-events: none;" class="inline"/></a> <a href="https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md"><img src="https://img.shields.io/static/v1.svg?label=Contributions&amp;message=Welcome&amp;color=0059b3&amp;style=flat-square" alt="contributions welcome" style="pointer-events: none;" class="inline"/></a> <img src="https://img.shields.io/github/repo-size/TheAlgorithms/C-Plus-Plus?color=red&amp;style=flat-square" alt="GitHub repo size" class="inline"/> <a href="https://TheAlgorithms.github.io/C-Plus-Plus"><img src="https://github.com/TheAlgorithms/C-Plus-Plus/workflows/Doxygen%20CI/badge.svg" alt="Doxygen CI" style="pointer-events: none;" class="inline"/></a> <a href="https://github.com/TheAlgorithms/C-Plus-Plus/actions?query=workflow%3A%22Awesome+CI+Workflow%22"><img src="https://github.com/TheAlgorithms/C-Plus-Plus/workflows/Awesome%20CI%20Workflow/badge.svg" alt="Awesome CI" style="pointer-events: none;" class="inline"/></a></p>
<h1><a class="anchor" id="autotoc_md38"></a>
<h1><a class="anchor" id="autotoc_md39"></a>
Overview</h1>
<p>The repository is a collection of open-source implementation of a variety of algorithms implemented in C++ and licensed under <a href="https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/LICENSE">MIT License</a>. The algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations and the associated documentation are meant to provide a learning resource for educators and students. Hence, one may find more than one implementation for the same objective but using a different algorithm strategies and optimizations.</p>
<h1><a class="anchor" id="autotoc_md39"></a>
<h1><a class="anchor" id="autotoc_md40"></a>
Features</h1>
<ul>
<li>The repository provides implementations of various algorithms in one of the most fundamental general purpose languages - <a href="https://en.wikipedia.org/wiki/C%2B%2B">C++</a>.</li>
@@ -110,12 +110,12 @@ Features</h1>
<li>Self-checks within programs ensure correct implementations with confidence.</li>
<li>Modular implementations and OpenSource licensing enable the functions to be utilized conveniently in other applications.</li>
</ul>
<h1><a class="anchor" id="autotoc_md40"></a>
<h1><a class="anchor" id="autotoc_md41"></a>
Documentation</h1>
<p><a href="https://TheAlgorithms.github.io/C-Plus-Plus">Online Documentation</a> is generated from the repository source codes directly. The documentation contains all resources including source code snippets, details on execution of the programs, diagrammatic representation of program flow, and links to external resources where necessary. The documentation also introduces interactive source code with links to documentation for C++ STL library functions used. Click on <a href="https://TheAlgorithms.github.io/C-Plus-Plus/files.html">Files menu</a> to see the list of all the files documented with the code.</p>
<p><a href="https://thealgorithms.github.io/C-Plus-Plus">Documentation of Algorithms in C++</a> by <a href="https://github.com/TheAlgorithms/C-Plus-Plus/graphs/contributors">The Algorithms Contributors</a> is licensed under <a href="https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1">CC BY-SA 4.0</a><br />
<a href="https://creativecommons.org/licenses/by-sa/4.0"><img src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt="Creative Commons License" style="pointer-events: none; height:22px!important;margin-left: 3px;vertical-align:text-bottom;" class="inline"/><img src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt="Credit must be given to the creator" style="pointer-events: none; height:22px!important;margin-left: 3px;vertical-align:text-bottom;" class="inline"/><img src="https://mirrors.creativecommons.org/presskit/icons/sa.svg" alt="Adaptations must be shared under the same terms" style="pointer-events: none; height:22px!important;margin-left: 3px;vertical-align:text-bottom;" class="inline"/></a></p>
<h1><a class="anchor" id="autotoc_md41"></a>
<h1><a class="anchor" id="autotoc_md42"></a>
Contributions</h1>
<p>As a community developed and maintained repository, we welcome new un-plagiarized quality contributions. Please read our <a href="https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md">Contribution Guidelines</a>. </p>
</div></div><!-- PageDoc -->