org.jgap.gp.function

Class ForLoop

java.lang.Object

org.jgap.gp.CommandGene

org.jgap.gp.function.ForLoop

All Implemented Interfaces:

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

public class ForLoop
extends CommandGene
implements ICloneable

The for-loop. You can preset the start index and the end index. If the latter is not given, it is dynamically computed from a child.

Since:

3.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jgap.gp.CommandGene

CommandGene.COMMAND_TYPE

Field Summary

Fields inherited from class org.jgap.gp.CommandGene

BooleanClass, CharacterClass, DELTA, DoubleClass, FloatClass, IntegerClass, LongClass, nodeIndex, VoidClass

Constructor Summary

Constructors

Constructor and Description
ForLoop(GPConfiguration a_conf, java.lang.Class a_typeVar, int a_maxLoop) Constructor.
ForLoop(GPConfiguration a_conf, java.lang.Class a_typeVar, int a_startIndex, int a_maxLoop) Constructor allowing to preset the starting index of the loop.
ForLoop(GPConfiguration a_conf, java.lang.Class a_typeVar, int a_startIndex, int a_endIndex, int a_increment, java.lang.String a_varName) Constructor allowing to preset the starting and the ending index of the loop.
ForLoop(GPConfiguration a_conf, java.lang.Class a_typeVar, int a_startIndex, int a_endIndex, int a_increment, java.lang.String a_varName, int a_subReturnType, int a_subChildType)
ForLoop(GPConfiguration a_conf, java.lang.Class a_typeVar, int a_startIndex, int a_maxLoop, java.lang.String a_varName)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clones the object.
int	compareTo(java.lang.Object a_other) The compareTo-method.
boolean	equals(java.lang.Object a_other) The equals-method.
java.lang.Object	execute_object(ProgramChromosome c, int n, java.lang.Object[] args) Executes this node as an object.
void	execute_void(ProgramChromosome c, int n, java.lang.Object[] args) Executes this node, returning nothing.
java.lang.Class	getChildType(IGPProgram a_ind, int a_chromNum) Gets the type of node allowed from the given child number.
java.lang.String	getCounterMemoryName()
java.lang.String	getName()
java.lang.String	getVarName()
boolean	isValid(ProgramChromosome a_program) Subclasses capable of validating programs should overwrite this method.
java.lang.String	toString()

Methods inherited from class org.jgap.gp.CommandGene

cleanup, dynamizeArity, ensureUniqueness, ensureUniqueness, ensureUniqueness2, execute_boolean, execute_double, execute_float, execute_int, execute_long, execute, getAllele, getApplicationData, getArity, getEnergy, getGPConfiguration, getPersistentRepresentation, getReturnType, getSubChildType, getSubChildTypes, getSubReturnType, hashCode, isAffectGlobalState, isCompareApplicationData, isFloatType, isIntegerType, isValid, setAllele, setApplicationData, setCompareApplicationData, setEnergy, setNoValidation, setReturnType, setToRandomValue, setValueFromPersistentRepresentation, size

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ForLoop

public ForLoop(GPConfiguration a_conf,
               java.lang.Class a_typeVar,
               int a_maxLoop)
        throws InvalidConfigurationException

Constructor.

Parameters:

a_conf - the configuration to use

a_typeVar - Class of the loop counter terminakl (e.g. IntegerClass)

a_maxLoop - the maximum number of loops to perform

Throws:

InvalidConfigurationException

Since:

3.0

ForLoop

public ForLoop(GPConfiguration a_conf,
               java.lang.Class a_typeVar,
               int a_startIndex,
               int a_maxLoop)
        throws InvalidConfigurationException

Constructor allowing to preset the starting index of the loop.

Parameters:

a_conf - the configuration to use

a_typeVar - Class of the loop counter terminakl (e.g. IntegerClass)

a_startIndex - index to start the loop with (normally 0)

a_maxLoop - the maximum number of loops to perform

Throws:

