Class ShortIterators
- java.lang.Object
-
- it.unimi.dsi.fastutil.shorts.ShortIterators
-
public final class ShortIterators extends java.lang.Object
A class providing static methods and objects that do useful things with type-specific iterators.- See Also:
Iterator
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ShortIterators.EmptyIterator
A class returning no elements and a type-specific iterator interface.static class
ShortIterators.UnmodifiableBidirectionalIterator
An unmodifiable wrapper class for bidirectional iterators.static class
ShortIterators.UnmodifiableIterator
An unmodifiable wrapper class for iterators.static class
ShortIterators.UnmodifiableListIterator
An unmodifiable wrapper class for list iterators.
-
Field Summary
Fields Modifier and Type Field Description static ShortIterators.EmptyIterator
EMPTY_ITERATOR
An empty iterator.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static boolean
all(ShortIterator iterator, java.util.function.IntPredicate predicate)
static boolean
any(ShortIterator iterator, java.util.function.IntPredicate predicate)
static ShortIterator
asShortIterator(java.util.Iterator i)
Wraps a standard iterator into a type-specific iterator.static ShortListIterator
asShortIterator(java.util.ListIterator i)
Wraps a standard list iterator into a type-specific list iterator.static ShortIterator
concat(ShortIterator[] a)
Concatenates all iterators contained in an array.static ShortIterator
concat(ShortIterator[] a, int offset, int length)
Concatenates a sequence of iterators contained in an array.static ShortListIterator
fromTo(short from, short to)
Creates a type-specific list iterator over an interval.static int
indexOf(ShortIterator iterator, java.util.function.IntPredicate predicate)
static ShortList
pour(ShortIterator i)
Pours an iterator, returning a type-specific list.static ShortList
pour(ShortIterator i, int max)
Pours an iterator, returning a type-specific list, with a limit on the number of elements.static int
pour(ShortIterator i, ShortCollection s)
Pours an iterator into a type-specific collection.static int
pour(ShortIterator i, ShortCollection s, int max)
Pours an iterator into a type-specific collection, with a limit on the number of elements.static ShortListIterator
singleton(short element)
Returns an immutable iterator that iterates just over the given element.static ShortBidirectionalIterator
unmodifiable(ShortBidirectionalIterator i)
Returns an unmodifiable bidirectional iterator backed by the specified bidirectional iterator.static ShortIterator
unmodifiable(ShortIterator i)
Returns an unmodifiable iterator backed by the specified iterator.static ShortListIterator
unmodifiable(ShortListIterator i)
Returns an unmodifiable list iterator backed by the specified list iterator.static short[]
unwrap(ShortIterator i)
Unwraps an iterator, returning an array.static short[]
unwrap(ShortIterator i, int max)
Unwraps an iterator, returning an array, with a limit on the number of elements.static int
unwrap(ShortIterator i, short[] array)
Unwraps an iterator into an array.static long
unwrap(ShortIterator i, short[][] array)
Unwraps an iterator into a big array.static long
unwrap(ShortIterator i, short[][] array, long offset, long max)
Unwraps an iterator into a big array starting at a given offset for a given number of elements.static int
unwrap(ShortIterator i, short[] array, int offset, int max)
Unwraps an iterator into an array starting at a given offset for a given number of elements.static long
unwrap(ShortIterator i, ShortCollection c)
Unwraps an iterator into a type-specific collection.static int
unwrap(ShortIterator i, ShortCollection c, int max)
Unwraps an iterator into a type-specific collection, with a limit on the number of elements.static short[][]
unwrapBig(ShortIterator i)
Unwraps an iterator, returning a big array.static short[][]
unwrapBig(ShortIterator i, long max)
Unwraps an iterator, returning a big array, with a limit on the number of elements.static ShortListIterator
wrap(short[] array)
Wraps the given array into a type-specific list iterator.static ShortListIterator
wrap(short[] array, int offset, int length)
Wraps the given part of an array into a type-specific list iterator.static ShortIterator
wrap(ByteIterator iterator)
Returns an iterator backed by the specified byte iterator.
-
-
-
Field Detail
-
EMPTY_ITERATOR
public static final ShortIterators.EmptyIterator EMPTY_ITERATOR
An empty iterator. It is serializable and cloneable.The class of this objects represent an abstract empty iterator that can iterate as a type-specific (list) iterator.
-
-
Method Detail
-
singleton
public static ShortListIterator singleton(short element)
Returns an immutable iterator that iterates just over the given element.- Parameters:
element
- the only element to be returned by a type-specific list iterator.- Returns:
- an immutable iterator that iterates just over
element
.
-
wrap
public static ShortListIterator wrap(short[] array, int offset, int length)
Wraps the given part of an array into a type-specific list iterator.The type-specific list iterator returned by this method will iterate
length
times, returning consecutive elements of the given array starting from the one with indexoffset
.- Parameters:
array
- an array to wrap into a type-specific list iterator.offset
- the first element of the array to be returned.length
- the number of elements to return.- Returns:
- an iterator that will return
length
elements ofarray
starting at positionoffset
.
-
wrap
public static ShortListIterator wrap(short[] array)
Wraps the given array into a type-specific list iterator.The type-specific list iterator returned by this method will return all elements of the given array.
- Parameters:
array
- an array to wrap into a type-specific list iterator.- Returns:
- an iterator that will the elements of
array
.
-
unwrap
public static int unwrap(ShortIterator i, short[] array, int offset, int max)
Unwraps an iterator into an array starting at a given offset for a given number of elements.This method iterates over the given type-specific iterator and stores the elements returned, up to a maximum of
length
, in the given array starting atoffset
. The number of actually unwrapped elements is returned (it may be less thanmax
if the iterator emits less thanmax
elements).- Parameters:
i
- a type-specific iterator.array
- an array to contain the output of the iterator.offset
- the first element of the array to be returned.max
- the maximum number of elements to unwrap.- Returns:
- the number of elements unwrapped.
-
unwrap
public static int unwrap(ShortIterator i, short[] array)
Unwraps an iterator into an array.This method iterates over the given type-specific iterator and stores the elements returned in the given array. The iteration will stop when the iterator has no more elements or when the end of the array has been reached.
- Parameters:
i
- a type-specific iterator.array
- an array to contain the output of the iterator.- Returns:
- the number of elements unwrapped.
-
unwrap
public static short[] unwrap(ShortIterator i, int max)
Unwraps an iterator, returning an array, with a limit on the number of elements.This method iterates over the given type-specific iterator and returns an array containing the elements returned by the iterator. At most
max
elements will be returned.- Parameters:
i
- a type-specific iterator.max
- the maximum number of elements to be unwrapped.- Returns:
- an array containing the elements returned by the iterator (at most
max
).
-
unwrap
public static short[] unwrap(ShortIterator i)
Unwraps an iterator, returning an array.This method iterates over the given type-specific iterator and returns an array containing the elements returned by the iterator.
- Parameters:
i
- a type-specific iterator.- Returns:
- an array containing the elements returned by the iterator.
-
unwrap
public static long unwrap(ShortIterator i, short[][] array, long offset, long max)
Unwraps an iterator into a big array starting at a given offset for a given number of elements.This method iterates over the given type-specific iterator and stores the elements returned, up to a maximum of
length
, in the given big array starting atoffset
. The number of actually unwrapped elements is returned (it may be less thanmax
if the iterator emits less thanmax
elements).- Parameters:
i
- a type-specific iterator.array
- a big array to contain the output of the iterator.offset
- the first element of the array to be returned.max
- the maximum number of elements to unwrap.- Returns:
- the number of elements unwrapped.
-
unwrap
public static long unwrap(ShortIterator i, short[][] array)
Unwraps an iterator into a big array.This method iterates over the given type-specific iterator and stores the elements returned in the given big array. The iteration will stop when the iterator has no more elements or when the end of the array has been reached.
- Parameters:
i
- a type-specific iterator.array
- a big array to contain the output of the iterator.- Returns:
- the number of elements unwrapped.
-
unwrap
public static int unwrap(ShortIterator i, ShortCollection c, int max)
Unwraps an iterator into a type-specific collection, with a limit on the number of elements.This method iterates over the given type-specific iterator and stores the elements returned, up to a maximum of
max
, in the given type-specific collection. The number of actually unwrapped elements is returned (it may be less thanmax
if the iterator emits less thanmax
elements).- Parameters:
i
- a type-specific iterator.c
- a type-specific collection array to contain the output of the iterator.max
- the maximum number of elements to unwrap.- Returns:
- the number of elements unwrapped. Note that this is the number of elements returned by the iterator, which is not necessarily the number of elements that have been added to the collection (because of duplicates).
-
unwrapBig
public static short[][] unwrapBig(ShortIterator i, long max)
Unwraps an iterator, returning a big array, with a limit on the number of elements.This method iterates over the given type-specific iterator and returns a big array containing the elements returned by the iterator. At most
max
elements will be returned.- Parameters:
i
- a type-specific iterator.max
- the maximum number of elements to be unwrapped.- Returns:
- a big array containing the elements returned by the iterator (at most
max
).
-
unwrapBig
public static short[][] unwrapBig(ShortIterator i)
Unwraps an iterator, returning a big array.This method iterates over the given type-specific iterator and returns a big array containing the elements returned by the iterator.
- Parameters:
i
- a type-specific iterator.- Returns:
- a big array containing the elements returned by the iterator.
-
unwrap
public static long unwrap(ShortIterator i, ShortCollection c)
Unwraps an iterator into a type-specific collection.This method iterates over the given type-specific iterator and stores the elements returned in the given type-specific collection. The returned count on the number unwrapped elements is a long, so that it will work also with very large collections.
- Parameters:
i
- a type-specific iterator.c
- a type-specific collection to contain the output of the iterator.- Returns:
- the number of elements unwrapped. Note that this is the number of elements returned by the iterator, which is not necessarily the number of elements that have been added to the collection (because of duplicates).
-
pour
public static int pour(ShortIterator i, ShortCollection s, int max)
Pours an iterator into a type-specific collection, with a limit on the number of elements.This method iterates over the given type-specific iterator and adds the returned elements to the given collection (up to
max
).- Parameters:
i
- a type-specific iterator.s
- a type-specific collection.max
- the maximum number of elements to be poured.- Returns:
- the number of elements poured. Note that this is the number of elements returned by the iterator, which is not necessarily the number of elements that have been added to the collection (because of duplicates).
-
pour
public static int pour(ShortIterator i, ShortCollection s)
Pours an iterator into a type-specific collection.This method iterates over the given type-specific iterator and adds the returned elements to the given collection.
- Parameters:
i
- a type-specific iterator.s
- a type-specific collection.- Returns:
- the number of elements poured. Note that this is the number of elements returned by the iterator, which is not necessarily the number of elements that have been added to the collection (because of duplicates).
-
pour
public static ShortList pour(ShortIterator i, int max)
Pours an iterator, returning a type-specific list, with a limit on the number of elements.This method iterates over the given type-specific iterator and returns a type-specific list containing the returned elements (up to
max
). Iteration on the returned list is guaranteed to produce the elements in the same order in which they appeared in the iterator.- Parameters:
i
- a type-specific iterator.max
- the maximum number of elements to be poured.- Returns:
- a type-specific list containing the returned elements, up to
max
.
-
pour
public static ShortList pour(ShortIterator i)
Pours an iterator, returning a type-specific list.This method iterates over the given type-specific iterator and returns a list containing the returned elements. Iteration on the returned list is guaranteed to produce the elements in the same order in which they appeared in the iterator.
- Parameters:
i
- a type-specific iterator.- Returns:
- a type-specific list containing the returned elements.
-
asShortIterator
public static ShortIterator asShortIterator(java.util.Iterator i)
Wraps a standard iterator into a type-specific iterator.This method wraps a standard iterator into a type-specific one which will handle the type conversions for you. Of course, any attempt to wrap an iterator returning the instances of the wrong class will generate a
ClassCastException
. The returned iterator is backed byi
: changes to one of the iterators will affect the other, too.If
i
is already type-specific, it will returned and no new object will be generated.- Parameters:
i
- an iterator.- Returns:
- a type-specific iterator backed by
i
.
-
asShortIterator
public static ShortListIterator asShortIterator(java.util.ListIterator i)
Wraps a standard list iterator into a type-specific list iterator.This method wraps a standard list iterator into a type-specific one which will handle the type conversions for you. Of course, any attempt to wrap an iterator returning the instances of the wrong class will generate a
ClassCastException
. The returned iterator is backed byi
: changes to one of the iterators will affect the other, too.If
i
is already type-specific, it will returned and no new object will be generated.- Parameters:
i
- a list iterator.- Returns:
- a type-specific list iterator backed by
i
.
-
any
public static boolean any(ShortIterator iterator, java.util.function.IntPredicate predicate)
-
all
public static boolean all(ShortIterator iterator, java.util.function.IntPredicate predicate)
-
indexOf
public static int indexOf(ShortIterator iterator, java.util.function.IntPredicate predicate)
-
fromTo
public static ShortListIterator fromTo(short from, short to)
Creates a type-specific list iterator over an interval.The type-specific list iterator returned by this method will return the elements
from
,from+1
,…,to-1
.- Parameters:
from
- the starting element (inclusive).to
- the ending element (exclusive).- Returns:
- a type-specific list iterator enumerating the elements from
from
toto
.
-
concat
public static ShortIterator concat(ShortIterator[] a)
Concatenates all iterators contained in an array.This method returns an iterator that will enumerate in order the elements returned by all iterators contained in the given array.
- Parameters:
a
- an array of iterators.- Returns:
- an iterator obtained by concatenation.
-
concat
public static ShortIterator concat(ShortIterator[] a, int offset, int length)
Concatenates a sequence of iterators contained in an array.This method returns an iterator that will enumerate in order the elements returned by
a[offset]
, then those returned bya[offset + 1]
, and so on up toa[offset + length - 1]
.- Parameters:
a
- an array of iterators.offset
- the index of the first iterator to concatenate.length
- the number of iterators to concatenate.- Returns:
- an iterator obtained by concatenation of
length
elements ofa
starting atoffset
.
-
unmodifiable
public static ShortIterator unmodifiable(ShortIterator i)
Returns an unmodifiable iterator backed by the specified iterator.- Parameters:
i
- the iterator to be wrapped in an unmodifiable iterator.- Returns:
- an unmodifiable view of the specified iterator.
-
unmodifiable
public static ShortBidirectionalIterator unmodifiable(ShortBidirectionalIterator i)
Returns an unmodifiable bidirectional iterator backed by the specified bidirectional iterator.- Parameters:
i
- the bidirectional iterator to be wrapped in an unmodifiable bidirectional iterator.- Returns:
- an unmodifiable view of the specified bidirectional iterator.
-
unmodifiable
public static ShortListIterator unmodifiable(ShortListIterator i)
Returns an unmodifiable list iterator backed by the specified list iterator.- Parameters:
i
- the list iterator to be wrapped in an unmodifiable list iterator.- Returns:
- an unmodifiable view of the specified list iterator.
-
wrap
public static ShortIterator wrap(ByteIterator iterator)
Returns an iterator backed by the specified byte iterator.- Parameters:
iterator
- a byte iterator.- Returns:
- an iterator backed by the specified byte iterator.
-
-