scala.collection.parallel

SeqSplitter

trait SeqSplitter[+T] extends IterableSplitter[T] with AugmentedSeqIterator[T] with PreciseSplitter[T]

Parallel sequence iterators allow splitting into arbitrary subsets.

Self Type
SeqSplitter[T]
Source
RemainsIterator.scala
Linear Supertypes
PreciseSplitter[T], AugmentedSeqIterator[T], IterableSplitter[T], DelegatedSignalling, Signalling, Splitter[T], AugmentedIterableIterator[T], RemainsIterator[T], Iterator[T], TraversableOnce[T], GenTraversableOnce[T], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SeqSplitter
  2. PreciseSplitter
  3. AugmentedSeqIterator
  4. IterableSplitter
  5. DelegatedSignalling
  6. Signalling
  7. Splitter
  8. AugmentedIterableIterator
  9. RemainsIterator
  10. Iterator
  11. TraversableOnce
  12. GenTraversableOnce
  13. AnyRef
  14. Any
Visibility
  1. Public
  2. All

Type Members

  1. class Appended[U >: T, PI <: SeqSplitter[U]] extends Appended[U, PI] with SeqSplitter[U]

    Definition Classes
    SeqSplitterIterableSplitter
  2. 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.

  3. class Mapped[S] extends Mapped[S] with SeqSplitter[S]

    Definition Classes
    SeqSplitterIterableSplitter
  4. class Patched[U >: T] extends SeqSplitter[U]

  5. class Taken extends Taken with SeqSplitter[T]

    Definition Classes
    SeqSplitterIterableSplitter
  6. class Zipped[S] extends Zipped[S] with SeqSplitter[(T, S)]

    Definition Classes
    SeqSplitterIterableSplitter
  7. class ZippedAll[U >: T, S] extends ZippedAll[U, S] with SeqSplitter[(U, S)]

    Definition Classes
    SeqSplitterIterableSplitter

