mirror of https://github.com/TheAlgorithms/C
138 lines
11 KiB
HTML
138 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Algorithms_in_C: The Algorithms - C</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">Algorithms_in_C<span id="projectnumber"> 1.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">Set of algorithms implemented in C.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div><div class="header">
|
|
<div class="headertitle"><div class="title">The Algorithms - C </div></div>
|
|
</div><!--header-->
|
|
<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&logo=gitter&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&message=Welcome&color=0059b3&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&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&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>
|
|
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>
|
|
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>
|
|
<li>Well documented source code with detailed explanations provide a valuable resource for educators and students alike.</li>
|
|
<li>Each source code is atomic using standard C library <a href="https://en.wikipedia.org/wiki/C_standard_library" target="_blank"><code>libc</code></a> and <em>no external libraries</em> are required for their compilation and execution. Thus the fundamentals of the algorithms can be studied in much depth.</li>
|
|
<li>Source codes are <a href="https://github.com/TheAlgorithms/C/actions?query=workflow%3A%22Awesome+CI+Workflow%22" target="_blank">compiled and tested</a> for every commit on the latest versions of two major operating systems viz., MacOS and Ubuntu (Linux) using AppleClang 14.0.0 and GNU 11.3.0 respectively.</li>
|
|
<li>Strict adherence to <a href="https://en.wikipedia.org/wiki/C11_(C_standard_revision)" target="_blank">C11</a> standard ensures portability of code to embedded systems as well like ESP32, ARM Cortex, etc. with little to no changes.</li>
|
|
<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>
|
|
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>
|
|
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 -->
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|