ProducerConsumerIterator

Type Members

class GroupedIterator[B >: A] extends AbstractIterator[Seq[B]] with 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.

Abstract Value Members

abstract val EndOfStream: T

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Definition Classes
Any
final def ##(): Int

Equivalent to x.hashCode except for boxed numeric types and null.
Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.
returns
a hash value consistent with ==

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
def ++(that: ⇒ collection.Iterator[T]): collection.Iterator[T]

[use case] Concatenates this iterator with another.
[use case]
Concatenates this iterator with another.
that
the other iterator
returns
a new iterator that first yields the values produced by this iterator followed by the values produced by iterator that.

Definition Classes
Iterator
Full Signature
def ++[B >: T](that: ⇒ GenTraversableOnce[B]): collection.Iterator[B]
def ->[B](y: B): (ProducerConsumerIterator[T], B)

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to ArrowAssoc[ProducerConsumerIterator[T]] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def /:[B](z: B)(op: (B, T) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
```
scala> val a = LinkedList(1,2,3,4)
a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15
```
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left:
```
op(...op(op(z, x_1), x_2), ..., x_n)
```
where x₁, ..., x_n are the elements of this traversable or iterator.
Definition Classes
TraversableOnce → GenTraversableOnce
def :\[B](z: B)(op: (T, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
```
scala> val a = LinkedList(1,2,3,4)
a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15
```
B
the result type of the binary operator.
z
the start value
op
the binary operator
returns
the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right:
```
op(x_1, op(x_2, ... op(x_n, z)...))
```
where x₁, ..., x_n are the elements of this traversable or iterator.
Definition Classes
TraversableOnce → GenTraversableOnce
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Test two objects for equality.
Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
val MaxQueueSize: Int
def addString(b: StringBuilder): StringBuilder

Appends all elements of this traversable or iterator to a string builder.
Appends all elements of this traversable or iterator to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this traversable or iterator without any separator string.
Example:
```
scala> val a = LinkedList(1,2,3,4)
a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
b: StringBuilder = 1234
```
b
the string builder to which elements are appended.
returns
the string builder b to which elements were appended.

Definition Classes
TraversableOnce
def addString(b: StringBuilder, sep: String): StringBuilder

Appends all elements of this traversable or iterator to a string builder using a separator string.
Appends all elements of this traversable or iterator to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this traversable or iterator, separated by the string sep.
Example:
```
scala> val a = LinkedList(1,2,3,4)
a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
```
b
the string builder to which elements are appended.
sep
the separator string.
returns
the string builder b to which elements were appended.

Definition Classes
TraversableOnce
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings.
Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this traversable or iterator are separated by the string sep.
Example:
```
scala> val a = LinkedList(1,2,3,4)
a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, "LinkedList(", ", ", ")")
res1: StringBuilder = LinkedList(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 b to which elements were appended.

Definition Classes
TraversableOnce
def aggregate[B](z: B)(seqop: (B, T) ⇒ B, combop: (B, B) ⇒ B): B

Aggregates the results of applying an operator to subsequent elements.
Aggregates the results of applying an operator to subsequent elements.
This is a more general form of fold and reduce. It has similar semantics, but does not require the result to be a supertype of the element type. It traverses the elements in different partitions sequentially, using seqop to update the result, and then applies combop to results from different partitions. The implementation of this operation may operate on an arbitrary number of collection partitions, so combop may be invoked an arbitrary number of times.
For example, one might want to process some elements and then produce a Set. In this case, seqop would process an element and append it to the list, while combop would concatenate two lists from different partitions together. The initial value z would be an empty set.
```
pc.aggregate(Set[Int]())(_ += process(_), _ ++ _)
```
Another example is calculating geometric mean from a collection of doubles (one would typically require big doubles for this).
B
the type of accumulated results
z
the initial value for the accumulated result of the partition - this will typically be the neutral element for the seqop operator (e.g. Nil for list concatenation or 0 for summation)
seqop
an operator used to accumulate results within a partition
combop
an associative operator used to combine results from different partitions

Definition Classes
TraversableOnce → GenTraversableOnce
final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
returns
the receiver object.

Definition Classes
Any
Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of type T0.
def available(): Boolean
def buffered: collection.BufferedIterator[T]

Creates a buffered iterator from this iterator.
Creates a buffered iterator from this iterator.
returns
a buffered iterator producing the same values as this iterator.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
See also
scala.collection.BufferedIterator
def clone(): AnyRef

Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
Note
not specified by SLS as a member of AnyRef
def collect[B](pf: PartialFunction[T, B]): collection.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 x produced by this iterator for which pf is defined the image pf(x).

Definition Classes
Iterator
Annotations
@migration
Migration
(Changed in version 2.8.0) collect has changed. The previous behavior can be reproduced with toSeq.
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def collectFirst[B](pf: PartialFunction[T, B]): Option[B]

Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered.
pf
the partial function
returns
an option value containing pf applied to the first value for which it is defined, or None if none exists.
Definition Classes
TraversableOnce
Example:
1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
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.
Note: may not terminate for infinite iterators.
elem
the element to test.
returns
true if this iterator produces some value that is is equal (as determined by ==) to elem, false otherwise.

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 copyToArray(xs: Array[T], start: Int, len: Int): Unit

[use case] Copies selected values produced by this iterator to an array.
[use case]
Copies selected values produced by this iterator to an array. Fills the given array xs starting at index start with at most len values produced by this iterator. Copying will stop once either the end of the current iterator is reached, or the end of the array is reached, or len elements have been copied.
Note: will not terminate for infinite iterators.
xs
the array to fill.
start
the starting index.
len
the maximal number of elements to copy.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
Full Signature
def copyToArray[B >: T](xs: Array[B], start: Int, len: Int): Unit
def copyToArray(xs: Array[A]): Unit

[use case] Copies values of this traversable or iterator to an array.
[use case]
Copies values of this traversable or iterator to an array. Fills the given array xs with values of this traversable or iterator. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the array is reached.
Note: will not terminate for infinite iterators.
xs
the array to fill.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def copyToArray[B >: T](xs: Array[B]): Unit
def copyToArray(xs: Array[A], start: Int): Unit

[use case] Copies values of this traversable or iterator to an array.
[use case]
Copies values of this traversable or iterator to an array. Fills the given array xs with values of this traversable or iterator, beginning at index start. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the array is reached.
Note: will not terminate for infinite iterators.
xs
the array to fill.
start
the starting index.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def copyToArray[B >: T](xs: Array[B], start: Int): Unit
def copyToBuffer[B >: T](dest: Buffer[B]): Unit

Copies all elements of this traversable or iterator to a buffer.
Copies all elements of this traversable or iterator to a buffer.
Note: will not terminate for infinite iterators.
dest
The buffer to which elements are copied.

Definition Classes
TraversableOnce
def corresponds[B](that: GenTraversableOnce[B])(p: (T, B) ⇒ Boolean): Boolean

Tests whether every element of this iterator relates to the corresponding element of another collection by satisfying a test predicate.
Tests whether every element of this iterator relates to the corresponding element of another collection by satisfying a test predicate.
B
the type of the elements of that
that
the other collection
p
the test predicate, which relates elements from both collections
returns
true if both collections have the same length and p(x, y) is true for all corresponding elements x of this iterator and y of that, otherwise false

Definition Classes
Iterator
def count(p: (T) ⇒ Boolean): Int

Counts the number of elements in the traversable or iterator which satisfy a predicate.
Counts the number of elements in the traversable or iterator which satisfy a predicate.
p
the predicate used to test elements.
returns
the number of elements satisfying the predicate p.

Definition Classes
TraversableOnce → GenTraversableOnce
def drop(n: Int): collection.Iterator[T]

Advances this iterator past the first n elements, or the length of the iterator, whichever is smaller.
Advances this iterator past the first n elements, or the length of the iterator, whichever is smaller.
n
the number of elements to drop
returns
an iterator which produces all values of the current iterator, except it omits the first n values.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def dropWhile(p: (T) ⇒ Boolean): collection.Iterator[T]

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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def duplicate: (collection.Iterator[T], collection.Iterator[T])

Creates two new iterators that both iterate over the same elements as this iterator (in the same order).
Creates two new iterators that both iterate over the same elements as this iterator (in the same order). The duplicate iterators are considered equal if they are positioned at the same element.
Given that most methods on iterators will make the original iterator unfit for further use, this methods provides a reliable way of calling multiple such methods on an iterator.
returns
a pair of iterators

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
,
The implementation may allocate temporary storage for elements iterated by one iterator but not yet by the other.
def ensuring(cond: (ProducerConsumerIterator[T]) ⇒ Boolean, msg: ⇒ Any): ProducerConsumerIterator[T]

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to Ensuring[ProducerConsumerIterator[T]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ProducerConsumerIterator[T]) ⇒ Boolean): ProducerConsumerIterator[T]

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to Ensuring[ProducerConsumerIterator[T]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ProducerConsumerIterator[T]

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to Ensuring[ProducerConsumerIterator[T]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ProducerConsumerIterator[T]

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to Ensuring[ProducerConsumerIterator[T]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
- It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
- For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
- null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
returns
true if the argument is a reference to the receiver object; false otherwise.

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

The equality method for reference types.
The equality method for reference types. Default implementation delegates to eq.
See also equals in scala.Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def exists(p: (T) ⇒ 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.
Note: may not terminate for infinite iterators.
p
the predicate used to test elements.
returns
true if the given predicate p holds for some of the values produced by this iterator, otherwise false.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
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: (T) ⇒ Boolean): collection.Iterator[T]

Returns an iterator over all the elements of this iterator that satisfy the predicate p.
Returns an iterator over all the elements of this iterator that satisfy the predicate p. The order of the elements is preserved.
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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def filterNot(p: (T) ⇒ Boolean): collection.Iterator[T]

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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def finalize(): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
Note
not specified by SLS as a member of AnyRef
def find(p: (T) ⇒ Boolean): Option[T]

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.
Note: may not terminate for infinite iterators.
p
the predicate used to test values.
returns
an option value containing the first value produced by the iterator that satisfies predicate p, or None if none exists.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
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: (T) ⇒ GenTraversableOnce[B]): collection.Iterator[B]

Creates a new iterator by applying a function to all values produced by this iterator and concatenating the results.
Creates a new iterator by applying a function to all values produced by this iterator and concatenating the results.
f
the function to apply on each element.
returns
the iterator resulting from applying the given iterator-valued function f to each value produced by this iterator and concatenating the results.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def fold[A1 >: T](z: A1)(op: (A1, A1) ⇒ A1): A1

Folds the elements of this traversable or iterator using the specified associative binary operator.
Folds the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
A1
a type parameter for the binary operator, a supertype of A.
z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication.)
op
a binary operator that must be associative
returns
the result of applying fold operator op between all the elements and z

Definition Classes
TraversableOnce → GenTraversableOnce
def foldLeft[B](z: B)(op: (B, T) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left:
```
op(...op(z, x_1), x_2, ..., x_n)
```
where x₁, ..., x_n are the elements of this traversable or iterator.
Definition Classes
TraversableOnce → GenTraversableOnce
def foldRight[B](z: B)(op: (T, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right:
```
op(x_1, op(x_2, ... op(x_n, z)...))
```
where x₁, ..., x_n are the elements of this traversable or iterator.
Definition Classes
TraversableOnce → GenTraversableOnce
def forall(p: (T) ⇒ 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.
Note: may not terminate for infinite iterators.
p
the predicate used to test elements.
returns
true if the given predicate p holds for all values produced by this iterator, otherwise false.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
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(f: (T) ⇒ Unit): Unit

[use case] Applies a function f to all values produced by this iterator.
[use case]
Applies a function f to all values produced by this iterator.
f
the function that is applied for its side-effect to every element. The result of function f is discarded.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
Full Signature
def foreach[U](f: (T) ⇒ U): Unit
def formatted(fmtstr: String): String

Returns string formatted according to given format string.
Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to StringFormat performed by method any2stringfmt in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.

Definition Classes
AnyRef → Any
Note
not specified by SLS as a member of AnyRef
def grouped[B >: T](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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def hasDefiniteSize: Boolean

Tests whether this Iterator has a known size.
Tests whether this Iterator has a known size.
returns
true for empty Iterators, false otherwise.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
Note
Reuse: The iterator remains valid for further use whatever result is returned.
def hasNext: Boolean

Tests whether this iterator can provide another element.
Tests whether this iterator can provide another element.
returns
true if a subsequent call to next will yield an element, false otherwise.

Definition Classes
ProducerConsumerIterator → Iterator
Note
Reuse: The iterator remains valid for further use whatever result is returned.
def hashCode(): Int

The hashCode method for reference types.
The hashCode method for reference types. See hashCode in scala.Any.
returns
the hash code value for this object.

Definition Classes
AnyRef → Any
def indexOf[B >: T](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.
Note: may not terminate for infinite iterators.
elem
element to search for.
returns
the index of the first occurrence of elem in 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: (T) ⇒ Boolean): Int

Returns the index of the first produced value satisfying a predicate, or -1.
Returns the index of the first produced value satisfying a predicate, or -1.
Note: may not terminate for infinite iterators.
p
the predicate to test values
returns
the index of the first produced value satisfying p, 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 interruptibly[T](body: ⇒ T): Option[T]
def isEmpty: Boolean

Tests whether this iterator is empty.
Tests whether this iterator is empty.
returns
true if hasNext is false, false otherwise.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
Note
Reuse: The iterator remains valid for further use whatever result is returned.
final def isInstanceOf[T0]: Boolean

Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.

Definition Classes
Any
def isTraversableAgain: Boolean

Tests whether this Iterator can be repeatedly traversed.
Tests whether this Iterator can be repeatedly traversed.
returns
false

Definition Classes
Iterator → GenTraversableOnce
Note
Reuse: The iterator remains valid for further use whatever result is returned.
def length: Int

Returns the number of elements in this iterator.
Returns the number of elements in this iterator.
Note: will not terminate for infinite iterators.

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 map[B](f: (T) ⇒ B): collection.Iterator[B]

Creates a new iterator that maps all produced values of this iterator to new values using a transformation function.
Creates a new iterator that maps all produced values of this iterator to new values using a transformation function.
f
the transformation function
returns
a new iterator which transforms every value produced by this iterator by applying the function f to it.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def max: A

[use case] Finds the largest element.
[use case]
Finds the largest element.
returns
the largest element of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def max[B >: T](implicit cmp: Ordering[B]): T
def maxBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T

Definition Classes
TraversableOnce → GenTraversableOnce
def min: A

[use case] Finds the smallest element.
[use case]
Finds the smallest element.
returns
the smallest element of this traversable or iterator

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def min[B >: T](implicit cmp: Ordering[B]): T
def minBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T

Definition Classes
TraversableOnce → GenTraversableOnce
def mkString: String

Displays all elements of this traversable or iterator in a string.
Displays all elements of this traversable or iterator in a string.
returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method toString) of all elements of this traversable or iterator follow each other without any separator string.

Definition Classes
TraversableOnce → GenTraversableOnce
def mkString(sep: String): String

Displays all elements of this traversable or iterator in a string using a separator string.
Displays all elements of this traversable or iterator in a string using a separator string.
sep
the separator string.
returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method toString) of all elements of this traversable or iterator are separated by the string sep.
Definition Classes
TraversableOnce → GenTraversableOnce
Example:
1. List(1, 2, 3).mkString("|") = "1|2|3"
def mkString(start: String, sep: String, end: String): String

Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
start
the starting string.
sep
the separator string.
end
the ending string.
returns
a string representation of this traversable or iterator. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this traversable or iterator are separated by the string sep.
Definition Classes
TraversableOnce → GenTraversableOnce
Example:
1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
final def ne(arg0: AnyRef): Boolean

Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.

Definition Classes
AnyRef
def next(): T

Produces the next element of this iterator.
Produces the next element of this iterator.
returns
the next element of this iterator, if hasNext is true, undefined behavior otherwise.

Definition Classes
ProducerConsumerIterator → Iterator
Note
Reuse: The iterator remains valid for further use whatever result is returned.
def nonEmpty: Boolean

Tests whether the traversable or iterator is not empty.
Tests whether the traversable or iterator is not empty.
returns
true if the traversable or iterator contains at least one element, false otherwise.

Definition Classes
TraversableOnce → GenTraversableOnce
final def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
def padTo(len: Int, elem: T): collection.Iterator[T]

[use case] Appends an element value to this iterator until a given target length is reached.
[use case]
Appends an element value to this iterator until a given target length is reached.
len
the target length
elem
the padding value
returns
a new iterator consisting of producing all values of this iterator, followed by the minimal number of occurrences of elem so that the number of produced values is at least len.

Definition Classes
Iterator
Full Signature
def padTo[A1 >: T](len: Int, elem: A1): collection.Iterator[A1]
def partition(p: (T) ⇒ Boolean): (collection.Iterator[T], collection.Iterator[T])

Partitions this iterator in two iterators according to a predicate.
Partitions this iterator in two iterators according to a predicate.
p
the predicate on which to partition
returns
a pair of iterators: the iterator that satisfies the predicate p and the iterator that does not. The relative order of the elements in the resulting iterators is the same as in the original iterator.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
def patch[B >: T](from: Int, patchElems: collection.Iterator[B], replaced: Int): collection.Iterator[B]

Returns this iterator with patched values.
Returns this iterator with patched values.
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: After calling this method, one should discard the iterator it was called on, as well as the one passed as a parameter, and use only the iterator that was returned. Using the old iterators is undefined, subject to change, and may result in changes to the new iterator as well.
def produce(x: T): Unit
def product: A

[use case] Multiplies up the elements of this collection.
[use case]
Multiplies up the elements of this collection.
returns
the product of all elements in this traversable or iterator of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the traversable or iterator and as result type of product. Examples of such types are: Long, Float, Double, BigInt.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def product[B >: T](implicit num: Numeric[B]): B
def reduce[A1 >: T](op: (A1, A1) ⇒ A1): A1

Reduces the elements of this traversable or iterator using the specified associative binary operator.
Reduces the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
A1
A type parameter for the binary operator, a supertype of A.
op
A binary operator that must be associative.
returns
The result of applying reduce operator op between all the elements if the traversable or iterator is nonempty.

Definition Classes
TraversableOnce → GenTraversableOnce
Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def reduceLeft[B >: T](op: (B, T) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator, going left to right.
Applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going left to right:
```
op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
```
where x₁, ..., x_n are the elements of this traversable or iterator.
Definition Classes
TraversableOnce
Exceptions thrown
`UnsupportedOperationException`
if this traversable or iterator is empty.
def reduceLeftOption[B >: T](op: (B, T) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceLeft(op) is this traversable or iterator is nonempty, None otherwise.

Definition Classes
TraversableOnce → GenTraversableOnce
def reduceOption[A1 >: T](op: (A1, A1) ⇒ A1): Option[A1]

Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.
Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
A1
A type parameter for the binary operator, a supertype of A.
op
A binary operator that must be associative.
returns
An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.

Definition Classes
TraversableOnce → GenTraversableOnce
def reduceRight[B >: T](op: (T, B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator, going right to left.
Applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this traversable or iterator, going right to left:
```
op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
```
where x₁, ..., x_n are the elements of this traversable or iterator.
Definition Classes
TraversableOnce → GenTraversableOnce
Exceptions thrown
`UnsupportedOperationException`
if this traversable or iterator is empty.
def reduceRightOption[B >: T](op: (T, B) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceRight(op) is this traversable or iterator is nonempty, None otherwise.

Definition Classes
TraversableOnce → GenTraversableOnce
def reversed: List[T]

Attributes
protected[this]
Definition Classes
TraversableOnce
def sameElements(that: collection.Iterator[_]): Boolean

Tests if another iterator produces the same values as this one.
Tests if another iterator produces the same values as this one.
Note: will not terminate for infinite iterators.
that
the other iterator
returns
true, if both iterators produce the same elements in the same order, false otherwise.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, as well as the one passed as parameter. Using the old iterators is undefined and subject to change.
def scanLeft[B](z: B)(op: (B, T) ⇒ B): collection.Iterator[B]

Produces a collection containing cummulative results of applying the operator going left to right.
Produces a collection containing cummulative results of applying the operator going left to right.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered.
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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def scanRight[B](z: B)(op: (T, B) ⇒ B): collection.Iterator[B]

Produces a collection containing cummulative results of applying the operator going right to left.
Produces a collection containing cummulative results of applying the operator going right to left. The head of the collection is the last cummulative result.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered.
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
Example:
1. Iterator(1, 2, 3, 4).scanRight(0)(_ + _).toList == List(10, 9, 7, 4, 0)
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def seq: collection.Iterator[T]

A version of this collection with all of the operations implemented sequentially (i.
A version of this collection with all of the operations implemented sequentially (i.e. in a single-threaded manner).
This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.
returns
a sequential view of the collection.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
def size: Int

The size of this traversable or iterator.
The size of this traversable or iterator.
Note: will not terminate for infinite iterators.
returns
the number of elements in this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
def slice(from: Int, until: Int): collection.Iterator[T]

Creates an iterator returning an interval of the values produced by this iterator.
Creates an iterator returning an interval of the values produced by this iterator.
from
the index of the first element in this iterator which forms part of the slice.
until
the index of the first element following the slice.
returns
an iterator which advances this iterator past the first from elements using drop, and then takes until - from elements, using take.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def sliding[B >: T](size: Int, step: Int = 1): GroupedIterator[B]

Returns an iterator which presents a "sliding window" view of another iterator.
Returns an iterator which presents a "sliding window" view of another iterator. The first argument is the window size, and the second is how far to advance the window on each iteration; defaults to 1. 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
```
Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def span(p: (T) ⇒ Boolean): (collection.Iterator[T], collection.Iterator[T])

Splits this Iterator into a prefix/suffix pair according to a predicate.
Splits this Iterator into a prefix/suffix pair according to a predicate.
p
the test predicate
returns
a pair of Iterators consisting of the longest prefix of this whose elements all satisfy p, and the rest of the Iterator.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
def sum: A

[use case] Sums up the elements of this collection.
[use case]
Sums up the elements of this collection.
returns
the sum of all elements in this traversable or iterator of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the traversable or iterator and as result type of sum. Examples of such types are: Long, Float, Double, BigInt.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def sum[B >: T](implicit num: Numeric[B]): B
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def take(n: Int): collection.Iterator[T]

Selects first n values of this iterator.
Selects first n values of this iterator.
n
the number of values to take
returns
an iterator producing only of the first n values of this iterator, or else the whole iterator, if it produces fewer than n values.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def takeWhile(p: (T) ⇒ Boolean): collection.Iterator[T]

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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def to[Col[_]]: Col[A]

[use case] Converts this traversable or iterator into another by copying all elements.
[use case]
Converts this traversable or iterator into another by copying all elements.
Note: will not terminate for infinite iterators.
Col
The collection type to build.
returns
a new collection containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, T, Col[T]]): Col[T]
def toArray: Array[A]

[use case] Converts this traversable or iterator to an array.
[use case]
Converts this traversable or iterator to an array.
Note: will not terminate for infinite iterators.
returns
an array containing all elements of this traversable or iterator. An ClassTag must be available for the element type of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def toArray[B >: T](implicit arg0: ClassTag[B]): Array[B]
def toBuffer[B >: T]: Buffer[B]

Converts this traversable or iterator to a mutable buffer.
Converts this traversable or iterator to a mutable buffer.
Note: will not terminate for infinite iterators.
returns
a buffer containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
def toIndexedSeq: collection.immutable.IndexedSeq[T]

Converts this traversable or iterator to an indexed sequence.
Converts this traversable or iterator to an indexed sequence.
Note: will not terminate for infinite iterators.
returns
an indexed sequence containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
def toIterable: collection.Iterable[T]

Converts this traversable or iterator to an iterable collection.
Converts this traversable or iterator to an iterable collection. Note that the choice of target Iterable is lazy in this default implementation as this TraversableOnce may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).
Note: will not terminate for infinite iterators.
returns
an Iterable containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
def toIterator: collection.Iterator[T]

