JGAP

org.jgap.gp.function
Class ReadFromMatrix

java.lang.Object
  extended by org.jgap.gp.CommandGene
      extended by org.jgap.gp.function.ReadFromMatrix
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, ICloneable

public class ReadFromMatrix
extends CommandGene
implements ICloneable

Reads a value from a two-dimensional matrix in internal memory.

Since:
3.4.3
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
ReadFromMatrix(GPConfiguration a_conf, java.lang.String a_matrixName)
           
ReadFromMatrix(GPConfiguration a_conf, java.lang.String a_matrixName, int a_subChildType)
          Allows setting a sub child type.
 
Method Summary
 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.
 java.lang.Class getChildType(IGPProgram a_ind, int a_chromNum)
          Determines which type a specific child of this command has.
 java.lang.String getName()
           
 java.lang.String toString()
           
 
Methods inherited from class org.jgap.gp.CommandGene
check, check, cleanup, dynamizeArity, ensureUniqueness, ensureUniqueness, ensureUniqueness2, execute_boolean, execute_double, execute_float, execute_int, execute_long, 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, isValid, setAllele, setApplicationData, setArity, setArityMax, setArityMin, setCompareApplicationData, setEnergy, setNoValidation, setReturnType, setToRandomValue, setValueFromPersistentRepresentation, setValueFromString, size
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReadFromMatrix

public ReadFromMatrix(GPConfiguration a_conf,
                      java.lang.String a_matrixName)
               throws InvalidConfigurationException
Throws:
InvalidConfigurationException

ReadFromMatrix

public ReadFromMatrix(GPConfiguration a_conf,
                      java.lang.String a_matrixName,
                      int a_subChildType)
               throws InvalidConfigurationException
Allows setting a sub child type.

Parameters:
a_conf - GPConfiguration
a_matrixName - String
a_subChildType - int
Throws:
InvalidConfigurationException
Since:
3.4.3
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.4.3

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

getChildType

public java.lang.Class getChildType(IGPProgram a_ind,
                                    int a_chromNum)
Determines which type a specific child of this command has.

Overrides:
getChildType in class CommandGene
Parameters:
a_ind - ignored here
a_chromNum - index of child
Returns:
type of the a_chromNum'th child
Since:
3.4.3

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

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

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

JGAP