examples.gp.paintedDesert
Class LoopUntil

java.lang.Object
  org.jgap.gp.CommandGene
      examples.gp.paintedDesert.LoopUntil

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class LoopUntil
extends CommandGene

A loop until the condition of the first argument is true.

Since:

3.2

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

LoopUntil(GPConfiguration a_conf)
Constructor for the function

LoopUntil(GPConfiguration a_conf, java.lang.Class a_typeVar, int a_count)

Method Summary

int	compareTo(java.lang.Object a_other) The compareTo-method.
boolean	equals(java.lang.Object a_other) The equals-method.
boolean	execute_boolean(ProgramChromosome c, int n, java.lang.Object[] args) Executes the LoopUntil function for a void argument.
java.lang.Class	getChildType(IGPProgram a_ind, int a_chromNum) Gets the type of node allowed from the given child number.
java.lang.String	getName()
boolean	isValid(ProgramChromosome a_program) Subclasses capable of validating programs should overwrite this method.
java.lang.String	toString() Program listing name of function

Methods inherited from class org.jgap.gp.CommandGene

check, check, cleanup, dynamizeArity, ensureUniqueness, ensureUniqueness, ensureUniqueness2, execute_double, execute_float, execute_int, execute_long, execute_object, execute_void, execute, getAllele, getApplicationData, getArity, getArityMax, getArityMin, getCommandType, getEnergy, getGPConfiguration, getInternalValue, getPersistentRepresentation, getPersistentRepresentationExt, getReturnType, getSubChildType, getSubChildTypes, getSubReturnType, hashCode, init, isAffectGlobalState, isCompareApplicationData, isFloatType, isIntegerType, isValid, setAllele, setApplicationData, setArity, setArityMax, setArityMin, setCompareApplicationData, setEnergy, setNoValidation, setReturnType, setToRandomValue, setValueFromPersistentRepresentation, setValueFromString, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LoopUntil

public LoopUntil(GPConfiguration a_conf)
          throws InvalidConfigurationException

Constructor for the function

Parameters:

a_conf -

Throws:

InvalidConfigurationException

LoopUntil

public LoopUntil(GPConfiguration a_conf,
                 java.lang.Class a_typeVar,
                 int a_count)
          throws InvalidConfigurationException

Throws:

InvalidConfigurationException

Method Detail

toString

public java.lang.String toString()

Program listing name of function

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

execute_boolean

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

Executes the LoopUntil function for a void argument. Essentially loops m_count times.

Overrides:

execute_boolean in class CommandGene

Parameters:

c -

test -

args -

Returns:

nothing but exception

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

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.01

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.01