From f6042d4ccf87e2f6b0fd866a70b0c9b253932c7e Mon Sep 17 00:00:00 2001 From: github-actions <${GITHUB_ACTOR}@users.noreply.github.com> Date: Thu, 10 Nov 2022 01:24:54 +0000 Subject: [PATCH] Documentation for 9101ccd27c62a17a4cad0b72bbff7441d60b12f1 --- ...md_data_structures_stack__r_e_a_d_m_e.html | 4 +- d5/d88/md__d_i_r_e_c_t_o_r_y.html | 756 +++++++++--------- d6/d77/md_leetcode__d_i_r_e_c_t_o_r_y.html | 297 +++++++ d6/dcd/md__c_o_n_t_r_i_b_u_t_i_n_g.html | 32 +- d7/db5/md_exercism__r_e_a_d_m_e.html | 2 +- ...md_data_structures_array__r_e_a_d_m_e.html | 6 +- da/d6c/exponential__search_8c.html | 4 +- ...ta_structures_dictionary__r_e_a_d_m_e.html | 2 +- df/d58/md_leetcode__r_e_a_d_m_e.html | 251 ++---- index.html | 8 +- navtreedata.js | 90 ++- navtreeindex0.js | 474 +++++------ navtreeindex1.js | 480 +++++------ navtreeindex2.js | 494 ++++++------ navtreeindex3.js | 498 ++++++------ navtreeindex4.js | 16 +- pages.html | 7 +- search/all_1d.js | 4 + search/all_e.js | 2 +- search/pages_5.js | 2 +- search/pages_9.js | 4 + search/searchdata.js | 4 +- 22 files changed, 1813 insertions(+), 1624 deletions(-) create mode 100644 d6/d77/md_leetcode__d_i_r_e_c_t_o_r_y.html create mode 100644 search/all_1d.js create mode 100644 search/pages_9.js diff --git a/d1/d12/md_data_structures_stack__r_e_a_d_m_e.html b/d1/d12/md_data_structures_stack__r_e_a_d_m_e.html index a2fe5161..aebf2347 100644 --- a/d1/d12/md_data_structures_stack__r_e_a_d_m_e.html +++ b/d1/d12/md_data_structures_stack__r_e_a_d_m_e.html @@ -101,7 +101,7 @@ $(document).ready(function(){initNavTree('d1/d12/md_data_structures_stack__r_e_a
This is a modular generic stack data-structure. The stack is self growing.
-You need to only import the stack.h
-Initializes the stack with a capacity of 10 elements.
diff --git a/d5/d88/md__d_i_r_e_c_t_o_r_y.html b/d5/d88/md__d_i_r_e_c_t_o_r_y.html index 11cbecd0..92beda8d 100644 --- a/d5/d88/md__d_i_r_e_c_t_o_r_y.html +++ b/d5/d88/md__d_i_r_e_c_t_o_r_y.html @@ -101,548 +101,554 @@ $(document).ready(function(){initNavTree('d5/d88/md__d_i_r_e_c_t_o_r_y.html','..
+ Algorithms_in_C 1.0.0
+
+ Set of algorithms implemented in C.
+ |
+
Please check the reviewer code file for maintainers and reviewers.
+Please check the reviewer code file for maintainers and reviewers.
Being a contributor at The Algorithms, we request you to follow the points mentioned below:
@@ -123,9 +123,13 @@ ContributorYou can add new algorithms or data structures that are not present in the repository or that can improve the old implementations (documentation, improving test cases, removing bugs, or in any other reasonable sense)
Issues Please avoid opening issues asking to be "assignedโ to a particular algorithm. This merely creates unnecessary noise for maintainers. Instead, please submit your implementation in a pull request, and it will be evaluated by project maintainers. -@subsection autotoc_md22 Making Changes +@subsection autotoc_md22 LeetCode solutions -@subsubsection autotoc_md23 Code +For LeetCode solutions, please check its <a href="https://github.com/TheAlgorithms/C/blob/master/src/leetcode/README.md" target="_blank" ><strong>guide</strong></a> to make a proper solution file. + +@subsection autotoc_md23 Making Changes + +@subsubsection autotoc_md24 Code - Please use the directory structure of the repository. - Make sure the file extensions should be <tt>*.h</tt> <tt>*.c</tt> @@ -138,7 +142,7 @@ Contributor - Please conform to <a href="https://www.doxygen.nl/manual/docblocks.html" target="_blank" >Doxygen</a> standards and document the code as much as possible. This not only facilitates the readers but also generates the correct info on the website. - <strong>Be consistent in the use of these guidelines.</strong> -@subsubsection autotoc_md24 Documentation +@subsubsection autotoc_md25 Documentation - Make sure you put useful comments in your code. Do not comment on obvious things. - Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure. If you want to create a new directory, then please check if a similar category has been recently suggested or created by other pull requests. @@ -146,13 +150,13 @@ Contributor - Do not update <a href="https://github.com/TheAlgorithms/C/blob/master/README.md" target="_blank" ><tt>README.md</tt></a> along with other changes. First, create an issue and then link to that issue in your pull request to suggest specific changes required to <a href="https://github.com/TheAlgorithms/C/blob/master/README.md" target="_blank" ><tt>README.md</tt></a>. - The repository follows <a href="https://www.doxygen.nl/manual/docblocks.html" target="_blank" >Doxygen</a> standards and auto-generates the <a href="https://thealgorithms.github.io/C" target="_blank" >repository website</a>. Please ensure the code is documented in this structure. A sample implementation is given below. -@subsubsection autotoc_md25 Test +@subsubsection autotoc_md26 Test - Make sure to add examples and test cases in your <tt>main()</tt> function. - If you find an algorithm or document without tests, please feel free to create a pull request or issue describing suggested changes. - Please try to add one or more <tt>test()</tt> functions that will invoke the algorithm implementation on random test data with the expected output. Use the <tt>assert()</tt> function to confirm that the tests will pass. Requires including the <tt>assert.h</tt> library. -@subsubsection autotoc_md26 Typical structure of a program +@subsubsection autotoc_md27 Typical structure of a program @icode{c} /** @@ -216,7 +220,7 @@ int main() { } @endicode -@subsubsection autotoc_md27 File name guidelines +@subsubsection autotoc_md28 File name guidelines - Use lowercase words with <tt>"_"</tt> as a separator - For instance @@ -230,7 +234,7 @@ my_new_c_struct.c is correct format - File name validation will run on Docker to ensure validity. - If an implementation of the algorithm already exists and your version is different from that implemented, please use an incremental numeric digit as a suffix. For example: if <tt>median_search.c</tt> already exists in the <tt>search</tt> folder, and you are contributing a new implementation, the filename should be <tt>median_search2.c</tt>. For a third implementation, <tt>median_search3.c</tt>, and so on. -@subsubsection autotoc_md28 Directory guidelines +@subsubsection autotoc_md29 Directory guidelines - We recommend adding files to existing directories as much as possible. - Use lowercase words with <tt>"_"</tt> as separator ( no spaces or <tt>"-"</tt> allowed ) @@ -244,7 +248,7 @@ some_new_fancy_category is correct - Filepaths will be used to dynamically create a directory of our algorithms. - Filepath validation will run on GitHub Actions to ensure compliance. -@subsubsection autotoc_md29 Commit Guidelines +@subsubsection autotoc_md30 Commit Guidelines - It is recommended to keep your changes grouped logically within individual commits. Maintainers find it easier to understand changes that are logically spilt across multiple commits. Try to modify just one or two files in the same directory. Pull requests that span multiple directories are often rejected. @@ -271,11 +275,11 @@ Common prefixes: - test: Correct existing tests or add new ones - chore: Miscellaneous changes that do not match any of the above. -@subsection autotoc_md30 Pull Requests +@subsection autotoc_md31 Pull Requests - Checkout our <a href="https://github.com/TheAlgorithms/C/blob/master/.github/pull_request_template.md" target="_blank" >pull request template</a> -@subsubsection autotoc_md31 Building Locally +@subsubsection autotoc_md32 Building Locally Before submitting a pull request, build the code locally or using the convenient <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"/></a> service. @@ -283,7 +287,7 @@ Before submitting a pull request, build the code locally or using the convenient cmake -B build -S . @endicode -@subsubsection autotoc_md32 Static Code Analyzer +@subsubsection autotoc_md33 Static Code Analyzer We use <a href="https://clang.llvm.org/extra/clang-tidy/" target="_blank" ><tt>clang-tidy</tt></a> as a static code analyzer with a configuration in <a href=".clang-tidy" target="_blank" ><tt>.clang-tidy</tt></a>. @@ -291,7 +295,7 @@ We use <a href="https://cl clang-tidy --fix --quiet -p build subfolder/file_to_check.c -- @endicode -@subsubsection autotoc_md33 Code Formatter +@subsubsection autotoc_md34 Code Formatter <a href="https://clang.llvm.org/docs/ClangFormat.html" target="_blank" >**<tt>clang-format</tt>**</a> is used for code formatting. @@ -302,7 +306,7 @@ clang-tidy --fix --quiet -p build subfolder/file_to_check.c -- - Linux (Debian): <tt>sudo apt-get install clang-format-10 clang-tidy-10</tt> - Running (all platforms): <tt>clang-format -i -style="file" my_file.c</tt> -@subsubsection autotoc_md34 GitHub Actions +@subsubsection autotoc_md35 GitHub Actions - Enable GitHub Actions on your fork of the repository. After enabling, it will execute <tt>clang-tidy</tt> and <tt>clang-format</tt> after every push (not a commit). diff --git a/d7/db5/md_exercism__r_e_a_d_m_e.html b/d7/db5/md_exercism__r_e_a_d_m_e.html index 7d0a373e..3689d875 100644 --- a/d7/db5/md_exercism__r_e_a_d_m_e.html +++ b/d7/db5/md_exercism__r_e_a_d_m_e.html @@ -101,7 +101,7 @@ $(document).ready(function(){initNavTree('d7/db5/md_exercism__r_e_a_d_m_e.html',
This directory contains some sample solutions for exercism.io
-In this directory you will find (in the right order):
Simple array of integers. With I/O functions, Sort Functions and Search Functions.
-The Sort function sorts the elements in the range in a particular order. The different types of sorting methods are Bubble Sort, Selection Sort, Merge Sort and Quick Sort. Bubble Sort repeatedly sorts the adjacent elements if they are in wrong order.
-Function: binary_search.
algorithm that search the index of the given item
recursive function that search the given element in
-Audio | |
Sample solutions for <a href="http://exercism.io/" target="_blank" >exercism.io</a> | |
Hash algorithms | |
LeetCode | |
ProjectEuler | |
Guidelines for reviewers and maintainers | |
LeetCode | |
๐ Contributing ๐ | |
ProjectEuler | |
Guidelines for reviewers and maintainers |