Documentation for 1cfb88c5eb

This commit is contained in:
github-actions 2023-03-01 02:33:13 +00:00
parent af36250fa0
commit 4f41d8e7a8
8 changed files with 27 additions and 30 deletions

View File

@ -367,6 +367,7 @@ Leetcode</h1>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/1657.c" target="_blank">1657</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/169.c" target="_blank">169</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/1695.c" target="_blank">1695</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/17.c" target="_blank">17</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/1704.c" target="_blank">1704</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/173.c" target="_blank">173</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/1752.c" target="_blank">1752</a></li>
@ -425,6 +426,7 @@ Leetcode</h1>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/404.c" target="_blank">404</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/42.c" target="_blank">42</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/442.c" target="_blank">442</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/45.c" target="_blank">45</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/461.c" target="_blank">461</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/476.c" target="_blank">476</a></li>
<li><a href="https://github.com/TheAlgorithms/C/blob/HEAD/leetcode/src/485.c" target="_blank">485</a></li>

View File

@ -183,7 +183,7 @@ Functions</h2></td></tr>
<p>Function: binary_search.</p>
<p>algorithm that search the index of the given item</p>
<p>recursive function that search the given element in </p>
<h2><a class="anchor" id="autotoc_md84"></a>
<h2><a class="anchor" id="autotoc_md83"></a>
the array using the &lt;a href="https://github.com/TheAlgorithms/Algorithms-Explanation/blob/master/en/Search%20Algorithms/Binary%20Search.md" target="_blank" &gt;Binary Search&lt;/a&gt;</h2>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
@ -253,7 +253,7 @@ Here is the call graph for this function:</div>
<p>Function: exponential_search.</p>
<p>algorithm that search the index of the given item</p>
<p>recursive function that take an array and quickly find the range </p>
<h2><a class="anchor" id="autotoc_md83"></a>
<h2><a class="anchor" id="autotoc_md82"></a>
where to apply the binary search algorithm to find the given element</h2>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">

View File