InvalidConfigurationException

Since:

3.0

ForLoop

public ForLoop(GPConfiguration a_conf,
               java.lang.Class a_typeVar,
               int a_startIndex,
               int a_maxLoop,
               java.lang.String a_varName)
        throws InvalidConfigurationException

Throws:

InvalidConfigurationException

ForLoop

public ForLoop(GPConfiguration a_conf,
               java.lang.Class a_typeVar,
               int a_startIndex,
               int a_endIndex,
               int a_increment,
               java.lang.String a_varName)
        throws InvalidConfigurationException

Constructor allowing to preset the starting and the ending index of the loop.

Parameters:

a_conf - the configuration to use

a_typeVar - Class of the loop counter terminal (e.g. IntegerClass)

a_startIndex - index to start the loop with

a_endIndex - index to end the loop with

a_increment - the maximum number of loops to perform

a_varName - informal textual name of the loop counter variable

Throws:

InvalidConfigurationException

Since:

3.2

ForLoop

public ForLoop(GPConfiguration a_conf,
               java.lang.Class a_typeVar,
               int a_startIndex,
               int a_endIndex,
               int a_increment,
               java.lang.String a_varName,
               int a_subReturnType,
               int a_subChildType)
        throws InvalidConfigurationException

Throws:

InvalidConfigurationException

Method Detail

toString

public java.lang.String toString()

Specified by:

toString in class CommandGene

Returns:

the string representation of the command. Especially usefull to output a resulting formula in human-readable form.

getName

public java.lang.String getName()

Overrides:

getName in class CommandGene

Returns:

textual name of this command

Since:

3.2

execute_object

public java.lang.Object execute_object(ProgramChromosome c,
                                       int n,
                                       java.lang.Object[] args)

Description copied from class: CommandGene

Executes this node as an object. Override to implement.

Overrides:

execute_object in class CommandGene

Parameters:

c - ignored here

n - ignored here

args - ignored here

Returns:

nothing but exception

execute_void

public void execute_void(ProgramChromosome c,
                         int n,
                         java.lang.Object[] args)

Description copied from class: CommandGene

Executes this node, returning nothing. Override to implement.

Overrides:

execute_void in class CommandGene

Parameters:

c - ignored here

n - ignored here

args - ignored here

isValid

public boolean isValid(ProgramChromosome a_program)

Description copied from class: CommandGene

Subclasses capable of validating programs should overwrite this method. See class Push as a sample.

Overrides:

isValid in class CommandGene

Parameters:

a_program - the ProgramChromosome to validate

Returns:

true: a_program is (superficially) valid with the current Command

getChildType

public java.lang.Class getChildType(IGPProgram a_ind,
                                    int a_chromNum)

Description copied from class: CommandGene

Gets the type of node allowed from the given child number. Should be overridden in subclasses.

Overrides:

getChildType in class CommandGene

Parameters:

a_ind - the individual the child belongs to

a_chromNum - the chromosome number

Returns:

the type of node allowed for that child, or null of no child exists

getVarName

public java.lang.String getVarName()

Returns:

symbolic name of the variable name used in the for header.

Since:

3.4

compareTo

public int compareTo(java.lang.Object a_other)

The compareTo-method.

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class CommandGene

Parameters:

a_other - the other object to compare

Returns:

-1, 0, 1

Since:

3.0

equals

public boolean equals(java.lang.Object a_other)

The equals-method.

Overrides:

equals in class CommandGene

Parameters:

a_other - the other object to compare

Returns:

true if the objects are seen as equal

Since:

3.0

getCounterMemoryName

public java.lang.String getCounterMemoryName()

Returns:

name of the memory cell where the current value of the loop variable is stored

Since:

3.2

clone

public java.lang.Object clone()

Clones the object. Simple and straight forward implementation here.

Specified by:

clone in interface ICloneable

Overrides:

clone in class java.lang.Object

Returns:

cloned instance of this object

Since:

3.4