trait ParIterable[+T] extends GenericParTemplate[T, ParIterable] with ParIterableLike[T, ParIterable, ParIterable[T], scala.Iterable[T]]

A template trait for parallel iterable collections.

This is a base trait for Scala parallel collections. It defines behaviour common to all parallel collections. Concrete parallel collections should inherit this trait and ParIterable if they want to define specific combiner factories.

Parallel operations are implemented with divide and conquer style algorithms that parallelize well. The basic idea is to split the collection into smaller parts until they are small enough to be operated on sequentially.

All of the parallel operations are implemented as tasks within this trait. Tasks rely on the concept of splitters, which extend iterators. Every parallel collection defines:

def splitter: IterableSplitter[T]

which returns an instance of IterableSplitter[T], which is a subtype of Splitter[T]. Splitters have a method remaining to check the remaining number of elements, and method split which is defined by splitters. Method split divides the splitters iterate over into disjunct subsets:

def split: Seq[Splitter]

which splits the splitter into a sequence of disjunct subsplitters. This is typically a very fast operation which simply creates wrappers around the receiver collection. This can be repeated recursively.

Tasks are scheduled for execution through a scala.collection.parallel.TaskSupport object, which can be changed through the tasksupport setter of the collection.

Method newCombiner produces a new combiner. Combiners are an extension of builders. They provide a method combine which combines two combiners and returns a combiner containing elements of both combiners. This method can be implemented by aggressively copying all the elements into the new combiner or by lazily binding their results. It is recommended to avoid copying all of the elements for performance reasons, although that cost might be negligible depending on the use case. Standard parallel collection combiners avoid copying when merging results, relying either on a two-step lazy construction or specific data-structure properties.

Methods:

def seq: Sequential
def par: Repr

produce the sequential or parallel implementation of the collection, respectively. Method par just returns a reference to this parallel collection. Method seq is efficient - it will not copy the elements. Instead, it will create a sequential version of the collection using the same underlying data structure. Note that this is not the case for sequential collections in general - they may copy the elements and produce a different underlying data structure.

The combination of methods toMap, toSeq or toSet along with par and seq is a flexible way to change between different collection types.

Since this trait extends the GenIterable trait, methods like size must also be implemented in concrete collections, while iterator forwards to splitter by default.

Each parallel collection is bound to a specific fork/join pool, on which dormant worker threads are kept. The fork/join pool contains other information such as the parallelism level, that is, the number of processors used. When a collection is created, it is assigned the default fork/join pool found in the scala.parallel package object.

Parallel collections are not necessarily ordered in terms of the foreach operation (see Traversable). Parallel sequences have a well defined order for iterators - creating an iterator and traversing the elements linearly will always yield the same order. However, bulk operations such as foreach, map or filter always occur in undefined orders for all parallel collections.

Existing parallel collection implementations provide strict parallel iterators. Strict parallel iterators are aware of the number of elements they have yet to traverse. It's also possible to provide non-strict parallel iterators, which do not know the number of elements remaining. To do this, the new collection implementation must override isStrictSplitterCollection to false. This will make some operations unavailable.

To create a new parallel collection, extend the ParIterable trait, and implement size, splitter, newCombiner and seq. Having an implicit combiner factory requires extending this trait in addition, as well as providing a companion object, as with regular collections.

Method size is implemented as a constant time operation for parallel collections, and parallel collection operations rely on this assumption.

The higher-order functions passed to certain operations may contain side-effects. Since implementations of bulk operations may not be sequential, this means that side-effects may not be predictable and may produce data-races, deadlocks or invalidation of state if care is not taken. It is up to the programmer to either avoid using side-effects or to use some form of synchronization when accessing mutable data.

T

the element type of the collection

Since

2.9

