jdsl
Class RBTree

java.lang.Object
  |
  +--jdsl.RBTree

public class RBTree

extends java.lang.Object

implements OrderedDictionary, ComparatorBased, RBColorConstants

A Red Black tree. Implemented using a RestructurableNodeBinaryTree.

Constructor Summary

RBTree(Comparator comparator)
The class's constructor.

Method Summary

Locator	after(Locator locator) Finds the locator after the passed in Locator.
Locator	before(Locator locator) Finds the locator before the passed in Locator
protected void	case1(Position sibling) take care of case 1 after deletion: sib is red
protected void	case2(Position child)
protected Position	case3(Position sibling)
protected void	case4(Position position)
Locator	closestAfter(java.lang.Object key) Finds the Locator that comes right after a Locator with the given key
Locator	closestBefore(java.lang.Object key) Finds the Locator that comes right before a Locator with the given key in the tree.
protected void	colorPromotion(Position parent) handy color promotion method.....promotes the red up
Comparator	comparator() Retrieves the Comparator.
java.util.Iterator	elements() Produces an Iterator of the elements of all the Locators in the tree
Locator	find(java.lang.Object key) Finds the Locator with the given key
java.util.Iterator	findAll(java.lang.Object key) Finds all of the locators in the tree with the given key
Position	findInSubtree(java.lang.Object key, Position subtreeRoot) a helper method that will return the position is key is found or the position where the key would be (i.e.
protected RBColorInfo	getCInfo()
BinaryTree	getTree() Returns the underlying tree.
void	insert(Locator locator) Inserts a locator into the tree.
Locator	insert(java.lang.Object key, java.lang.Object element) Inserts a new key element pair into the tree.
boolean	isEmpty()
java.util.Iterator	keys() Returns an Iterator of all the keys within this Container.
java.util.Iterator	locators() Returns an iterator of colors
Locator	makeLocator(java.lang.Object key, java.lang.Object element) Produces a Locator that is ready to be inserted.
Container	newContainer()
protected void	recolor(Position root)
protected void	recolorAfterRemove(Position child)
void	remove(Locator locator)
java.lang.Object	replaceElement(Locator loc, java.lang.Object newElement) Replaces the element of the passed in locator
java.lang.Object	replaceKey(Locator locator, java.lang.Object key) Replaces the key of the passed in locator
protected Position	rotation(Position grandchild) silly method that just calls restructure on the restructurable BT
Comparator	setComparator(Comparator c) Sets the Comparator to be used in this container.
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

RBTree

public RBTree(Comparator comparator)

The class's constructor. * Also, sets the binary tree's root to hold a RBTLocator which is black.

Parameters:

comparator - the comparator for this dictionary

Method Detail

comparator

public Comparator comparator()

Retrieves the Comparator.

Specified by:

comparator in interface ComparatorBased

Returns:

the Comparator that is used by this PriorityQueue.

find

public Locator find(java.lang.Object key)
             throws InvalidKeyException

Finds the Locator with the given key

Parameters:

key - The search key.

Returns:

The found Locator(NO_SUCH_KEY if one wasn't found)

Throws:

InvalidKeyException - If the key is not compatible with this container.

findAll

public java.util.Iterator findAll(java.lang.Object key)
                           throws InvalidKeyException

Finds all of the locators in the tree with the given key

Parameters:

key - The search key.

Returns:

An Iterator of the found locators

Throws:

InvalidKeyException - If the key is not compatible with this container.

closestBefore

public Locator closestBefore(java.lang.Object key)
                      throws InvalidKeyException

Finds the Locator that comes right before a Locator with the given key in the tree.

Specified by:

closestBefore in interface OrderedDictionary

Parameters:

key - The key to search for

Returns:

The Locator if it exists.

Throws:

InvalidKeyException - If the key is not compatible with this container.

closestAfter

public Locator closestAfter(java.lang.Object key)
                     throws InvalidKeyException

Finds the Locator that comes right after a Locator with the given key

Specified by:

closestAfter in interface OrderedDictionary

Parameters:

key - The key of the Locator to find the closestAfter

Returns:

The Locator if it exists

Throws:

InvalidKeyException - If the key is not compatible with this container.

after

public Locator after(Locator locator)
              throws InvalidLocatorException

Finds the locator after the passed in Locator.

Specified by:

after in interface OrderedDictionary

Parameters:

locator -

Returns:

The Locator after locator, or BOUNDARY_VIOLATION if it doesn't exist.

Throws:

InvalidLocatorException - if locator is incompatible with this container

before

public Locator before(Locator locator)
               throws InvalidLocatorException

Finds the locator before the passed in Locator

Specified by:

before in interface OrderedDictionary

Parameters:

locator -

Returns:

The Locator before locator, or BOUNDARY_VIOLATION if it doesn't exist.

Throws:

InvalidLocatorException - if locator is incompatible with this container

findInSubtree

public Position findInSubtree(java.lang.Object key,
                              Position subtreeRoot)
                       throws InvalidKeyException

a helper method that will return the position is key is found or the position where the key would be (i.e. an external)

Parameters:

key - The search key.

subtreeRoot - Where the search will start.

Returns:

The found Position

Throws:

InvalidKeyException - if key is incompatible with this container

insert

public void insert(Locator locator)
            throws InvalidKeyException,
                   InvalidLocatorException,
                   ContainedLocatorException

Inserts a locator into the tree.

Parameters:

locator - The Locator to insert.

Throws:

InvalidKeyException - if the key of the given locator is incompatible with the container.

InvalidLocatorException - if the given locator is invalid

ContainedLocatorException - if the given locator is already contained

insert

public Locator insert(java.lang.Object key,
                      java.lang.Object element)
               throws InvalidKeyException,
                      ContainedLocatorException

Inserts a new key element pair into the tree.

Parameters:

locator - The Locator to insert.

Throws:

InvalidKeyException - if the key of the given locator is incompatible with the container.

InvalidLocatorException - if the given locator is invalid

ContainedLocatorException - if the given locator is already contained

remove

public void remove(Locator locator)
            throws InvalidLocatorException

recolorAfterRemove

protected void recolorAfterRemove(Position child)

case1

protected void case1(Position sibling)

take care of case 1 after deletion: sib is red

case2

protected void case2(Position child)

case3

protected Position case3(Position sibling)

case4

protected void case4(Position position)

replaceKey

public java.lang.Object replaceKey(Locator locator,
                                   java.lang.Object key)
                            throws InvalidLocatorException,
                                   InvalidKeyException

Replaces the key of the passed in locator

Parameters:

locator - The Locator whose key will be replaced.

key - The new key

Returns:

The old key

Throws:

InvalidLocatorException - if the locator's key is not valid or the container is empty.

InvalidKeyException - if the key is not comparable

replaceElement

public java.lang.Object replaceElement(Locator loc,
                                       java.lang.Object newElement)
                                throws InvalidLocatorException

Replaces the element of the passed in locator

Parameters:

locator - The Locator whose element will be replaced.

newElement - The new element

Returns:

The old element

Throws:

InvalidLocatorException - if the locator's key is not valid or the container is empty.

colorPromotion

protected void colorPromotion(Position parent)

handy color promotion method.....promotes the red up

Parameters:

parent - The position to promote

rotation

protected Position rotation(Position grandchild)

silly method that just calls restructure on the restructurable BT

Parameters:

grandchild - The position to rotate

recolor

protected void recolor(Position root)

locators

public java.util.Iterator locators()

Returns an iterator of colors

Returns:

an Iterator

keys

public java.util.Iterator keys()

Returns an Iterator of all the keys within this Container. If this Container is empty then an empty Iterator is returned.

Returns:

An Iterator of all the keys stored in the container. Note: this Iterator may be empty.

See Also:

elements, Iterator

makeLocator

public Locator makeLocator(java.lang.Object key,
                           java.lang.Object element)

Produces a Locator that is ready to be inserted.

Parameters:

key - The new Locator's key.

element - The new Locator's element.

Returns:

The newly created Locator

elements

public java.util.Iterator elements()

Produces an Iterator of the elements of all the Locators in the tree

Returns:

An Iterator

newContainer

public Container newContainer()

size

public int size()

isEmpty

public boolean isEmpty()

getTree

public BinaryTree getTree()

Returns the underlying tree.

getCInfo

protected RBColorInfo getCInfo()

setComparator

public Comparator setComparator(Comparator c)

Sets the Comparator to be used in this container.

Specified by:

setComparator in interface ComparatorBased

Parameters:

c - The comparator to use.

Returns:

The old Comparator