Interface PhenomeCacheInterface

Interface for a cache of phenome associated with genomes.

This cache is used by the genetic search algorithm to store and retrieve the phenome of genomes.

Used in GeneticSearchStrategyConfig.

Remarks

The cache is used to store the phenome of genomes, which are used to calculate the fitness of the population.

interface PhenomeCacheInterface {
    clear(excludeGenomeIds: number[]): void;
    export(): Record<number, unknown>;
    get(genomeId: number, defaultValue?: PhenomeRow): undefined | PhenomeRow;
    getReady(genomeId: number): undefined | PhenomeRow;
    import(data: Record<number, unknown>): void;
    set(genomeId: number, phenome: PhenomeRow): void;
}

Implemented by

Methods

clear export get getReady import set

Methods

clear

  • clear(excludeGenomeIds: number[]): void

    Clears the cache, excluding the specified genome IDs.

    Parameters

    • excludeGenomeIds: number[]

      The IDs of the genomes to exclude from the clear operation.

    Returns void

export

  • export(): Record<number, unknown>

    Exports the cache as a record of genome IDs to phenome.

    Returns Record<number, unknown>

    The cache as a record of genome IDs to phenome.

get

  • get(genomeId: number, defaultValue?: PhenomeRow): undefined | PhenomeRow

    Gets the phenome of a genome.

    Parameters

    • genomeId: number

      The ID of the genome.

    • OptionaldefaultValue: PhenomeRow

      The default value to return if the genome is not found.

    Returns undefined | PhenomeRow

    The phenome of the genome, or the default value if the genome phenome is not found.

getReady

  • getReady(genomeId: number): undefined | PhenomeRow

    Gets the phenome of a genome, or undefined if the genome is not ready.

    Parameters

    • genomeId: number

      The ID of the genome.

    Returns undefined | PhenomeRow

    The phenome of the genome, or undefined if the genome is not ready.

import

  • import(data: Record<number, unknown>): void

    Imports the cache from a record of genome IDs to phenome.

    Parameters

    • data: Record<number, unknown>

      The cache as a record of genome IDs to phenome.

    Returns void

set

  • set(genomeId: number, phenome: PhenomeRow): void

    Sets the phenome of a genome.

    Parameters

    • genomeId: number

      The ID of the genome.

    • phenome: PhenomeRow

      The phenome of the genome.

    Returns void

Settings

Member Visibility

On This Page

Methods