Global

Methods

alphabet() → {string}

Returns a random letter in the alphabet, including uppercase characters and whitespace

Source:

• genetic/geneFactories.js, line 33

Returns:

A random letter in the alphabet

Type

string

arrayEqual(a, b) → {boolean}

Compares two arrays by each element

Parameters:

Name	Type	Description
a	array	The first array to compare
b	array	The second array to compare

Source:

• infrastructure/utils.js, line 47

Returns:

True if the provided arrays are equal, otherwise false

Type

boolean

binaryNumber() → {number}

Returns a random binary number

Source:

• genetic/geneFactories.js, line 17

Returns:

A random binary number

Type

number

binaryString() → {number}

Returns a random binary string

Source:

• genetic/geneFactories.js, line 25

Returns:

A random binary string

Type

number

createCalculation(registerSet, index) → {RegisterReference}

Returns a new calculation register reference

Parameters:

Name	Type	Description
registerSet	RegisterSet	A register set instance
index	number	Optional user specified index

Source:

• genetic/linear/registerReference.js, line 102

Returns:

A new calculation register reference

Type

RegisterReference

createConstant(registerSet, index) → {RegisterReference}

Returns a new constant register reference

Parameters:

Name	Type	Description
registerSet	RegisterSet	A register set instance
index	number	Optional user specified index

Source:

• genetic/linear/registerReference.js, line 92

Returns:

A new constant register reference

Type

RegisterReference

createInput(registerSet, index) → {RegisterReference}

Returns a new input register reference

Parameters:

Name	Type	Description
registerSet	RegisterSet	A register set instance
index	number	Optional user specified index

Source:

• genetic/linear/registerReference.js, line 82

Returns:

A new input register reference

Type

RegisterReference

createOutput(registerSet, index) → {RegisterReference}

Returns a new output register reference

Parameters:

Name	Type	Description
registerSet	RegisterSet	A register set instance
index	number	Optional user specified index

Source:

• genetic/linear/registerReference.js, line 112

Returns:

A new output register reference

Type

RegisterReference

formatString(stringVar, argsArray) → {string}

Replaces each tag in the provided string with its corresponding parameter element

Parameters:

Name	Type	Description
stringVar	string	String to convert
argsArray	array	An array of arguments

Source:

• infrastructure/utils.js, line 63

Returns:

Converted string

Type

string

fpEqual(a, b) → {boolean}

Performs floating point comparison between two numbers with an epsilon of 0.00001

Parameters:

Name	Type	Description
a	number	The first number to compare
b	number	The second number to compare

Source:

• infrastructure/utils.js, line 37

Returns:

True if the provided numbers are equal, otherwise false

Type

boolean

inherits()

Calls nodes util.inherits function

Source:

• infrastructure/utils.js, line 72

linearNode(A) → {LinearGPNode}

Returns a random linear node for linear genetic programming

Parameters:

Name	Type	Description
A	LinearIndividual	linear individual to create a node for

Source:

• genetic/geneFactories.js, line 43

Returns:

A random linear node

Type

LinearGPNode

onePointFixed(individuals) → {Array.<Individual>}

Performs one point fixed crossover

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array containing two individuals

Source:

• genetic/crossoverStrategies.js, line 53

Returns:

An array containing two offspring

Type

Array.<Individual>

onePointVariable(individuals) → {Array.<Individual>}

Performs one point variable crossover

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array containing two individuals

Source:

• genetic/crossoverStrategies.js, line 106

Returns:

An array containing two offspring

Type

Array.<Individual>

randBetween(min, max)

Returns a random whole number between a specified range

Parameters:

Name	Type	Description
min	number	Minimum value (inclusive)
max	number	Maximum value (exclusive)

Source:

• infrastructure/utils.js, line 9

Returns:

A random whole number between a specified range

random()

Returns a random number between 0 and 1

Source:

• infrastructure/utils.js, line 18

Returns:

A random number between 0 and 1

random(individuals, options)

Returns two randomly selected individuals

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array of individuals
options	object	Population options

Source:

• genetic/selectionStrategies.js, line 8

randomNumber() → {number}

Returns a random number between 0 and 1

Source:

• genetic/geneFactories.js, line 9

Returns:

A random number between 0 and 1

Type

number

rank(individuals, options)

Returns two individuals using the rank selection algorithm

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array of individuals
options	object	Population options

Source:

• genetic/selectionStrategies.js, line 25

rouletteWheel(individuals, options)

Returns two individuals using the roulette wheel selection algorithm

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array of individuals
options	object	Population options

Source:

• genetic/selectionStrategies.js, line 62

selectRandom(from)

Returns a randomly selected element from an array

Parameters:

Name	Type	Description
from	array	An array to select an element from

Source:

• infrastructure/utils.js, line 27

Returns:

A randomly selected element from the provided array

swapGenes(indvidualA, indvidualB, index)

Swaps genes between two individuals at the specified index

Parameters:

Name	Type	Description
indvidualA	Individual	The first individual
indvidualB	Individual	The second individual
index	number	Body array index to swap genes at

Source:

• genetic/crossoverStrategies.js, line 42

tournament(individuals, options)

Returns two individuals using the tournament selection algorithm

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array of individuals
options	object	Population options

Source:

• genetic/selectionStrategies.js, line 34

twoPointFixed(individuals) → {Array.<Individual>}

Performs two point fixed crossover

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array containing two individuals

Source:

• genetic/crossoverStrategies.js, line 70

Returns:

An array containing two offspring

Type

Array.<Individual>

twoPointVariable(individuals) → {Array.<Individual>}

Performs two point variable crossover

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array containing two individuals

Source:

• genetic/crossoverStrategies.js, line 123

Returns:

An array containing two offspring

Type

Array.<Individual>

uniform(individuals) → {Array.<Individual>}

Performs uniform crossover

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array containing two individuals

Source:

• genetic/crossoverStrategies.js, line 88

Returns:

An array containing two offspring

Type

Array.<Individual>

validateFixedLength(individuals)

Throws an exception if any individuals are not fixed length

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array of individuals to validate

Source:

• genetic/crossoverStrategies.js, line 19

Throws:

An exception is thrown if any individuals are not fixed length

validateMinimumLength(individuals)

Throws an exception if any individuals have less than two genes

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array of individuals to validate

Source:

• genetic/crossoverStrategies.js, line 8

Throws:

An exception is thrown if any individuals have less than two genes

validateVariableLength(individuals)

Throws an exception if any individuals are fixed length

Parameters:

Name	Type	Description
individuals	Array.<Individual>	An array of individuals to validate

Source:

• genetic/crossoverStrategies.js, line 30

Throws:

An exception is thrown if any individuals are fixed length