org.jgap.gp.function

Class IncrementMemory

java.lang.Object

org.jgap.gp.CommandGene

org.jgap.gp.MathCommand

org.jgap.gp.function.IncrementMemory

All Implemented Interfaces:

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

public class IncrementMemory
extends MathCommand
implements ICloneable

Increments the value of a memory cell and returns the incremented value. Allows presetting a value in case* memory cell is not initialized.

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

Constructors

Constructor and Description
IncrementMemory(GPConfiguration a_conf, java.lang.Class a_returnType, java.lang.String a_memoryName, int a_initialValue) Constructor for using an increment of 1.
IncrementMemory(GPConfiguration a_conf, java.lang.Class a_returnType, java.lang.String a_memoryName, int a_initialValue, int a_increment) Constructor to freely choose increment.

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.
int	execute_int(ProgramChromosome c, int n, java.lang.Object[] args) Executes this node as an integer.
java.lang.String	getName()
java.lang.String	toString()

Methods inherited from class org.jgap.gp.CommandGene

cleanup, dynamizeArity, ensureUniqueness, ensureUniqueness, ensureUniqueness2, execute_boolean, execute_double, execute_float, execute_long, execute_object, execute_void, execute, getAllele, getApplicationData, getArity, getChildType, getEnergy, getGPConfiguration, getPersistentRepresentation, getReturnType, getSubChildType, getSubChildTypes, getSubReturnType, hashCode, isAffectGlobalState, isCompareApplicationData, isFloatType, isIntegerType, isValid, 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

IncrementMemory

public IncrementMemory(GPConfiguration a_conf,
                       java.lang.Class a_returnType,
                       java.lang.String a_memoryName,
                       int a_initialValue)
                throws InvalidConfigurationException

Constructor for using an increment of 1.

Parameters:

a_conf - the configuration to use

a_returnType - the type of the terminal to increment (e.g. IntegerClass)

a_memoryName - name of the memory cell

a_initialValue - initial value of the memory cell

Throws:

InvalidConfigurationException

Since:

3.2

IncrementMemory

public IncrementMemory(GPConfiguration a_conf,
                       java.lang.Class a_returnType,
                       java.lang.String a_memoryName,
                       int a_initialValue,
                       int a_increment)
                throws InvalidConfigurationException

Constructor to freely choose increment.

Parameters:

a_conf - the configuration to use

a_returnType - the type of the terminal to increment (e.g. IntegerClass)

a_memoryName - name of the memory cell

a_initialValue - initial value of the memory cell

a_increment - the increment to use, may also be negative

Throws:

InvalidConfigurationException

Since:

3.2

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_int

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

Description copied from class: CommandGene

Executes this node as an integer. Override to implement.

Overrides:

execute_int in class CommandGene

Parameters:

c - ignored here

n - ignored here

args - ignored here

Returns:

nothing but exception

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

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