it.unimi.dsi.fastutil.bytes

Interface ByteSortedSet

All Superinterfaces:

ByteCollection, ByteIterable, ByteSet, Collection<Byte>, Iterable<Byte>, Set<Byte>, SortedSet<Byte>

All Known Implementing Classes:

AbstractByteSortedSet, ByteAVLTreeSet, ByteLinkedOpenCustomHashSet, ByteLinkedOpenHashSet, ByteRBTreeSet, ByteSortedSets.EmptySet, ByteSortedSets.Singleton, ByteSortedSets.SynchronizedSortedSet, ByteSortedSets.UnmodifiableSortedSet

public interface ByteSortedSet
extends ByteSet, SortedSet<Byte>

A type-specific SortedSet; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens iterator(), comparator() (for primitive types), SortedSet.subSet(Object,Object), SortedSet.headSet(Object) and SortedSet.tailSet(Object).

See Also:

SortedSet

Method Summary

Modifier and Type	Method and Description
ByteBidirectionalIterator	byteIterator() Deprecated. As of fastutil 5, replaced by iterator().
ByteComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
byte	firstByte()
ByteSortedSet	headSet(byte toElement)
ByteSortedSet	headSet(Byte toElement) Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
ByteBidirectionalIterator	iterator() Returns a type-specific BidirectionalIterator on the elements in this set.
ByteBidirectionalIterator	iterator(byte fromElement) Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
byte	lastByte()
ByteSortedSet	subSet(byte fromElement, byte toElement)
ByteSortedSet	subSet(Byte fromElement, Byte toElement) Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
ByteSortedSet	tailSet(byte fromElement)
ByteSortedSet	tailSet(Byte fromElement) Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.

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

remove

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

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

Methods inherited from interface java.util.SortedSet

first, last, spliterator

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

iterator

ByteBidirectionalIterator iterator(byte fromElement)

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.

Parameters:

fromElement - an element to start from.

Returns:

a bidirectional iterator on the element in this set, starting at the given element.

Throws:

UnsupportedOperationException - if this set does not support iterators with a starting point.

byteIterator

@Deprecated
ByteBidirectionalIterator byteIterator()

Deprecated. As of fastutil 5, replaced by iterator().

Returns a type-specific BidirectionalIterator iterator on the collection.

The iterator returned by the iterator() method and by this method are identical; however, using this method you can save a type casting. Note that this specification strengthens the one given in the corresponding type-specific Collection.

Specified by:

byteIterator in interface ByteCollection

See Also:

ByteCollection.iterator()

iterator

ByteBidirectionalIterator iterator()

Returns a type-specific BidirectionalIterator on the elements in this set.

This method returns a parameterised bidirectional iterator. The iterator can be moreover safely cast to a type-specific iterator. Note that this specification strengthens the one given in the corresponding type-specific Collection.

Specified by:

iterator in interface ByteCollection

Specified by:

iterator in interface ByteIterable

Specified by:

iterator in interface ByteSet

Specified by:

iterator in interface Collection<Byte>

Specified by:

iterator in interface Iterable<Byte>

Specified by:

iterator in interface Set<Byte>

Returns:

a bidirectional iterator on the element in this set.

subSet

ByteSortedSet subSet(Byte fromElement,
                     Byte toElement)

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 SortedSet<Byte>

See Also:

SortedSet.subSet(Object,Object)

headSet

ByteSortedSet headSet(Byte toElement)

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 SortedSet<Byte>

See Also:

SortedSet.headSet(Object)

tailSet

ByteSortedSet tailSet(Byte fromElement)

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.tailSet(Object).

Specified by:

tailSet in interface SortedSet<Byte>

See Also:

SortedSet.tailSet(Object)

comparator

ByteComparator comparator()

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 SortedSet<Byte>

See Also:

SortedSet.comparator()

subSet

ByteSortedSet subSet(byte fromElement,
                     byte toElement)

See Also:

SortedSet.subSet(Object,Object)

headSet

ByteSortedSet headSet(byte toElement)

See Also:

SortedSet.headSet(Object)

tailSet

ByteSortedSet tailSet(byte fromElement)

See Also:

SortedSet.tailSet(Object)

firstByte

byte firstByte()

See Also:

SortedSet.first()

lastByte

byte lastByte()

See Also:

SortedSet.last()