craterdog.collections

Class Set<E>

java.lang.Object

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.OrderedCollection<E>

craterdog.collections.Set<E>

Type Parameters:

E - The type of element managed by the collection.

All Implemented Interfaces:

Accessible<E>, Iteratable<E>, Ordered<E>, Composite, Sequential<E>, java.lang.Iterable<E>

public class Set<E>
extends OrderedCollection<E>

This collection class implements an ordered collection that does not allow duplicate elements. The implementation dynamically scales up and down the size of the underlying data structures as the number elements changes over time.

Author:

Derk Norton

Constructor Summary

Constructors

Constructor and Description
Set() This constructor creates a new empty set with no comparator function.
Set(java.util.Comparator<? super E> comparator) This constructor creates a new set with the specified comparator function.
Set(E[] elements) This constructor creates a new set with no comparator function and seeds it with the elements from the specified array.
Set(E[] elements, java.util.Comparator<? super E> comparator) This constructor creates a new set with the specified comparator function and seeds it with the elements from the specified array.
Set(java.lang.Iterable<? extends E> elements) This constructor creates a new set with no comparator function and seeds it with the elements from the specified collection.
Set(java.lang.Iterable<? extends E> elements, java.util.Comparator<? super E> comparator) This constructor creates a new set with the specified comparator function and seeds it with the elements from the specified collection.

Method Summary

Modifier and Type	Method and Description
static <E> Set<E>	and(Set<E> set1, Set<E> set2) This function returns a new set that contains the elements that are in both the first set and the second set.
static <E> Set<E>	or(Set<E> set1, Set<E> set2) This function returns a new set that contains all the elements that are in the first set or the second set or both.
static <E> Set<E>	sans(Set<E> set1, Set<E> set2) This function returns a new set that contains the elements that are in the first set but not in the second set.
static <E> Set<E>	xor(Set<E> set1, Set<E> set2) This function returns a new set that contains all the elements that are in the first set or the second set but not both.

Methods inherited from class craterdog.collections.abstractions.OrderedCollection

addElement, containsElement, createDefaultIterator, getNumberOfElements, removeAllElements, removeElement

Methods inherited from class craterdog.collections.abstractions.Collection

addElements, addElements, containsAllElementsIn, containsAnyElementsIn, equals, hashCode, isEmpty, iterator, normalizedIndex, removeElements, removeElements, toArray, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface craterdog.core.Sequential

isEmpty, iterator, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface craterdog.core.Composite

toString

Constructor Detail

Set

public Set()

This constructor creates a new empty set with no comparator function.

Set

public Set(E[] elements)

This constructor creates a new set with no comparator function and seeds it with the elements from the specified array.

Parameters:

elements - The elements to be used to seed the new set.

Set

public Set(java.lang.Iterable<? extends E> elements)

This constructor creates a new set with no comparator function and seeds it with the elements from the specified collection.

Parameters:

elements - The elements to be used to seed the new set.

Set

public Set(java.util.Comparator<? super E> comparator)

This constructor creates a new set with the specified comparator function.

Parameters:

comparator - The comparator to be used to compare two elements during ordering.

Set

public Set(E[] elements,
           java.util.Comparator<? super E> comparator)

This constructor creates a new set with the specified comparator function and seeds it with the elements from the specified array.

Parameters:

elements - The elements to be used to seed the new set.

comparator - The comparator to be used to compare two elements during ordering.

Set

public Set(java.lang.Iterable<? extends E> elements,
           java.util.Comparator<? super E> comparator)

This constructor creates a new set with the specified comparator function and seeds it with the elements from the specified collection.

Parameters:

elements - The elements to be used to seed the new set.

comparator - The comparator to be used to compare two elements during ordering.

Method Detail

and

public static <E> Set<E> and(Set<E> set1,
                             Set<E> set2)

This function returns a new set that contains the elements that are in both the first set and the second set.

Type Parameters:

E - The type of element contained in the sets.

Parameters:

set1 - The first set to be operated on.

set2 - The second set to be operated on.

Returns:

The resulting set.

sans

public static <E> Set<E> sans(Set<E> set1,
                              Set<E> set2)

This function returns a new set that contains the elements that are in the first set but not in the second set.

Type Parameters:

E - The type of element contained in the sets.

Parameters:

set1 - The first set to be operated on.

set2 - The second set to be operated on.

Returns:

The resulting set.

or

public static <E> Set<E> or(Set<E> set1,
                            Set<E> set2)

This function returns a new set that contains all the elements that are in the first set or the second set or both.

Type Parameters:

E - The type of element contained in the sets.

Parameters:

set1 - The first set to be operated on.

set2 - The second set to be operated on.

Returns:

The resulting set.

xor

public static <E> Set<E> xor(Set<E> set1,
                             Set<E> set2)

This function returns a new set that contains all the elements that are in the first set or the second set but not both.

Type Parameters:

E - The type of element contained in the sets.

Parameters:

set1 - The first set to be operated on.

set2 - The second set to be operated on.

Returns:

The resulting set.