Returns an Iterator over the elements in this traversable or iterator.
Returns an Iterator over the elements in this traversable or iterator. Will return the same Iterator if this instance is already an Iterator.
Note: will not terminate for infinite iterators.
returns
an Iterator containing all elements of this traversable or iterator.

Definition Classes
Iterator → GenTraversableOnce
def toList: List[T]

Converts this traversable or iterator to a list.
Converts this traversable or iterator to a list.
Note: will not terminate for infinite iterators.
returns
a list containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
def toMap[T, U]: Map[T, U]

[use case] Converts this traversable or iterator to a map.
[use case]
Converts this traversable or iterator to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.
Note: will not terminate for infinite iterators.
returns
a map of type immutable.Map[T, U] containing all key/value pairs of type (T, U) of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
Full Signature
def toMap[T, U](implicit ev: <:<[T, (T, U)]): Map[T, U]
def toSeq: collection.Seq[T]

Converts this traversable or iterator to a sequence.
Converts this traversable or iterator to a sequence. As with toIterable, it's lazy in this default implementation, as this TraversableOnce may be lazy and unevaluated.
Note: will not terminate for infinite iterators.
returns
a sequence containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
def toSet[B >: T]: Set[B]

Converts this traversable or iterator to a set.
Converts this traversable or iterator to a set.
Note: will not terminate for infinite iterators.
returns
a set containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
def toStream: collection.immutable.Stream[T]

