it.unimi.dsi.fastutil.chars
Class CharRBTreeSet

java.lang.Object
  extended byit.unimi.dsi.fastutil.chars.AbstractCharCollection
      extended byit.unimi.dsi.fastutil.chars.AbstractCharSet
          extended byit.unimi.dsi.fastutil.chars.CharRBTreeSet
All Implemented Interfaces:
CharCollection, CharSet, CharSortedSet, Cloneable, Collection, Serializable, Set, SortedSet

public class CharRBTreeSet
extends AbstractCharSet
implements Serializable, Cloneable, CharSortedSet

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
CharRBTreeSet()
          Creates a new empty tree set.
CharRBTreeSet(char[] a)
          Creates a new tree set copying the elements of an array.
CharRBTreeSet(char[] a, Comparator c)
          Creates a new tree set copying the elements of an array using a given Comparator.
CharRBTreeSet(CharCollection c)
          Creates a new tree set copying a given type-specific collection.
CharRBTreeSet(CharIterator i)
          Creates a new tree set using elements provided by a type-specific iterator.
CharRBTreeSet(CharSortedSet s)
          Creates a new tree set copying a given type-specific sorted set (and its Comparator).
CharRBTreeSet(Collection c)
          Creates a new tree set copying a given collection.
CharRBTreeSet(Comparator c)
          Creates a new empty tree set with the given comparator.
CharRBTreeSet(Iterator i)
          Creates a new tree set using elements provided by an iterator.
CharRBTreeSet(SortedSet s)
          Creates a new tree set copying a given sorted set (and its Comparator).
 
Method Summary
 boolean add(char k)
           
 CharIterator charIterator()
          Returns a type-specific iterator on the collection.
 void clear()
           
 Object clone()
          Returns a deep copy of this tree set.
 Comparator comparator()
           
 boolean contains(char k)
           
 Object first()
           
 char firstChar()
           
 CharSortedSet headSet(char to)
           
 SortedSet headSet(Object oto)
           
 boolean isEmpty()
           
 CharBidirectionalIterator iterator(char from)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 Object last()
           
 char lastChar()
           
 boolean remove(char k)
           
 int size()
           
 CharSortedSet subSet(char from, char to)
           
 SortedSet subSet(Object ofrom, Object oto)
           
 CharSortedSet tailSet(char from)
           
 SortedSet tailSet(Object ofrom)
           
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharSet
equals, hashCode
 
Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection
add, addAll, addAll, contains, containsAll, containsAll, iterator, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toCharArray, toCharArray, 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.chars.CharCollection
addAll, containsAll, removeAll, retainAll, toArray, toCharArray, toCharArray
 

Field Detail

serialVersionUID

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

CharRBTreeSet

public CharRBTreeSet()
Creates a new empty tree set.


CharRBTreeSet

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

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

CharRBTreeSet

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


CharRBTreeSet

public CharRBTreeSet(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.

CharRBTreeSet

public CharRBTreeSet(CharCollection 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.

CharRBTreeSet

public CharRBTreeSet(CharSortedSet 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.

CharRBTreeSet

public CharRBTreeSet(CharIterator 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.

CharRBTreeSet

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

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

CharRBTreeSet

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

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

CharRBTreeSet

public CharRBTreeSet(char[] 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(char k)
Specified by:
add in interface CharCollection
Overrides:
add in class AbstractCharCollection

remove

public final boolean remove(char k)
Specified by:
remove in interface CharCollection
Overrides:
remove in class AbstractCharCollection

contains

public boolean contains(char k)
Specified by:
contains in interface CharCollection
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 AbstractCharCollection

firstChar

public char firstChar()
Specified by:
firstChar in interface CharSortedSet
See Also:
SortedSet.first()

lastChar

public char lastChar()
Specified by:
lastChar in interface CharSortedSet
See Also:
SortedSet.last()

first

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

last

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

charIterator

public CharIterator charIterator()
Description copied from interface: CharCollection
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:
charIterator in interface CharCollection
See Also:
Collection.iterator()

iterator

public CharBidirectionalIterator iterator(char from)
Description copied from interface: CharSortedSet
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 CharSortedSet
Overrides:
iterator in class AbstractCharSet

comparator

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

headSet

public CharSortedSet headSet(char to)
Specified by:
headSet in interface CharSortedSet
See Also:
SortedSet.headSet(Object)

tailSet

public CharSortedSet tailSet(char from)
Specified by:
tailSet in interface CharSortedSet
See Also:
SortedSet.tailSet(Object)

subSet

public CharSortedSet subSet(char from,
                            char to)
Specified by:
subSet in interface CharSortedSet
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.