org.jgap.gp.function
Class SubProgram

java.lang.Object
  org.jgap.gp.CommandGene
      org.jgap.gp.function.SubProgram

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class SubProgram
extends CommandGene

A connector for indipendent subprograms (subtrees). Each subtree except the last one must have a memory- or stack-modifying command (such as push or store), otherwise there is no connection between the subtrees (which would be useless bloating).

Since:

3.0

See Also:

Serialized Form

Field Summary

Fields inherited from class org.jgap.gp.CommandGene

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

Constructor Summary

SubProgram(GPConfiguration a_conf, java.lang.Class[] a_types)

Method Summary

int	compareTo(java.lang.Object a_other) The compareTo-method.
boolean	equals(java.lang.Object a_other) The equals-method.
double	execute_double(ProgramChromosome c, int n, java.lang.Object[] args) Executes this node as a double.
float	execute_float(ProgramChromosome c, int n, java.lang.Object[] args) Executes this node as a float.
int	execute_int(ProgramChromosome c, int n, java.lang.Object[] args) Executes this node as an integer.
long	execute_long(ProgramChromosome c, int n, java.lang.Object[] args) Executes this node as a long.
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 form the given child number.
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

check, check, cleanup, execute_boolean, execute, getAllele, getApplicationData, getArity, getEnergy, getGPConfiguration, getInternalValue, getName, getPersistentRepresentation, getReturnType, hashCode, init, isAffectGlobalState, isCompareApplicationData, isFloatType, isIntegerType, isValid, setAllele, setApplicationData, setCompareApplicationData, setEnergy, setNoValidation, setReturnType, setToRandomValue, setValueFromPersistentRepresentation, size

Methods inherited from class java.lang.Object

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

Constructor Detail

SubProgram

public SubProgram(GPConfiguration a_conf,
                  java.lang.Class[] a_types)
           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.

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

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

execute_long

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

Description copied from class: CommandGene

Executes this node as a long. Override to implement.

Overrides:

execute_long in class CommandGene

Parameters:

c - ignored here

n - ignored here

args - ignored here

Returns:

nothing but exception

execute_float

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

Description copied from class: CommandGene

Executes this node as a float. Override to implement.

Overrides:

execute_float in class CommandGene

Parameters:

c - ignored here

n - ignored here

args - ignored here

Returns:

nothing but exception

execute_double

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

Description copied from class: CommandGene

Executes this node as a double. Override to implement.

Overrides:

execute_double in class CommandGene

Parameters:

c - ignored here

n - ignored here

args - ignored here

Returns:

nothing but exception

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

isValid

public boolean isValid(ProgramChromosome a_program)

Description copied from class: CommandGene

Subclasses capable of validating programs should overwrite this method. See PushCommand 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 form the given child number. Must 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

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