Converts this traversable or iterator to a stream.
Converts this traversable or iterator to a stream.
Note: will not terminate for infinite iterators.
returns
a stream containing all elements of this traversable or iterator.

Definition Classes
Iterator → GenTraversableOnce
def toString(): String

Converts this iterator to a string.
Converts this iterator to a string.
returns
"empty iterator" or "non-empty iterator", depending on whether or not the iterator is empty.

Definition Classes
Iterator → AnyRef → Any
Note
Reuse: The iterator remains valid for further use whatever result is returned.
def toTraversable: collection.Traversable[T]

Converts this traversable or iterator to an unspecified Traversable.
Converts this traversable or iterator to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite iterators.
returns
a Traversable containing all elements of this traversable or iterator.

Definition Classes
Iterator → TraversableOnce → GenTraversableOnce
def toVector: Vector[T]

Converts this traversable or iterator to a Vector.
Converts this traversable or iterator to a Vector.
Note: will not terminate for infinite iterators.
returns
a vector containing all elements of this traversable or iterator.

Definition Classes
TraversableOnce → GenTraversableOnce
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: (T) ⇒ Boolean): collection.Iterator[T]

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: withFilter is the same as filter on 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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def zip[B](that: collection.Iterator[B]): collection.Iterator[(T, B)]

