Package it.unimi.dsi.fastutil.objects

Interface ReferenceSortedSet<K>

All Superinterfaces:

Collection<K>, Iterable<K>, ObjectBidirectionalIterable<K>, ObjectIterable<K>, ReferenceCollection<K>, ReferenceSet<K>, SequencedCollection<K>, SequencedSet<K>, Set<K>, SortedSet<K>

All Known Implementing Classes:

AbstractReferenceSortedSet, ReferenceLinkedOpenHashSet, ReferenceSortedSets.EmptySet, ReferenceSortedSets.Singleton, ReferenceSortedSets.SynchronizedSortedSet, ReferenceSortedSets.UnmodifiableSortedSet

public interface ReferenceSortedSet<K>
extends ReferenceSet<K>, SortedSet<K>, ObjectBidirectionalIterable<K>

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

Additionally, this interface strengthens iterator(), SortedSet.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
ReferenceSortedSet<K>	headSet(K toElement)	Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
ObjectBidirectionalIterator<K>	iterator()	Returns a type-specific BidirectionalIterator on the elements in this set.
ObjectBidirectionalIterator<K>	iterator(K fromElement)	Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
default ObjectSpliterator<K>	spliterator()	Returns a type-specific spliterator on the elements of this sorted-set.
ReferenceSortedSet<K>	subSet(K fromElement, K toElement)	Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
ReferenceSortedSet<K>	tailSet(K fromElement)	Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

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, comparator, first, getFirst, getLast, last, removeFirst, removeLast, reversed

Method Details

iterator

ObjectBidirectionalIterator<K> iterator(K 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

ObjectBidirectionalIterator<K> 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 Collection<K>

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface ObjectBidirectionalIterable<K>

Specified by:

iterator in interface ObjectIterable<K>

Specified by:

iterator in interface ReferenceCollection<K>

Specified by:

iterator in interface ReferenceSet<K>

Specified by:

iterator in interface Set<K>

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 ObjectSpliterator<K> 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 SortedSet.comparator().

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

Specified by:

spliterator in interface Collection<K>

Specified by:

spliterator in interface Iterable<K>

Specified by:

spliterator in interface ObjectIterable<K>

Specified by:

spliterator in interface ReferenceCollection<K>

Specified by:

spliterator in interface ReferenceSet<K>

Specified by:

spliterator in interface Set<K>

Specified by:

spliterator in interface SortedSet<K>

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

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

ReferenceSortedSet<K> subSet(K fromElement,
 K toElement)

Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.

Specified by:

subSet in interface SortedSet<K>

See Also:

• SortedSet.subSet(Object,Object)

API Notes:

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

headSet

ReferenceSortedSet<K> headSet(K toElement)

Returns a view of the portion of this sorted set whose elements are strictly less than toElement.

Specified by:

headSet in interface SortedSet<K>

See Also:

• SortedSet.headSet(Object)

API Notes:

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

tailSet

ReferenceSortedSet<K> tailSet(K fromElement)

Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.

Specified by:

tailSet in interface SortedSet<K>

See Also:

• SortedSet.tailSet(Object)

API Notes:

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