Class DoubleIterators
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A skeletal implementation for an iterator backed by an index-based data store.static class
A skeletal implementation for a list-iterator backed by an index-based data store.static class
A class returning no elements and a type-specific iterator interface.static class
An unmodifiable wrapper class for bidirectional iterators.static class
An unmodifiable wrapper class for iterators.static class
An unmodifiable wrapper class for list iterators. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
all
(DoubleIterator iterator, DoublePredicate predicate) Returns whether all elements returned by the given iterator satisfy the given predicate.static boolean
any
(DoubleIterator iterator, DoublePredicate predicate) Returns whether an element returned by the given iterator satisfies the given predicate.static DoubleIterator
Wraps a standard iterator into a type-specific iterator.static DoubleListIterator
Wraps a standard list iterator into a type-specific list iterator.static DoubleIterator
concat
(DoubleIterator... a) Concatenates all iterators contained in an array.static DoubleIterator
concat
(DoubleIterator[] a, int offset, int length) Concatenates a sequence of iterators contained in an array.static int
indexOf
(DoubleIterator iterator, DoublePredicate 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 DoubleList
Pours an iterator, returning a type-specific list.static DoubleList
pour
(DoubleIterator i, int max) Pours an iterator, returning a type-specific list, with a limit on the number of elements.static int
Pours an iterator into a type-specific collection.static int
pour
(DoubleIterator i, DoubleCollection s, int max) Pours an iterator into a type-specific collection, with a limit on the number of elements.static DoubleListIterator
singleton
(double element) Returns an immutable iterator that iterates just over the given element.static DoubleBidirectionalIterator
Returns an unmodifiable bidirectional iterator backed by the specified bidirectional iterator.static DoubleIterator
Returns an unmodifiable iterator backed by the specified iterator.static DoubleListIterator
Returns an unmodifiable list iterator backed by the specified list iterator.static double[]
Unwraps an iterator, returning an array.static int
unwrap
(DoubleIterator i, double[] array) Unwraps an iterator into an array.static long
unwrap
(DoubleIterator i, double[][] array) Unwraps an iterator into a big array.static long
unwrap
(DoubleIterator i, double[][] 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
(DoubleIterator i, double[] array, int offset, int max) Unwraps an iterator into an array starting at a given offset for a given number of elements.static double[]
unwrap
(DoubleIterator i, int max) Unwraps an iterator, returning an array, with a limit on the number of elements.static long
Unwraps an iterator into a type-specific collection.static int
unwrap
(DoubleIterator i, DoubleCollection c, int max) Unwraps an iterator into a type-specific collection, with a limit on the number of elements.static double[][]
Unwraps an iterator, returning a big array.static double[][]
unwrapBig
(DoubleIterator i, long max) Unwraps an iterator, returning a big array, with a limit on the number of elements.static DoubleListIterator
wrap
(double[] array) Wraps the given array into a type-specific list iterator.static DoubleListIterator
wrap
(double[] array, int offset, int length) Wraps the given part of an array into a type-specific list iterator.static DoubleIterator
wrap
(ByteIterator iterator) Returns an iterator backed by the specified byte iterator.static DoubleIterator
wrap
(CharIterator iterator) Returns an iterator backed by the specified char iterator.static DoubleIterator
wrap
(FloatIterator iterator) Returns an iterator backed by the specified float iterator.static DoubleIterator
wrap
(IntIterator iterator) Returns an iterator backed by the specified integer iterator.static DoubleIterator
wrap
(ShortIterator iterator) Returns an iterator backed by the specified short iterator.
-
Field Details
-
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 Details
-
singleton
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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.
-
asDoubleIterator
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.
-
asDoubleIterator
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
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
.
-
all
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
.
-
indexOf
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.
-
concat
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
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
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
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
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
Returns an iterator backed by the specified byte iterator.- Parameters:
iterator
- a byte iterator.- Returns:
- an iterator backed by the specified byte iterator.
-
wrap
Returns an iterator backed by the specified short iterator.- Parameters:
iterator
- a short iterator.- Returns:
- an iterator backed by the specified short iterator.
-
wrap
Returns an iterator backed by the specified char 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:
iterator
- a char iterator.- Returns:
- an iterator backed by the specified char iterator.
-
wrap
Returns an iterator backed by the specified integer iterator.- Parameters:
iterator
- an integer iterator.- Returns:
- an iterator backed by the specified integer iterator.
-
wrap
Returns an iterator backed by the specified float iterator.- Parameters:
iterator
- a float iterator.- Returns:
- an iterator backed by the specified float iterator.
-