Creates an iterator formed from this iterator and another iterator by combining corresponding values in pairs.
Creates an iterator formed from this iterator and another iterator by combining corresponding values in pairs. If one of the two iterators is longer than the other, its remaining elements are ignored.
that
The iterator providing the second half of each result pair
returns
a new iterator containing pairs consisting of corresponding elements of this iterator and that. The number of elements returned by the new iterator is the minimum of the number of elements returned by this iterator and that.

Definition Classes
Iterator
Note
Reuse: After calling this method, one should discard the iterator it was called on, as well as the one passed as a parameter, and use only the iterator that was returned. Using the old iterators is undefined, subject to change, and may result in changes to the new iterator as well.
def zipAll[B](that: collection.Iterator[B], thisElem: T, thatElem: B): collection.Iterator[(T, B)]

[use case] Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs.
[use case]
Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs. If one of the two iterators is shorter than the other, placeholder elements are used to extend the shorter iterator to the length of the longer.
that
iterator that may have a different length as the self iterator.
thisElem
element thisElem is used to fill up the resulting iterator if the self iterator is shorter than that
thatElem
element thatElem is used to fill up the resulting iterator if that is shorter than the self iterator
returns
a new iterator containing pairs consisting of corresponding values of this iterator and that. The length of the returned iterator is the maximum of the lengths of this iterator and that. If this iterator is shorter than that, thisElem values are used to pad the result. If that is shorter than this iterator, thatElem values are used to pad the result.

