org.oakgp.node.walk

Class DepthWalk

java.lang.Object

org.oakgp.node.walk.DepthWalk

public final class DepthWalk
extends Object

Provides a mechanism for recursively visiting nodes in a tree structure while keeping track of the depth of each node.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DepthWalk.DepthWalkReplacement Defines a strategy for determining a replacement for a node encountered when walking a tree structure.
static interface	DepthWalk.DepthWalkStrategy Defines a strategy for determining which nodes should be considered when walking a tree structure.

Method Summary

Modifier and Type	Method and Description
static Node	getAt(Node current, int index, DepthWalk.DepthWalkStrategy treeWalkerStrategy) Returns a Node from the tree structure represented by the given Node that matches the specified predicate.
static int	getNodeCount(Node tree, DepthWalk.DepthWalkStrategy treeWalkerStrategy) Returns the total number of nodes contained in the tree-structure represented by the given Node that match the specified predicate.
static Node	replaceAt(Node current, int index, DepthWalk.DepthWalkReplacement replacement) Returns a new Node resulting from replacing the Node at position index of the given Node with the result of replacement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNodeCount

public static int getNodeCount(Node tree,
                               DepthWalk.DepthWalkStrategy treeWalkerStrategy)

Returns the total number of nodes contained in the tree-structure represented by the given Node that match the specified predicate.

Parameters:

treeWalkerStrategy - the predicate used to determine if a Node should be included in the count

getAt

public static Node getAt(Node current,
                         int index,
                         DepthWalk.DepthWalkStrategy treeWalkerStrategy)

Returns a Node from the tree structure represented by the given Node that matches the specified predicate.

replaceAt

public static Node replaceAt(Node current,
                             int index,
                             DepthWalk.DepthWalkReplacement replacement)

Returns a new Node resulting from replacing the Node at position index of the given Node with the result of replacement.

Parameters:

index - the index of the Node, in the tree structure represented by this object, that needs to be replaced

replacement - the function to apply to the Node at index to determine the Node that should replace it

Returns:

a new Node derived from replacing the Node at index with the result of replacement