structure
Class SetVector<ELTTYPE>

java.lang.Object
  structure.AbstractStructure<ELTTYPE>
      structure.AbstractSet<ELTTYPE>
          structure.SetVector<ELTTYPE>

All Implemented Interfaces:

java.lang.Iterable<ELTTYPE>, Set<ELTTYPE>, Structure<ELTTYPE>

public class SetVector<ELTTYPE>
extends AbstractSet<ELTTYPE>

Implementation of a set of elements using a vector as the underlying storage mechanism. As with the mathematical object, the elements of the set are not duplicated. No order is implied or enforced in this structure, but simple set operations such as intersection, union, difference, and subset are provided.

Example Usage: Given a list of students who completed a computer science thesis in the 2001-2002 academic year at Williams College and a list of graduating computer science majors who are continuing on to graduate school, we could determine which thesis students are planning to attend graduate school as follows:

 public static void main(String[] argv){
        //thesis students in the class of '02
        String[] thesis = new String[]{"Doug", "Evan", "Feng"};
        
        //students continuing on to grad school
        String[] grad = new String[]{"Doug", "Feng", "Lida"};

        //instantiate our sets
        Set thesisSet = new SetVector(), 
            gradSet = new SetVector();
                
        //build sets up
        for(int i = 0; i < thesis.length; i++) thesisSet.add(thesis[i]);
        for(int i = 0; i < grad.length; i++) gradSet.add(grad[i]);
        
        //calculate the intersection of the two sets
        thesisSet.retainAll(gradSet);
        System.out.println(thesisSet);
 }
 

Constructor Summary

SetVector()
Construct a new set.

SetVector(Structure<ELTTYPE> other)
Construct a new set from another structure.

Method Summary

void	add(ELTTYPE e) Add an element to set, if not already present.
void	addAll(Structure<ELTTYPE> other) Compute the union of this set with other.
void	clear() Remove all the elements from the set.
java.lang.Object	clone() Returns a shallow clone of this set.
boolean	contains(ELTTYPE e) Returns true if value is an element of the set.
boolean	containsAll(Structure<ELTTYPE> other) Determine if this set is a subset of other.
boolean	isEmpty() Determine if the set is empty.
java.util.Iterator<ELTTYPE>	iterator() Construct an traversal to traverse the elements of the set.
static void	main(java.lang.String[] argv)
ELTTYPE	remove(ELTTYPE e) Remove an element from the set.
void	removeAll(Structure<ELTTYPE> other) Compute the difference between two sets.
void	retainAll(Structure<ELTTYPE> other) Compute the intersection of this set and other.
int	size() Determine the number of elements in the set.
java.lang.String	toString() Construct a string representation of the set.

Methods inherited from class structure.AbstractStructure

elements, hashCode, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface structure.Structure

elements, values

Constructor Detail

SetVector

public SetVector()

Construct a new set.

Post:

constructs a new, empty set

SetVector

public SetVector(Structure<ELTTYPE> other)

Construct a new set from another structure.

Post:

constructs a new set with elements from other

Method Detail

clear

public void clear()

Remove all the elements from the set.

Post:

elements of set are removed

isEmpty

public boolean isEmpty()

Determine if the set is empty.

Specified by:

isEmpty in interface Structure<ELTTYPE>

Overrides:

isEmpty in class AbstractStructure<ELTTYPE>

Returns:

True iff there are no elements in set.

Post:

returns true iff set is empty

add

public void add(ELTTYPE e)

Add an element to set, if not already present.

Parameters:

e - The new value to be added to set.

Pre:

e is non-null object

Post:

adds element e to set

remove

public ELTTYPE remove(ELTTYPE e)

Remove an element from the set.

Parameters:

e - The element of the set to be removed.

Returns:

The value actually removed.

Pre:

e is non-null object

Post:

e is removed from set, value returned

contains

public boolean contains(ELTTYPE e)

Returns true if value is an element of the set.

Specified by:

contains in interface Structure<ELTTYPE>

Overrides:

contains in class AbstractStructure<ELTTYPE>

Parameters:

e - The element sought in set.

Returns:

True iff the element is in the set.

Pre:

e is non-null

Post:

returns true iff e is in set

containsAll

public boolean containsAll(Structure<ELTTYPE> other)

Determine if this set is a subset of other.

Specified by:

containsAll in interface Set<ELTTYPE>

Overrides:

containsAll in class AbstractSet<ELTTYPE>

Parameters:

other - The potential superset.

Pre:

other is non-null reference to set

Post:

returns true iff this set is subset of other

clone

public java.lang.Object clone()

Returns a shallow clone of this set.

Overrides:

clone in class java.lang.Object

Returns:

A new set with same values.

Post:

returns a copy of set

addAll

public void addAll(Structure<ELTTYPE> other)

Compute the union of this set with other.

Specified by:

addAll in interface Set<ELTTYPE>

Overrides:

addAll in class AbstractSet<ELTTYPE>

Parameters:

other - The set to be unioned with this.

Pre:

other is a non-null structure

Post:

add all elements of other to set, if needed

retainAll

public void retainAll(Structure<ELTTYPE> other)

Compute the intersection of this set and other. Members of result are in both this and other.

Specified by:

retainAll in interface Set<ELTTYPE>

Overrides:

retainAll in class AbstractSet<ELTTYPE>

Parameters:

other - The other set to be intersected with this.

Pre:

other is non-null reference to set

Post:

returns set containing intersection of this and other

removeAll

public void removeAll(Structure<ELTTYPE> other)

Compute the difference between two sets. Values of the result are members of this, but not other.

Specified by:

removeAll in interface Set<ELTTYPE>

Overrides:

removeAll in class AbstractSet<ELTTYPE>

Parameters:

other - The set whose values are to be eliminated from this.

Pre:

other is non-null reference to set

Post:

returns set containing difference of this and other

iterator

public java.util.Iterator<ELTTYPE> iterator()

Construct an traversal to traverse the elements of the set. Elements will not appear in any particular order.

Returns:

An traversal for inspecting members of the set.

See Also:

AbstractIterator, Iterator, Enumeration, Structure.elements()

Post:

returns traversal to traverse the elements of set

size

public int size()

Determine the number of elements in the set.

Returns:

The number of elements in the set.

Post:

returns number of elements in set

toString

public java.lang.String toString()

Construct a string representation of the set.

Overrides:

toString in class java.lang.Object

Returns:

A string representing the set.

Post:

returns a string representation of set

main

public static void main(java.lang.String[] argv)