Class GeneticSearch<TGenome>

A genetic search algorithm.

Remarks

This class implements the genetic search algorithm. The algorithm is configured using the [[GeneticSearchConfig]] object.

The algorithm uses the following components, which can be customized by providing a custom implementation:

A [[PopulateStrategyInterface]] to generate the initial population.
A [[MutationStrategyInterface]] to mutate the population.
A [[CrossoverStrategyInterface]] to cross over the population.
A [[PhenomeStrategyInterface]] to calculate the phenome of the population.
A [[FitnessStrategyInterface]] to calculate the fitness of the population.
A [[PhenomeCacheInterface]] to cache the phenome of the population.

Type Parameters

TGenome extends BaseGenome
The type of genome objects in the population.

Implements

GeneticSearchInterface<TGenome>

Index

Constructors

constructor

new GeneticSearch<TGenome extends BaseGenome>(
    config: GeneticSearchConfig,
    strategy: GeneticSearchStrategyConfig<TGenome>,
    idGenerator?: IdGeneratorInterface<TGenome>,
): GeneticSearch<TGenome>
Constructs a new instance of the GeneticSearch class.
Type Parameters
- TGenome extends BaseGenome
Parameters
- config: GeneticSearchConfig
  The configuration for the genetic search.
- strategy: GeneticSearchStrategyConfig<TGenome>
  The strategy configuration for genetic operations.
- OptionalidGenerator: IdGeneratorInterface<TGenome>
  An optional ID generator for the genomes.
Returns GeneticSearch<TGenome>
- Defined in src/genetic.ts:60

Properties

`Protected`_generation

_generation: number = 1

`Protected`_population

_population: Population<TGenome>

`Protected`_populationBuffer

_populationBuffer: Population<TGenome> = []

Accessors

bestGenome

get bestGenome(): TGenome
Gets the best genome from the population.

Returns TGenome
The best genome from the population.
Implementation of GeneticSearchInterface.bestGenome
- Defined in src/genetic.ts:88

cache

get cache(): PhenomeCacheInterface
Retrieves the phenome cache used by the genetic search algorithm.

Returns PhenomeCacheInterface
The phenome cache instance.
Implementation of GeneticSearchInterface.cache
- Defined in src/genetic.ts:152

generation

get generation(): number
The current generation number.

Returns number
The current generation number.
Implementation of GeneticSearchInterface.generation
- Defined in src/genetic.ts:79

partitions

get partitions(): [number, number, number]
Calculates and returns the partitions of the population for the genetic operations.

Returns [number, number, number]
A tuple containing:
- The number of genomes that will survive.
- The number of genomes that will be created by crossover.
- The number of genomes that will be created by mutation.
Implementation of GeneticSearchInterface.partitions
- Defined in src/genetic.ts:131

population

get population(): Population<TGenome>
The current population of genomes.

Returns Population<TGenome>
The current population of genomes.
Implementation of GeneticSearchInterface.population
- Defined in src/genetic.ts:97
set population(population: Population<TGenome>): void
Sets the current population of genomes.
Parameters
- population: Population<TGenome>
  The new population of genomes.
Returns void
Implementation of GeneticSearchInterface.population
- Defined in src/genetic.ts:106

Methods

clearCache

clearCache(): void
Clears the cache.

Returns void
Remarks
This method clears the cache, which is used to store the phenome of the genomes. The cache is used to avoid re-calculating the phenome of the genomes if they remain unchanged.
Implementation of GeneticSearchInterface.clearCache
- Defined in src/genetic.ts:255

`Protected`crossover

crossover(input: EvaluatedGenome<TGenome>[], count: number): Population<TGenome>
Crosses the given input population.
Parameters
- input: EvaluatedGenome<TGenome>[]
  The population of genomes to cross.
- count: number
  The number of new genomes to create.
Returns Population<TGenome>
An array of new genomes created by crossing the input population.
- Defined in src/genetic.ts:277

fit

fit(config: GeneticSearchFitConfig<TGenome>): Promise<void>
Runs the genetic search algorithm.
Parameters
- config: GeneticSearchFitConfig<TGenome>
  The configuration for the genetic search algorithm.
