structure5
Class BinarySearchTree<E extends Comparable<E>>

java.lang.Object
  structure5.AbstractStructure<E>
      structure5.BinarySearchTree<E>

All Implemented Interfaces:

Iterable<E>, OrderedStructure<E>, Structure<E>

Direct Known Subclasses:

SplayTree

public class BinarySearchTree<E extends Comparable<E>>
extends AbstractStructure<E>
implements OrderedStructure<E>

A binary search tree structure. This structure maintains data in an ordered tree. It does not keep the tree balanced, so performance may degrade if the tree height is not optimal.

Example usage:

To create a Binary search tree containing the months of the year and to print out this tree as it grows we could use the following.

 public static void main(String[] argv){
     BinarySearchTree test = new BinarySearchTree();
       
     //declare an array of months
     String[] months = new String[]{"March", "May", "November", "August", 
                              "April", "January", "December", "July",
                                      "February", "June", "October", "September"};
      
     //add the months to the tree and print out the tree as it grows
     for(int i=0; i < months.length; i++){
        test.add(months[i]);
        System.out.println("Adding: " + months[i] + "\n" +test.treeString());
      }
  }
 

See Also:

SplayTree, BinaryTree

Constructor Summary

BinarySearchTree()
Constructs a binary search tree with no data

BinarySearchTree(Comparator<E> alternateOrder)
Constructs a binary search tree with no data

Method Summary

void	add(E value) Add a (possibly duplicate) value to binary search tree
void	clear() Removes all data from the binary search tree
boolean	contains(E value) Determines if the binary search tree contains a value
E	get(E value) Returns reference to value found within three.
int	hashCode() Returns the hashCode of the value stored by this object.
boolean	isEmpty() Checks for an empty binary search tree
Iterator<E>	iterator() Returns an iterator over the binary search tree.
E	remove(E value) Remove an value "equals to" the indicated value.
int	size() Determines the number of data values within the tree
String	toString() Returns a string representing tree
String	treeString() Returns a (possibly long) string representing tree.

Methods inherited from class structure5.AbstractStructure

elements, values

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface structure5.Structure

elements, values

Constructor Detail

BinarySearchTree

public BinarySearchTree()

Constructs a binary search tree with no data

BinarySearchTree

public BinarySearchTree(Comparator<E> alternateOrder)

Constructs a binary search tree with no data

Method Detail

isEmpty

public boolean isEmpty()

Checks for an empty binary search tree

Specified by:

isEmpty in interface Structure<E extends Comparable<E>>

Overrides:

isEmpty in class AbstractStructure<E extends Comparable<E>>

Returns:

True iff the tree contains no data

clear

public void clear()

Removes all data from the binary search tree

Specified by:

clear in interface Structure<E extends Comparable<E>>

size

public int size()

Determines the number of data values within the tree

Specified by:

size in interface Structure<E extends Comparable<E>>

Returns:

The number of nodes in the binary search tree

add

public void add(E value)

Add a (possibly duplicate) value to binary search tree

Specified by:

add in interface Structure<E extends Comparable<E>>

Parameters:

val - A reference to non-null object

contains

public boolean contains(E value)

Determines if the binary search tree contains a value

Specified by:

contains in interface Structure<E extends Comparable<E>>

Overrides:

contains in class AbstractStructure<E extends Comparable<E>>

Parameters:

val - The value sought. Should be non-null

Returns:

True iff the tree contains a value "equals to" sought value

get

public E get(E value)

Returns reference to value found within three. This method can be potentially dangerous if returned value is modified: if modification would change the relation of value to others within the tree, the consistency of the structure is lost Don't modify returned value

Parameters:

val - Value sought from within tree

Returns:

A value "equals to" value sought; otherwise null

remove

public E remove(E value)

Remove an value "equals to" the indicated value. Only one value is removed, and no guarantee is made concerning which of duplicate values are removed. Value returned is no longer part of the structure

Specified by:

remove in interface Structure<E extends Comparable<E>>

Parameters:

val - Value sought to be removed from tree

Returns:

Actual value removed from tree

iterator

public Iterator<E> iterator()

Returns an iterator over the binary search tree. Iterator should not be used if tree is modified, as behavior may be unpredicatable Traverses elements using in-order traversal order

Specified by:

iterator in interface Iterable<E extends Comparable<E>>

Specified by:

iterator in interface Structure<E extends Comparable<E>>

Returns:

An iterator over binary search tree

See Also:

AbstractIterator, Iterator, Enumeration, Structure.elements()

hashCode

public int hashCode()

Returns the hashCode of the value stored by this object.

Overrides:

hashCode in class AbstractStructure<E extends Comparable<E>>

Returns:

The hashCode of the value stored by this object.

treeString

public String treeString()

Returns a (possibly long) string representing tree. Differs from toString() in that toString() outputs a single line representation of the contents of the tree. treeString, however, prints out a graphical representations of the tree's structure.

Returns:

String representation of tree

toString

public String toString()

Returns a string representing tree

Overrides:

toString in class Object

Returns:

String representation of tree