Class DepthCalculator<T>

java.lang.Object

io.openml.gearbox.algorithms.binarytree.pathvisitor.AbstractRootToLeafPathVisitor<T,Integer>

io.openml.gearbox.algorithms.binarytree.pathvisitor.DepthCalculator<T>

Type Parameters:

T - The type of value store in the node of the original tree

public class DepthCalculator<T>
extends AbstractRootToLeafPathVisitor<T,Integer>

Measures the depth of a binary tree.

Constructor Summary

Constructors

Constructor	Description
DepthCalculator()

Method Summary

Modifier and Type	Method	Description
static <T> DepthCalculator<T>	depthOf(TreeNode<T> root)	Takes the root of a binary tree and calculates the depth of the tree rooted at that node.
int	getDepth()	Returns the pre-computed tree height.
Integer	getVisitResult()	Retrieves the result of the path-traversal.
protected void	visitLeaf(Path<T> path)	Performs action while path-traversal is visiting a leaf node.

Methods inherited from class AbstractRootToLeafPathVisitor

visit

Methods inherited from class Object

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

Constructor Details

DepthCalculator

public DepthCalculator()

Method Details

depthOf

public static <T> DepthCalculator<T> depthOf(TreeNode<T> root)

Takes the root of a binary tree and calculates the depth of the tree rooted at that node.

Type Parameters:

T - The type of value store in the node of the original tree

Parameters:

root - The root of the tree whose height is to be measured

Returns:

a new instance that stores the computed height

getDepth

public int getDepth()

Returns the pre-computed tree height.

Returns:

an integer

getVisitResult

public Integer getVisitResult()

Description copied from class: AbstractRootToLeafPathVisitor

Retrieves the result of the path-traversal.

AbstractRootToLeafPathVisitor.visit(TreeNode) must be called before calling this method; otherwise the behavior of this method is not defined.

Specified by:

getVisitResult in class AbstractRootToLeafPathVisitor<T,Integer>

Returns:

identity to be calculated by path-traversal

visitLeaf

protected void visitLeaf(Path<T> path)

Description copied from class: AbstractRootToLeafPathVisitor

Performs action while path-traversal is visiting a leaf node.

For example, while path-traversing the following tree

     1
   /  \
  2   3
 / \   \
4  5   6

AbstractRootToLeafPathVisitor.visitLeaf(Path) is called at node 4, 5, and 6.

Specified by:

visitLeaf in class AbstractRootToLeafPathVisitor<T,Integer>

Parameters:

path - A complete root-to-leaf path ending on the leaf being visited; for example, when calling AbstractRootToLeafPathVisitor.visitLeaf(Path) at node 4, path is 1 -> 2 -> 4; at node 5, path is 1 -> 2 -> 5; at node 6, path is 1 -> 3 -> 6