it.unimi.dsi.fastutil.bytes.ByteRBTreeSet

All Implemented Interfaces:: ByteBidirectionalIterable, ByteCollection, ByteIterable, ByteSet, ByteSortedSet, Serializable, Cloneable, Iterable<Byte>, Collection<Byte>, Set<Byte>, SortedSet<Byte>

public class ByteRBTreeSet
extends AbstractByteSortedSet
implements Serializable, Cloneable, ByteSortedSet

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

Constructor Summary

Constructors
Constructor	Description
`ByteRBTreeSet()`	Creates a new empty tree set.
`ByteRBTreeSet(byte[] a)`	Creates a new tree set copying the elements of an array.
`ByteRBTreeSet(byte[] a, int offset, int length)`	Creates a new tree set and fills it with the elements of a given array.
`ByteRBTreeSet(byte[] a, int offset, int length, Comparator<? super Byte> c)`	Creates a new tree set and fills it with the elements of a given array using a given `Comparator`.
`ByteRBTreeSet(byte[] a, Comparator<? super Byte> c)`	Creates a new tree set copying the elements of an array using a given `Comparator`.
`ByteRBTreeSet(ByteCollection c)`	Creates a new tree set copying a given type-specific collection.
`ByteRBTreeSet(ByteIterator i)`	Creates a new tree set using elements provided by a type-specific iterator.
`ByteRBTreeSet(ByteSortedSet s)`	Creates a new tree set copying a given type-specific sorted set (and its `Comparator`).
`ByteRBTreeSet(Collection<? extends Byte> c)`	Creates a new tree set copying a given collection.
`ByteRBTreeSet(Comparator<? super Byte> c)`	Creates a new empty tree set with the given comparator.
`ByteRBTreeSet(Iterator<?> i)`	Creates a new tree set using elements provided by an iterator.
`ByteRBTreeSet(SortedSet<Byte> s)`	Creates a new tree set copying a given sorted set (and its `Comparator`).

Method Summary

Modifier and Type	Method	Description
`boolean`	`add(byte k)`	Ensures that this collection contains the specified element (optional operation).
`void`	`clear()`
`Object`	`clone()`	Returns a deep copy of this tree set.
`ByteComparator`	`comparator()`
`boolean`	`contains(byte k)`	Returns `true` if this collection contains the specified element.
`byte`	`firstByte()`	Returns the first (lowest) element currently in this set.
`ByteSortedSet`	`headSet(byte to)`	Returns a view of the portion of this sorted set whose elements are strictly less than `toElement`.
`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()`	Returns the last (highest) element currently in this set.
`boolean`	`remove(byte k)`	Removes an element from this set.
`int`	`size()`
`ByteSortedSet`	`subSet(byte from, byte to)`	Returns a view of the portion of this sorted set whose elements range from `fromElement`, inclusive, to `toElement`, exclusive.
`ByteSortedSet`	`tailSet(byte from)`	Returns a view of the portion of this sorted set whose elements are greater than or equal to `fromElement`.

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

equals, hashCode, rem

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

add, addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toByteArray, toByteArray, toString

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

addAll, containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toByteArray, toByteArray

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

forEach, forEach

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

add, contains, rem, remove

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

first, headSet, last, subSet, tailSet

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Details
- ByteRBTreeSet
  
  public ByteRBTreeSet()
  
  Creates a new empty tree set.
- ByteRBTreeSet
  
  public ByteRBTreeSet(Comparator<? super Byte> c)
  
  Creates a new empty tree set with the given comparator.
  
  Parameters:
  
  c - a Comparator (even better, a type-specific comparator).
- ByteRBTreeSet
  
  public ByteRBTreeSet(Collection<? extends Byte> c)
  
  Creates a new tree set copying a given collection.
  
  Parameters:
  
  c - a collection to be copied into the new tree set.
