it.unimi.dsi.fastutil.bytes
Class ByteAVLTreeSet

java.lang.Object
  extended by java.util.AbstractCollection<java.lang.Byte>
      extended by it.unimi.dsi.fastutil.bytes.AbstractByteCollection
          extended by it.unimi.dsi.fastutil.bytes.AbstractByteSet
              extended by it.unimi.dsi.fastutil.bytes.AbstractByteSortedSet
                  extended by it.unimi.dsi.fastutil.bytes.ByteAVLTreeSet
All Implemented Interfaces:
ByteCollection, ByteIterable, ByteSet, ByteSortedSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Byte>, java.util.Collection<java.lang.Byte>, java.util.Set<java.lang.Byte>, java.util.SortedSet<java.lang.Byte>

public class ByteAVLTreeSet
extends AbstractByteSortedSet
implements java.io.Serializable, java.lang.Cloneable, ByteSortedSet

A type-specific AVL 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

Constructor Summary
ByteAVLTreeSet()
          Creates a new empty tree set.
ByteAVLTreeSet(byte[] a)
          Creates a new tree set copying the elements of an array.
ByteAVLTreeSet(byte[] a, java.util.Comparator<? super java.lang.Byte> c)
          Creates a new tree set copying the elements of an array using a given Comparator.
ByteAVLTreeSet(byte[] a, int offset, int length)
          Creates a new tree set and fills it with the elements of a given array.
ByteAVLTreeSet(byte[] a, int offset, int length, java.util.Comparator<? super java.lang.Byte> c)
          Creates a new tree set and fills it with the elements of a given array using a given Comparator.
ByteAVLTreeSet(ByteCollection c)
          Creates a new tree set copying a given type-specific collection.
ByteAVLTreeSet(ByteIterator i)
          Creates a new tree set using elements provided by a type-specific iterator.
ByteAVLTreeSet(ByteSortedSet s)
          Creates a new tree set copying a given type-specific sorted set (and its Comparator).
ByteAVLTreeSet(java.util.Collection<? extends java.lang.Byte> c)
          Creates a new tree set copying a given set.
ByteAVLTreeSet(java.util.Comparator<? super java.lang.Byte> c)
          Creates a new empty tree set with the given comparator.
ByteAVLTreeSet(java.util.Iterator<? extends java.lang.Byte> i)
          Creates a new tree set using elements provided by an iterator.
ByteAVLTreeSet(java.util.SortedSet<java.lang.Byte> s)
          Creates a new tree set copying a given sorted set (and its Comparator).
 
Method Summary
 boolean add(byte k)
           
 void clear()
           
 java.lang.Object clone()
          Returns a deep copy of this tree set.
 ByteComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
 boolean contains(byte k)
           
 byte firstByte()
           
 ByteSortedSet headSet(byte to)
           
 boolean isEmpty()
           
 ByteBidirectionalIterator iterator()
          Returns a type-specific iterator on the elements of this collection.
 ByteBidirectionalIterator iterator(byte from)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 byte lastByte()
           
 boolean remove(byte k)
          Removes an element from this set.
 int size()
           
 ByteSortedSet subSet(byte from, byte to)
           
 ByteSortedSet tailSet(byte from)
           
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteSortedSet
byteIterator, first, headSet, last, subSet, tailSet
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteSet
equals, hashCode, rem, remove
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
add, addAll, addAll, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toByteArray, toByteArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteSortedSet
byteIterator, headSet, subSet, tailSet
 
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection
addAll, containsAll, rem, removeAll, retainAll, toArray, toArray, toByteArray, toByteArray
 
Methods inherited from interface java.util.SortedSet
first, last
 
Methods inherited from interface java.util.Set
add, addAll, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray
 

Constructor Detail

ByteAVLTreeSet

public ByteAVLTreeSet()
Creates a new empty tree set.


ByteAVLTreeSet

public ByteAVLTreeSet(java.util.Comparator<? super java.lang.Byte> c)
Creates a new empty tree set with the given comparator.

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

ByteAVLTreeSet

public ByteAVLTreeSet(java.util.Collection<? extends java.lang.Byte> c)
Creates a new tree set copying a given set.

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

