trait Iterator[+A] extends IterableOnce[A]

A core Iterator class

Self Type
Iterator[A]
Linear Supertypes
IterableOnce[A], AnyRef, Any
Known Subclasses
GroupedIterator, VectorIterator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Iterator
  2. IterableOnce
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. 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 grouped and sliding.

Abstract Value Members

  1. abstract def hasNext: Boolean
  2. abstract def next(): A
    Annotations
    @throws( ... )

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++[B >: A](xs: ⇒ IterableOnce[B]): Iterator[B]
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def concat[B >: A](xs: ⇒ IterableOnce[B]): Iterator[B]
  8. 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

    true if this iterator produces some value that is is equal (as determined by ==) to elem, false otherwise.

    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  9. def count(p: (A) ⇒ 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.

  10. def drop(n: Int): Iterator[A]
  11. def dropWhile(p: (A) ⇒ Boolean): Iterator[A]

    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

    Note

    Reuse: $consumesAndProducesIterator

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def exists(p: (A) ⇒ 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

    true if the given predicate p holds for some of the values produced by this iterator, otherwise false.

    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  15. def filter(p: (A) ⇒ Boolean): Iterator[A]
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def find(p: (A) ⇒ Boolean): Option[A]

    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, or None if none exists.

    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  18. def flatMap[B](f: (A) ⇒ IterableOnce[B]): Iterator[B]
  19. def foldLeft[B](z: B)(op: (B, A) ⇒ B): B
  20. def foldRight[B](z: B)(op: (A, B) ⇒ B): B
  21. def forall(p: (A) ⇒ 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

    true if the given predicate p holds for all values produced by this iterator, otherwise false.

    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  22. def foreach[U](f: (A) ⇒ U): Unit
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  24. def grouped[B >: A](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
    Note

    Reuse: $consumesAndProducesIterator

  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  26. def indexOf[B >: A](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 >= from 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.

    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  27. def indexOf[B >: A](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 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.

    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  28. def indexWhere(p: (A) ⇒ Boolean, from: Int = 0): Int
  29. def isEmpty: Boolean

    Tests whether this iterator is empty.

    Tests whether this iterator is empty.

    returns

    true if hasNext is false, false otherwise.

    Note

    Reuse: $preservesIterator

  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def iterator(): Iterator[A]

    Iterator can be used only once

    Iterator can be used only once

    Definition Classes
    Iterator → IterableOnce
  32. def length: Int
  33. def map[B](f: (A) ⇒ B): Iterator[B]
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  37. def sameElements[B >: A](that: IterableOnce[B]): Boolean
  38. def scanLeft[B](z: B)(op: (B, A) ⇒ 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

    Note

    Reuse: $consumesAndProducesIterator

  39. final def size: Int
  40. def sliding[B >: A](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 step is how far to advance the window on each iteration. The step defaults to 1.

    The default GroupedIterator can be configured to either pad a partial result to size size or 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 size size, except the last element (which may be the only element) will be truncated if there are fewer than size elements remaining to be grouped. This behavior can be configured.

    Note

    Reuse: $consumesAndProducesIterator

  41. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  42. def take(n: Int): Iterator[A]
  43. def takeWhile(p: (A) ⇒ Boolean): Iterator[A]

    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.

    Note

    Reuse: $consumesAndProducesIterator

  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def zip[B](that: IterableOnce[B]): Iterator[(A, B)]
  49. def zipWithIndex: Iterator[(A, 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.

    Note

    Reuse: $consumesAndProducesIterator

Inherited from IterableOnce[A]

Inherited from AnyRef

Inherited from Any

Ungrouped