mirror of
https://github.com/TheAlgorithms/C
synced 2024-11-24 06:19:37 +03:00
acbaf4a291
* feat: added BLAKE2b with one working assert docs: added BLAKE2b to README.md * [enhancement] added more doc comments and fully implemented BLAKE2b key hashing * fix: forgot to add arg * chore: applied clang-format * updating DIRECTORY.md * docs: added main function docs Co-authored-by: David Leal <halfpacho@gmail.com> * docs: removed @file qualifier Co-authored-by: David Leal <halfpacho@gmail.com> * docs: added doc comment for assert_bytes() Co-authored-by: David Leal <halfpacho@gmail.com> * docs: added documentation for #include's As requested by Panquesito27 in https://github.com/TheAlgorithms/C/pull/1230#discussion_r1130143641 * docs: added algorithm description As requested in https://github.com/TheAlgorithms/C/pull/1230#discussion_r1130143364 * docs: added reasoning for warning suppression pragmas * docs: spellcheck and additions Added doc for bb definition. Added description for mixing function G and compression function F. * Added print statement to let user know tests have passed Co-authored-by: David Leal <halfpacho@gmail.com> * Updated doc comments for variables * docs: removed old doc comments * fix: had minus sign instead of assignment operator * chore: replaced uint64_t[16] with block_t type to improve readability * docs: defined macro constants to reduce magic numbers * fix: fixed memory leak in blake2b() * docs: moved comment Moved comment about the suppressed warning directly above the code that emits the warning * docs: added psuedocode/feat: added u128 Added psuedocode for the algorithm in doc comment for BLAKE2B(). Added return docs for void functions. Defined an unsigned 128-bit integer to match the max input size specified for the algorithm. * fix: fixed build errors * docs: added some clarifying comments * docs: reduced magic numbers --------- Co-authored-by: github-actions[bot] <github-actions@users.noreply.github.com> Co-authored-by: David Leal <halfpacho@gmail.com> |
||
|---|---|---|
| .github | ||
| .vscode | ||
| audio | ||
| client_server | ||
| conversions | ||
| data_structures | ||
| developer_tools | ||
| dynamic_programming | ||
| exercism | ||
| games | ||
| geometry | ||
| graphics | ||
| greedy_approach | ||
| hash | ||
| leetcode | ||
| machine_learning | ||
| math | ||
| misc | ||
| numerical_methods | ||
| process_scheduling_algorithms | ||
| project_euler | ||
| scripts | ||
| searching | ||
| sorting | ||
| .clang-format | ||
| .clang-tidy | ||
| .gitignore | ||
| .gitpod.dockerfile | ||
| .gitpod.yml | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| CodingGuidelines.md | ||
| CONTRIBUTING.md | ||
| DIRECTORY.md | ||
| Doxyfile | ||
| LICENSE | ||
| README.md | ||
| REVIEWER_CODE.md | ||
The Algorithms - C
Overview
The repository is a collection of open-source implementations of a variety of algorithms implemented in C and licensed under GPLv3 License. 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.
Features
- The repository provides implementations of various algorithms in one of the most fundamental general purpose languages - C.
- Well documented source code with detailed explanations provide a valuable resource for educators and students alike.
- Each source code is atomic using standard C library
libcand no external libraries are required for their compilation and execution. Thus the fundamentals of the algorithms can be studied in much depth. - Source codes are compiled and tested for every commit on the latest versions of three major operating systems viz., Windows, MacOS and Ubuntu (Linux) using MSVC 16 2019, AppleClang 11.0 and GNU 7.5.0 respectively.
- Strict adherence to C11 standard ensures portability of code to embedded systems as well like ESP32, ARM Cortex, etc. with little to no changes.
- Self-checks within programs ensure correct implementations with confidence.
- Modular implementations and OpenSource licensing enable the functions to be utilized conveniently in other applications.
Documentation
Online Documentation 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 Files menu to see the list of all the files documented with the code.
Documentation of Algorithms in C by The Algorithms Contributors is licensed under CC BY-SA 4.0
Contributions
As a community developed and maintained repository, we welcome new un-plagiarized quality contributions. Please read our Contribution Guidelines.