org.oakgp.node

Class VariableNode

java.lang.Object

org.oakgp.node.VariableNode

All Implemented Interfaces:

Node

public final class VariableNode
extends Object

Represents a variable.

The result of evaluating this node will vary based on the Assignments specified.

Constructor Summary

Constructors

Constructor and Description
VariableNode(int id, Type type) Constructs a new VariableNode with the specified ID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Two VariableNode references are only "equal" if they refer to the same instance.
Object	evaluate(Assignments assignments) Returns the value assigned to this VariableNode by the specified Assignments.
int	getHeight() Returns the height of this Node.
int	getId() Returns the ID associated with the variable.
int	getNodeCount() Returns the total number of nodes represented by this Node - including any child-nodes.
NodeType	getNodeType() Returns the NodeType of this Node.
Type	getType() Returns the Type of this Node.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableNode

public VariableNode(int id,
                    Type type)

Constructs a new VariableNode with the specified ID.

Parameters:

id - represents the index to specify when getting the value for this variable from an Assignments

type - the Type that the values represented by this node are of

Method Detail

getId

public int getId()

Returns the ID associated with the variable.

The ID indicates the index to specify when getting the value for this variable from an Assignments.

evaluate

public Object evaluate(Assignments assignments)

Returns the value assigned to this VariableNode by the specified Assignments.

Parameters:

assignments - represents the values to assign to any variables used in the evaluation of this Node

Returns:

the value stored in Assignments at the index specified by the ID of this VariableNode

getType

public Type getType()

Description copied from interface: Node

Returns the Type of this Node.

This indicates the type of the value returned when #evaluate(Assignments) is called on this Node.

getNodeType

public NodeType getNodeType()

Description copied from interface: Node

Returns the NodeType of this Node.

This can be used to determine if the node is a function, constant or variable node.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Two VariableNode references are only "equal" if they refer to the same instance.

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getHeight

public final int getHeight()

Description copied from interface: Node

Returns the height of this Node.

The height of a node is the number of edges on the longest downward path between that node and a leaf.

Specified by:

getHeight in interface Node

getNodeCount

public final int getNodeCount()

Description copied from interface: Node

Returns the total number of nodes represented by this Node - including any child-nodes.

Specified by:

getNodeCount in interface Node