GeneticSharp is a fast, extensible, multi-platform, and multithreading C# Genetic Algorithm library that simplifies the development of applications using Genetic Algorithms (GAs).

It can be used in any kind of .NET 6, .NET Standard, and .NET Framework apps, like ASP .NET MVC, ASP .NET Core, Blazor, Web Forms, UWP, Windows Forms, GTK#, Xamarin, MAUI and Unity3D games.

Projects, papers, journals, books, tutorials, courses, and apps using GeneticSharp

Features

Chromosomes

FloatingPointChromosome
IntegerChromosome
Add your own chromosome representation implementing IChromosome / IBinaryChromosome interfaces or extending ChromosomeBase / BinaryChromosomeBase.

Fitness

Add your own fitness evaluation, implementing IFitness interface.

Populations

Population
TplPopulation
Others populations can be added implementing IPopulation interface or extending Population.

Generations

Generation
Generation strategy
- Performance strategy
- Tracking strategy
- Others generation strategies can be added implementing IGenerationStrategy.cs interface.

Operators strategy

DefaultOperatorsStrategy
TplOperatorsStrategy
Others operators strategies can be added implementing IOperatorsStrategy interface.

Reinsertions

Elitist
Fitness Based
Pure
Uniform
Others reinsertions can be added implementing IReinsertion interface or extending ReinsertionBase.

Terminations

Generation number
Time evolving
Fitness stagnation
Fitness threshold
And e Or (allows combine others terminations)
Others terminations can be added implementing ITermination interface or extending TerminationBase.

Randomizations

Basic randomization (using System.Random)
Fast random
If you need a special kind of randomization for your GA, just implement the IRandomization interface.

Task executors

LinearTaskExecutor
ParallelTaskExecutor
TplTaskExecutor
Others task executors can be added implementing ITaskExecutor interface.

Samples

BlazorAI

Blazor samples

TSP (Travelling Salesman Problem)

Console samples

AutoConfig
Bitmap equality
Equality equation
Equation solver
Function builder
Ghostwriter
TSP (Travelling Salesman Problem)

GTK# samples

Bitmap equality
Function optimization
Sudoku
TSP (Travelling Salesman Problem)

Unity3D Samples

Car2D
TSP (Travelling Salesman Problem)
Wall Builder

Multi-platform

.NET 6, .NET Standard 2.0, Mono and .NET Framework 4.6.2 support
Fully tested on Windows and MacOS

Code quality

100% unit test code coverage
100% code documentation
SonarCloud validated
Performance benchmarks

Setup

.NET 6

Only GeneticSharp:

install-package GeneticSharp

GeneticSharp and extensions (TSP, AutoConfig, Bitmap equality, Equality equation, Equation solver, Function builder, etc):

install-package GeneticSharp.Extensions

Unity3D

You should use the UnityNuGet to install GeneticSharp directly from NuGet.

Or you can use the latest GeneticSharp.unitypackage available on our release page.

.NET Standard 2.0 and .NET Framework 4.6.2

To install previous version that support .NET Standard 2.0 and .NET Framework 4.6.2:

install-package GeneticSharp -Version 2.6.0

Mono and .NET Framework 3.5

To install previous version that support .NET Framework 3.5:

install-package GeneticSharp -Version 1.2.0

Running samples

If you want to run the console, GTK# and Unity samples, just fork this repository and follow the instruction from our setup page wiki.

An easy way to run the Unity Samples, if you have a Android device, is download it from Google Play.

Usage

Creating your own fitness evaluation

public class MyProblemFitness : IFitness
{  
	public double Evaluate (IChromosome chromosome)
	{
		// Evaluate the fitness of chromosome.
	}
}

Creating your own chromosome

public class MyProblemChromosome : ChromosomeBase
{
	// Change the argument value passed to base constructor to change the length 
	// of your chromosome.
	public MyProblemChromosome() : base(10) 
	{
		CreateGenes();
	}

	public override Gene GenerateGene (int geneIndex)
	{
		// Generate a gene base on my problem chromosome representation.
	}

	public override IChromosome CreateNew ()
	{
		return new MyProblemChromosome();
	}
}

Running your GA

var selection = new EliteSelection();
var crossover = new OrderedCrossover();
var mutation = new ReverseSequenceMutation();
var fitness = new MyProblemFitness();
var chromosome = new MyProblemChromosome();
var population = new Population (50, 70, chromosome);

var ga = new GeneticAlgorithm(population, fitness, selection, crossover, mutation);
ga.Termination = new GenerationNumberTermination(100);

Console.WriteLine("GA running...");
ga.Start();

Console.WriteLine("Best solution found has {0} fitness.", ga.BestChromosome.Fitness);

Templates for `dotnet new`

If you're using .NET 6 or .NET Core, you can install GeneticSharp.Templates:

dotnet new -i GeneticSharp.Templates

There are 4 templates in GeneticSharp.Templates:

TSP Blazor application

A Blazor client application template with GeneticSharp ready to run a Travelling Salesman Problem (TSP).

dotnet new GeneticSharpTspBlazorApp -n MyNamespace -o MyOutoputFolder

Console application

A console application template with GeneticSharp, you just need to implement the chromosome and fitness function.

dotnet new GeneticSharpConsoleApp -n MyNamespace -o MyOutoputFolder

TSP Console application

A console application template with GeneticSharp ready to run a Travelling Salesman Problem (TSP).

dotnet new GeneticSharpTspConsoleApp -n MyNamespace -o MyOutoputFolder

TSP Unity3D

A Unity3D template with GeneticSharp ready to run a Travelling Salesman Problem (TSP).

dotnet new GeneticSharpTspUnity3d -n MyNamespace -o MyOutoputFolder

FAQ

Having troubles?

Read our wiki.
Tutorials
Ask on Stack Overflow using the tag GeneticSharp.
Open an issue.

How to improve it?

Create a fork of GeneticSharp.

Did you change it? Submit a pull request.

License

Licensed under the The MIT License (MIT). In others words, you can use this library for developement any kind of software: open source, commercial, proprietary, etc.

Thanks to

AppVeyor: open source license for continuous integration.
JetBrains: open source license for all products pack.
SMASHINGLOGO: GeneticSharp's logo.
SonarCloud: open source license for online inspection.

thingthatis / geneticsharp Goto Github PK

geneticsharp's Introduction