GeneticAlgorithms 1.0.0
dotnet add package GeneticAlgorithms --version 1.0.0
NuGet\Install-Package GeneticAlgorithms -Version 1.0.0
<PackageReference Include="GeneticAlgorithms" Version="1.0.0" />
<PackageVersion Include="GeneticAlgorithms" Version="1.0.0" />
<PackageReference Include="GeneticAlgorithms" />
paket add GeneticAlgorithms --version 1.0.0
#r "nuget: GeneticAlgorithms, 1.0.0"
#:package GeneticAlgorithms@1.0.0
#addin nuget:?package=GeneticAlgorithms&version=1.0.0
#tool nuget:?package=GeneticAlgorithms&version=1.0.0
Genetic Algorithms
GeneticAlgorithms is a small F# library for experimenting with genetic algorithms. It provides a compact, generic execution pipeline for evolving chromosomes and includes example projects that demonstrate both binary and character-based optimization problems.
The repository is structured as an educational, easy-to-read implementation rather than a feature-complete optimization framework. The core abstractions are intentionally small so you can understand how the algorithm works and adapt it for your own problems.
Inspiration
This library is heavily influenced by the ideas and teaching approach in Genetic Algorithms in Elixir: Solve Problems Using Evolution by Sean Moriarity. If you want a practical introduction to evolutionary algorithms and how to structure them in code, it is a strong companion resource for this repository.
Installation
The library is published on nuget.org:
dotnet add package GeneticAlgorithms
Features
- Generic chromosome representation with support for any gene type
- Problem definition through pluggable genotype, fitness, and termination functions
- Population evaluation with age tracking and fitness sorting
- Configurable parent selection: elite, random, tournament, tournament without duplicates, roulette-wheel, Boltzmann, stochastic universal sampling, or rank-based
- Configurable crossover: single-point by default, or order-one crossover for permutation genotypes
- Configurable mutation: rate and strategy, gene-shuffling by default
- A
Distancemodule with reusable string-similarity functions (currently Jaro similarity) for building fitness functions that compare a candidate string against a target - Included examples and automated tests
Project Structure
src/GeneticAlgorithms Core library
examples/ Example problems, each with F# and/or C# variants - see examples/README.md
tests/GeneticAlgorithms.Tests Automated tests with Expecto
tests/GeneticAlgorithms.CSharpSmoke Minimal C# consumer validating the interop layer
tests/GeneticAlgorithms.NuGetSmoke Verifies a published NuGet release installs and runs correctly
Core Concepts
The library revolves around three types:
Chromosome<'T>
Represents a candidate solution. Size is derived from Genes rather than stored separately.
type Chromosome<'T> =
{ Genes: 'T array
Fitness: float
Age: int }
member this.Size = this.Genes.Length
Age counts the number of generations a chromosome has existed, incremented once per generation by Genetic.evaluate. It resets to 0 when a chromosome is "born" - by Crossover (which always produces a genuinely new individual from two parents) or by a freshly generated genotype (the initial population, or padding a shortfall back to PopulationSize). Mutation does not reset it - a mutated chromosome is still the same individual, one generation older, with modified genes, the same way a Reinsertion-carried-over survivor keeps aging without being "reborn". Because evaluate always runs before Options.Probe/Problem.Terminate see a generation, the minimum Age ever observable is 1, not 0, for both the very first generation and any chromosome born since.
Problem<'Gene>
Defines how a specific optimization problem behaves.
type Problem<'Gene> =
{ Genotype: System.Random -> Chromosome<'Gene>
FitnessFunction: Chromosome<'Gene> -> float
Terminate: seq<Chromosome<'Gene>> -> int -> float -> bool }
Options<'Gene>
Controls runtime configuration.
type Options<'Gene> =
{ PopulationSize: int
SelectionRate: float
SelectionFn: System.Random -> Chromosome<'Gene> array -> int -> Chromosome<'Gene> array
CrossoverFn: System.Random -> Chromosome<'Gene> -> Chromosome<'Gene> -> Chromosome<'Gene> * Chromosome<'Gene>
MutationRate: float
MutationFn: System.Random -> Chromosome<'Gene> -> Chromosome<'Gene>
ReinsertionFn:
System.Random -> Chromosome<'Gene> array -> Chromosome<'Gene> array -> Chromosome<'Gene> array -> Chromosome<'Gene> array
Probe: GenerationInfo<'Gene> -> unit
Random: System.Random }
SelectionFn picks from the Selection module (Selection.elite, Selection.random, Selection.tournament, Selection.tournamentNoDuplicates, Selection.roulette, Selection.boltzmann, Selection.stochasticUniversalSampling, Selection.rank) or a custom function of the same shape.
CrossoverFn picks from the Crossover module (Crossover.singlePoint for any gene array, or Crossover.orderOneCrossover for permutation genotypes such as NQueens) or a custom function of the same shape.
MutationFn picks from the Mutation module (Mutation.scramble/Mutation.scrambleSlice for any gene array, Mutation.flip/Mutation.flipEachGene for binary genotypes, or Mutation.gaussian for real-valued genotypes) or a custom function of the same shape; Genetic.mutation decides, via MutationRate, how many chromosomes to sample from the population as mutants each generation.
ReinsertionFn picks from the Reinsertion module (Reinsertion.`pure` to replace the population outright with this generation's offspring, or Reinsertion.elitist/Reinsertion.uniform to carry over a fraction of the previous generation's fittest or randomly chosen survivors alongside it) or a custom function of the same shape - it decides how parents, offspring, and leftover chromosomes combine into the next population.
Probe is called with a GenerationInfo<'Gene> snapshot after every evaluation. It's a generic injection point - the library only decides when it fires and what it carries; what a probe does with that snapshot (print it, collect it in memory, write it to a file or database, push it to a monitoring service) is entirely up to whoever plugs one in. The default is Probes.noop - probing is opt-in, not imposed. Probes.printProgress is a ready-made probe that prints the best fitness; Probes.combine runs several probes together, and Probes.everyNth throttles one to fire only every n generations.
Random is the single source of randomness for an entire run - every SelectionFn/CrossoverFn/MutationFn/ReinsertionFn, and Problem.Genotype, are called with this same instance rather than reaching for System.Random.Shared, so seeding it ({ Options.create 100 with Random = System.Random(42) }) makes an otherwise-identical run fully reproducible.
GenerationInfo<'Gene>
A snapshot of one generation's state, passed to Options.Probe.
type GenerationInfo<'Gene> =
{ Generation: int
Population: Chromosome<'Gene> array
Best: Chromosome<'Gene>
Temperature: float }
Population is this generation's full population, already evaluated and sorted by descending fitness. Best is Population.[0]. Temperature is the same value passed to Problem.Terminate for this generation.
Algorithm Flow
Genetic.run executes the following loop:
- Initialize a population using the supplied genotype function.
- Evaluate all chromosomes with the fitness function and sort by descending fitness.
- Report progress via
Probe. - Stop if the termination function returns
truefor the current population, generation, and temperature. - Otherwise, select parents using
SelectionFnandSelectionRate, keeping any unselected chromosomes as leftover. - Produce children from the selected parents using
CrossoverFn. - Sample a subset of the population, sized by
MutationRate, and applyMutationFnto each to produce mutants. - Combine the children and mutants into this generation's offspring, and let
ReinsertionFndecide how parents, offspring, and leftover chromosomes combine into the next population. - Repeat from step 2 with the resulting population.
The termination callback receives the evaluated population, the current generation number, and a temperature value computed from recent fitness progress, so problems can stop either on solution quality, a generation cap, temperature behavior, or a combination of those signals.
Getting Started
Requirements
- .NET 10 SDK
Build the solution
From the repository root:
dotnet build genetic-algorithms.sln
Run the tests
dotnet run --project tests/GeneticAlgorithms.Tests/GeneticAlgorithms.Tests.fsproj
Basic Usage
Define a genotype function, a fitness function, and a termination condition, then call Genetic.run.
open GeneticAlgorithms
let genotype (rng: System.Random) =
let genes = Array.init 10 (fun _ -> rng.Next(0, 2))
{ Genes = genes
Fitness = 0.0
Age = 0 }
let fitness_function (chromosome: Chromosome<int>) =
chromosome.Genes |> Array.sum |> float
let terminate (population: seq<Chromosome<int>>) (_generation: int) (_temperature: float) =
population |> Seq.exists (fun chromosome -> chromosome.Fitness >= 10.0)
let problem: Problem<int> =
{ Genotype = genotype
FitnessFunction = fitness_function
Terminate = terminate }
// Options.create fills in every field except PopulationSize with sensible defaults -
// SelectionRate 0.8 + MutationRate 0.05 + Reinsertion.elitist's survivalRate 0.15 sum to
// 1.0, which keeps population size stable across generations (`` Reinsertion.`pure` ``, the
// simplest strategy, would discard SelectionRate's 20% leftover with nothing to replace it
// beyond this generation's mutants, shrinking the population by ~15% every generation).
// Override only what you need via ordinary record-update syntax.
let options =
{ Options.create 100 with
Probe = Probes.printProgress }
let solution = Genetic.run problem options
Building the record from scratch, field by field, works just as well if you'd rather not rely on Options.create's defaults:
let options =
{ PopulationSize = 100
SelectionRate = 0.8
SelectionFn = Selection.elite
CrossoverFn = Crossover.singlePoint
MutationRate = 0.05
MutationFn = Mutation.scramble
ReinsertionFn = Reinsertion.elitist 0.15
Probe = Probes.printProgress
Random = System.Random() }
Every strategy function draws its randomness from Options.Random instead of System.Random.Shared, so seeding it makes an otherwise-identical run fully reproducible:
let options =
{ Options.create 100 with
Random = System.Random(42) }
C# Interop
The core API is implemented in idiomatic F#, but the library also exposes a small C#-friendly facade through GeneticAlgorithms.GeneticAlgorithm. This avoids forcing C# examples to construct F# records with curried function fields directly.
using GeneticAlgorithms;
var solution = GeneticAlgorithm.Run(
genotype: rng => GeneticAlgorithm.CreateChromosome(new[] { rng.Next(0, 2) }),
fitnessFunction: chromosome => chromosome.Genes[0],
terminate: (population, generation, temperature) =>
population.Any(chromosome => chromosome.Fitness >= 1.0) || generation >= 10,
populationSize: 8);
Every Func<...> strategy parameter (selectionFn, crossoverFn, mutationFn, reinsertionFn, and genotype) is passed the run's System.Random as its first argument. For a reproducible run from C#, use the CreateOptions overload that takes an explicit random: Random parameter instead of the populationSize-only convenience overloads.
The populationSize-only overloads (this one and CreateOptions(populationSize)) default to SelectionRate = 0.8, MutationRate = 0.05, and Reinsertion.elitist 0.15 - the same population-stable combination used throughout this library's own examples, so population size stays constant across generations without any further configuration.
To use a non-default selection, crossover, or mutation strategy, build Options<'Gene> with GeneticAlgorithm.CreateOptions(populationSize, selectionFn, crossoverFn, mutationFn) instead - the library's own Selection/Crossover/Mutation module functions can be passed directly as method groups, since they compile to ordinary multi-argument static methods:
var options = GeneticAlgorithm.CreateOptions<int>(
populationSize: 100,
selectionFn: Selection.elite,
crossoverFn: Crossover.orderOneCrossover,
mutationFn: Mutation.scramble);
var solution = GeneticAlgorithm.Run(genotype, fitnessFunction, terminate, options);
The older Interop type remains available as a compatibility wrapper, but new C# examples should prefer GeneticAlgorithm.
The smoke project in tests/GeneticAlgorithms.CSharpSmoke exists specifically to validate that this API stays straightforward to consume from C#.
Examples
See examples/README.md for the full index of example projects, what each one demonstrates, and their available language variants.
Test Coverage
The test project verifies the main building blocks of the algorithm:
Genetic.evaluateapplies fitness, increments age, and sorts by descending fitnessGenetic.crossoverpreserves chromosome size and recombines parent genes using the suppliedCrossoverFnGenetic.mutationpreserves population size and gene membership, applyingMutationFnper chromosome atMutationRateGenetic.initializecreates the requested number of chromosomesGenetic.runreturns the fittest chromosome when termination is reachedGenetic.runforwards generation and temperature values to the termination callbackSelection.elite,Selection.random,Selection.tournament,Selection.tournamentNoDuplicates,Selection.roulette,Selection.boltzmann,Selection.stochasticUniversalSampling, andSelection.rankeach return the requested number of chromosomes under their respective selection rulesSelection.selectsplits a population into parent pairs, the chromosomes consumed as parents, and leftover chromosomes according toSelectionRate, rounding odd counts up to stay even - parents are counted per physically consumed population slot (never more than actually exist for a given value), so they add back up to the population size alongside leftover whetherSelectionFnredraws the same individual more than once (astournament,roulette,boltzmann, andstochasticUniversalSamplingcan) oreliteselects several distinct slots that happen to share a value (common once a population has converged)Crossover.orderOneCrossoveralways produces children that are valid permutations of the parents' genes, with no duplicate or missing valuesMutation.scrambleandMutation.scrambleSlicepreserve the exact multiset of gene values (and, forscrambleSlice, the overall chromosome length), only reordering themMutation.flipflips every gene, andMutation.flipEachGeneflips each gene independently at its own probabilityMutation.gaussianpreserves chromosome length and its resampled genes have approximately the same mean as the original genesDistance.jaroSimilaritymatches known reference values (for example, the standardMARTHA/MARHTAexample), and is symmetricOptions.createfills every field butPopulationSizewith the same defaults asGeneticAlgorithm.CreateOptions, and every field can still be overridden via ordinary record-update syntaxGenetic.runkeeps every generation's population at exactlyPopulationSize, even thoughSelection.select,Genetic.mutation, andReinsertion.elitist/Reinsertion.uniformeach round their own fractional share of it independently and can drift by a chromosome or two on their own (for example,PopulationSize = 8with the library's own default rates produces 6 crossover children + 0 mutants + 1 survivor = 7)Genetic.runrejects anullOptions.Random, and every public rate-shaped parameter (Options.SelectionRate/MutationRate,Reinsertion.elitist/Reinsertion.uniform'ssurvivalRate,Mutation.flipEachGene/Mutation.randomReset'srate, andCrossover.uniform'srate) rejects a value outside[0, 1]- Every
Crossoverstrategy resets both children'sAgeandFitnessto0/0.0, regardless of either parent's values - and, end to end,Genetic.runkeeps every chromosome atAge = 1(the first generation a freshly born individual is observed) rather than letting it accumulate with the generation count - An empty chromosome (
Genes = [||]) is a no-op for everyCrossoverandMutationstrategy - producing another empty chromosome (or, for mutation, the same chromosome unchanged) rather than crashing or being rejected - Every
Crossoverstrategy that assumes equal-length parents validates that assumption explicitly and consistently, via one shared internal helper, rather than relying on an incidental failure from whatever array operation it happens to call first:singlePoint,multiPoint,uniform, andwholeArithmeticCrossoverall raise the same clear error naming the actual problem.multiPoint'spointCountis validated the same way, against the number of interior cut positions the parents' length actually has
Design Notes
This implementation is intentionally minimal. A few design choices to be aware of:
Mutation.scrambleis the default strategy, scrambling the genes within a chromosome rather than replacing individual genes with newly generated values;Mutation.scrambleSlicescrambles only a random window instead of the whole chromosome,Mutation.flip/Mutation.flipEachGeneare binary-genotype alternatives, andMutation.gaussianis a real-valued alternative that resamples every gene from a normal distribution fitted to the chromosome's own genes- There is no configurable crossover rate;
CrossoverFnalways runs on every selected parent pair - Every strategy function draws its randomness from the single
System.Randominstance inOptions.Random, rather thanSystem.Random.Shared, so seeding it ({ Options.create 100 with Random = System.Random(42) }in F#, or therandom-takingCreateOptionsoverload in C#) makes an otherwise-identical run fully reproducible Selection.selectidentifies which population slots were used as parents by comparingChromosomevalues, not by tracking population indices - correct (seeSelection.partitionSelected's remarks for why), but it means every'Geneneeds a meaningful equality, and multiple physically distinct chromosomes that happen to be value-identical are indistinguishable by design. A future major version could haveSelectionFnreturn indices instead of values, sidestepping both the equality constraint and the identity ambiguity entirely - a breaking change toOptions.SelectionFn's shape, not attempted herePopulationSizeis enforced by padding or truncating each generation's combined selection/crossover/mutation/reinsertion output back to the exact target size, rather than by making that combination round exactly on its own (which isn't possible in general - see theTest Coveragebullet above). A shortfall is padded with freshly generated genotypes, the same mechanism the first generation uses, rather than by duplicating existing survivors - a deliberate small diversity injection, not just a size fix- Every public rate-shaped parameter - a probability, meant to be a value in
[0, 1]- is validated the same way through one shared, internal helper, so the range check and its error message stay consistent everywhere instead of being re-implemented per call site:Options.SelectionRateandOptions.MutationRateare checked centrally inGenetic.run(which also rejects anullOptions.Random), whileReinsertion.elitist/Reinsertion.uniform'ssurvivalRate,Mutation.flipEachGene/Mutation.randomReset'srate, andCrossover.uniform'srateeach validate themselves the moment they're curried, since - unlikeSelectionRate/MutationRate- there is no single call site that can see those values.Crossover.wholeArithmeticCrossover'salphais deliberately excluded: it is a blend weight, not a probability, and values outside[0, 1]extrapolate rather than misbehave - An empty chromosome is treated as a valid, if degenerate, value everywhere rather than being rejected as invalid input - matching
Chromosome.Size's own contract, which is explicitly0for one. This was a deliberate policy choice: mostCrossover/Mutationstrategies already no-op correctly for empty input on their own (an operation over an empty array is usually itself a no-op), so treating emptiness as valid needed far less code than the alternative of adding new rejection checks to every strategy that already worked - onlyCrossover.singlePoint/messySinglePoint/orderOneCrossover(each of which drew a random cut point via a range derived fromGenes.Length, invalid when it's0) andMutation.gaussian(which fits a mean/variance to the genes, undefined for zero genes) needed an explicit guard to fall in line with the rest
Those constraints keep the code simple, but they also make the project a good starting point for extending the algorithm with richer mutation operators or alternative crossover strategies.
Repository Goals
This project is a good fit if you want to:
- Learn how a genetic algorithm can be implemented in F#
- Experiment with generic chromosome representations
- Build on a small codebase instead of adopting a large framework
- Add new example problems and compare evolutionary behavior
License
This repository is licensed under the terms of the LICENSE file in the project root.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- FSharp.Core (>= 10.1.401)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.