Linear Supertypes
ParIterableLike[T, ParIterable, ParIterable[T], scala.Iterable[T]], Parallel, CustomParallelizable[T, ParIterable[T]], Parallelizable[T, ParIterable[T]], IterableOnce[T], GenericParTemplate[T, ParIterable], HasNewCombiner[T, scala.collection.parallel.ParIterable[T] @scala.annotation.unchecked.uncheckedVariance], GenericTraversableTemplate[T, ParIterable], HasNewBuilder[T, scala.collection.parallel.ParIterable[T] @scala.annotation.unchecked.uncheckedVariance], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParIterable
  2. ParIterableLike
  3. Parallel
  4. CustomParallelizable
  5. Parallelizable
  6. IterableOnce
  7. GenericParTemplate
  8. HasNewCombiner
  9. GenericTraversableTemplate
  10. HasNewBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type SSCTask[R, Tp] = StrictSplitterCheckTask[R, Tp]
    Definition Classes
    ParIterableLike
  2. trait Accessor[R, Tp] extends StrictSplitterCheckTask[R, Tp]

    Standard accessor task that iterates over the elements of the collection.

    Standard accessor task that iterates over the elements of the collection.

    R

    type of the result of this method (R for result).

    Tp

    the representation type of the task at hand.

    Attributes
    protected
    Definition Classes
    ParIterableLike
  3. class Aggregate[S] extends Accessor[S, Aggregate[S]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  4. trait BuilderOps[Elem, To] extends AnyRef
    Definition Classes
    ParIterableLike
  5. class Collect[S, That] extends Transformer[Combiner[S, That], Collect[S, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  6. abstract class Composite[FR, SR, R, First <: StrictSplitterCheckTask[FR, _], Second <: StrictSplitterCheckTask[SR, _]] extends NonDivisibleTask[R, Composite[FR, SR, R, First, Second]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  7. class Copy[U >: T, That] extends Transformer[Combiner[U, That], Copy[U, That]]
    Attributes
    protected
    Definition Classes
    ParIterableLike
  8. class CopyToArray[U >: T, This >: Repr] extends Accessor[Unit, CopyToArray[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  9. class Count extends Accessor[Int, Count]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  10. class CreateScanTree[U >: T] extends Transformer[ScanTree[U], CreateScanTree[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  11. class Drop[U >: T, This >: Repr] extends Transformer[Combiner[U, This], Drop[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  12. class Exists extends Accessor[Boolean, Exists]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  13. class Filter[U >: T, This >: Repr] extends Transformer[Combiner[U, This], Filter[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  14. class FilterNot[U >: T, This >: Repr] extends Transformer[Combiner[U, This], FilterNot[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  15. class Find[U >: T] extends Accessor[Option[U], Find[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  16. class FlatMap[S, That] extends Transformer[Combiner[S, That], FlatMap[S, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  17. class Fold[U >: T] extends Accessor[U, Fold[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  18. class Forall extends Accessor[Boolean, Forall]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  19. class Foreach[S] extends Accessor[Unit, Foreach[S]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  20. class FromScanTree[U >: T, That] extends StrictSplitterCheckTask[Combiner[U, That], FromScanTree[U, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  21. class GroupBy[K, U >: T] extends Transformer[HashMapCombiner[K, U], GroupBy[K, U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  22. class Map[S, That] extends Transformer[Combiner[S, That], Map[S, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  23. class Max[U >: T] extends Accessor[Option[U], Max[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  24. class Min[U >: T] extends Accessor[Option[U], Min[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  25. trait NonDivisible[R] extends NonDivisibleTask[R, NonDivisible[R]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  26. trait NonDivisibleTask[R, Tp] extends StrictSplitterCheckTask[R, Tp]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  27. abstract class ParComposite[FR, SR, R, First <: StrictSplitterCheckTask[FR, _], Second <: StrictSplitterCheckTask[SR, _]] extends Composite[FR, SR, R, First, Second]

    Performs two tasks in parallel, and waits for both to finish.

    Performs two tasks in parallel, and waits for both to finish.

    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  28. class Partition[U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Combiner[U, This]), Partition[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  29. class Product[U >: T] extends Accessor[U, Product[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  30. class Reduce[U >: T] extends Accessor[Option[U], Reduce[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  31. abstract class ResultMapping[R, Tp, R1] extends NonDivisibleTask[R1, ResultMapping[R, Tp, R1]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  32. case class ScanLeaf[U >: T](pit: IterableSplitter[U], op: (U, U) => U, from: Int, len: Int, prev: Option[ScanLeaf[U]], acc: U) extends ScanTree[U] with scala.Product with Serializable
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  33. case class ScanNode[U >: T](left: ScanTree[U], right: ScanTree[U]) extends ScanTree[U] with scala.Product with Serializable
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  34. trait ScanTree[U >: T] extends AnyRef
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  35. abstract class SeqComposite[FR, SR, R, First <: StrictSplitterCheckTask[FR, _], Second <: StrictSplitterCheckTask[SR, _]] extends Composite[FR, SR, R, First, Second]

    Sequentially performs one task after another.

    Sequentially performs one task after another.

    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  36. trait SignallingOps[PI <: DelegatedSignalling] extends AnyRef
    Definition Classes
    ParIterableLike
  37. class Slice[U >: T, This >: Repr] extends Transformer[Combiner[U, This], Slice[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  38. class Span[U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Combiner[U, This]), Span[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  39. class SplitAt[U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Combiner[U, This]), SplitAt[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  40. trait StrictSplitterCheckTask[R, Tp] extends Task[R, Tp]
    Attributes
    protected
    Definition Classes
    ParIterableLike
  41. class Sum[U >: T] extends Accessor[U, Sum[U]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  42. class Take[U >: T, This >: Repr] extends Transformer[Combiner[U, This], Take[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  43. class TakeWhile[U >: T, This >: Repr] extends Transformer[(Combiner[U, This], Boolean), TakeWhile[U, This]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  44. trait TaskOps[R, Tp] extends AnyRef
    Definition Classes
    ParIterableLike
  45. class ToParCollection[U >: T, That] extends Transformer[Combiner[U, That], ToParCollection[U, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  46. class ToParMap[K, V, That] extends Transformer[Combiner[(K, V), That], ToParMap[K, V, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  47. trait Transformer[R, Tp] extends Accessor[R, Tp]
    Attributes
    protected
    Definition Classes
    ParIterableLike
  48. class Zip[U >: T, S, That] extends Transformer[Combiner[(U, S), That], Zip[U, S, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  49. class ZipAll[U >: T, S, That] extends Transformer[Combiner[(U, S), That], ZipAll[U, S, That]]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike

Abstract Value Members

  1. abstract def seq: scala.Iterable[T]
    Definition Classes
    ParIterableLikeParallelizable
  2. abstract def size: Int
    Definition Classes
    ParIterableLike
  3. abstract def splitter: IterableSplitter[T]

    Creates a new parallel iterator used to traverse the elements of this parallel collection.

    Creates a new parallel iterator used to traverse the elements of this parallel collection. This iterator is more specific than the iterator of the returned by iterator, and augmented with additional accessor and transformer methods.

    returns

    a parallel iterator

    Attributes
    protected[scala.collection.parallel]
    Definition Classes
    ParIterableLike

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++[U >: T](that: scala.IterableOnce[U]): ParIterable[U]
    Definition Classes
    ParIterableLike
  4. def /:[S](z: S)(op: (S, T) => S): S
    Definition Classes
    ParIterableLike
  5. def :\[S](z: S)(op: (T, S) => S): S
    Definition Classes
    ParIterableLike
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def aggregate[S](z: => S)(seqop: (S, T) => S, combop: (S, S) => S): S

    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 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 set, while combop would concatenate two sets 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).

    S

    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) and may be evaluated more than once

    seqop

    an operator used to accumulate results within a partition

    combop

    an associative operator used to combine results from different partitions

    Definition Classes
    ParIterableLike
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. implicit def builder2ops[Elem, To](cb: Builder[Elem, To]): BuilderOps[Elem, To]
    Attributes
    protected
    Definition Classes
    ParIterableLike
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def collect[S](pf: PartialFunction[T, S]): ParIterable[S]
    Definition Classes
    ParIterableLike
  12. def combinerFactory[S, That](cbf: () => Combiner[S, That]): CombinerFactory[S, That]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  13. def combinerFactory: CombinerFactory[T, ParIterable[T]]

    Creates a combiner factory.

    Creates a combiner factory. Each combiner factory instance is used once per invocation of a parallel transformer method for a single collection.

    The default combiner factory creates a new combiner every time it is requested, unless the combiner is thread-safe as indicated by its canBeShared method. In this case, the method returns a factory which returns the same combiner each time. This is typically done for concurrent parallel collections, the combiners of which allow thread safe access.

    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  14. def companion: GenericParCompanion[ParIterable]

    The factory companion object that builds instances of class ParIterable.

    The factory companion object that builds instances of class ParIterable. (or its Iterable superclass where class ParIterable is not a Seq.)

    Definition Classes
    ParIterableParIterableLikeGenericParTemplateGenericTraversableTemplate
  15. def copyToArray[U >: T](xs: Array[U], start: Int, len: Int): Unit
    Definition Classes
    ParIterableLike
  16. def copyToArray[U >: T](xs: Array[U], start: Int): Unit
    Definition Classes
    ParIterableLike
  17. def copyToArray[U >: T](xs: Array[U]): Unit
    Definition Classes
    ParIterableLike
  18. def count(p: (T) => Boolean): Int
    Definition Classes
    ParIterableLike
  19. def debugBuffer: ArrayBuffer[String]
    Definition Classes
    ParIterableLike
  20. implicit def delegatedSignalling2ops[PI <: DelegatedSignalling](it: PI): SignallingOps[PI]
    Attributes
    protected
    Definition Classes
    ParIterableLike
  21. def drop(n: Int): ParIterable[T]
    Definition Classes
    ParIterableLike
  22. def dropWhile(pred: (T) => Boolean): ParIterable[T]

    Drops all elements in the longest prefix of elements that satisfy the predicate, and returns a collection composed of the remaining elements.

    Drops all elements in the longest prefix of elements that satisfy the predicate, and returns a collection composed of the remaining elements.

    This method will use indexFlag signalling capabilities. This means that splitters may set and read the indexFlag state. The index flag is initially set to maximum integer value.

    pred

    the predicate used to test the elements

    returns

    a collection composed of all the elements after the longest prefix of elements in this parallel iterable that satisfy the predicate pred

    Definition Classes
    ParIterableLike
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. def exists(p: (T) => Boolean): Boolean

    Tests whether a predicate holds for some element of this parallel iterable.

    Tests whether a predicate holds for some element of this parallel iterable.

    This method will use abort signalling capabilities. This means that splitters may send and read abort signals.

    p

    a predicate used to test elements

    returns

    true if p holds for some element, false otherwise

    Definition Classes
    ParIterableLike
  26. def filter(pred: (T) => Boolean): ParIterable[T]
    Definition Classes
    ParIterableLike
  27. def filterNot(pred: (T) => Boolean): ParIterable[T]
    Definition Classes
    ParIterableLike
  28. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  29. def find(p: (T) => Boolean): Option[T]

    Finds some element in the collection for which the predicate holds, if such an element exists.

    Finds some element in the collection for which the predicate holds, if such an element exists. The element may not necessarily be the first such element in the iteration order.

    If there are multiple elements obeying the predicate, the choice is nondeterministic.

    This method will use abort signalling capabilities. This means that splitters may send and read abort signals.

    p

    predicate used to test the elements

    returns

    an option value with the element if such an element exists, or None otherwise

    Definition Classes
    ParIterableLike
  30. def flatMap[S](f: (T) => scala.IterableOnce[S]): ParIterable[S]
    Definition Classes
    ParIterableLike
  31. def flatten[B]: <error>

    [use case] Converts this parallel iterable of traversable collections into a parallel iterable formed by the elements of these traversable collections.

    [use case]

    Converts this parallel iterable of traversable collections into a parallel iterable formed by the elements of these traversable collections.

    The resulting collection's type will be guided by the static type of parallel iterable. For example:

    val xs = List(
               Set(1, 2, 3),
               Set(1, 2, 3)
             ).flatten
    // xs == List(1, 2, 3, 1, 2, 3)
    
    val ys = Set(
               List(1, 2, 3),
               List(3, 2, 1)
             ).flatten
    // ys == Set(1, 2, 3)
    B

    the type of the elements of each traversable collection.

    returns

    a new parallel iterable resulting from concatenating all element parallel iterables.

    Definition Classes
    GenericTraversableTemplate
    Full Signature

    def flatten[B](implicit asTraversable: (T) => scala.IterableOnce[B]): ParIterable[B]

  32. def fold[U >: T](z: U)(op: (U, U) => U): U

    Folds the elements of this sequence using the specified associative binary operator.

    Folds the elements of this sequence using the specified associative binary operator. The order in which the elements are reduced is unspecified and may be nondeterministic.

    Note this method has a different signature than the foldLeft and foldRight methods of the trait Traversable. The result of folding may only be a supertype of this parallel collection's type parameter T.

    U

    a type parameter for the binary operator, a supertype of T.

    z

    a neutral element for the fold operation, it may be added to the result an arbitrary number of times, not changing 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
    ParIterableLike
  33. def foldLeft[S](z: S)(op: (S, T) => S): S
    Definition Classes
    ParIterableLike
  34. def foldRight[S](z: S)(op: (T, S) => S): S
    Definition Classes
    ParIterableLike
  35. def forall(p: (T) => Boolean): Boolean

    Tests whether a predicate holds for all elements of this parallel iterable.

    Tests whether a predicate holds for all elements of this parallel iterable.

    This method will use abort signalling capabilities. This means that splitters may send and read abort signals.

    p

    a predicate used to test elements

    returns

    true if p holds for all elements, false otherwise

    Definition Classes
    ParIterableLike
  36. def foreach[U](f: (T) => U): Unit

    Applies a function f to all the elements of parallel iterable in an undefined order.

    Applies a function f to all the elements of parallel iterable in an undefined order.

    U

    the result type of the function applied to each element, which is always discarded

    f

    function applied to each element

    Definition Classes
    ParIterableLike
  37. def genericBuilder[B]: Combiner[B, ParIterable[B]]

    The generic builder that builds instances of $Coll at arbitrary element types.

    The generic builder that builds instances of $Coll at arbitrary element types.

    Definition Classes
    GenericParTemplateGenericTraversableTemplate
  38. def genericCombiner[B]: Combiner[B, ParIterable[B]]
    Definition Classes
    GenericParTemplate
  39. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def groupBy[K](f: (T) => K): immutable.ParMap[K, ParIterable[T]]
    Definition Classes
    ParIterableLike
  41. def hasDefiniteSize: Boolean
    Definition Classes
    ParIterableLike
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def head: T
    Definition Classes
    ParIterableLike
  44. def headOption: Option[T]
    Definition Classes
    ParIterableLike
  45. def init: ParIterable[T]
    Definition Classes
    ParIterableLike
  46. def initTaskSupport(): Unit
    Attributes
    protected
    Definition Classes
    ParIterableLike
  47. def isEmpty: Boolean
    Definition Classes
    ParIterableLike
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. def isStrictSplitterCollection: Boolean

    Denotes whether this parallel collection has strict splitters.

    Denotes whether this parallel collection has strict splitters.

    This is true in general, and specific collection instances may choose to override this method. Such collections will fail to execute methods which rely on splitters being strict, i.e. returning a correct value in the remaining method.

    This method helps ensure that such failures occur on method invocations, rather than later on and in unpredictable ways.

    Definition Classes
    ParIterableLike
  50. final def isTraversableAgain: Boolean
    Definition Classes
    ParIterableLike
  51. def iterator: Splitter[T]

    Creates a new split iterator used to traverse the elements of this collection.

    Creates a new split iterator used to traverse the elements of this collection.

    By default, this method is implemented in terms of the protected splitter method.

    returns

    a split iterator

    Definition Classes
    ParIterableLike → IterableOnce
  52. def knownSize: Int
    Definition Classes
    IterableOnce
  53. def last: T
    Definition Classes
    ParIterableLike
  54. def lastOption: Option[T]
    Definition Classes
    ParIterableLike
  55. def map[S](f: (T) => S): ParIterable[S]
    Definition Classes
    ParIterableLike
  56. def max[U >: T](implicit ord: Ordering[U]): T
    Definition Classes
    ParIterableLike
  57. def maxBy[S](f: (T) => S)(implicit cmp: Ordering[S]): T
    Definition Classes
    ParIterableLike
  58. def min[U >: T](implicit ord: Ordering[U]): T
    Definition Classes
    ParIterableLike
  59. def minBy[S](f: (T) => S)(implicit cmp: Ordering[S]): T
    Definition Classes
    ParIterableLike
  60. def mkString: String
    Definition Classes
    ParIterableLike
  61. def mkString(sep: String): String
    Definition Classes
    ParIterableLike
  62. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    ParIterableLike
  63. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  64. def newBuilder: Builder[T, ParIterable[T]]

    The builder that builds instances of type $Coll[A]

    The builder that builds instances of type $Coll[A]

    Attributes
    protected[this]
    Definition Classes
    GenericParTemplateGenericTraversableTemplateHasNewBuilder
  65. def newCombiner: Combiner[T, ParIterable[T]]
    Attributes
    protected[this]
    Definition Classes
    GenericParTemplateHasNewCombiner
  66. def nonEmpty: Boolean
    Definition Classes
    ParIterableLike
  67. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. def par: ParIterable[T]

    Returns a parallel implementation of this collection.

    Returns a parallel implementation of this collection.

    For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

    Specific collections (e.g. ParArray or mutable.ParHashMap) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

    All parallel collections return a reference to themselves.

    returns

    a parallel implementation of this collection

    Definition Classes
    ParIterableLikeCustomParallelizableParallelizable
  70. def parCombiner: Combiner[T, ParIterable[T]]

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    returns

    a combiner for the parallel collection of type ParRepr

    Attributes
    protected[this]
    Definition Classes
    CustomParallelizableParallelizable
  71. def partition(pred: (T) => Boolean): (ParIterable[T], ParIterable[T])
    Definition Classes
    ParIterableLike
  72. def product[U >: T](implicit num: Numeric[U]): U
    Definition Classes
    ParIterableLike
  73. def reduce[U >: T](op: (U, U) => U): U

    Reduces the elements of this sequence using the specified associative binary operator.

    Reduces the elements of this sequence using the specified associative binary operator.

    The order in which operations are performed on elements is unspecified and may be nondeterministic.

    Note this method has a different signature than the reduceLeft and reduceRight methods of the trait Traversable. The result of reducing may only be a supertype of this parallel collection's type parameter T.

    U

    A type parameter for the binary operator, a supertype of T.

    op

    A binary operator that must be associative.

    returns

    The result of applying reduce operator op between all the elements if the collection is nonempty.

    Definition Classes
    ParIterableLike
    Exceptions thrown

    UnsupportedOperationException if this parallel iterable is empty.

  74. def reduceLeft[U >: T](op: (U, T) => U): U
    Definition Classes
    ParIterableLike
  75. def reduceLeftOption[U >: T](op: (U, T) => U): Option[U]
    Definition Classes
    ParIterableLike
  76. def reduceOption[U >: T](op: (U, U) => U): Option[U]

    Optionally reduces the elements of this sequence using the specified associative binary operator.

    Optionally reduces the elements of this sequence using the specified associative binary operator.

    The order in which operations are performed on elements is unspecified and may be nondeterministic.

    Note this method has a different signature than the reduceLeftOption and reduceRightOption methods of the trait Traversable. The result of reducing may only be a supertype of this parallel collection's type parameter T.

    U

    A type parameter for the binary operator, a supertype of T.

    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
    ParIterableLike
  77. def reduceRight[U >: T](op: (T, U) => U): U
    Definition Classes
    ParIterableLike
  78. def reduceRightOption[U >: T](op: (T, U) => U): Option[U]
    Definition Classes
    ParIterableLike
  79. def repr: ParIterable[T]
    Definition Classes
    ParIterableLike
  80. def reuse[S, That](oldc: Option[Combiner[S, That]], newc: Combiner[S, That]): Combiner[S, That]

    Optionally reuses an existing combiner for better performance.

    Optionally reuses an existing combiner for better performance. By default it doesn't - subclasses may override this behaviour. The provided combiner oldc that can potentially be reused will be either some combiner from the previous computational task, or None if there was no previous phase (in which case this method must return newc).

    oldc

    The combiner that is the result of the previous task, or None if there was no previous task.

    newc

    The new, empty combiner that can be used.

    returns

    Either newc or oldc.

    Attributes
    protected
    Definition Classes
    ParIterableLike
  81. def sameElements[U >: T](that: scala.IterableOnce[U]): Boolean
    Definition Classes
    ParIterableLike
  82. def scan[U >: T](z: U)(op: (U, U) => U): ParIterable[U]

    Computes a prefix scan of the elements of the collection.

    Computes a prefix scan of the elements of the collection.

    Note: The neutral element z may be applied more than once.

    U

    element type of the resulting collection

    z

    neutral element for the operator op

    op

    the associative operator for the scan

    returns

    a new parallel iterable containing the prefix scan of the elements in this parallel iterable

    Definition Classes
    ParIterableLike
  83. def scanBlockSize: Int
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  84. def scanLeft[S](z: S)(op: (S, T) => S): scala.Iterable[S]
    Definition Classes
    ParIterableLike
  85. def scanRight[S](z: S)(op: (T, S) => S): scala.Iterable[S]
    Definition Classes
    ParIterableLike
  86. def sequentially[S, That <: Parallel](b: (scala.Iterable[T]) => scala.Iterable[T]): ParIterable[T]
    Attributes
    protected[this]
    Definition Classes
    ParIterableLike
  87. def slice(unc_from: Int, unc_until: Int): ParIterable[T]
    Definition Classes
    ParIterableLike
  88. def span(pred: (T) => Boolean): (ParIterable[T], ParIterable[T])

    Splits this parallel iterable into a prefix/suffix pair according to a predicate.

    Splits this parallel iterable into a prefix/suffix pair according to a predicate.

    This method will use indexFlag signalling capabilities. This means that splitters may set and read the indexFlag state. The index flag is initially set to maximum integer value.

    pred

    the predicate used to test the elements

    returns

    a pair consisting of the longest prefix of the collection for which all the elements satisfy pred, and the rest of the collection

    Definition Classes
    ParIterableLike
  89. def splitAt(n: Int): (ParIterable[T], ParIterable[T])
    Definition Classes
    ParIterableLike
  90. def stepper[S <: Stepper[_]](implicit shape: StepperShape[T, S]): S
    Definition Classes
    IterableOnce
  91. def stringPrefix: String
    Definition Classes
    ParIterableParIterableLike
  92. def sum[U >: T](implicit num: Numeric[U]): U
    Definition Classes
    ParIterableLike
  93. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  94. def tail: ParIterable[T]
    Definition Classes
    ParIterableLike
  95. def take(n: Int): ParIterable[T]
    Definition Classes
    ParIterableLike
  96. def takeWhile(pred: (T) => Boolean): ParIterable[T]

    Takes the longest prefix of elements that satisfy the predicate.

    Takes the longest prefix of elements that satisfy the predicate.

    This method will use indexFlag signalling capabilities. This means that splitters may set and read the indexFlag state. The index flag is initially set to maximum integer value.

    pred

    the predicate used to test the elements

    returns

    the longest prefix of this parallel iterable of elements that satisfy the predicate pred

    Definition Classes
    ParIterableLike
  97. implicit def task2ops[R, Tp](tsk: SSCTask[R, Tp]): TaskOps[R, Tp]
    Attributes
    protected
    Definition Classes
    ParIterableLike
  98. def tasksupport: TaskSupport

    The task support object which is responsible for scheduling and load-balancing tasks to processors.

    The task support object which is responsible for scheduling and load-balancing tasks to processors.

    Definition Classes
    ParIterableLike
    See also

    scala.collection.parallel.TaskSupport

  99. def tasksupport_=(ts: TaskSupport): Unit

    Changes the task support object which is responsible for scheduling and load-balancing tasks to processors.

    Changes the task support object which is responsible for scheduling and load-balancing tasks to processors.

    A task support object can be changed in a parallel collection after it has been created, but only during a quiescent period, i.e. while there are no concurrent invocations to parallel collection methods.

    Here is a way to change the task support of a parallel collection:

    import scala.collection.parallel._
    val pc = mutable.ParArray(1, 2, 3)
    pc.tasksupport = new ForkJoinTaskSupport(
      new java.util.concurrent.ForkJoinPool(2))
    Definition Classes
    ParIterableLike
    See also

    scala.collection.parallel.TaskSupport

  100. def to[C](factory: Factory[T, C]): C
    Definition Classes
    ParIterableLike
  101. def toArray[U >: T](implicit arg0: ClassTag[U]): Array[U]
    Definition Classes
    ParIterableLike
  102. def toBuffer[U >: T]: Buffer[U]
    Definition Classes
    ParIterableLike
  103. def toIndexedSeq: immutable.IndexedSeq[T]
    Definition Classes
    ParIterableLike
  104. def toIterable: ParIterable[T]
    Definition Classes
    ParIterableLike
  105. def toIterator: scala.Iterator[T]
    Definition Classes
    ParIterableLike
  106. def toList: List[T]
    Definition Classes
    ParIterableLike
  107. def toMap[K, V](implicit ev: <:<[T, (K, V)]): immutable.ParMap[K, V]
    Definition Classes
    ParIterableLike
  108. def toParCollection[U >: T, That](cbf: () => Combiner[U, That]): That
    Attributes
    protected
    Definition Classes
    ParIterableLike
  109. def toParMap[K, V, That](cbf: () => Combiner[(K, V), That])(implicit ev: <:<[T, (K, V)]): That
    Attributes
    protected
    Definition Classes
    ParIterableLike
  110. def toSeq: ParSeq[T]
    Definition Classes
    ParIterableLike
  111. def toSet[U >: T]: immutable.ParSet[U]
    Definition Classes
    ParIterableLike
  112. def toString(): String
    Definition Classes
    ParIterableLike → AnyRef → Any
  113. def toVector: Vector[T]
    Definition Classes
    ParIterableLike
  114. def transpose[B](implicit asTraversable: (T) => scala.IterableOnce[B]): ParIterable[ParIterable[B]]

    Transposes this collection of traversable collections into a collection of collections.

    Transposes this collection of traversable collections into a collection of collections.

    The resulting collection's type will be guided by the static type of collection. For example:

    val xs = List(
               Set(1, 2, 3),
               Set(4, 5, 6)).transpose
    // xs == List(
    //         List(1, 4),
    //         List(2, 5),
    //         List(3, 6))
    
    val ys = Vector(
               List(1, 2, 3),
               List(4, 5, 6)).transpose
    // ys == Vector(
    //         Vector(1, 4),
    //         Vector(2, 5),
    //         Vector(3, 6))
    B

    the type of the elements of each traversable collection.

    asTraversable

    an implicit conversion which asserts that the element type of this collection is a Traversable.

    returns

    a two-dimensional collection of collections which has as nth row the nth column of this collection.

    Definition Classes
    GenericTraversableTemplate
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.

    Exceptions thrown

    IllegalArgumentException if all collections in this collection are not of the same size.

  115. def unzip[A1, A2](implicit asPair: (T) => (A1, A2)): (ParIterable[A1], ParIterable[A2])

    Converts this collection of pairs into two collections of the first and second half of each pair.

    Converts this collection of pairs into two collections of the first and second half of each pair.

    val xs = $Coll(
               (1, "one"),
               (2, "two"),
               (3, "three")).unzip
    // xs == ($Coll(1, 2, 3),
    //        $Coll(one, two, three))
    A1

    the type of the first half of the element pairs

    A2

    the type of the second half of the element pairs

    asPair

    an implicit conversion which asserts that the element type of this collection is a pair.

    returns

    a pair of collections, containing the first, respectively second half of each element pair of this collection.

    Definition Classes
    GenericTraversableTemplate
  116. def unzip3[A1, A2, A3](implicit asTriple: (T) => (A1, A2, A3)): (ParIterable[A1], ParIterable[A2], ParIterable[A3])

    Converts this collection of triples into three collections of the first, second, and third element of each triple.

    Converts this collection of triples into three collections of the first, second, and third element of each triple.

    val xs = $Coll(
               (1, "one", '1'),
               (2, "two", '2'),
               (3, "three", '3')).unzip3
    // xs == ($Coll(1, 2, 3),
    //        $Coll(one, two, three),
    //        $Coll(1, 2, 3))
    A1

    the type of the first member of the element triples

    A2

    the type of the second member of the element triples

    A3

    the type of the third member of the element triples

    asTriple

    an implicit conversion which asserts that the element type of this collection is a triple.

    returns

    a triple of collections, containing the first, second, respectively third member of each element triple of this collection.

    Definition Classes
    GenericTraversableTemplate
  117. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  118. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  119. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  120. def withFilter(pred: (T) => Boolean): ParIterable[T]
    Definition Classes
    ParIterableLike
  121. def wrap[R](body: => R): NonDivisible[R]
    Attributes
    protected
    Definition Classes
    ParIterableLike
  122. def zip[U >: T, S](that: scala.Iterable[S]): ParIterable[(U, S)]
    Definition Classes
    ParIterableLike
  123. def zip[U >: T, S](that: ParIterable[S]): ParIterable[(U, S)]
    Definition Classes
    ParIterableLike
  124. def zipAll[S, U >: T](that: ParIterable[S], thisElem: U, thatElem: S): ParIterable[(U, S)]
    Definition Classes
    ParIterableLike
  125. def zipWithIndex[U >: T]: ParIterable[(U, Int)]

    Zips this parallel iterable with its indices.

    Zips this parallel iterable with its indices.

    U

    the type of the first half of the returned pairs (this is always a supertype of the collection's element type T).

    returns

    A new collection of type ParIterable containing pairs consisting of all elements of this parallel iterable paired with their index. Indices start at 0.

    Definition Classes
    ParIterableLike

Deprecated Value Members

  1. def toStream: Stream[T]
    Definition Classes
    ParIterableLike
    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.3) Use to(LazyList) instead.

  2. def toTraversable: ParIterable[T]
    Definition Classes
    ParIterableLike
    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.3) Use toIterable instead

Inherited from Parallel

Inherited from CustomParallelizable[T, ParIterable[T]]

Inherited from Parallelizable[T, ParIterable[T]]

Inherited from IterableOnce[T]

Inherited from GenericParTemplate[T, ParIterable]

Inherited from HasNewCombiner[T, scala.collection.parallel.ParIterable[T] @scala.annotation.unchecked.uncheckedVariance]

Inherited from HasNewBuilder[T, scala.collection.parallel.ParIterable[T] @scala.annotation.unchecked.uncheckedVariance]

Inherited from AnyRef

Inherited from Any

Ungrouped