org.oakgp.node

Class FunctionNode

java.lang.Object

org.oakgp.node.FunctionNode

All Implemented Interfaces:

Node

public final class FunctionNode
extends Object
implements Node

Contains a function (operator) and the arguments (operands) to apply to it.

Constructor Summary

Constructors

Constructor and Description
FunctionNode(Function function, Arguments arguments) Constructs a new FunctionNode with the specified function function and arguments.
FunctionNode(Function function, Node... arguments) Constructs a new FunctionNode with the specified function function and arguments.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Object	evaluate(Assignments assignments) Returns the result of evaluating this Node using the values of the specified Assignments.
Arguments	getArguments()
Function	getFunction()
int	getHeight() Returns the height of this Node.
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

FunctionNode

public FunctionNode(Function function,
                    Node... arguments)

Constructs a new FunctionNode with the specified function function and arguments.

Parameters:

function - the function to associate with this FunctionNode

arguments - the arguments (i.e. operands) to apply to function when evaluating this FunctionNode

FunctionNode

public FunctionNode(Function function,
                    Arguments arguments)

Constructs a new FunctionNode with the specified function function and arguments.

Parameters:

function - the function to associate with this FunctionNode

arguments - the arguments (i.e. operands) to apply to function when evaluating this FunctionNode

Method Detail

getFunction

public Function getFunction()

getArguments

public Arguments getArguments()

evaluate

public Object evaluate(Assignments assignments)

Description copied from interface: Node

Returns the result of evaluating this Node using the values of the specified Assignments.

Specified by:

evaluate in interface Node

Parameters:

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

Returns:

the result of evaluating this Node using the values of the specified Assignments

getNodeCount

public 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

getHeight

public 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

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.

Specified by:

getType in interface 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.

Specified by:

getNodeType in interface Node

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object