class GroupedIterator[B >: A] extends Iterator[Seq[B]]
A flexible iterator for transforming an Iterator[A] into an
Iterator[Seq[A]], with configurable sequence size, step, and
strategy for dealing with elements which don't fit evenly.
Typical uses can be achieved via methods grouped and sliding.
- Alphabetic
- By Inheritance
- GroupedIterator
- Iterator
- IterableOnce
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
GroupedIterator[B >: A] extends Iterator[Seq[B]]
A flexible iterator for transforming an
Iterator[A]into an Iterator[Seq[A]], with configurable sequence size, step, and strategy for dealing with elements which don't fit evenly.A flexible iterator for transforming an
Iterator[A]into an Iterator[Seq[A]], with configurable sequence size, step, and strategy for dealing with elements which don't fit evenly.Typical uses can be achieved via methods
groupedandsliding.- Definition Classes
- Iterator
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
++[B >: Seq[B]](xs: ⇒ IterableOnce[B]): Iterator[B]
- Definition Classes
- Iterator
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
Appends all elements of this $coll to a string builder using start, end, and separator strings.
Appends all elements of this $coll to a string builder using start, end, and separator strings. The written text begins with the string
startand ends with the stringend. Inside, the string representations (w.r.t. the methodtoString) of all elements of this $coll are separated by the stringsep.Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b , "List(" , ", " , ")") res5: StringBuilder = List(1, 2, 3, 4)
- b
the string builder to which elements are appended.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
the string builder
bto which elements were appended.
- Definition Classes
- Iterator
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
collect[B](pf: PartialFunction[Seq[B], B]): Iterator[B]
Creates an iterator by transforming values produced by this iterator with a partial function, dropping those values for which the partial function is not defined.
Creates an iterator by transforming values produced by this iterator with a partial function, dropping those values for which the partial function is not defined.
- pf
the partial function which filters and maps the iterator.
- returns
a new iterator which yields each value
xproduced by this iterator for whichpfis defined the imagepf(x).
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
def
concat[B >: Seq[B]](xs: ⇒ IterableOnce[B]): Iterator[B]
- Definition Classes
- Iterator
-
def
contains(elem: Any): Boolean
Tests whether this iterator contains a given value as an element.
Tests whether this iterator contains a given value as an element. $mayNotTerminateInf
- elem
the element to test.
- returns
trueif this iterator produces some value that is is equal (as determined by==) toelem,falseotherwise.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
count(p: (Seq[B]) ⇒ Boolean): Int
Counts the number of elements in the $coll which satisfy a predicate.
Counts the number of elements in the $coll which satisfy a predicate.
- p
the predicate used to test elements.
- returns
the number of elements satisfying the predicate
p.
- Definition Classes
- Iterator
-
def
distinct: Iterator[Seq[B]]
Builds a new iterator from this one without any duplicated elements on it.
Builds a new iterator from this one without any duplicated elements on it.
- returns
iterator with distinct elements
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
distinctBy[B](f: (Seq[B]) ⇒ B): Iterator[Seq[B]]
Builds a new iterator from this one without any duplicated elements as determined by
==after applying the transforming functionf.Builds a new iterator from this one without any duplicated elements as determined by
==after applying the transforming functionf.- B
the type of the elements after being transformed by
f- f
The transforming function whose result is used to determine the uniqueness of each element
- returns
iterator with distinct elements
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
drop(n: Int): Iterator[Seq[B]]
- Definition Classes
- Iterator
-
def
dropWhile(p: (Seq[B]) ⇒ Boolean): Iterator[Seq[B]]
Skips longest sequence of elements of this iterator which satisfy given predicate
p, and returns an iterator of the remaining elements.Skips longest sequence of elements of this iterator which satisfy given predicate
p, and returns an iterator of the remaining elements.- p
the predicate used to skip elements.
- returns
an iterator consisting of the remaining elements
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
exists(p: (Seq[B]) ⇒ Boolean): Boolean
Tests whether a predicate holds for some of the values produced by this iterator.
Tests whether a predicate holds for some of the values produced by this iterator. $mayNotTerminateInf
- p
the predicate used to test elements.
- returns
trueif the given predicatepholds for some of the values produced by this iterator, otherwisefalse.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
filter(p: (Seq[B]) ⇒ Boolean): Iterator[Seq[B]]
Selects all elements of this iterator which satisfy a predicate.
Selects all elements of this iterator which satisfy a predicate.
- p
the predicate used to test elements.
- returns
a new iterator consisting of all elements of this $coll that satisfy the given predicate
p. The order of the elements is preserved.
- Definition Classes
- Iterator
-
def
filterNot(p: (Seq[B]) ⇒ Boolean): Iterator[Seq[B]]
Creates an iterator over all the elements of this iterator which do not satisfy a predicate p.
Creates an iterator over all the elements of this iterator which do not satisfy a predicate p.
- p
the predicate used to test values.
- returns
an iterator which produces those values of this iterator which do not satisfy the predicate
p.
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
find(p: (Seq[B]) ⇒ Boolean): Option[Seq[B]]
Finds the first value produced by the iterator satisfying a predicate, if any.
Finds the first value produced by the iterator satisfying a predicate, if any. $mayNotTerminateInf
- p
the predicate used to test values.
- returns
an option value containing the first value produced by the iterator that satisfies predicate
p, orNoneif none exists.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
flatMap[B](f: (Seq[B]) ⇒ IterableOnce[B]): Iterator[B]
- Definition Classes
- Iterator
-
def
foldLeft[B](z: B)(op: (B, Seq[B]) ⇒ B): B
- Definition Classes
- Iterator
-
def
foldRight[B](z: B)(op: (Seq[B], B) ⇒ B): B
- Definition Classes
- Iterator
-
def
forall(p: (Seq[B]) ⇒ Boolean): Boolean
Tests whether a predicate holds for all values produced by this iterator.
Tests whether a predicate holds for all values produced by this iterator. $mayNotTerminateInf
- p
the predicate used to test elements.
- returns
trueif the given predicatepholds for all values produced by this iterator, otherwisefalse.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
foreach[U](f: (Seq[B]) ⇒ U): Unit
- Definition Classes
- Iterator
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
grouped[B >: Seq[B]](size: Int): GroupedIterator[B]
Returns an iterator which groups this iterator into fixed size blocks.
Returns an iterator which groups this iterator into fixed size blocks. Example usages:
// Returns List(List(1, 2, 3), List(4, 5, 6), List(7))) (1 to 7).iterator grouped 3 toList // Returns List(List(1, 2, 3), List(4, 5, 6)) (1 to 7).iterator grouped 3 withPartial false toList // Returns List(List(1, 2, 3), List(4, 5, 6), List(7, 20, 25) // Illustrating that withPadding's argument is by-name. val it2 = Iterator.iterate(20)(_ + 5) (1 to 7).iterator grouped 3 withPadding it2.next toList
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
def
hasNext: Boolean
- Definition Classes
- GroupedIterator → Iterator
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
def
indexOf[B >: Seq[B]](elem: B, from: Int): Int
Returns the index of the first occurrence of the specified object in this iterable object after or at some start index.
Returns the index of the first occurrence of the specified object in this iterable object after or at some start index. $mayNotTerminateInf
- elem
element to search for.
- from
the start index
- returns
the index
>= fromof the first occurrence ofelemin the values produced by this iterator, or -1 if such an element does not exist until the end of the iterator is reached.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
indexOf[B >: Seq[B]](elem: B): Int
Returns the index of the first occurrence of the specified object in this iterable object.
Returns the index of the first occurrence of the specified object in this iterable object. $mayNotTerminateInf
- elem
element to search for.
- returns
the index of the first occurrence of
elemin the values produced by this iterator, or -1 if such an element does not exist until the end of the iterator is reached.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
-
def
indexWhere(p: (Seq[B]) ⇒ Boolean, from: Int = 0): Int
- Definition Classes
- Iterator
-
def
isEmpty: Boolean
Tests whether this iterator is empty.
Tests whether this iterator is empty.
- returns
trueif hasNext is false,falseotherwise.
- Definition Classes
- Iterator
- Note
Reuse: $preservesIterator
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
iterator(): Iterator[Seq[B]]
Iterator can be used only once
Iterator can be used only once
- Definition Classes
- Iterator → IterableOnce
-
final
def
knownSize: Int
- Definition Classes
- Iterator → IterableOnce
-
def
length: Int
- Definition Classes
- Iterator
-
def
map[B](f: (Seq[B]) ⇒ B): Iterator[B]
- Definition Classes
- Iterator
-
def
mkString: String
- Definition Classes
- Iterator
-
def
mkString(sep: String): String
- Definition Classes
- Iterator
-
def
mkString(start: String, sep: String, end: String): String
- Definition Classes
- Iterator
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
next(): ImmutableArray[B]
- Definition Classes
- GroupedIterator → Iterator
- Annotations
- @throws( ... )
-
def
nextOption(): Option[Seq[B]]
Wraps the value of
next()in an option.Wraps the value of
next()in an option.- returns
Some(next)if a next element exists,Noneotherwise.
- Definition Classes
- Iterator
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
patch[B >: Seq[B]](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]
Returns this iterator with patched values.
Returns this iterator with patched values. Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original iterator appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
- from
The start index from which to patch
- patchElems
The iterator of patch values
- replaced
The number of values in the original iterator that are replaced by the patch.
- Definition Classes
- Iterator
- Note
Reuse: $consumesTwoAndProducesOneIterator
-
def
sameElements[B >: Seq[B]](that: IterableOnce[B]): Boolean
- Definition Classes
- Iterator
-
def
scanLeft[B](z: B)(op: (B, Seq[B]) ⇒ B): Iterator[B]
Produces a collection containing cumulative results of applying the operator going left to right.
Produces a collection containing cumulative results of applying the operator going left to right.
$willNotTerminateInf $orderDependent
- B
the type of the elements in the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- returns
iterator with intermediate results
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
final
def
size: Int
- Definition Classes
- Iterator
-
def
sliding[B >: Seq[B]](size: Int, step: Int = 1): GroupedIterator[B]
Returns an iterator which presents a "sliding window" view of this iterator.
Returns an iterator which presents a "sliding window" view of this iterator. The first argument is the window size, and the second argument
stepis how far to advance the window on each iteration. Thestepdefaults to1.The default
GroupedIteratorcan be configured to either pad a partial result to sizesizeor suppress the partial result entirely.Example usages:
// Returns List(List(1, 2, 3), List(2, 3, 4), List(3, 4, 5)) (1 to 5).iterator.sliding(3).toList // Returns List(List(1, 2, 3, 4), List(4, 5)) (1 to 5).iterator.sliding(4, 3).toList // Returns List(List(1, 2, 3, 4)) (1 to 5).iterator.sliding(4, 3).withPartial(false).toList // Returns List(List(1, 2, 3, 4), List(4, 5, 20, 25)) // Illustrating that withPadding's argument is by-name. val it2 = Iterator.iterate(20)(_ + 5) (1 to 5).iterator.sliding(4, 3).withPadding(it2.next).toList
- returns
An iterator producing
Seq[B]s of sizesize, except the last element (which may be the only element) will be truncated if there are fewer thansizeelements remaining to be grouped. This behavior can be configured.
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
take(n: Int): Iterator[Seq[B]]
- Definition Classes
- Iterator
-
def
takeWhile(p: (Seq[B]) ⇒ Boolean): Iterator[Seq[B]]
Takes longest prefix of values produced by this iterator that satisfy a predicate.
Takes longest prefix of values produced by this iterator that satisfy a predicate.
- p
The predicate used to test elements.
- returns
An iterator returning the values produced by this iterator, until this iterator produces a value that does not satisfy the predicate
p.
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
def
to[C](factory: Factory[Seq[B], C]): C
Converts this Iterator into another collection.
Converts this Iterator into another collection.
- C
The collection type to build.
- factory
Collection factory to use. The factory may or may not eagerly consume this iterator.
- returns
a new collection containing all elements of this Iterator.
- Definition Classes
- Iterator
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withFilter(p: (Seq[B]) ⇒ Boolean): Iterator[Seq[B]]
Creates an iterator over all the elements of this iterator that satisfy the predicate
p.Creates an iterator over all the elements of this iterator that satisfy the predicate
p. The order of the elements is preserved.Note:
withFilteris the same asfilteron iterators. It exists so that for-expressions with filters work over iterators.- p
the predicate used to test values.
- returns
an iterator which produces those values of this iterator which satisfy the predicate
p.
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator
-
def
withPadding(x: ⇒ B): GroupedIterator.this.type
Public functions which can be used to configure the iterator before use.
Public functions which can be used to configure the iterator before use.
Pads the last segment if necessary so that all segments will have the same size.
- x
The element that will be appended to the last segment, if necessary.
- returns
The same iterator, and not a new iterator.
- Note
This method is mutually exclusive with
,withPartial(true).This method mutates the iterator it is called on, which can be safely used afterwards.
-
def
withPartial(x: Boolean): GroupedIterator.this.type
Public functions which can be used to configure the iterator before use.
Public functions which can be used to configure the iterator before use.
Select whether the last segment may be returned with less than
sizeelements. If not, some elements of the original iterator may not be returned at all.- x
trueif partial segments may be returned,falseotherwise.- returns
The same iterator, and not a new iterator.
- Note
This method is mutually exclusive with
,withPadding.This method mutates the iterator it is called on, which can be safely used afterwards.
-
def
zip[B](that: IterableOnce[B]): Iterator[(Seq[B], B)]
- Definition Classes
- Iterator
-
def
zipWithIndex: Iterator[(Seq[B], Int)]
Creates an iterator that pairs each element produced by this iterator with its index, counting from 0.
Creates an iterator that pairs each element produced by this iterator with its index, counting from 0.
- returns
a new iterator containing pairs consisting of corresponding elements of this iterator and their indices.
- Definition Classes
- Iterator
- Note
Reuse: $consumesAndProducesIterator