Class CharIterators
- java.lang.Object
-
- it.unimi.dsi.fastutil.chars.CharIterators
-
public final class CharIterators 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
CharIterators.AbstractIndexBasedIterator
A skeletal implementation for an iterator backed by an index-based data store.static class
CharIterators.AbstractIndexBasedListIterator
A skeletal implementation for a list-iterator backed by an index-based data store.static class
CharIterators.EmptyIterator
A class returning no elements and a type-specific iterator interface.static class
CharIterators.UnmodifiableBidirectionalIterator
An unmodifiable wrapper class for bidirectional iterators.static class
CharIterators.UnmodifiableIterator
An unmodifiable wrapper class for iterators.static class
CharIterators.UnmodifiableListIterator
An unmodifiable wrapper class for list iterators.
-
Field Summary
Fields Modifier and Type Field Description static CharIterators.EmptyIterator
EMPTY_ITERATOR
An empty iterator.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static boolean
all(CharIterator iterator, CharPredicate predicate)
Returns whether all elements returned by the given iterator satisfy the given predicate.static boolean
all(CharIterator iterator, java.util.function.IntPredicate predicate)
Returns whether all elements returned by the given iterator satisfy the given predicate.static boolean
any(CharIterator iterator, CharPredicate predicate)
Returns whether an element returned by the given iterator satisfies the given predicate.static boolean
any(CharIterator iterator, java.util.function.IntPredicate predicate)
Returns whether an element returned by the given iterator satisfies the given predicate.static CharIterator
asCharIterator(java.util.Iterator i)
Wraps a standard iterator into a type-specific iterator.static CharListIterator
asCharIterator(java.util.ListIterator i)
Wraps a standard list iterator into a type-specific list iterator.static CharIterator
concat(CharIterator... a)
Concatenates all iterators contained in an array.static CharIterator
concat(CharIterator[] a, int offset, int length)
Concatenates a sequence of iterators contained in an array.static CharListIterator
fromTo(char from, char to)
Creates a type-specific list iterator over an interval.static int
indexOf(CharIterator iterator, CharPredicate predicate)
Returns the index of the first element returned by the given iterator that satisfies the given predicate, or −1 if no such element was found.static int
indexOf(CharIterator iterator, java.util.function.IntPredicate predicate)
Returns the index of the first element returned by the given iterator that satisfies the given predicate, or −1 if no such element was found.static CharIterator
narrow(java.util.PrimitiveIterator.OfInt i)
Wrap a JDK primitive iterator to a type-specific iterator, making checked narrowed casts.static CharList
pour(CharIterator i)
Pours an iterator, returning a type-specific list.static CharList
pour(CharIterator i, int max)
Pours an iterator, returning a type-specific list, with a limit on the number of elements.static int
pour(CharIterator i, CharCollection s)
Pours an iterator into a type-specific collection.static int
pour(CharIterator i, CharCollection s, int max)
Pours an iterator into a type-specific collection, with a limit on the number of elements.static CharListIterator
singleton(char element)
Returns an immutable iterator that iterates just over the given element.static CharIterator
uncheckedNarrow(java.util.PrimitiveIterator.OfInt i)
Wrap a JDK primitive iterator to a type-specific iterator, making unchecked narrowing casts.static CharBidirectionalIterator
unmodifiable(CharBidirectionalIterator i)
Returns an unmodifiable bidirectional iterator backed by the specified bidirectional iterator.static CharIterator
unmodifiable(CharIterator i)
Returns an unmodifiable iterator backed by the specified iterator.static CharListIterator
unmodifiable(CharListIterator i)
Returns an unmodifiable list iterator backed by the specified list iterator.static char[]
unwrap(CharIterator i)
Unwraps an iterator, returning an array.static int
unwrap(CharIterator i, char[] array)
Unwraps an iterator into an array.static long
unwrap(CharIterator i, char[][] array)
Unwraps an iterator into a big array.static long
unwrap(CharIterator i, char[][] 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(CharIterator i, char[] array, int offset, int max)
Unwraps an iterator into an array starting at a given offset for a given number of elements.static char[]
unwrap(CharIterator i, int max)
Unwraps an iterator, returning an array, with a limit on the number of elements.static long
unwrap(CharIterator i, CharCollection c)
Unwraps an iterator into a type-specific collection.static int
unwrap(CharIterator i, CharCollection c, int max)
Unwraps an iterator into a type-specific collection, with a limit on the number of elements.static char[][]
unwrapBig(CharIterator i)
Unwraps an iterator, returning a big array.static char[][]
unwrapBig(CharIterator i, long max)
Unwraps an iterator, returning a big array, with a limit on the number of elements.static IntIterator
widen(CharIterator i)
Wrap a type-specific iterator to a JDK compatible primitive iterator.static CharListIterator
wrap(char[] array)
Wraps the given array into a type-specific list iterator.static CharListIterator
wrap(char[] array, int offset, int length)
Wraps the given part of an array into a type-specific list iterator.
-
-
-
Field Detail
-
EMPTY_ITERATOR
public static final CharIterators.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 CharListIterator singleton(char 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 CharListIterator wrap(char[] 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 CharListIterator wrap(char[] 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 return the elements of
array
.
-
unwrap
public static int unwrap(CharIterator i, char[] 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(CharIterator i, char[] 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 char[] unwrap(CharIterator 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 char[] unwrap(CharIterator 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(CharIterator i, char[][] 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(CharIterator i, char[][] 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(CharIterator i, CharCollection 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 char[][] unwrapBig(CharIterator 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 char[][] unwrapBig(CharIterator 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(CharIterator i, CharCollection 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(CharIterator i, CharCollection 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(CharIterator i, CharCollection 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 CharList pour(CharIterator 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 CharList pour(CharIterator 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.
-
asCharIterator
public static CharIterator asCharIterator(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.- Parameters:
i
- an iterator.- Returns:
- a type-specific iterator backed by
i
. - Implementation Notes:
- If
i
is already type-specific, it will returned and no new object will be generated.
-
narrow
public static CharIterator narrow(java.util.PrimitiveIterator.OfInt i)
Wrap a JDK primitive iterator to a type-specific iterator, making checked narrowed casts.- Parameters:
i
- an iterator.- Returns:
- a type-specific iterator backed by
i
. - Since:
- 8.5.0
- Implementation Notes:
- The
next
method throwsIllegalArgumentException
if any element would underflow or overflow.
-
uncheckedNarrow
public static CharIterator uncheckedNarrow(java.util.PrimitiveIterator.OfInt i)
Wrap a JDK primitive iterator to a type-specific iterator, making unchecked narrowing casts.No test is done for overflow or underflow.
- Parameters:
i
- an iterator.- Returns:
- a type-specific iterator backed by
i
. - Since:
- 8.5.0
-
widen
public static IntIterator widen(CharIterator i)
Wrap a type-specific iterator to a JDK compatible primitive iterator.WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs
(int)(charValue)
casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. SeeCharacter
for more discussion on code points, char values, and surrogate pairs.- Parameters:
i
- an iterator- Returns:
- a JDK compatible primitive iterator backed by
i
- Since:
- 8.5.0
-
asCharIterator
public static CharListIterator asCharIterator(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(CharIterator iterator, CharPredicate predicate)
Returns whether an element returned by the given iterator satisfies the given predicate.Short circuit evaluation is performed; the first
true
from the predicate terminates the loop.- Returns:
- true if an element returned by
iterator
satisfiespredicate
.
-
any
public static boolean any(CharIterator iterator, java.util.function.IntPredicate predicate)
Returns whether an element returned by the given iterator satisfies the given predicate.Short circuit evaluation is performed; the first
true
from the predicate terminates the loop.- Returns:
- true if an element returned by
iterator
satisfiespredicate
. lambda to perform widening casts. Please use the type-specific overload to avoid this overhead.
-
all
public static boolean all(CharIterator iterator, CharPredicate predicate)
Returns whether all elements returned by the given iterator satisfy the given predicate.Short circuit evaluation is performed; the first
false
from the predicate terminates the loop.- Returns:
- true if all elements returned by
iterator
satisfypredicate
.
-
all
public static boolean all(CharIterator iterator, java.util.function.IntPredicate predicate)
Returns whether all elements returned by the given iterator satisfy the given predicate.Short circuit evaluation is performed; the first
false
from the predicate terminates the loop.- Returns:
- true if all elements returned by
iterator
satisfypredicate
. - Implementation Notes:
- Unless the argument is type-specific, this method will introduce an intermediary lambda to perform widening casts. Please use the type-specific overload to avoid this overhead.
-
indexOf
public static int indexOf(CharIterator iterator, CharPredicate predicate)
Returns the index of the first element returned by the given iterator that satisfies the given predicate, or −1 if no such element was found.The next element returned by the iterator always considered element 0, even for
ListIterators
. In other wordsListIterator.nextIndex
is ignored.- Returns:
- the index of the first element returned by
iterator
that satisfiespredicate
, or −1 if no such element was found.
-
indexOf
public static int indexOf(CharIterator iterator, java.util.function.IntPredicate predicate)
Returns the index of the first element returned by the given iterator that satisfies the given predicate, or −1 if no such element was found.The next element returned by the iterator always considered element 0, even for
ListIterators
. In other wordsListIterator.nextIndex
is ignored.- Returns:
- the index of the first element returned by
iterator
that satisfiespredicate
, or −1 if no such element was found. - Implementation Notes:
- Unless the argument is type-specific, this method will introduce an intermediary lambda to perform widening casts. Please use the type-specific overload to avoid this overhead.
-
fromTo
public static CharListIterator fromTo(char from, char 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 CharIterator concat(CharIterator... 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 CharIterator concat(CharIterator[] 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 CharIterator unmodifiable(CharIterator 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 CharBidirectionalIterator unmodifiable(CharBidirectionalIterator 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 CharListIterator unmodifiable(CharListIterator 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.
-
-