it.unimi.dsi.fastutil.ints
Interface IntSortedSet

All Superinterfaces:
Collection<Integer>, IntCollection, IntIterable, IntSet, Iterable<Integer>, Set<Integer>, SortedSet<Integer>
All Known Implementing Classes:
AbstractIntSortedSet, IntAVLTreeSet, IntLinkedOpenCustomHashSet, IntLinkedOpenHashSet, IntRBTreeSet, IntSortedSets.EmptySet, IntSortedSets.Singleton, IntSortedSets.SynchronizedSortedSet, IntSortedSets.UnmodifiableSortedSet

public interface IntSortedSet
extends IntSet, SortedSet<Integer>

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
 IntComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
 int firstInt()
           
 IntSortedSet headSet(int toElement)
           
 IntSortedSet headSet(Integer toElement)
          Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
 IntBidirectionalIterator intIterator()
          Deprecated. As of fastutil 5, replaced by iterator().
 IntBidirectionalIterator iterator()
          Returns a type-specific BidirectionalIterator on the elements in this set.
 IntBidirectionalIterator iterator(int fromElement)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 int lastInt()
           
 IntSortedSet subSet(Integer fromElement, Integer toElement)
          Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
 IntSortedSet subSet(int fromElement, int toElement)
           
 IntSortedSet tailSet(int fromElement)
           
 IntSortedSet tailSet(Integer 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.ints.IntSet
remove
 
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
add, addAll, contains, containsAll, rem, removeAll, retainAll, toArray, toArray, toIntArray, toIntArray
 
Methods inherited from interface java.util.SortedSet
first, last
 
Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray
 

Method Detail

iterator

IntBidirectionalIterator iterator(int 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.

intIterator

@Deprecated
IntBidirectionalIterator intIterator()
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:
intIterator in interface IntCollection
See Also:
IntCollection.iterator()

iterator

IntBidirectionalIterator 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 Collection<Integer>
Specified by:
iterator in interface IntCollection
Specified by:
iterator in interface IntIterable
Specified by:
iterator in interface IntSet
Specified by:
iterator in interface Iterable<Integer>
Specified by:
iterator in interface Set<Integer>
Returns:
a bidirectional iterator on the element in this set.

subSet

IntSortedSet subSet(Integer fromElement,
                    Integer 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<Integer>
See Also:
SortedSet.subSet(Object,Object)

headSet

IntSortedSet headSet(Integer 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<Integer>
See Also:
SortedSet.headSet(Object)

tailSet

IntSortedSet tailSet(Integer 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<Integer>
See Also:
SortedSet.tailSet(Object)

comparator

IntComparator 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<Integer>
See Also:
SortedSet.comparator()

subSet

IntSortedSet subSet(int fromElement,
                    int toElement)
See Also:
SortedSet.subSet(Object,Object)

headSet

IntSortedSet headSet(int toElement)
See Also:
SortedSet.headSet(Object)

tailSet

IntSortedSet tailSet(int fromElement)
See Also:
SortedSet.tailSet(Object)

firstInt

int firstInt()
See Also:
SortedSet.first()

lastInt

int lastInt()
See Also:
SortedSet.last()