|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Sorted set is a collection with no duplicate elements. Primitive sets have
some features not found in object sets. A primitive set is
associated with a domain with boundaries defined by IntSet.min()
and IntSet.max()
. All numbers contained within this set must fit
between min and max, inclusive. Attempt to add a number from outside the
domain will have no effect.
It is possible to obtain a complement view of a
primitive set, using IntSet.complementSet()
. The complement view contains
all numbers between min and max, inclusive, which are not contained in
this set. (In other words, complement view never contains numbers from
outside of the domain of this set).
Contrary to standard Java collections, intervals in this primitive collection package are inclusive on both sides. In other words, interval [min, max] contains all numbers c such that min <= c <= max. (Otherwise, MAX_VALUE could not be put in the set).
It is possible to obtain a subset view of a sorted set, using one of
the methods #subSet()
, #headSet()
, and #tailSet()
.
The subset view narrows the domain, and its size is thus never bigger than
that of this set.
Sorted sets define a family of navigation methods, analogous to that
found in NavigableSet
.
Method Summary | |
int |
ceiling(int e)
Returns the smallest number in this set >= e. |
IntInterval |
ceilingInterval(int e)
Returns the smallest (left-most), widest interval contained in this set which elements are not all smaller than the specified number. |
java.util.Iterator |
descendingIntervalIterator()
Returns an iterator over intervals of this set, in a decreasing numerical order. |
IntIterator |
descendingIterator()
Returns an iterator over numbers in this set, in a decreasing numerical order. |
IntInterval |
enclosingInterval(int e)
Returns the widest interval contained in this set that includes the specified number, or null if this set does not include the specified number. |
int |
first()
Returns the smallest number in this set. |
IntInterval |
firstInterval()
Returns the first (left-most), widest interval contained in this set, or null if this set is empty. |
int |
floor(int e)
Returns the largest number in this set <= e. |
IntInterval |
floorInterval(int e)
Returns the largest (right-most), widest interval contained in this set which elements are not all greater than the specified number. |
IntSortedSet |
headSet(int last)
A subset view containing all elements from this set that are not greater than last. |
int |
higher(int e)
Returns the smallest number in this set > e. |
IntInterval |
higherInterval(int e)
Returns the smallest (left-most), widest interval contained in this set which all elements are strictly greater than the specified number. |
int |
intervalCount()
Returns the minimum count of intervals into which this set can be decomposed. |
java.util.Iterator |
intervalIterator()
Returns an iterator over intervals of this set, in an increasing numerical order. |
IntIterator |
iterator()
Returns an iterator over numbers in this set, in an increasing numerical order. |
int |
last()
Returns the largest number in this set. |
IntInterval |
lastInterval()
Returns the last (right-most), widest interval contained in this set, or null if this set is empty. |
int |
lower(int e)
Returns the largest number in this set < e. |
IntInterval |
lowerInterval(int e)
Returns the largest and widest interval contained in this set which all elements are strictly less than the specified number. |
int |
pollFirst()
Returns and removes the smallest number in this set. |
IntInterval |
pollFirstInterval()
Returns and removes the first (left-most), widest interval contained in this set, or null if this set is empty. |
int |
pollLast()
Returns and removes the largest number in this set. |
IntInterval |
pollLastInterval()
Returns and removes the last (right-most), widest interval contained in this set, or null if this set is empty. |
IntSortedSet |
subSet(int first,
int last)
A subset view containing all elements from this set between first, inclusive, and last, inclusive. |
IntSortedSet |
tailSet(int first)
A subset view containing all elements from this set that are not smaller than first. |
java.lang.String |
toCompactString()
Returns the interval-string representation of this set (suitable for representing sets that are possibly large but clustered). |
java.lang.String |
toString()
|
Methods inherited from interface edu.emory.mathcs.util.collections.ints.IntSet |
add, addAll, addInterval, clear, complementSet, contains, containsAll, containsInterval, equals, hashCode, isEmpty, max, min, remove, removeAll, removeInterval, retainAll, retainInterval, size, size64, toArray, toArray |
Method Detail |
public IntSortedSet subSet(int first, int last)
first
- the minimum element of this view (inclusive).last
- the maximum element of this view (inclusive).
public IntSortedSet headSet(int last)
last
- the maximum element of this view (inclusive).
public IntSortedSet tailSet(int first)
first
- the minimum element of this view (inclusive).
public int first()
java.util.NoSuchElementException
- if the set is empty.public int last()
java.util.NoSuchElementException
- if the set is empty.public int ceiling(int e)
java.util.NoSuchElementException
- if all elements are < e.public int higher(int e)
java.util.NoSuchElementException
- if all elements are <= e.public int floor(int e)
java.util.NoSuchElementException
- if all elements are > e.public int lower(int e)
java.util.NoSuchElementException
- if all elements are >= e.public int pollFirst()
java.util.NoSuchElementException
- if the set is empty.public int pollLast()
java.util.NoSuchElementException
- if the set is empty.public int intervalCount()
public java.util.Iterator intervalIterator()
public java.util.Iterator descendingIntervalIterator()
public IntIterator iterator()
iterator
in interface IntSet
public IntIterator descendingIterator()
public IntInterval firstInterval()
public IntInterval lastInterval()
public IntInterval enclosingInterval(int e)
public IntInterval lowerInterval(int e)
public IntInterval higherInterval(int e)
public IntInterval floorInterval(int e)
public IntInterval ceilingInterval(int e)
public IntInterval pollFirstInterval()
public IntInterval pollLastInterval()
public java.lang.String toString()
public java.lang.String toCompactString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |