it.unimi.dsi.fastutil.shorts
Class ShortRBTreeSet

java.lang.Object
  extended byit.unimi.dsi.fastutil.shorts.AbstractShortCollection
      extended byit.unimi.dsi.fastutil.shorts.AbstractShortSet
          extended byit.unimi.dsi.fastutil.shorts.ShortRBTreeSet
All Implemented Interfaces:
Cloneable, Collection, Serializable, Set, ShortCollection, ShortSet, ShortSortedSet, SortedSet

public class ShortRBTreeSet
extends AbstractShortSet
implements Serializable, Cloneable, ShortSortedSet

A type-specific red-black tree set with a fast, small-footprint implementation.

The iterators provided by this class are type-specific bidirectional iterators. Moreover, the iterator returned by iterator() can be safely cast to a type-specific list iterator.

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
ShortRBTreeSet()
          Creates a new empty tree set.
ShortRBTreeSet(Collection c)
          Creates a new tree set copying a given collection.
ShortRBTreeSet(Comparator c)
          Creates a new empty tree set with the given comparator.
ShortRBTreeSet(Iterator i)
          Creates a new tree set using elements provided by an iterator.
ShortRBTreeSet(short[] a)
          Creates a new tree set copying the elements of an array.
ShortRBTreeSet(short[] a, Comparator c)
          Creates a new tree set copying the elements of an array using a given Comparator.
ShortRBTreeSet(ShortCollection c)
          Creates a new tree set copying a given type-specific collection.
ShortRBTreeSet(ShortIterator i)
          Creates a new tree set using elements provided by a type-specific iterator.
ShortRBTreeSet(ShortSortedSet s)
          Creates a new tree set copying a given type-specific sorted set (and its Comparator).
ShortRBTreeSet(SortedSet s)
          Creates a new tree set copying a given sorted set (and its Comparator).
 
Method Summary
 boolean add(short k)
           
 void clear()
           
 Object clone()
          Returns a deep copy of this tree set.
 Comparator comparator()
           
 boolean contains(short k)
           
 Object first()
           
 short firstShort()
           
 SortedSet headSet(Object oto)
           
 ShortSortedSet headSet(short to)
           
 boolean isEmpty()
           
 ShortBidirectionalIterator iterator(short from)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 Object last()
           
 short lastShort()
           
 boolean remove(short k)
           
 ShortIterator shortIterator()
          Returns a type-specific iterator on the collection.
 int size()
           
 SortedSet subSet(Object ofrom, Object oto)
           
 ShortSortedSet subSet(short from, short to)
           
 SortedSet tailSet(Object ofrom)
           
 ShortSortedSet tailSet(short from)
           
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortSet
equals, hashCode
 
Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortCollection
add, addAll, addAll, contains, containsAll, containsAll, iterator, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toShortArray, toShortArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
add, addAll, contains, containsAll, equals, hashCode, iterator, remove, removeAll, retainAll, toArray, toArray
 
Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortCollection
addAll, containsAll, removeAll, retainAll, toArray, toShortArray, toShortArray
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

ShortRBTreeSet

public ShortRBTreeSet()
Creates a new empty tree set.


ShortRBTreeSet

public ShortRBTreeSet(Comparator c)
Creates a new empty tree set with the given comparator.

Parameters:
c - a Comparator (even better, a type-specific comparator).

ShortRBTreeSet

public ShortRBTreeSet(Collection c)
Creates a new tree set copying a given collection.


ShortRBTreeSet

public ShortRBTreeSet(SortedSet s)
Creates a new tree set copying a given sorted set (and its Comparator).

Parameters:
s - a SortedSet to be copied into the new tree set.

ShortRBTreeSet

public ShortRBTreeSet(ShortCollection c)
Creates a new tree set copying a given type-specific collection.

Parameters:
c - a type-specific collection to be copied into the new tree set.

ShortRBTreeSet

