it.unimi.dsi.fastutil.bytes
Class ByteAVLTreeSet

java.lang.Object
  it.unimi.dsi.fastutil.bytes.AbstractByteCollection
      it.unimi.dsi.fastutil.bytes.AbstractByteSet
          it.unimi.dsi.fastutil.bytes.AbstractByteSortedSet
              it.unimi.dsi.fastutil.bytes.ByteAVLTreeSet

All Implemented Interfaces:

ByteCollection, ByteSet, ByteSortedSet, Cloneable, Collection, Serializable, Set, SortedSet

public class ByteAVLTreeSet

extends AbstractByteSortedSet

implements Serializable, 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

Field Summary

static long

serialVersionUID

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, Comparator 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, Comparator 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(Collection c)
Creates a new tree set copying a given set.

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

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

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

Method Summary

boolean	add(byte k)
ByteIterator	byteIterator() Returns a type-specific iterator on the collection.
void	clear()
Object	clone() Returns a deep copy of this tree set.
Comparator	comparator()
boolean	contains(byte k)
byte	firstByte()
ByteSortedSet	headSet(byte to)
boolean	isEmpty()
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) Note that the corresponding method of the type-specific collection is rem().
int	size()
ByteSortedSet	subSet(byte from, byte to)
ByteSortedSet	tailSet(byte from)

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteSortedSet

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, iterator, 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 java.util.Set

add, addAll, contains, containsAll, equals, hashCode, iterator, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection

addAll, containsAll, rem, removeAll, retainAll, toArray, toByteArray, toByteArray

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

ByteAVLTreeSet

public ByteAVLTreeSet()

Creates a new empty tree set.

ByteAVLTreeSet

public ByteAVLTreeSet(Comparator c)

Creates a new empty tree set with the given comparator.

Parameters:

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

ByteAVLTreeSet

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

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(Iterator 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,
                      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).

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,
                      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(byte k)

Specified by:

add in interface ByteCollection

Overrides:

add in class AbstractByteCollection

remove

public final boolean remove(byte k)

Description copied from interface: ByteSet

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

contains

public boolean contains(byte k)

Specified by:

contains in interface ByteCollection

See Also:

Collection.contains(Object)

clear

public void clear()

Specified by:

clear in interface Set

Overrides:

clear in class AbstractByteCollection

size

public int size()

Specified by:

size in interface Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Set

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()

byteIterator

public ByteIterator byteIterator()

Description copied from interface: ByteCollection

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:

byteIterator in interface ByteCollection

See Also:

Collection.iterator()

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

Overrides:

iterator in class AbstractByteSet

comparator

public Comparator comparator()

Specified by:

comparator in interface SortedSet

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 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.