it.unimi.dsi.fastutil.floats
Interface FloatSortedSet

All Superinterfaces:
java.util.Collection<java.lang.Float>, FloatCollection, FloatIterable, FloatSet, java.lang.Iterable<java.lang.Float>, java.util.Set<java.lang.Float>, java.util.SortedSet<java.lang.Float>
All Known Implementing Classes:
AbstractFloatSortedSet, FloatAVLTreeSet, FloatLinkedOpenHashSet, FloatRBTreeSet, FloatSortedSets.EmptySet, FloatSortedSets.Singleton, FloatSortedSets.SynchronizedSortedSet, FloatSortedSets.UnmodifiableSortedSet

public interface FloatSortedSet
extends FloatSet, java.util.SortedSet<java.lang.Float>

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
 FloatComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
 float firstFloat()
           
 FloatBidirectionalIterator floatIterator()
          Deprecated. As of fastutil 5, replaced by iterator().
 FloatSortedSet headSet(float toElement)
           
 FloatSortedSet headSet(java.lang.Float toElement)
          Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
 FloatBidirectionalIterator iterator()
          Returns a type-specific BidirectionalIterator on the elements in this set.
 FloatBidirectionalIterator iterator(float fromElement)
          Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
 float lastFloat()
           
 FloatSortedSet subSet(float fromElement, float toElement)
           
 FloatSortedSet subSet(java.lang.Float fromElement, java.lang.Float toElement)
          Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
 FloatSortedSet tailSet(float fromElement)
           
 FloatSortedSet tailSet(java.lang.Float 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.floats.FloatSet
remove
 
Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatCollection
add, addAll, contains, containsAll, rem, removeAll, retainAll, toArray, toArray, toFloatArray, toFloatArray
 
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
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

FloatBidirectionalIterator iterator(float 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:
java.lang.UnsupportedOperationException - if this set does not support iterators with a starting point.

floatIterator

@Deprecated
FloatBidirectionalIterator floatIterator()
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:
floatIterator in interface FloatCollection
See Also:
FloatCollection.iterator()

iterator

FloatBidirectionalIterator 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 java.util.Collection<java.lang.Float>
Specified by:
iterator in interface FloatCollection
Specified by:
iterator in interface FloatIterable
Specified by:
iterator in interface FloatSet
Specified by:
iterator in interface java.lang.Iterable<java.lang.Float>
Specified by:
iterator in interface java.util.Set<java.lang.Float>
Returns:
a bidirectional iterator on the element in this set.

subSet

FloatSortedSet subSet(java.lang.Float fromElement,
                      java.lang.Float 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 java.util.SortedSet<java.lang.Float>
See Also:
SortedSet.subSet(Object,Object)

headSet

FloatSortedSet headSet(java.lang.Float 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 java.util.SortedSet<java.lang.Float>
See Also:
SortedSet.headSet(Object)

tailSet

FloatSortedSet tailSet(java.lang.Float 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 java.util.SortedSet<java.lang.Float>
See Also:
SortedSet.tailSet(Object)

comparator

FloatComparator 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 java.util.SortedSet<java.lang.Float>
See Also:
SortedSet.comparator()

subSet

FloatSortedSet subSet(float fromElement,
                      float toElement)
See Also:
SortedSet.subSet(Object,Object)

headSet

FloatSortedSet headSet(float toElement)
See Also:
SortedSet.headSet(Object)

tailSet

FloatSortedSet tailSet(float fromElement)
See Also:
SortedSet.tailSet(Object)

firstFloat

float firstFloat()
See Also:
SortedSet.first()

lastFloat

float lastFloat()
See Also:
SortedSet.last()