cpsc331.collections

Class BSTOrderedSet<E extends java.lang.Comparable<E>>

java.lang.Object

cpsc331.collections.BSTOrderedSet<E>

All Implemented Interfaces:

OrderedSet<E>, Set<E>

public class BSTOrderedSet<E extends java.lang.Comparable<E>>
extends java.lang.Object
implements OrderedSet<E>

Provides an implementation of an Ordered Set using a binary search tree.

Constructor Summary

Constructors

Constructor and Description
BSTOrderedSet() Constructs an empty BSTOrderedSet Preconditions: None Postcondition: An empty BSTOrdered (satisfying the above BSTOrderedSet Invariant) has been created.

Method Summary

Modifier and Type	Method and Description
void	add(E e, cpsc331.collections.BSTOrderedSet.BSTNode x)
boolean	contains(E e) Reports whether a given element belongs to this set.
void	include(E e) Adds an input element to this set, throwing an ElementFoundException if this element already belongs to it.
void	remove(E e) Removes an input element to this set, throwing a NoSuchElementException if this element does not belong to it.

Methods inherited from class java.lang.Object

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

Constructor Detail

BSTOrderedSet

public BSTOrderedSet()

Constructs an empty BSTOrderedSet

Preconditions: None
Postcondition: An empty BSTOrdered (satisfying the above BSTOrderedSet Invariant) has been created.

Method Detail

contains

public boolean contains(E e)

Description copied from interface: Set

Reports whether a given element belongs to this set.

Specified by:

contains in interface Set<E extends java.lang.Comparable<E>>

Parameters:

e - the element to be searched for

Returns:

true if this element is found; false otherwise

Precondition:

1. The Set Invariant is satisfied.
2. A value e with type E has been given as input.

Postcondition:

1. The Set Invariant is satisfied.
2. This set has not been changed.
3. If the given element e belongs to this set then “true” is returned; “false” is returned otherwise.

include

public void include(E e)
             throws ElementFoundException

Description copied from interface: Set

Adds an input element to this set, throwing an ElementFoundException if this element already belongs to it.

Specified by:

include in interface Set<E extends java.lang.Comparable<E>>

Parameters:

e - the element to be added to this set

Throws:

ElementFoundException - if this element is already in the set

Precondition:

1. The Set Invariant is satisfied.
2. A value e with type E has been given as input.

Postcondition:

1. The Set Invariant is satisfied.
2. If the input element e was not already included in this set then e has been added to it, and no other changes have been made. An ElementFoundException is thrown, otherwise, and this set has not been changed.

add

public void add(E e,
                cpsc331.collections.BSTOrderedSet.BSTNode x)
         throws ElementFoundException

Throws:

ElementFoundException

remove

public void remove(E e)
            throws java.util.NoSuchElementException

Description copied from interface: Set

Removes an input element to this set, throwing a NoSuchElementException if this element does not belong to it.

Specified by:

remove in interface Set<E extends java.lang.Comparable<E>>

Parameters:

e - the element to be removed from this set

Throws:

java.util.NoSuchElementException - if this element was not in this set

Precondition:

1. The Set Invariant is satisfied.
2. A value e with type E has been given as input.

Postcondition:

1. The Set Invariant is satisfied.
2. If the input element e was already included in this set then this element is removed from it. A NoSuchElementException is thrown otherwise, and this set is not changed.