@ -127,12 +127,10 @@ $(document).ready(function(){initNavTree('df/d58/md_leetcode__r_e_a_d_m_e.html',
<li>Doxygen documentation isn't used in LeetCode solutions. Simple/small documentation or comments should be fine.</li>
<li>Don't include libraries/headers such as <code>stdio.h</code>. Your file should be the solution to the problem only.</li>
</ol>
<h2><a class="anchor" id="autotoc_md75"></a>
📜 Adding your new solution to the list 📜</h2>
<p>Great! You've added your solution. Now, you'll have to add it to <code>leetcode/DIRECTORY.md</code>.\ Please use numerical order. For example: if the solution's number is <code>98</code>, add your solution after <code>97</code>, if available.</p>
<p>This is the required format for new solutinos:</p>
<div class="fragment"><div class="line">| &lt;solution number&gt; | [&lt;solution name&gt;](&lt;leetcode link to problem&gt;) | [C](./src/&lt;filename&gt;.c) | &lt;difficulty&gt; |</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md76"></a>
<blockquote class="doxtable">
<p>&zwj;<b>Note</b> There was a requirement to update the <code>leetcode/DIRECTORY.md</code> file with details of the solved problem. It's not required anymore. The information about the problem is fetched automatically throughout the LeetCode API. </p>
</blockquote>
<h1><a class="anchor" id="autotoc_md75"></a>
📦 Committing your changes 📦</h1>
<p>Once you're done with adding a new LeetCode solution, it's time we make a pull request.</p>
<ol type="1">

View File

@ -102,10 +102,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" target="_blank"><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://github.com/TheAlgorithms/C/actions/workflows/codeql_analysis.yml" target="_blank"><img src="https://github.com/TheAlgorithms/C/actions/workflows/codeql.yml/badge.svg" alt="CodeQL CI" style="pointer-events: none;" class="inline"/></a> <a href="https://gitter.im/TheAlgorithms" target="_blank"><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/blob/master/CONTRIBUTING.md" target="_blank"><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?color=red&amp;style=flat-square" alt="GitHub repo size" class="inline"/> <a href="https://TheAlgorithms.github.io/C" target="_blank"><img src="https://github.com/TheAlgorithms/C/workflows/Doxygen%20CI/badge.svg" alt="Doxygen CI" style="pointer-events: none;" class="inline"/></a> <a href="https://github.com/TheAlgorithms/C/actions?query=workflow%3A%22Awesome+CI+Workflow%22" target="_blank"><img src="https://github.com/TheAlgorithms/C/workflows/Awesome%20CI%20Workflow/badge.svg" alt="Awesome CI" style="pointer-events: none;" class="inline"/></a> <a href="https://liberapay.com/TheAlgorithms" target="_blank"><img src="https://img.shields.io/liberapay/receives/TheAlgorithms.svg?logo=liberapay" alt="Income" style="pointer-events: none;" class="inline"/></a> <a href="https://the-algorithms.com/discord/" target="_blank"><img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&amp;colorB=5865F2" alt="Discord chat" style="pointer-events: none;" class="inline"/></a> <a href="https://liberapay.com/TheAlgorithms/donate" target="_blank"><img src="https://liberapay.com/assets/widgets/donate.svg" alt="Donate" style="pointer-events: none;" class="inline"/></a></p>
<h1><a class="anchor" id="autotoc_md78"></a>
<h1><a class="anchor" id="autotoc_md77"></a>
Overview</h1>
<p>The repository is a collection of open-source implementations of a variety of algorithms implemented in C and licensed under <a href="https://github.com/TheAlgorithms/C/blob/master/LICENSE" target="_blank">GPLv3 License</a>. The algorithms span a variety of topics from computer science, mathematics and statistics, data science, machine learning, engineering, etc.. The implementations and their associated documentations 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 different algorithm strategies and optimizations.</p>
<h1><a class="anchor" id="autotoc_md79"></a>
<h1><a class="anchor" id="autotoc_md78"></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_(programming_language)" target="_blank">C</a>.</li>
@ -116,12 +116,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_md80"></a>
<h1><a class="anchor" id="autotoc_md79"></a>
Documentation</h1>
<p><a href="https://TheAlgorithms.github.io/C" target="_blank">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. Click on <a href="https://TheAlgorithms.github.io/C/files.html" target="_blank">Files menu</a> to see the list of all the files documented with the code.</p>
<p><a href="https://thealgorithms.github.io/C" target="_blank">Documentation of Algorithms in C</a> by <a href="https://github.com/TheAlgorithms/C/graphs/contributors" target="_blank">The Algorithms Contributors</a> is licensed under <a href="https://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1" target="_blank">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_md81"></a>
<h1><a class="anchor" id="autotoc_md80"></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/blob/master/CONTRIBUTING.md" target="_blank">Contribution Guidelines</a>. </p>
</div></div><!-- PageDoc -->

View File

@ -1,7 +1,7 @@
var index =
[
[ "Overview", "index.html#autotoc_md78", null ],
[ "Features", "index.html#autotoc_md79", null ],
[ "Documentation", "index.html#autotoc_md80", null ],
[ "Contributions", "index.html#autotoc_md81", null ]
[ "Overview", "index.html#autotoc_md77", null ],
[ "Features", "index.html#autotoc_md78", null ],
[ "Documentation", "index.html#autotoc_md79", null ],
[ "Contributions", "index.html#autotoc_md80", null ]
];

View File

@ -103,10 +103,8 @@ var NAVTREE =
[ "LeetCode", "d6/d77/md_leetcode__d_i_r_e_c_t_o_r_y.html", null ],
[ "📚 Contributing 📚", "df/d58/md_leetcode__r_e_a_d_m_e.html", [
[ "💻 Cloning/setting up the project 💻", "df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md73", null ],
[ "📝 Adding a new solution 📝", "df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md74", [
[ "📜 Adding your new solution to the list 📜", "df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md75", null ]
] ],
[ "📦 Committing your changes 📦", "df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md76", null ]
[ "📝 Adding a new solution 📝", "df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md74", null ],
[ "📦 Committing your changes 📦", "df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md75", null ]
] ],
[ "ProjectEuler", "d8/d81/md_project_euler__r_e_a_d_m_e.html", null ],
[ "Guidelines for reviewers and maintainers", "dc/db4/md__r_e_v_i_e_w_e_r__c_o_d_e.html", null ],
@ -138,7 +136,7 @@ var NAVTREEINDEX =
"d4/d68/qr__decompose_8h.html",
"d7/dfd/structdual__quat__.html#a1b05fbc4135e4f9b731423f26527543d",
"dc/d73/shunting__yard_8c.html#aa8dca7b867074164d5f45b0f3851269d",
"dir_bb1b521853a9c46347182a9d10420771.html"
"dir_bd4a7dd282074645ef41b1ea31ac813a.html"
];
var SYNCONMSG = 'click to disable panel synchronisation';

View File

@ -169,8 +169,7 @@ var NAVTREEINDEX3 =
"df/d58/md_leetcode__r_e_a_d_m_e.html":[11],
"df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md73":[11,0],
"df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md74":[11,1],
"df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md75":[11,1,0],
"df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md76":[11,2],
"df/d58/md_leetcode__r_e_a_d_m_e.html#autotoc_md75":[11,2],
"df/d83/selection__sort_8c.html":[16,0,20,10],
"df/d83/selection__sort_8c.html#aa8dca7b867074164d5f45b0f3851269d":[16,0,20,10,3],
"df/d83/selection__sort_8c.html#ac0f2228420376f4db7e1274f2b41667c":[16,0,20,10,0],
@ -249,5 +248,6 @@ var NAVTREEINDEX3 =
"dir_abf1a26ece768c4076e73592705ae077.html":[16,0,4],
"dir_b2dbfa46230fd9f775c32c1836ed3764.html":[16,0,18,15],
"dir_b3d331eabd4234f247030c297aaf021c.html":[16,0,18],
"dir_b6018f60d424a2ef7e4c942ac681e38b.html":[16,0,3,7]
"dir_b6018f60d424a2ef7e4c942ac681e38b.html":[16,0,3,7],
"dir_bb1b521853a9c46347182a9d10420771.html":[16,0,20]
};

View File

@ -1,6 +1,5 @@
var NAVTREEINDEX4 =
{
"dir_bb1b521853a9c46347182a9d10420771.html":[16,0,20],
"dir_bd4a7dd282074645ef41b1ea31ac813a.html":[16,0,3,3],
"dir_c7ef0fcb2f2095a74f0a3a1634dfc798.html":[16,0,3,0],
"dir_d20ad0b8de644c123692ba5582cc7a7b.html":[16,0,1],
@ -74,12 +73,12 @@ var NAVTREEINDEX4 =
"globals_vars.html":[16,1,2],
"globals_w.html":[16,1,0,23],
"globals_x.html":[16,1,0,24],
"index.html":[],
"index.html":[0],
"index.html#autotoc_md78":[0,0],
"index.html#autotoc_md79":[0,1],
"index.html#autotoc_md80":[0,2],
"index.html#autotoc_md81":[0,3],
"index.html":[],
"index.html#autotoc_md77":[0,0],
"index.html#autotoc_md78":[0,1],
"index.html#autotoc_md79":[0,2],
"index.html#autotoc_md80":[0,3],
"modules.html":[14],
"pages.html":[]
};