Definition Classes
Iterator
Full Signature
def zipAll[B, A1 >: T, B1 >: B](that: collection.Iterator[B], thisElem: A1, thatElem: B1): collection.Iterator[(A1, B1)]
def zipWithIndex: collection.Iterator[(T, 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: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def →[B](y: B): (ProducerConsumerIterator[T], B)

Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to ArrowAssoc[ProducerConsumerIterator[T]] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

def filter(p: (T) ⇒ Boolean): collection.TraversableOnce[T]
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(producerConsumerIterator: MonadOps[T]).filter(p)
Definition Classes
MonadOps
def flatMap[B](f: (T) ⇒ GenTraversableOnce[B]): collection.TraversableOnce[B]
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(producerConsumerIterator: MonadOps[T]).flatMap(f)
Definition Classes
MonadOps
def map[B](f: (T) ⇒ B): collection.TraversableOnce[B]
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(producerConsumerIterator: MonadOps[T]).map(f)
Definition Classes
MonadOps
val self: Any
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to StringAdd performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(producerConsumerIterator: StringAdd).self
Definition Classes
StringAdd
val self: Any
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to StringFormat performed by method any2stringfmt in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(producerConsumerIterator: StringFormat).self
Definition Classes
StringFormat
def withFilter(p: (T) ⇒ Boolean): collection.Iterator[T]
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(producerConsumerIterator: MonadOps[T]).withFilter(p)
Definition Classes
MonadOps

Deprecated Value Members

def /:\[A1 >: T](z: A1)(op: (A1, A1) ⇒ A1): A1

A syntactic sugar for out of order folding.
A syntactic sugar for out of order folding. See fold.
Example:
```
scala> val a = LinkedList(1,2,3,4)
a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)

scala> val b = (a /:\ 5)(_+_)
b: Int = 15
```
Definition Classes
GenTraversableOnce
Annotations
@deprecated
Deprecated
(Since version 2.10.0) use fold instead
def x: ProducerConsumerIterator[T]
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to ArrowAssoc[ProducerConsumerIterator[T]] performed by method any2ArrowAssoc in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(producerConsumerIterator: ArrowAssoc[ProducerConsumerIterator[T]]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: ProducerConsumerIterator[T]
Implicit information
This member is added by an implicit conversion from ProducerConsumerIterator[T] to Ensuring[ProducerConsumerIterator[T]] performed by method any2Ensuring in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(producerConsumerIterator: Ensuring[ProducerConsumerIterator[T]]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

Inherited from collection.Iterator[T]

trait ProducerConsumerIterator[T >: scala.Null] extends Iterator[T]

Type Members

class GroupedIterator[B >: A] extends AbstractIterator[Seq[B]] with Iterator[Seq[B]]

Abstract Value Members

abstract val EndOfStream: T

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ++(that: ⇒ collection.Iterator[T]): collection.Iterator[T]

def ++[B >: T](that: ⇒ GenTraversableOnce[B]): collection.Iterator[B]

def ->[B](y: B): (ProducerConsumerIterator[T], B)

def /:[B](z: B)(op: (B, T) ⇒ B): B

def :\[B](z: B)(op: (T, B) ⇒ B): B

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

val MaxQueueSize: Int

def addString(b: StringBuilder): StringBuilder

def addString(b: StringBuilder, sep: String): StringBuilder

def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

def aggregate[B](z: B)(seqop: (B, T) ⇒ B, combop: (B, B) ⇒ B): B

final def asInstanceOf[T0]: T0

def available(): Boolean

def buffered: collection.BufferedIterator[T]

def clone(): AnyRef

def collect[B](pf: PartialFunction[T, B]): collection.Iterator[B]

def collectFirst[B](pf: PartialFunction[T, B]): Option[B]

def contains(elem: Any): Boolean

def copyToArray(xs: Array[T], start: Int, len: Int): Unit

def copyToArray[B >: T](xs: Array[B], start: Int, len: Int): Unit

def copyToArray(xs: Array[A]): Unit

def copyToArray[B >: T](xs: Array[B]): Unit

def copyToArray(xs: Array[A], start: Int): Unit

def copyToArray[B >: T](xs: Array[B], start: Int): Unit

def copyToBuffer[B >: T](dest: Buffer[B]): Unit

def corresponds[B](that: GenTraversableOnce[B])(p: (T, B) ⇒ Boolean): Boolean

def count(p: (T) ⇒ Boolean): Int

def drop(n: Int): collection.Iterator[T]

def dropWhile(p: (T) ⇒ Boolean): collection.Iterator[T]

def duplicate: (collection.Iterator[T], collection.Iterator[T])

def ensuring(cond: (ProducerConsumerIterator[T]) ⇒ Boolean, msg: ⇒ Any): ProducerConsumerIterator[T]

def ensuring(cond: (ProducerConsumerIterator[T]) ⇒ Boolean): ProducerConsumerIterator[T]

def ensuring(cond: Boolean, msg: ⇒ Any): ProducerConsumerIterator[T]

def ensuring(cond: Boolean): ProducerConsumerIterator[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exists(p: (T) ⇒ Boolean): Boolean

def filter(p: (T) ⇒ Boolean): collection.Iterator[T]

def filterNot(p: (T) ⇒ Boolean): collection.Iterator[T]

def finalize(): Unit

def find(p: (T) ⇒ Boolean): Option[T]

def flatMap[B](f: (T) ⇒ GenTraversableOnce[B]): collection.Iterator[B]

def fold[A1 >: T](z: A1)(op: (A1, A1) ⇒ A1): A1

def foldLeft[B](z: B)(op: (B, T) ⇒ B): B

def foldRight[B](z: B)(op: (T, B) ⇒ B): B

def forall(p: (T) ⇒ Boolean): Boolean

def foreach(f: (T) ⇒ Unit): Unit

def foreach[U](f: (T) ⇒ U): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def grouped[B >: T](size: Int): GroupedIterator[B]

def hasDefiniteSize: Boolean

def hasNext: Boolean

def hashCode(): Int

def indexOf[B >: T](elem: B): Int

def indexWhere(p: (T) ⇒ Boolean): Int

def interruptibly[T](body: ⇒ T): Option[T]

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

def isTraversableAgain: Boolean

def length: Int

def map[B](f: (T) ⇒ B): collection.Iterator[B]

def max: A

def max[B >: T](implicit cmp: Ordering[B]): T

def maxBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T

def min: A

def min[B >: T](implicit cmp: Ordering[B]): T

def minBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T