https://github.com/developerpaul123/genetic
A performant and flexible genetic algorithm implemented in C++20/23.
https://github.com/developerpaul123/genetic
cpp20 cpp20-lib cpp20-library cpp23 cpplib cpplibrary evolutionary-algorithm evolutionary-algorithms genetic-algorithm genetic-algorithms modern-cpp optimisation optimization optimization-algorithms optimization-methods optimization-tools
Last synced: 2 months ago
JSON representation
A performant and flexible genetic algorithm implemented in C++20/23.
- Host: GitHub
- URL: https://github.com/developerpaul123/genetic
- Owner: DeveloperPaul123
- License: mit
- Created: 2023-05-23T21:28:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-22T03:04:10.000Z (10 months ago)
- Last Synced: 2025-03-28T13:05:17.123Z (3 months ago)
- Topics: cpp20, cpp20-lib, cpp20-library, cpp23, cpplib, cpplibrary, evolutionary-algorithm, evolutionary-algorithms, genetic-algorithm, genetic-algorithms, modern-cpp, optimisation, optimization, optimization-algorithms, optimization-methods, optimization-tools
- Language: C++
- Homepage:
- Size: 1.62 MB
- Stars: 19
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
genetic
[](https://github.com/DeveloperPaul123/genetic/stargazers)
[](https://discord.gg/CX2ybByRnt)
A flexible and performant implementation of the genetic algorithm in C++20/23.
## Features
- Built entirely with C++20/23
- Includes many default operators for most use cases
- Supply your own operations for:
- Selection
- Crossover
- Mutation
- Fitness
- Termination
## Integration
`dp::genetic` is a header only library. All the files needed are in `include/genetic`.
### CMake
`genetic` defines two CMake targets:
- `Genetic::Genetic`
- `dp::genetic`
You can then use `find_package()`:
```cmake
find_package(dp::genetic REQUIRED)
```
Alternatively, you can use something like [CPM](https://github.com/TheLartians/CPM) which is based on CMake's `Fetch_Content` module.
```cmake
CPMAddPackage(
NAME genetic
GITHUB_REPOSITORY DeveloperPaul123/genetic
GIT_TAG 0.1.0 # change this to latest commit or release tag
)
```
## Usage
[Knapsack problem](https://en.wikipedia.org/wiki/Knapsack_problem) example:
```cpp
struct knapsack_box {
int value;
int weight;
auto operator<=>(const knapsack_box&) const = default;
};
// weight capacity of our knapsack
constexpr auto max_weight = 15;
// available boxes for the knapsack
std::vector available_items = {{4, 12}, {2, 1}, {10, 4}, {1, 1}, {2, 2}};
// fitness evaluator (omitted for brevity)
auto fitness = { // ...};
// random mutation operator (omitted for brevity)
auto mutator = { // ... };
// crossover operator (i.e. child generator, omitted for brevity)
auto crossover = { // ... };
// the solution is all the boxes except for the heaviest one.
const knapsack solution = {-1, 1, 2, 3, 4};
const knapsack all_items = {0, 1, 2, 3, 4};
// genetic algorithm settings.
constexpr dp::genetic::algorithm_settings settings{0.1, 0.5, 0.25};
// generate an initial random population
constexpr auto population_size = 2;
std::vector initial_population{};
initial_population.reserve(population_size);
// generate the initial population
std::ranges::generate_n(std::back_inserter(initial_population), population_size,
knapsack_generator);
// define the termination criteria
auto termination = dp::genetic::fitness_termination_criteria(fitness(solution));
// setup the params object for the algorithm
auto params = dp::genetic::params::builder()
.with_mutation_operator(mutator)
.with_crossover_operator(crossover)
.with_fitness_operator(fitness)
.with_termination_operator(termination)
.build();
auto [best, fitness] = dp::genetic::solve(initial_population, settings, params);
```
For more details see the `/examples` folder and the unit tests under `/test`.
## Building
This project has been built with:
- Visual Studio 2022
- Clang `10.+` (via WSL on Windows)
- GCC `11.+` (via WSL on Windows)
- CMake `3.21+`
To build, run:
```bash
cmake -S . -B build
cmake --build build
```
### Build Options
| Option | Description | Default |
|:-------|:------------|:--------:|
| `DP_GENETIC_BUILD_TESTS` | Turn on to build unit tests. Required for formatting build targets. | ON |
| `DP_GENETIC_BUILD_EXAMPLES` | Turn on to build examples | ON |
### Run clang-format
Use the following commands from the project's root directory to check and fix C++ and CMake source style.
This requires _clang-format_, _cmake-format_ and _pyyaml_ to be installed on the current system. To use this feature you must turn on `TP_BUILD_TESTS`.
```bash
# view changes
cmake --build build/test --target format
# apply changes
cmake --build build/test --target fix-format
```
See [Format.cmake](https://github.com/TheLartians/Format.cmake) for details.
### Build the documentation
The documentation is automatically built and [published](https://developerpaul123.github.io/genetic) whenever a [GitHub Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) is created.
To manually build documentation, call the following command.
```bash
cmake -S documentation -B build/doc
cmake --build build/doc --target GenerateDocs
# view the docs
open build/doc/doxygen/html/index.html
```
To build the documentation locally, you will need [Doxygen](https://www.doxygen.nl/) and [Graphviz](https://graphviz.org/) on your system.
## Contributing
Contributions are very welcome. Please see [contribution guidelines for more info](CONTRIBUTING.md).
## License
The project is licensed under the MIT license. See [LICENSE](LICENSE) for more details.
## Author
| [
@DeveloperPaul123](https://github.com/DeveloperPaul123) |
|:----:|