org.dllearner.utilities.datastructures

Class AbstractSearchTree<T extends AbstractSearchTreeNode>

java.lang.Object

org.dllearner.utilities.datastructures.AbstractSearchTree<T>

Direct Known Subclasses:

SearchTree, SynchronizedSearchTree

public class AbstractSearchTree<T extends AbstractSearchTreeNode>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected NavigableSet<T>	nodes
protected T	root
protected Comparator<T>	sortOrderComp

Constructor Summary

Constructors

Constructor and Description
AbstractSearchTree(Comparator<T> comparator) create a new search tree

Method Summary

Modifier and Type	Method and Description
void	addNode(T parentNode, T node) add node to the search tree
protected boolean	allowedNode(T node) filter certain nodes to be permitted in the node-set
T	best()
Iterator<T>	descendingIterator()
SortedSet<T>	descendingSet()
Set<T>	getNodeSet()
T	getRoot()
void	notifyNode(T node) internally used by tree<->node contract to notify a tree about an added node
void	setRoot(T node) set the tree root to a node
int	size()
void	updateDone(T node) must be called after modifying a node, to support immutable set element pattern
void	updatePrepare(T node) must be called before modifying a node, to support immutable set element pattern

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected NavigableSet<T extends AbstractSearchTreeNode> nodes

sortOrderComp

protected Comparator<T extends AbstractSearchTreeNode> sortOrderComp

root

protected T extends AbstractSearchTreeNode root

Constructor Detail

AbstractSearchTree

public AbstractSearchTree(Comparator<T> comparator)

create a new search tree

Parameters:

comparator - the comparator to use for the nodes

Method Detail

addNode

public void addNode(T parentNode,
                    T node)

add node to the search tree

Parameters:

parentNode - the parent node or null if root

node - the node to add

notifyNode

public final void notifyNode(T node)

internally used by tree<->node contract to notify a tree about an added node

Parameters:

node - the node

allowedNode

protected boolean allowedNode(T node)

filter certain nodes to be permitted in the node-set

Parameters:

node - node to test

Returns:

whether node is allowed in the node-set

setRoot

public void setRoot(T node)

set the tree root to a node

Parameters:

node - the node

updatePrepare

public final void updatePrepare(T node)

must be called before modifying a node, to support immutable set element pattern

Parameters:

node - the node

updateDone

public final void updateDone(T node)

must be called after modifying a node, to support immutable set element pattern

descendingIterator

public Iterator<T> descendingIterator()

Returns:

an iterator over the elements in this search tree in descending comparison order

descendingSet

public SortedSet<T> descendingSet()

Returns:

a set of the nodes in the search tree ordered in descending comparison order

best

public T best()

Returns:

best node according to comparator

getNodeSet

public Set<T> getNodeSet()

Returns:

the underlying set of all tree nodes

size

public int size()

Returns:

the tree size

getRoot

public T getRoot()

Returns:

the tree root node