Package it.unimi.dsi.fastutil.bytes

Interface ByteSortedSet

All Superinterfaces:

ByteBidirectionalIterable, ByteCollection, ByteIterable, ByteSet, Collection<Byte>, Iterable<Byte>, SequencedCollection<Byte>, SequencedSet<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>, ByteBidirectionalIterable

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	Description
ByteComparator	comparator()
default Byte	first()	Deprecated. Please use the corresponding type-specific method instead.
byte	firstByte()	Returns the first (lowest) element currently in this set.
ByteSortedSet	headSet(byte toElement)	Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
default ByteSortedSet	headSet(Byte to)	Deprecated. Please use the corresponding type-specific method instead.
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).
default Byte	last()	Deprecated. Please use the corresponding type-specific method instead.
byte	lastByte()	Returns the last (highest) element currently in this set.
default ByteSpliterator	spliterator()	Returns a type-specific spliterator on the elements of this sorted-set.
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.
default ByteSortedSet	subSet(Byte from, Byte to)	Deprecated. Please use the corresponding type-specific method instead.
ByteSortedSet	tailSet(byte fromElement)	Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.
default ByteSortedSet	tailSet(Byte from)	Deprecated. Please use the corresponding type-specific method instead.

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

add, addAll, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toByteArray, toByteArray

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

forEach, forEach, forEach

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

add, contains, rem, remove, remove

Methods inherited from interface java.util.Collection

toArray

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

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, reversed

Method Details

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.

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.

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

See Also:

• Iterable.iterator()

API Notes:

This specification strengthens the one given in the corresponding type-specific Collection.

spliterator

default ByteSpliterator spliterator()

Returns a type-specific spliterator on the elements of this sorted-set.

SortedSet spliterators must report at least Spliterator.DISTINCT, Spliterator.ORDERED, and Spliterator.SORTED. The returned spliterator's getComparator() must be the same (or at the very least, consistent with) this instance's comparator().

See SortedSet.spliterator() for more documentation on the requirements of the returned spliterator.

Specified by:

spliterator in interface ByteCollection

Specified by:

spliterator in interface ByteIterable

Specified by:

spliterator in interface ByteSet

Specified by:

spliterator in interface Collection<Byte>

Specified by:

spliterator in interface Iterable<Byte>

Specified by:

spliterator in interface Set<Byte>

Specified by:

spliterator in interface SortedSet<Byte>

Returns:

a type-specific spliterator on the elements of this collection.

Since:

8.5.0

API Notes:

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

Also, this is generally the only spliterator method subclasses should override.

Implementation Specification:

The default implementation returns a late-binding spliterator (see Spliterator for documentation on what binding policies mean) that wraps this instance's type specific iterator(byte).

Additionally, it reports Spliterator.SIZED, Spliterator.DISTINCT, Spliterator.SORTED, and Spliterator.ORDERED. The reported Comparator from Spliterator.getComparator() will be the one reported by this instance's comparator().

Implementation Notes:

As this default implementation wraps the iterator, and Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's trySplit() will have linear runtime.

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.

See Also:

• SortedSet.subSet(Object,Object)

API Notes:

This specification strengthens the one given in 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.

See Also:

• SortedSet.headSet(Object)

API Notes:

This specification strengthens the one given in 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.

See Also:

• SortedSet.tailSet(Object)

API Notes:

This specification strengthens the one given in SortedSet.headSet(Object).

comparator

ByteComparator comparator()

Specified by:

comparator in interface SortedSet<Byte>

API Notes:

This specification strengthens the one given in SortedSet.comparator().

firstByte

byte firstByte()

Returns the first (lowest) element currently in this set.

See Also:

• SortedSet.first()

lastByte

byte lastByte()

Returns the last (highest) element currently in this set.

See Also:

• SortedSet.last()

subSet

@Deprecated
default ByteSortedSet subSet(Byte from,
 Byte to)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

subSet in interface SortedSet<Byte>

headSet

@Deprecated
default ByteSortedSet headSet(Byte to)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

headSet in interface SortedSet<Byte>

tailSet

@Deprecated
default ByteSortedSet tailSet(Byte from)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

tailSet in interface SortedSet<Byte>

first

@Deprecated
default Byte first()

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

first in interface SortedSet<Byte>

last

@Deprecated
default Byte last()

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

last in interface SortedSet<Byte>