Returns Promise<void>
A promise that resolves when the algorithm has finished running.
Implementation of GeneticSearchInterface.fit
- Defined in src/genetic.ts:175

fitStep

fitStep(
scheduler?: SchedulerInterface<TGenome>,
): Promise<GenerationFitnessColumn>
Runs a single step of the genetic search algorithm.
Parameters
- Optionalscheduler: SchedulerInterface<TGenome>
  Optional. The scheduler to use for the genetic search algorithm.
Returns Promise<GenerationFitnessColumn>
A promise that resolves with the fitness of the best genome in the population.
Implementation of GeneticSearchInterface.fitStep
- Defined in src/genetic.ts:213

getPopulationSummary

getPopulationSummary(roundPrecision?: number): PopulationSummary
Retrieves the population summary, optionally rounding the statistics to a specified precision.
Parameters
- OptionalroundPrecision: number
  Optional. The number of decimal places to round the summary statistics to. If not provided, no rounding is applied.
Returns PopulationSummary
The population summary, with statistics rounded to the specified precision if provided.
Implementation of GeneticSearchInterface.getPopulationSummary
- Defined in src/genetic.ts:163

`Protected`mutate

mutate(input: EvaluatedGenome<TGenome>[], count: number): Population<TGenome>
Mutates the given input population.
Parameters
- input: EvaluatedGenome<TGenome>[]
  The population of genomes to mutate.
- count: number
  The number of new genomes to create.
Returns Population<TGenome>
An array of new genomes created by mutating the input population.
- Defined in src/genetic.ts:300

refreshPopulation

refreshPopulation(): void
Refreshes the population.

Returns void
Remarks
This method is used to refresh the population, which is the array of genomes that are currently being evaluated. The population is refreshed by swapping the current population with the population buffer.
Implementation of GeneticSearchInterface.refreshPopulation
- Defined in src/genetic.ts:266

`Protected`refreshPopulationBuffer

refreshPopulationBuffer(input: EvaluatedGenome<TGenome>[]): void
Refreshes the population buffer from the evaluated population.
Parameters
- input: EvaluatedGenome<TGenome>[]
  The population of genomes to refresh the population buffer with.
Returns void
- Defined in src/genetic.ts:323

setPopulation

setPopulation(population: Population<TGenome>, resetIdGenerator?: boolean): void
Sets the current population of genomes.
Parameters
- population: Population<TGenome>
  The new population of genomes.
- resetIdGenerator: boolean = true
  Whether to reset the ID generator. Defaults to true.
Returns void
Implementation of GeneticSearchInterface.setPopulation
- Defined in src/genetic.ts:116

Class GeneticSearch<TGenome>

Remarks

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GeneticSearch<TGenome>

Properties

Protected_generation

Protected_population

Protected_populationBuffer

Protected Readonlyconfig

Protected ReadonlygenomeStatsManager

Protected ReadonlyidGenerator

Protected ReadonlypopulationSummaryManager

Protected Readonlystrategy

Accessors

bestGenome

Returns TGenome

cache

Returns PhenomeCacheInterface

generation

Returns number

partitions

Returns [number, number, number]

population

Returns Population<TGenome>

Parameters

Returns void

Methods

clearCache

Returns void

Remarks

Protectedcrossover

Parameters

Returns Population<TGenome>

fit

Parameters

Returns Promise<void>

fitStep

Parameters

Returns Promise<GenerationFitnessColumn>

getPopulationSummary

Parameters

Returns PopulationSummary

Protectedmutate

Parameters

Returns Population<TGenome>

refreshPopulation

Returns void

Remarks

ProtectedrefreshPopulationBuffer

Parameters

Returns void

setPopulation

Parameters

Returns void

Settings

On This Page

`Protected`_generation

`Protected`_population

`Protected`_populationBuffer

`Protected` `Readonly`config

`Protected` `Readonly`genomeStatsManager

`Protected` `Readonly`idGenerator

`Protected` `Readonly`populationSummaryManager

`Protected` `Readonly`strategy

`Protected`crossover

`Protected`mutate

`Protected`refreshPopulationBuffer