it.unimi.dsi.fastutil.ints
Class IntRBTreeSet

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractIntCollection
      it.unimi.dsi.fastutil.ints.AbstractIntSet
          it.unimi.dsi.fastutil.ints.AbstractIntSortedSet
              it.unimi.dsi.fastutil.ints.IntRBTreeSet

All Implemented Interfaces:

Cloneable, Collection, IntCollection, IntSet, IntSortedSet, Serializable, Set, SortedSet

public class IntRBTreeSet

extends AbstractIntSortedSet

implements Serializable, Cloneable, IntSortedSet

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

IntRBTreeSet()
Creates a new empty tree set.

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

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

IntRBTreeSet(int[] a)
Creates a new tree set copying the elements of an array.

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

IntRBTreeSet(int[] a, int offset, int length)
Creates a new tree set and fills it with the elements of a given array.

IntRBTreeSet(int[] a, int offset, int length, Comparator c)
Creates a new tree set and fills it with the elements of a given array using a given Comparator.

IntRBTreeSet(IntCollection c)
Creates a new tree set copying a given type-specific collection.

IntRBTreeSet(IntIterator i)
Creates a new tree set using elements provided by a type-specific iterator.

IntRBTreeSet(IntSortedSet s)
Creates a new tree set copying a given type-specific sorted set (and its Comparator).

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

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

Method Summary

boolean	add(int k)
void	clear()
Object	clone() Returns a deep copy of this tree set.
Comparator	comparator()
boolean	contains(int k)
int	firstInt()
IntSortedSet	headSet(int to)
IntIterator	intIterator() Returns a type-specific iterator on the collection.
boolean	isEmpty()
IntBidirectionalIterator	iterator(int from) Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
int	lastInt()
boolean	remove(int k) Note that the corresponding method of the type-specific collection is rem().
int	size()
IntSortedSet	subSet(int from, int to)
IntSortedSet	tailSet(int from)

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntSortedSet

first, headSet, last, subSet, tailSet

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntSet

equals, hashCode, rem, remove

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection

add, addAll, addAll, contains, containsAll, containsAll, iterator, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toIntArray, toIntArray, 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.ints.IntCollection

addAll, containsAll, rem, removeAll, retainAll, toArray, toIntArray, toIntArray

Methods inherited from interface java.util.SortedSet

first, headSet, last, subSet, tailSet

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

IntRBTreeSet

public IntRBTreeSet()

Creates a new empty tree set.

IntRBTreeSet

public IntRBTreeSet(Comparator c)

Creates a new empty tree set with the given comparator.

Parameters:

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

IntRBTreeSet

public IntRBTreeSet(Collection c)

Creates a new tree set copying a given collection.

Parameters:

c - a collection to be copied into the new tree set.

IntRBTreeSet

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

IntRBTreeSet

public IntRBTreeSet(IntCollection 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.

IntRBTreeSet

public IntRBTreeSet(IntSortedSet 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.

IntRBTreeSet

public IntRBTreeSet(IntIterator 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.

IntRBTreeSet

public IntRBTreeSet(Iterator i)

Creates a new tree set using elements provided by an iterator.

Parameters:

i - an iterator whose elements will fill the set.

IntRBTreeSet

public IntRBTreeSet(int[] a,
                    int offset,
                    int length,
                    Comparator c)

Creates a new tree set and fills it with the elements of a given array using a given Comparator.

Parameters:

a - an array whose elements will be used to fill the set.

offset - the first element to use.

length - the number of elements to use.

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

IntRBTreeSet

public IntRBTreeSet(int[] a,
                    int offset,
                    int length)

Creates a new tree set and fills it with the elements of a given array.

Parameters:

a - an array whose elements will be used to fill the set.

offset - the first element to use.

length - the number of elements to use.

IntRBTreeSet

public IntRBTreeSet(int[] a)

Creates a new tree set copying the elements of an array.

Parameters:

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

IntRBTreeSet

public IntRBTreeSet(int[] 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(int k)

Specified by:

add in interface IntCollection

Overrides:

add in class AbstractIntCollection

remove

public final boolean remove(int k)

Description copied from interface: IntSet

Note that the corresponding method of the type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface.

Specified by:

remove in interface IntSet

Overrides:

remove in class AbstractIntSet

contains

public boolean contains(int k)

Specified by:

contains in interface IntCollection

See Also:

Collection.contains(Object)

clear

public void clear()

Specified by:

clear in interface Set

Overrides:

clear in class AbstractIntCollection

size

public int size()

Specified by:

size in interface Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Set

Overrides:

isEmpty in class AbstractIntCollection

firstInt

public int firstInt()

Specified by:

firstInt in interface IntSortedSet

See Also:

SortedSet.first()

lastInt

public int lastInt()

Specified by:

lastInt in interface IntSortedSet

See Also:

SortedSet.last()

intIterator

public IntIterator intIterator()

Description copied from interface: IntCollection

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:

intIterator in interface IntCollection

See Also:

Collection.iterator()

iterator

public IntBidirectionalIterator iterator(int from)

Description copied from interface: IntSortedSet

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 IntSortedSet

Overrides:

iterator in class AbstractIntSet

comparator

public Comparator comparator()

Specified by:

comparator in interface SortedSet

headSet

public IntSortedSet headSet(int to)

Specified by:

headSet in interface IntSortedSet

See Also:

SortedSet.headSet(Object)

tailSet

public IntSortedSet tailSet(int from)

Specified by:

tailSet in interface IntSortedSet

See Also:

SortedSet.tailSet(Object)

subSet

public IntSortedSet subSet(int from,
                           int to)

Specified by:

subSet in interface IntSortedSet

See Also:

SortedSet.subSet(Object,Object)

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.