public ShortRBTreeSet(ShortSortedSet s)
Creates a new tree set copying a given type-specific sorted set (and its Comparator).

Parameters:
s - a type-specific sorted set to be copied into the new tree set.

ShortRBTreeSet

public ShortRBTreeSet(ShortIterator i)
Creates a new tree set using elements provided by a type-specific iterator.

Parameters:
i - a type-specific iterator whose elements will fill the set.

ShortRBTreeSet

public ShortRBTreeSet(Iterator i)
Creates a new tree set using elements provided by an iterator.

Parameters:
i - an iterator whose elements will fill the set.

ShortRBTreeSet

public ShortRBTreeSet(short[] a)
Creates a new tree set copying the elements of an array.

Parameters:
a - an array to be copied into the new tree set.

ShortRBTreeSet

public ShortRBTreeSet(short[] a,
                      Comparator c)
Creates a new tree set copying the elements of an array using a given Comparator.

Parameters:
a - an array to be copied into the new tree set.
c - a Comparator (even better, a type-specific comparator).
Method Detail

add

public final boolean add(short k)
Specified by:
add in interface ShortCollection
Overrides:
add in class AbstractShortCollection

remove

public final boolean remove(short k)
Specified by:
remove in interface ShortCollection
Overrides:
remove in class AbstractShortCollection

contains

public boolean contains(short k)
Specified by:
contains in interface ShortCollection
See Also:
Collection.contains(Object)

clear

public void clear()
Specified by:
clear in interface Set

size

public int size()
Specified by:
size in interface Set

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Set
Overrides:
isEmpty in class AbstractShortCollection

firstShort

public short firstShort()
Specified by:
firstShort in interface ShortSortedSet
See Also:
SortedSet.first()

lastShort

public short lastShort()
Specified by:
lastShort in interface ShortSortedSet
See Also:
SortedSet.last()

first

public Object first()
Specified by:
first in interface SortedSet

last

public Object last()
Specified by:
last in interface SortedSet

shortIterator

public ShortIterator shortIterator()
Description copied from interface: ShortCollection
Returns a type-specific iterator on the collection.

The iterator returned by the Collection.iterator() method and by this method are identical; however, using this method you can save a type casting.

Specified by:
shortIterator in interface ShortCollection
See Also:
Collection.iterator()

iterator

public ShortBidirectionalIterator iterator(short from)
Description copied from interface: ShortSortedSet
Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).

This method returns a type-specific bidirectional iterator with given starting point. The starting point is any element comparable to the elements of this set (even if it does not actually belong to the set). The next element of the returned iterator is the least element of the set that is greater than the starting point (if there are no elements greater than the starting point, hasNext() will return false). The previous element of the returned iterator is the greatest element of the set that is smaller than or equal to the starting point (if there are no elements smaller than or equal to the starting point, hasPrevious() will return false).

Note that passing the last element of the set as starting point and calling previous() you can traverse the entire set in reverse order.

Specified by:
iterator in interface ShortSortedSet
Overrides:
iterator in class AbstractShortSet

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedSet

headSet

public ShortSortedSet headSet(short to)
Specified by:
headSet in interface ShortSortedSet
See Also:
SortedSet.headSet(Object)

tailSet

public ShortSortedSet tailSet(short from)
Specified by:
tailSet in interface ShortSortedSet
See Also:
SortedSet.tailSet(Object)

subSet

public ShortSortedSet subSet(short from,
                             short to)
Specified by:
subSet in interface ShortSortedSet
See Also:
SortedSet.subSet(Object,Object)

headSet

public SortedSet headSet(Object oto)
Specified by:
headSet in interface SortedSet

tailSet

public SortedSet tailSet(Object ofrom)
Specified by:
tailSet in interface SortedSet

subSet

public SortedSet subSet(Object ofrom,
                        Object oto)
Specified by:
subSet in interface SortedSet

clone

public Object clone()
Returns a deep copy of this tree set.

This method performs a deep copy of this tree set; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Returns:
a deep copy of this tree set.