8b1eab204b
* chore: remove cppreference * feat: add doxyfile * feat: add doxygen-awesome theme * chore: remove unneccessary doxygen config form cmake * test: for doxygen test purposes Note: revert before merging to main * fix: try removing css from rm * fix: set style sheet via cmake * feat: make doxygen theme finally work * fix: remove mathjax from doxyfile * feat: add sidebar and make mathjax work * doc: add transparency and make output svg of dot * fix: make dots interactive * chore: move math jax from cmake to doxyfile * feat: add header file * chore: add header file to cmake * chore: remove redundant transparency config * fix: force cmake to use config file * chore: remove working directory * fix: use old add_docs command * feat: fix doxygen build * fix: re enable clang assited parsing * fix: use relative paths * fix: relative paths arent necessary * feat: add project logo and favicon * fix: revert gh-pages to master * fix: add dot to doxyfile * fix: add lib clang to doxygen * fix: use source browser * fix: add clang as compiler * docs: remove headers from source browser * revert: branch to master
The Algorithms - C++
Overview
This repository is a collection of open-source implementation of a variety of algorithms implemented in C++ and licensed under MIT License. These 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.
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 STL classes and 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 19 2022, AppleClang 14.0.0, and GNU 11.3.0 respectively.
- Strict adherence to C++17 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. The documentation also introduces interactive source code with links to documentation for C++ STL library functions used. 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.