ByteAVLTreeSet

public ByteAVLTreeSet(java.util.SortedSet<java.lang.Byte> 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.

ByteAVLTreeSet

public ByteAVLTreeSet(ByteCollection 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.

ByteAVLTreeSet

public ByteAVLTreeSet(ByteSortedSet 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.

ByteAVLTreeSet

public ByteAVLTreeSet(ByteIterator 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.

ByteAVLTreeSet

public ByteAVLTreeSet(java.util.Iterator<? extends java.lang.Byte> i)
Creates a new tree set using elements provided by an iterator.

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

ByteAVLTreeSet

public ByteAVLTreeSet(byte[] a,
                      int offset,
                      int length,
                      java.util.Comparator<? super java.lang.Byte> 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).

ByteAVLTreeSet

public ByteAVLTreeSet(byte[] 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.

ByteAVLTreeSet

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

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

ByteAVLTreeSet

public ByteAVLTreeSet(byte[] a,
                      java.util.Comparator<? super java.lang.Byte> 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 boolean add(byte k)
Specified by:
add in interface ByteCollection
Overrides:
add in class AbstractByteCollection
See Also:
Collection.add(Object)

remove

public boolean remove(byte k)
Description copied from interface: ByteSet
Removes an element from this set.

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 ByteSet
Overrides:
remove in class AbstractByteSet
See Also:
Collection.remove(Object)

contains

public boolean contains(byte k)
Specified by:
contains in interface ByteCollection
Overrides:
contains in class AbstractByteCollection
See Also:
Collection.contains(Object)

clear

public void clear()
Specified by:
clear in interface java.util.Collection<java.lang.Byte>
Specified by:
clear in interface java.util.Set<java.lang.Byte>
Overrides:
clear in class java.util.AbstractCollection<java.lang.Byte>

size

public int size()
Specified by:
size in interface java.util.Collection<java.lang.Byte>
Specified by:
size in interface java.util.Set<java.lang.Byte>
Specified by:
size in class java.util.AbstractCollection<java.lang.Byte>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection<java.lang.Byte>
Specified by:
isEmpty in interface java.util.Set<java.lang.Byte>
Overrides:
isEmpty in class AbstractByteCollection

firstByte

public byte firstByte()
Specified by:
firstByte in interface ByteSortedSet
See Also:
SortedSet.first()

lastByte

public byte lastByte()
Specified by:
lastByte in interface ByteSortedSet
See Also:
SortedSet.last()

iterator

public ByteBidirectionalIterator iterator()
Description copied from interface: ByteCollection
Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:
iterator in interface ByteCollection
Specified by:
iterator in interface ByteIterable
Specified by:
iterator in interface ByteSet
Specified by:
iterator in interface ByteSortedSet
Specified by:
iterator in interface java.lang.Iterable<java.lang.Byte>
Specified by:
iterator in interface java.util.Collection<java.lang.Byte>
Specified by:
iterator in interface java.util.Set<java.lang.Byte>
Specified by:
iterator in class AbstractByteSortedSet
Returns:
a type-specific iterator on the elements of this collection.

iterator

public ByteBidirectionalIterator iterator(byte from)
Description copied from interface: ByteSortedSet
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 ByteSortedSet
Parameters:
from - an element to start from.
Returns:
a bidirectional iterator on the element in this set, starting at the given element.

comparator

public ByteComparator comparator()
Description copied from interface: ByteSortedSet
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.

Note that this specification strengthens the one given in SortedSet.comparator().

Specified by:
comparator in interface ByteSortedSet
Specified by:
comparator in interface java.util.SortedSet<java.lang.Byte>
See Also:
SortedSet.comparator()

headSet

public ByteSortedSet headSet(byte to)
Specified by:
headSet in interface ByteSortedSet
See Also:
SortedSet.headSet(Object)

tailSet

public ByteSortedSet tailSet(byte from)
Specified by:
tailSet in interface ByteSortedSet
See Also:
SortedSet.tailSet(Object)

subSet

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

clone

public java.lang.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.

Overrides:
clone in class java.lang.Object
Returns:
a deep copy of this tree set.