- ByteRBTreeSet
  
  public ByteRBTreeSet(SortedSet<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.
- ByteRBTreeSet
  
  public ByteRBTreeSet(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.
- ByteRBTreeSet
  
  public ByteRBTreeSet(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.
- ByteRBTreeSet
  
  public ByteRBTreeSet(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.
- ByteRBTreeSet
  
  public ByteRBTreeSet(Iterator<?> i)
  
  Creates a new tree set using elements provided by an iterator.
  
  Parameters:
  
  i - an iterator whose elements will fill the set.
- ByteRBTreeSet
  
  public ByteRBTreeSet(byte[] a, int offset, int length, Comparator<? super 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).
- ByteRBTreeSet
  
  public ByteRBTreeSet(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.
- ByteRBTreeSet
  
  public ByteRBTreeSet(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.
- ByteRBTreeSet
  
  public ByteRBTreeSet(byte[] a, Comparator<? super 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 Details
- add
  
  public boolean add(byte k)
  
  Description copied from class: AbstractByteCollection
  
  Ensures that this collection contains the specified element (optional operation).
  This implementation always throws an UnsupportedOperationException.
  
  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 class: AbstractByteSet
  
  Removes an element from this set.
  Note that the corresponding method of a type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface. Delegates to the type-specific rem() method implemented by type-specific abstract Collection superclass.
  
  Specified by:
  
  remove in interface ByteSet
  
  Overrides:
  
  remove in class AbstractByteSet
  
  See Also:
  
  Collection.remove(Object)
- contains
  
  public boolean contains(byte k)
  
  Description copied from class: AbstractByteCollection
  
  Returns true if this collection contains the specified element.
  This implementation iterates over the elements in the collection, looking for the specified element.
  
  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 Collection<Byte>
  
  Specified by:
  
  clear in interface Set<Byte>
  
  Overrides:
  
  clear in class AbstractCollection<Byte>
- size
  
  public int size()
  
  Specified by:
  
  size in interface Collection<Byte>
  
  Specified by:
  
  size in interface Set<Byte>
  
  Specified by:
  
  size in class AbstractCollection<Byte>
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface Collection<Byte>
  
  Specified by:
  
  isEmpty in interface Set<Byte>
  
  Overrides:
  
  isEmpty in class AbstractCollection<Byte>
- firstByte
  
  public byte firstByte()
  
  Description copied from interface: ByteSortedSet
  
  Returns the first (lowest) element currently in this set.
  
  Specified by:
  
  firstByte in interface ByteSortedSet
  
  See Also:
  
  SortedSet.first()
- lastByte
  
  public byte lastByte()
  
  Description copied from interface: ByteSortedSet
  
  Returns the last (highest) element currently in this set.
  
  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 ByteBidirectionalIterable
  
  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 Collection<Byte>
  
  Specified by:
  
  iterator in interface Iterable<Byte>
  
  Specified by:
  
  iterator in interface Set<Byte>
  
  Specified by:
  
  iterator in class AbstractByteSortedSet
  
  Returns:
  
  a type-specific iterator on the elements of this collection.
  
  See Also:
  
  Iterable.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
  
  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
  
  Note that this specification strengthens the one given in SortedSet.comparator().
  
  Specified by:
  
  comparator in interface ByteSortedSet
  
  Specified by:
  
  comparator in interface SortedSet<Byte>
- headSet
  
  public ByteSortedSet headSet(byte to)
  
  Description copied from interface: ByteSortedSet
  
  Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
  Note that this specification strengthens the one given in SortedSet.headSet(Object).
  
  Specified by:
  
  headSet in interface ByteSortedSet
  
  See Also:
  
  SortedSet.headSet(Object)
- tailSet
  
  public ByteSortedSet tailSet(byte from)
  
  Description copied from interface: ByteSortedSet
  
  Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.
  Note that this specification strengthens the one given in SortedSet.headSet(Object).
  
  Specified by:
  
  tailSet in interface ByteSortedSet
  
  See Also:
  
  SortedSet.tailSet(Object)
- subSet
  
  public ByteSortedSet subSet(byte from, byte to)
  
  Description copied from interface: ByteSortedSet
  
  Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
  Note that this specification strengthens the one given in SortedSet.subSet(Object,Object).
  
  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.

Class ByteRBTreeSet