org.licas.ai_solver.model.genetic.genes

Class EvolveGenes

java.lang.Object

org.licas.ai_solver.model.genetic.genes.EvolveGenes

Direct Known Subclasses:

DefaultEvolveGenes, DefaultEvolveGenesPct, EvolveGenesBOW

public abstract class EvolveGenes
extends java.lang.Object

This is the base class for evolving two different gene lists through crossovers or mutations, to generate a new one. This does not store the gene list itself, which is stored in a Chromosome, but gets passed the gene lists from the chromosome and applies the evolution mechanism to create a new one. While the gene data is stored as a MetricDataset, these classes get passed the data list only. This can be a ArrayList of MetricValue objects, or the data objects directly.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.String>	evolveTypes The different ways that a crossover or mutation can be performed.
protected java.lang.String	geneType The type of object that represents a gene.

Constructor Summary

Constructors

Constructor and Description
EvolveGenes(java.lang.String thisGeneType, java.util.ArrayList<java.lang.String> thisEvolveTypes) Create a new instance of EvolveGenes.

Method Summary

Modifier and Type	Method and Description
boolean	addEvolveType(java.lang.String thisEvolveType) Ad a new evolution type to the list.
abstract boolean	areSame(java.util.ArrayList<?> geneList1, java.util.ArrayList<?> geneList2) Return true if the two sets of genes are the same.
void	clearEvolveTypes() Clear the list of evolution types that determine how a mutation is performed.
protected abstract java.util.ArrayList<?>	crossover(java.util.ArrayList<?> geneList1, java.util.ArrayList<?> geneList2) Generate a crossover between this gene list and the variable passed in.
java.util.ArrayList<?>	evolveGenes(java.util.ArrayList<?> geneList1, java.util.ArrayList<?> geneList2) Combine the two sets of genes to create a new list.
static EvolveGenes	getEvolveGeneType(EvolveInfo evolveInfo) Return an appropriate gene evolution object based on the gene type (probably the dataset type) and set of evolution requirements.
java.util.ArrayList<java.lang.String>	getEvolveTypes() Get the list of different ways that a evolutions can be performed.
protected abstract java.util.ArrayList<?>	mutate(java.util.ArrayList<?> geneList1, java.util.ArrayList<?> geneList2) Generate a mutation between this gene list and the variable passed in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

geneType

protected java.lang.String geneType

The type of object that represents a gene. This should be the classname

evolveTypes

protected java.util.ArrayList<java.lang.String> evolveTypes

The different ways that a crossover or mutation can be performed. This is a list of Strings describing each type.

Constructor Detail

EvolveGenes

public EvolveGenes(java.lang.String thisGeneType,
                   java.util.ArrayList<java.lang.String> thisEvolveTypes)

Create a new instance of EvolveGenes.

Parameters:

thisGeneType - the type of gene as the object classname.

thisEvolveTypes - the different ways that a crossover or mutation can be performed.

Method Detail

areSame

public abstract boolean areSame(java.util.ArrayList<?> geneList1,
                                java.util.ArrayList<?> geneList2)
                         throws java.lang.Exception

Return true if the two sets of genes are the same.

Parameters:

geneList1 - the first list of consider.

geneList2 - the second list to consider.

Returns:

true if the genes are the same. This implementation returns false by default. You need to override this implementation to make any real comparison.

Throws:

java.lang.Exception - any error.

crossover

protected abstract java.util.ArrayList<?> crossover(java.util.ArrayList<?> geneList1,
                                                    java.util.ArrayList<?> geneList2)
                                             throws java.lang.Exception

Generate a crossover between this gene list and the variable passed in.

Parameters:

geneList1 - the first list of consider.

geneList2 - the second list to consider.

Returns:

the result of the crossover. Can return null.

Throws:

java.lang.Exception - any error.

mutate

protected abstract java.util.ArrayList<?> mutate(java.util.ArrayList<?> geneList1,
                                                 java.util.ArrayList<?> geneList2)
                                          throws java.lang.Exception

Generate a mutation between this gene list and the variable passed in.

Parameters:

geneList1 - the first list of consider.

geneList2 - the second list to consider.

Returns:

the result of the mutation. Can return null.

Throws:

java.lang.Exception - any error.

evolveGenes

public java.util.ArrayList<?> evolveGenes(java.util.ArrayList<?> geneList1,
                                          java.util.ArrayList<?> geneList2)
                                   throws java.lang.Exception

Combine the two sets of genes to create a new list.

Parameters:

geneList1 - the first list of consider.

geneList2 - th second list to consider.

Returns:

the evolved gene list. Can return null.

Throws:

java.lang.Exception - any error.

clearEvolveTypes

public void clearEvolveTypes()

Clear the list of evolution types that determine how a mutation is performed.

addEvolveType

public boolean addEvolveType(java.lang.String thisEvolveType)

Ad a new evolution type to the list.

Parameters:

thisEvolveType - a type of evolution that can be performed.

Returns:

true if added, false if it already exists.

getEvolveTypes

public java.util.ArrayList<java.lang.String> getEvolveTypes()

Get the list of different ways that a evolutions can be performed.

Returns:

the value of evolveTypes.

getEvolveGeneType

public static EvolveGenes getEvolveGeneType(EvolveInfo evolveInfo)

Return an appropriate gene evolution object based on the gene type (probably the dataset type) and set of evolution requirements.

Parameters:

evolveInfo - a full description of the evolution process.

Returns:

the object that will be used to evolve chromosome genes.