org.jgap
Interface IChromosome

All Superinterfaces:

java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

All Known Implementing Classes:

BaseChromosome, Chromosome, MyChromosome

public interface IChromosome
extends java.lang.Comparable, java.lang.Cloneable, java.io.Serializable

Interface for chromosomes.

Since:

2.6

Field Summary

static java.lang.String	CVS_REVISION String containing the CVS revision.
static java.lang.String	S_ALLELES
static java.lang.String	S_APPLICATION_DATA
static java.lang.String	S_FITNESS_VALUE Constants for toString()
static java.lang.String	S_SIZE

Method Summary

void	cleanup() Invoked when this Chromosome is no longer needed and should perform any necessary cleanup.
java.lang.Object	clone() Creates and returns a copy of this object.
java.lang.Object	getApplicationData() Retrieves the application-specific data that is attached to this Chromosome.
Configuration	getConfiguration()
double	getFitnessValue() Retrieves the fitness value of this Chromosome, as determined by the active fitness function.
double	getFitnessValueDirectly()
Gene	getGene(int a_desiredLocus) Returns the Gene at the given index (locus) within the Chromosome.
Gene[]	getGenes() Retrieves the set of genes that make up this Chromosome.
boolean	isSelectedForNextGeneration() Retrieves whether this Chromosome has been selected by the natural selector to continue to the next generation.
void	setApplicationData(java.lang.Object a_newData) This sets the application-specific data that is attached to this Chromosome.
void	setConstraintChecker(IGeneConstraintChecker a_constraintChecker) Sets the constraint checker to be used for this gene whenever method setAllele(Object) is called.
void	setFitnessValue(double a_newFitnessValue) Sets the fitness value of this Chromosome.
void	setFitnessValueDirectly(double a_newFitnessValue) Sets the fitness value of this Chromosome directly without any constraint checks, conversions or checks.
void	setGenes(Gene[] a_genes) Sets the genes for the chromosome.
void	setIsSelectedForNextGeneration(boolean a_isSelected) Sets whether this Chromosome has been selected by the natural selector to continue to the next generation or manually (e.g. via an add-method).
int	size() Returns the size of this Chromosome (the number of genes it contains).

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

CVS_REVISION

static final java.lang.String CVS_REVISION

String containing the CVS revision. Read out via reflection!

See Also:

Constant Field Values

S_FITNESS_VALUE

static final java.lang.String S_FITNESS_VALUE

Constants for toString()

See Also:

Constant Field Values

S_ALLELES

static final java.lang.String S_ALLELES

See Also:

Constant Field Values

S_APPLICATION_DATA

static final java.lang.String S_APPLICATION_DATA

See Also:

Constant Field Values

S_SIZE

static final java.lang.String S_SIZE

See Also:

Constant Field Values

Method Detail

getGene

Gene getGene(int a_desiredLocus)

Returns the Gene at the given index (locus) within the Chromosome. The first gene is at index zero and the last gene is at the index equal to the size of this Chromosome - 1.

Parameters:

a_desiredLocus - index of the gene value to be returned

Returns:

Gene at the given index

Since:

2.6

getGenes

Gene[] getGenes()

Retrieves the set of genes that make up this Chromosome. This method exists primarily for the benefit of GeneticOperators that require the ability to manipulate Chromosomes at a low level.

Returns:

an array of the Genes contained within this Chromosome

Since:

2.6

setGenes

void setGenes(Gene[] a_genes)
              throws InvalidConfigurationException

Sets the genes for the chromosome.

Parameters:

a_genes - the genes to set for the chromosome

Throws:

InvalidConfigurationException - in case constraint checker is provided

Since:

2.6

size

int size()

Returns the size of this Chromosome (the number of genes it contains). A Chromosome's size is constant and will not change, until setGenes(...) is used.

Returns:

number of genes contained within this Chromosome instance

Since:

2.6

setFitnessValue

void setFitnessValue(double a_newFitnessValue)

Sets the fitness value of this Chromosome. This method is for use by bulk fitness functions and should not be invokved from anything else (except test cases).

Parameters:

a_newFitnessValue - a positive integer representing the fitness of this Chromosome

Since:

2.6

setFitnessValueDirectly

void setFitnessValueDirectly(double a_newFitnessValue)

Sets the fitness value of this Chromosome directly without any constraint checks, conversions or checks. Only use if you know what you do.

Parameters:

a_newFitnessValue - a positive integer representing the fitness of this Chromosome

Since:

2.6

getFitnessValue

double getFitnessValue()

Retrieves the fitness value of this Chromosome, as determined by the active fitness function. If a bulk fitness function is in use and has not yet assigned a fitness value to this Chromosome, then -1 is returned.

Attention: should not be called from toString() as the fitness value would be computed if it was initial!

Returns:

a positive double value representing the fitness of this Chromosome, or -1 if a bulk fitness function is in use and has not yet assigned a fitness value to this Chromosome

Since:

2.6

getFitnessValueDirectly

double getFitnessValueDirectly()

Returns:

the lastly computed fitness value, or FitnessFunction.NO_FITNESS_VALUE in case no value has been computed yet.

Since:

2.6

setIsSelectedForNextGeneration

void setIsSelectedForNextGeneration(boolean a_isSelected)

Sets whether this Chromosome has been selected by the natural selector to continue to the next generation or manually (e.g. via an add-method).

Parameters:

a_isSelected - true if this Chromosome has been selected, false otherwise

Since:

2.6

isSelectedForNextGeneration

boolean isSelectedForNextGeneration()

Retrieves whether this Chromosome has been selected by the natural selector to continue to the next generation.

Returns:

true if this Chromosome has been selected, false otherwise

Since:

2.6

clone

java.lang.Object clone()

Creates and returns a copy of this object. Added to this interface to ensure that each chromosome implementation supports cloning.

Returns:

a clone of this instance

Throws:

java.lang.IllegalStateException - instead of CloneNotSupportedException

Since:

2.6

setConstraintChecker

void setConstraintChecker(IGeneConstraintChecker a_constraintChecker)
                          throws InvalidConfigurationException

Sets the constraint checker to be used for this gene whenever method setAllele(Object) is called.

Parameters:

a_constraintChecker - the constraint checker to be set

Throws:

InvalidConfigurationException

Since:

2.6

setApplicationData

void setApplicationData(java.lang.Object a_newData)

This sets the application-specific data that is attached to this Chromosome. Attaching application-specific data may be useful for some applications when it comes time to evaluate this Chromosome in the fitness function.

Parameters:

a_newData - the new application-specific data to attach to this Chromosome. Should be an instance of IApplicationData

Since:

2.6

getApplicationData

java.lang.Object getApplicationData()

Retrieves the application-specific data that is attached to this Chromosome. Attaching application-specific data may be useful for some applications when it comes time to evaluate this Chromosome in the fitness function. JGAP ignores this data functionally.

Returns:

the application-specific data previously attached to this Chromosome, or null if there is no data attached

Since:

2.6

cleanup

void cleanup()

Invoked when this Chromosome is no longer needed and should perform any necessary cleanup. Note that this method will attempt to release this Chromosome instance to the active ChromosomePool, if any.

Since:

2.6

getConfiguration

Configuration getConfiguration()

Returns:

the configuration set

Since:

3.0