How to use C-Plus-Plus: clone, build and study the algorithms

What C-Plus-Plus is and who it is for

The repository collects implementations of many algorithms in C++, licensed under the MIT License. The code and its documentation are written as a learning resource, so the same problem may appear more than once, each solved with a different strategy or optimization.

It suits students learning algorithms and data structures in C++, educators who want example code to teach from, and developers preparing for technical interviews or competitive programming. It is not a production library to call from an application, and it is not a packaged tool with an installer or release versions.

What you need before you start

The README lists one prerequisite for the install method it describes: a C++17-capable compiler. Each source file uses only the STL (standard template library), so no external libraries are required to compile and run the code.

You should already know some C++, because the code and explanations assume it.

• A C++17-capable compiler
• Git, to clone the repository (the README gives a git clone command)
• Basic C++ knowledge

Clone the repository

The README's install method is clone-and-build. Run the command below to copy the repository to your machine. The project's documentation site is at https://thealgorithms.github.io/C-Plus-Plus.

Find and study an algorithm

Browse the repository files to find the topic you want. The online documentation is generated from the source code and includes source snippets, details on how to run the programs, diagrams of program flow, and links to external resources. Its Files menu lists every documented file.

Because several implementations of one problem may exist, compare them to see how different strategies and optimizations change the code.

• Open the online documentation at https://thealgorithms.github.io/C-Plus-Plus
• Use the Files menu to see all documented files
• Compare two implementations of the same problem side by side

Compile and run a program

The README says the code is compiled and tested on Windows (MSVC 19 2022), macOS (AppleClang 15.0.15) and Ubuntu Linux (GNU 13.3.0), and that it follows the C++17 standard. Use a compiler with C++17 support. The README does not give a specific build command, so consult the individual file's documentation for how to run it.

Many files include self-checks that verify the implementation is correct.

• Use a compiler that supports C++17
• Check each file's documentation for execution details
• Look for the built-in self-checks to confirm results

Contribute or reuse the code

The project is community developed and welcomes new, original, quality contributions. Read the Contribution Guidelines before submitting. Because the code is MIT licensed, you may reuse the modular implementations in other applications under the license terms. The documentation itself is licensed under CC BY-SA 4.0.

• Read CONTRIBUTING.md before opening a contribution
• Check the MIT License before reusing code