it.unimi.dsi.fastutil.doubles
Class DoubleRBTreeSet

java.lang.Object
  extended byit.unimi.dsi.fastutil.doubles.AbstractDoubleCollection
      extended byit.unimi.dsi.fastutil.doubles.AbstractDoubleSet
          extended byit.unimi.dsi.fastutil.doubles.DoubleRBTreeSet
All Implemented Interfaces:
Cloneable, Collection, DoubleCollection, DoubleSet, DoubleSortedSet, Serializable, Set, SortedSet

public class DoubleRBTreeSet
extends AbstractDoubleSet
implements Serializable, Cloneable, DoubleSortedSet

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
DoubleRBTreeSet()
          Creates a new empty tree set.
DoubleRBTreeSet(Collection c)
          Creates a new tree set copying a given collection.
DoubleRBTreeSet(Comparator c)
          Creates a new empty tree set with the given comparator.
DoubleRBTreeSet(double[] a)
          Creates a new tree set copying the elements of an array.
DoubleRBTreeSet(double[] a, Comparator c)
          Creates a new tree set copying the elements of an array using a given Comparator.
DoubleRBTreeSet(DoubleCollection c)
          Creates a new tree set copying a given type-specific collection.
DoubleRBTreeSet(DoubleIterator i)
          Creates a new tree set using elements provided by a type-specific iterator.
DoubleRBTreeSet(DoubleSortedSet s)
          Creates a new tree set copying a given type-specific sorted set (and its Comparator).
DoubleRBTreeSet(Iterator i)
          Creates a new tree set using elements provided by an iterator.
DoubleRBTreeSet(SortedSet s)
          Creates a new tree set copying a given sorted set (and its Comparator).
 
Method Summary
 boolean add(double k)
           
 void clear()
           
 Object clone()
          Returns a deep copy of this tree set.
 Comparator comparator()
           
 boolean contains(double k)
           
 DoubleIterator doubleIterator()
          Returns a type-specific iterator on the collection.
 Object first()
           
 double firstDouble()
           
 DoubleSortedSet headSet(double to)
           
 SortedSet headSet(Object oto)
           
 boolean isEmpty()
           
 DoubleBidirectionalIterator iterator(double from)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 Object last()
           
 double lastDouble()
           
 boolean remove(double k)
           
 int size()
           
 DoubleSortedSet subSet(double from, double to)
           
 SortedSet subSet(Object ofrom, Object oto)
           
 DoubleSortedSet tailSet(double from)
           
 SortedSet tailSet(Object ofrom)
           
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleSet
equals, hashCode
 
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection
add, addAll, addAll, contains, containsAll, containsAll, iterator, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toDoubleArray, toDoubleArray, 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.doubles.DoubleCollection
addAll, containsAll, removeAll, retainAll, toArray, toDoubleArray, toDoubleArray
 

Field Detail

serialVersionUID

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

DoubleRBTreeSet

public DoubleRBTreeSet()
Creates a new empty tree set.


DoubleRBTreeSet

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

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

DoubleRBTreeSet

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


DoubleRBTreeSet

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

DoubleRBTreeSet

public DoubleRBTreeSet(DoubleCollection 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.

DoubleRBTreeSet

public DoubleRBTreeSet(DoubleSortedSet 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.

DoubleRBTreeSet

public DoubleRBTreeSet(DoubleIterator 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.

DoubleRBTreeSet

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

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

DoubleRBTreeSet

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

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

DoubleRBTreeSet

public DoubleRBTreeSet(double[] 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(double k)
Specified by:
add in interface DoubleCollection
Overrides:
add in class AbstractDoubleCollection

remove

public final boolean remove(double k)
Specified by:
remove in interface DoubleCollection
Overrides:
remove in class AbstractDoubleCollection

contains

public boolean contains(double k)
Specified by:
contains in interface DoubleCollection
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 AbstractDoubleCollection

firstDouble

public double firstDouble()
Specified by:
firstDouble in interface DoubleSortedSet
See Also:
SortedSet.first()

lastDouble

public double lastDouble()
Specified by:
lastDouble in interface DoubleSortedSet
See Also:
SortedSet.last()

first

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

last

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

doubleIterator

public DoubleIterator doubleIterator()
Description copied from interface: DoubleCollection
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:
doubleIterator in interface DoubleCollection
See Also:
Collection.iterator()

iterator

public DoubleBidirectionalIterator iterator(double from)
Description copied from interface: DoubleSortedSet
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 DoubleSortedSet
Overrides:
iterator in class AbstractDoubleSet

comparator

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

headSet

public DoubleSortedSet headSet(double to)
Specified by:
headSet in interface DoubleSortedSet
See Also:
SortedSet.headSet(Object)

tailSet

public DoubleSortedSet tailSet(double from)
Specified by:
tailSet in interface DoubleSortedSet
See Also:
SortedSet.tailSet(Object)

subSet

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