Abstract Value Members

  1. abstract def dup: SeqSplitter[T]

    Creates a copy of this iterator.

    Creates a copy of this iterator.

    Definition Classes
    SeqSplitterIterableSplitter
  2. abstract 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
    Iterator
    Note

    Reuse: The iterator remains valid for further use whatever result is returned.

  3. abstract 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
    Iterator
    Note

    Reuse: The iterator remains valid for further use whatever result is returned.

  4. abstract def psplit(sizes: Int*): Seq[SeqSplitter[T]]

    Splits the splitter into disjunct views.

    Splits the splitter into disjunct views.

    This overloaded version of the split method is specific to precise splitters. It returns a sequence of splitters, each iterating some subset of the elements in this splitter. The sizes of the subsplitters in the partition is equal to the size in the corresponding argument, as long as there are enough elements in this splitter to split it that way.

    If there aren't enough elements, a zero element splitter is appended for each additional argument. If there are additional elements, an additional splitter is appended at the end to compensate.

    For example, say we have a splitter ps with 100 elements. Invoking:

       ps.split(50, 25, 25, 10, 5)
    

    will return a sequence of five splitters, last two views being empty. On the other hand, calling:

       ps.split(50, 40)
    

    will return a sequence of three splitters, last of them containing ten elements.

    Note: this method actually invalidates the current splitter.

    Unlike the case with split found in splitters, views returned by this method can be empty.

    sizes

    the sizes used to split this split iterator into iterators that traverse disjunct subsets

    returns

    a sequence of disjunct subsequence iterators of this parallel iterator

    Definition Classes
    SeqSplitterPreciseSplitter
  5. abstract def remaining: Int

    The number of elements this iterator has yet to traverse.

    The number of elements this iterator has yet to traverse. This method doesn't change the state of the iterator. Unlike the version of this method in the supertrait, method remaining in ParSeqLike.this.ParIterator must return an exact number of elements remaining in the iterator.

    returns

    an exact number of elements this iterator has yet to iterate

    Definition Classes
    SeqSplitter → AugmentedSeqIterator → IterableSplitter → RemainsIterator
  6. abstract val signalDelegate: Signalling

    A delegate that method calls are redirected to.

    A delegate that method calls are redirected to.

    Definition Classes
    DelegatedSignalling
  7. abstract def split: Seq[SeqSplitter[T]]

    Splits the iterator into a sequence of disjunct views.

    Splits the iterator into a sequence of disjunct views.

    Returns a sequence of split iterators, each iterating over some subset of the elements in the collection. These subsets are disjoint and should be approximately equal in size. These subsets are not empty, unless the iterator is empty in which case this method returns a sequence with a single empty iterator. If the splitter has more than two elements, this method will return two or more splitters.

    Implementors are advised to keep this partition relatively small - two splitters are already enough when partitioning the collection, although there may be a few more.

    Note: this method actually invalidates the current splitter.

    returns

    a sequence of disjunct iterators of the collection

    Definition Classes
    SeqSplitterPreciseSplitterIterableSplitterSplitter

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. 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
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types.

    Equivalent to x.hashCode except for boxed numeric types. 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.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  4. abstract def ++(that: ⇒ Iterator[T]): 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
  5. def ++[B >: T](that: ⇒ GenTraversableOnce[B]): Iterator[B]

    Concatenates this iterator with another.

    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
    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.

  6. 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, x1), x2), ..., xn)
    

    where x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  7. 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
  8. 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(x1, op(x2, ... op(xn, z)...))
    

    where x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  9. final def ==(arg0: AnyRef): Boolean

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

    Test two objects for equality.

    Test two objects for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  11. def abort(): Unit

    Sends an abort signal to other workers.

    Sends an abort signal to other workers.

    Abort flag being true means that a worker can abort and produce whatever result, since its result will not affect the final result of computation. An example of operations using this are find, forall and exists methods.

    Definition Classes
    DelegatedSignallingSignalling
  12. 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
  13. 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
  14. 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
  15. 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
    TraversableOnceGenTraversableOnce
  16. def appendParIterable[U >: T, PI <: IterableSplitter[U]](that: PI): Appended[U, PI]

    Definition Classes
    IterableSplitter
  17. def appendParSeq[U >: T, PI <: SeqSplitter[U]](that: PI): Appended[U, PI]

  18. 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.

  19. def buffered: 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

    BufferedIterator

  20. def buildString(closure: ((String) ⇒ Unit) ⇒ Unit): String

    Attributes
    protected
    Definition Classes
    IterableSplitter
  21. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  22. def collect[B](pf: PartialFunction[T, 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 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.

  23. def collect2combiner[S, That](pf: PartialFunction[T, S], cb: Combiner[S, That]): Combiner[S, That]

    Definition Classes
    AugmentedIterableIterator
  24. 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)

  25. 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 (wrt ==) 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.

  26. def copy2builder[U >: T, Coll, Bld <: Builder[U, Coll]](b: Bld): Bld

    Definition Classes
    AugmentedIterableIterator
  27. abstract 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.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    Definition Classes
    Iterator
  28. def copyToArray[U >: T](array: Array[U], from: Int, len: Int): Unit

    Copies selected values produced by this iterator to an array.

    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.

    len

    the maximal number of elements to copy.

    Definition Classes
    AugmentedIterableIterator → IteratorTraversableOnceGenTraversableOnce
    Note

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

  29. abstract def copyToArray(xs: Array[T]): 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.

    xs

    the array to fill.

    Definition Classes
    GenTraversableOnce
  30. def copyToArray[B >: T](xs: Array[B]): Unit

    Copies values of this traversable or iterator to an array.

    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.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    Definition Classes
    TraversableOnceGenTraversableOnce
  31. abstract def copyToArray(xs: Array[T], 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.

    xs

    the array to fill.

    start

    the starting index.

    Definition Classes
    GenTraversableOnce
  32. def copyToArray[B >: T](xs: Array[B], start: Int): Unit

    Copies values of this traversable or iterator to an array.

    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.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index.

    Definition Classes
    TraversableOnceGenTraversableOnce
  33. 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
  34. def corresponds[S](corr: (T, S) ⇒ Boolean)(that: Iterator[S]): Boolean

    Definition Classes
    AugmentedSeqIterator
  35. 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
    AugmentedIterableIterator → TraversableOnceGenTraversableOnce
  36. def drop(n: Int): 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.

  37. def drop2combiner[U >: T, This](n: Int, cb: Combiner[U, This]): Combiner[U, This]

    Definition Classes
    AugmentedIterableIterator
  38. def dropWhile(p: (T) ⇒ Boolean): 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.

  39. def duplicate: (Iterator[T], 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.

  40. 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
  41. def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. See equals in Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  42. 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
    IteratorTraversableOnceGenTraversableOnce
    Note

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

  43. def filter(p: (T) ⇒ Boolean): 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.

  44. def filter2combiner[U >: T, This](pred: (T) ⇒ Boolean, cb: Combiner[U, This]): Combiner[U, This]

    Definition Classes
    AugmentedIterableIterator
  45. def filterNot(p: (T) ⇒ Boolean): 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.

  46. def filterNot2combiner[U >: T, This](pred: (T) ⇒ Boolean, cb: Combiner[U, This]): Combiner[U, This]

    Definition Classes
    AugmentedIterableIterator
  47. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  48. 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
    IteratorTraversableOnceGenTraversableOnce
    Note

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

  49. def flatMap[B](f: (T) ⇒ GenTraversableOnce[B]): 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.

  50. def flatmap2combiner[S, That](f: (T) ⇒ GenTraversableOnce[S], cb: Combiner[S, That]): Combiner[S, That]

    Definition Classes
    AugmentedIterableIterator
  51. def fold[U >: T](z: U)(op: (U, U) ⇒ U): U

    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.

    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
    AugmentedIterableIterator → TraversableOnceGenTraversableOnce
  52. 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, x1), x2, ..., xn)
    

    where x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  53. 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(x1, op(x2, ... op(xn, z)...))
    

    where x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  54. 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
    IteratorTraversableOnceGenTraversableOnce
    Note

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

  55. abstract 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
  56. def foreach[U](f: (T) ⇒ U): Unit

    Applies a function f to all values produced by this iterator.

    Applies a function f to all values produced by this iterator.

    U

    the type parameter describing the result of function f. This result will always be ignored. Typically U is Unit, but this is not necessary.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    Definition Classes
    IteratorTraversableOnceGenTraversableOnce
    Note

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

  57. final def getClass(): java.lang.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

  58. 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.

  59. 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
    IteratorTraversableOnceGenTraversableOnce
    Note

    Reuse: The iterator remains valid for further use whatever result is returned.

  60. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  61. def indexFlag: Int

    Returns the value of the index flag.

    Returns the value of the index flag.

    The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile, dropWhile, span and indexOf.

    returns

    the value of the index flag

    Definition Classes
    DelegatedSignallingSignalling
  62. 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.

  63. def indexWhere(pred: (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.

    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
    AugmentedSeqIterator → Iterator
    Note

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

  64. def isAborted: Boolean

    Checks whether an abort signal has been issued.

    Checks whether an abort signal has been issued.

    Abort flag being true means that a worker can abort and produce whatever result, since its result will not affect the final result of computation. An example of operations using this are find, forall and exists methods.

    returns

    the state of the abort

    Definition Classes
    DelegatedSignallingSignalling
  65. 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
    IteratorTraversableOnceGenTraversableOnce
    Note

    Reuse: The iterator remains valid for further use whatever result is returned.

  66. 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
  67. def isTraversableAgain: Boolean

    Tests whether this Iterator can be repeatedly traversed.

    Tests whether this Iterator can be repeatedly traversed.

    returns

    false

    Definition Classes
    IteratorGenTraversableOnce
    Note

    Reuse: The iterator remains valid for further use whatever result is returned.

  68. def lastIndexWhere(pred: (T) ⇒ Boolean): Int

    Definition Classes
    AugmentedSeqIterator
  69. 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.

  70. def map[S](f: (T) ⇒ S): Mapped[S]

    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
    SeqSplitterIterableSplitterIterator
    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.

  71. def map2combiner[S, That](f: (T) ⇒ S, cb: Combiner[S, That]): Combiner[S, That]

    Definition Classes
    AugmentedIterableIterator
  72. abstract def max: T

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this traversable or iterator with respect to the ordering cmp.

    Definition Classes
    GenTraversableOnce
  73. def max[U >: T](implicit ord: Ordering[U]): T

    Finds the largest element.

    Finds the largest element.

    returns

    the largest element of this traversable or iterator with respect to the ordering cmp.

    Definition Classes
    AugmentedIterableIterator → TraversableOnceGenTraversableOnce
  74. def maxBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T

    Definition Classes
    TraversableOnceGenTraversableOnce
  75. abstract def min: T

    [use case] Finds the smallest element.

    [use case]

    Finds the smallest element.

    returns

    the smallest element of this traversable or iterator with respect to the ordering cmp.

    Definition Classes
    GenTraversableOnce
  76. def min[U >: T](implicit ord: Ordering[U]): T

    Finds the smallest element.

    Finds the smallest element.

    returns

    the smallest element of this traversable or iterator with respect to the ordering cmp.

    Definition Classes
    AugmentedIterableIterator → TraversableOnceGenTraversableOnce
  77. def minBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T

    Definition Classes
    TraversableOnceGenTraversableOnce
  78. 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
    TraversableOnceGenTraversableOnce
  79. 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
    TraversableOnceGenTraversableOnce
    Example:
    1. List(1, 2, 3).mkString("|") = "1|2|3"

  80. 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
    TraversableOnceGenTraversableOnce
    Example:
    1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

  81. 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
  82. 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
    TraversableOnceGenTraversableOnce
  83. 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

  84. 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

  85. abstract def padTo(len: Int, elem: T): 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
  86. def padTo[A1 >: T](len: Int, elem: A1): Iterator[A1]

    Appends an element value to this iterator until a given target length is reached.

    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
    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.

  87. def partition(p: (T) ⇒ Boolean): (Iterator[T], 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.

  88. def partition2combiners[U >: T, This](pred: (T) ⇒ Boolean, btrue: Combiner[U, This], bfalse: Combiner[U, This]): (Combiner[U, This], Combiner[U, This])

    Definition Classes
    AugmentedIterableIterator
  89. def patch[B >: T](from: Int, patchElems: Iterator[B], replaced: Int): 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.

  90. def patchParSeq[U >: T](from: Int, patchElems: SeqSplitter[U], replaced: Int): Patched[U]

  91. def prefixLength(pred: (T) ⇒ Boolean): Int

    Definition Classes
    AugmentedSeqIterator
  92. abstract def product: T

    [use case] Multiplies up the elements of this collection.

    [use case]

    Multiplies up the elements of this collection.

    returns

    the product of all elements of this traversable or iterator with respect to the * operator in num.

    Definition Classes
    GenTraversableOnce
  93. def product[U >: T](implicit num: Numeric[U]): U

    Multiplies up the elements of this collection.

    Multiplies up the elements of this collection.

    num

    an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

    returns

    the product of all elements of this traversable or iterator with respect to the * operator in num.

    Definition Classes
    AugmentedIterableIterator → TraversableOnceGenTraversableOnce
  94. def reduce[U >: T](op: (U, U) ⇒ U): U

    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.

    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
    AugmentedIterableIterator → TraversableOnceGenTraversableOnce
    Exceptions thrown
    UnsupportedOperationException

    if this traversable or iterator is empty.

  95. def reduceLeft[U >: T](howmany: Int, op: (U, U) ⇒ U): U

    Definition Classes
    AugmentedIterableIterator
  96. def reduceLeft[B >: T](op: (B, T) ⇒ B): B

    Definition Classes
    TraversableOnce
  97. 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
    TraversableOnceGenTraversableOnce
  98. 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
    TraversableOnceGenTraversableOnce
  99. 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 x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Exceptions thrown
    `UnsupportedOperationException`

    if this traversable or iterator is empty.

  100. 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
    TraversableOnceGenTraversableOnce
  101. def reverse: SeqSplitter[T]

  102. def reverse2combiner[U >: T, This](cb: Combiner[U, This]): Combiner[U, This]

    Definition Classes
    AugmentedSeqIterator
  103. def reverseMap2combiner[S, That](f: (T) ⇒ S, cb: Combiner[S, That]): Combiner[S, That]

    Definition Classes
    AugmentedSeqIterator
  104. def reversed: List[T]

    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  105. def sameElements(that: 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.

  106. def scanLeft[B](z: B)(op: (B, T) ⇒ B): 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.

  107. def scanRight[B](z: B)(op: (T, B) ⇒ B): 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.

  108. def scanToArray[U >: T, A >: U](z: U, op: (U, U) ⇒ U, array: Array[A], from: Int): Unit

    Definition Classes
    AugmentedIterableIterator
  109. def scanToCombiner[U >: T, That](howmany: Int, startValue: U, op: (U, U) ⇒ U, cb: Combiner[U, That]): Combiner[U, That]

    Definition Classes
    AugmentedIterableIterator
  110. def scanToCombiner[U >: T, That](startValue: U, op: (U, U) ⇒ U, cb: Combiner[U, That]): Combiner[U, That]

    Definition Classes
    AugmentedIterableIterator
  111. def seq: 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
    IteratorTraversableOnceGenTraversableOnce
  112. def setIndexFlag(f: Int): Unit

    Sets the value of the index flag.

    Sets the value of the index flag.

    The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile, dropWhile, span and indexOf.

    f

    the value to which the index flag is set.

    Definition Classes
    DelegatedSignallingSignalling
  113. def setIndexFlagIfGreater(f: Int): Unit

    Sets the value of the index flag if argument is greater than current value.

    Sets the value of the index flag if argument is greater than current value. This method does this atomically.

    The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile, dropWhile, span and indexOf.

    f

    the value to which the index flag is set

    Definition Classes
    DelegatedSignallingSignalling
  114. def setIndexFlagIfLesser(f: Int): Unit

    Sets the value of the index flag if argument is lesser than current value.

    Sets the value of the index flag if argument is lesser than current value. This method does this atomically.

    The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile, dropWhile, span and indexOf.

    f

    the value to which the index flag is set

    Definition Classes
    DelegatedSignallingSignalling
  115. 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
    TraversableOnceGenTraversableOnce
  116. def slice(from1: Int, until1: Int): SeqSplitter[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.

    returns

    an iterator which advances this iterator past the first from elements using drop, and then takes until - from elements, using take.

    Definition Classes
    SeqSplitterIterableSplitterIterator
    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.

  117. def slice2combiner[U >: T, This](from: Int, until: Int, cb: Combiner[U, This]): Combiner[U, This]

    Definition Classes
    AugmentedIterableIterator
  118. 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.

  119. def span(p: (T) ⇒ Boolean): (Iterator[T], 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.

  120. def span2combiners[U >: T, This](p: (T) ⇒ Boolean, before: Combiner[U, This], after: Combiner[U, This]): (Combiner[U, This], Combiner[U, This])

    Definition Classes
    AugmentedIterableIterator
  121. def splitAt2combiners[U >: T, This](at: Int, before: Combiner[U, This], after: Combiner[U, This]): (Combiner[U, This], Combiner[U, This])

    Definition Classes
    AugmentedIterableIterator
  122. abstract def sum: T

    [use case] Sums up the elements of this collection.

    [use case]

    Sums up the elements of this collection.

    returns

    the sum of all elements of this traversable or iterator with respect to the + operator in num.

    Definition Classes
    GenTraversableOnce
  123. def sum[U >: T](implicit num: Numeric[U]): U

    Sums up the elements of this collection.

    Sums up the elements of this collection.

    num

    an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

    returns

    the sum of all elements of this traversable or iterator with respect to the + operator in num.

    Definition Classes
    AugmentedIterableIterator → TraversableOnceGenTraversableOnce
  124. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  125. def tag: Int

    A read only tag specific to the signalling object.

    A read only tag specific to the signalling object. It is used to give specific workers information on the part of the collection being operated on.

    Definition Classes
    DelegatedSignallingSignalling
  126. def take(n: Int): SeqSplitter[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
    SeqSplitterIterableSplitterIterator
    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.

  127. def take2combiner[U >: T, This](n: Int, cb: Combiner[U, This]): Combiner[U, This]

    Definition Classes
    AugmentedIterableIterator
  128. def takeWhile(p: (T) ⇒ Boolean): 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.

  129. def takeWhile2combiner[U >: T, This](p: (T) ⇒ Boolean, cb: Combiner[U, This]): (Combiner[U, This], Boolean)

    Definition Classes
    AugmentedIterableIterator
  130. abstract def toArray: Array[T]

    [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.

    Definition Classes
    GenTraversableOnce
  131. def toArray[B >: T](implicit arg0: ClassManifest[B]): Array[B]

    Converts this traversable or iterator to an array.

    Converts this traversable or iterator to an array.

    Note: will not terminate for infinite iterators.

    B

    the type of the elements of the array. A ClassManifest for this type must be available.

    returns

    an array containing all elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  132. 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
    TraversableOnceGenTraversableOnce
  133. def toIndexedSeq[B >: T]: IndexedSeq[B]

    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
    TraversableOnceGenTraversableOnce
  134. def toIterable: 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
    TraversableOnceGenTraversableOnce
  135. def toIterator: 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
    IteratorGenTraversableOnce
  136. 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
    TraversableOnceGenTraversableOnce
  137. abstract 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 containing all elements of this traversable or iterator.

    Definition Classes
    GenTraversableOnce
  138. def toMap[T, U](implicit ev: <:<[T, (T, U)]): Map[T, U]

    Converts this traversable or iterator to a map.

    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 containing all elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  139. def toSeq: 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
    TraversableOnceGenTraversableOnce
  140. 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
    TraversableOnceGenTraversableOnce
  141. def toStream: 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
    IteratorGenTraversableOnce
  142. 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.

  143. def toTraversable: 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
    IteratorTraversableOnceGenTraversableOnce
  144. def updated2combiner[U >: T, That](index: Int, elem: U, cb: Combiner[U, That]): Combiner[U, That]

    Definition Classes
    AugmentedSeqIterator
  145. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  146. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  147. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  148. def withFilter(p: (T) ⇒ Boolean): 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.

  149. def zip[B](that: Iterator[B]): 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.

  150. def zip2combiner[U >: T, S, That](otherpit: RemainsIterator[S], cb: Combiner[(U, S), That]): Combiner[(U, S), That]

    Definition Classes
    AugmentedIterableIterator
  151. abstract def zipAll[B](that: Iterator[B], thisElem: T, thatElem: B): 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
  152. def zipAll[B, A1 >: T, B1 >: B](that: Iterator[B], thisElem: A1, thatElem: B1): Iterator[(A1, B1)]

    Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs.

    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
    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.

  153. def zipAll2combiner[U >: T, S, That](that: RemainsIterator[S], thiselem: U, thatelem: S, cb: Combiner[(U, S), That]): Combiner[(U, S), That]

    Definition Classes
    AugmentedIterableIterator
  154. def zipAllParSeq[S, U >: T, R >: S](that: SeqSplitter[S], thisElem: U, thatElem: R): ZippedAll[U, R]

    Definition Classes
    SeqSplitterIterableSplitter
  155. def zipParSeq[S](that: SeqSplitter[S]): Zipped[S]

    Definition Classes
    SeqSplitterIterableSplitter
  156. def zipWithIndex: Iterator[(T, Int)] { ... /* 2 definitions in type refinement */ }

    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.

Deprecated Value Members

  1. def append[B >: T](that: Iterator[B]): Iterator[B]

    Returns a new iterator that first yields the elements of this iterator followed by the elements provided by iterator that.

    Returns a new iterator that first yields the elements of this iterator followed by the elements provided by iterator that.

    Definition Classes
    Iterator
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.2) use ++

  2. def counted: CountedIterator[T]

    Returns a counted iterator from this iterator.

    Returns a counted iterator from this iterator.

    Definition Classes
    Iterator
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use zipWithIndex in Iterator

  3. def findIndexOf(p: (T) ⇒ Boolean): Int

    Returns index of the first element satisfying a predicate, or -1.

    Returns index of the first element satisfying a predicate, or -1.

    Definition Classes
    Iterator
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use indexWhere instead

  4. def readInto[B >: T](xs: Array[B]): Unit

    Definition Classes
    Iterator
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use copyToArray instead

  5. def readInto[B >: T](xs: Array[B], start: Int): Unit

    Definition Classes
    Iterator
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use copyToArray instead

  6. def readInto[B >: T](xs: Array[B], start: Int, sz: Int): Unit

    Fills the given array xs with the elements of this sequence starting at position start.

    Fills the given array xs with the elements of this sequence starting at position start. Like copyToArray, but designed to accomodate IO stream operations.

    Note: the array must be large enough to hold sz elements.

    xs

    the array to fill.

    start

    the starting index.

    sz

    the maximum number of elements to be read.

    Definition Classes
    Iterator
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use copyToArray instead

Inherited from PreciseSplitter[T]

Inherited from AugmentedSeqIterator[T]

Inherited from IterableSplitter[T]

Inherited from DelegatedSignalling

Inherited from Signalling

Inherited from Splitter[T]

Inherited from AugmentedIterableIterator[T]

Inherited from RemainsIterator[T]

Inherited from Iterator[T]

Inherited from TraversableOnce[T]

Inherited from GenTraversableOnce[T]

Inherited from AnyRef

Inherited from Any