Trait

scala.collection.parallel

Combiner

Related Doc: package parallel

Permalink

trait Combiner[-Elem, +To] extends Builder[Elem, To] with Sizing with Parallel

The base trait for all combiners. A combiner incremental collection construction just like a regular builder, but also implements an efficient merge operation of two builders via combine method. Once the collection is constructed, it may be obtained by invoking the result method.

The complexity of the combine method should be less than linear for best performance. The result method doesn't have to be a constant time operation, but may be performed in parallel.

Elem

the type of the elements added to the builder

To

the type of the collection the builder produces

Since

2.9

Linear Supertypes
Parallel, Sizing, Builder[Elem, To], Growable[Elem], Clearable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Combiner
  2. Parallel
  3. Sizing
  4. Builder
  5. Growable
  6. Clearable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def +=(elem: Elem): Combiner.this.type

    Permalink

    Adds a single element to the builder.

    Adds a single element to the builder.

    elem

    the element to be added.

    returns

    the builder itself.

    Definition Classes
    BuilderGrowable
  2. abstract def clear(): Unit

    Permalink

    Clears the contents of this builder.

    Clears the contents of this builder. After execution of this method the builder will contain no elements.

    Definition Classes
    BuilderGrowableClearable
  3. abstract def combine[N <: Elem, NewTo >: To](other: Combiner[N, NewTo]): Combiner[N, NewTo]

    Permalink

    Combines the contents of the receiver builder and the other builder, producing a new builder containing both their elements.

    Combines the contents of the receiver builder and the other builder, producing a new builder containing both their elements.

    This method may combine the two builders by copying them into a larger collection, by producing a lazy view that gets evaluated once result is invoked, or use a merge operation specific to the data structure in question.

    Note that both the receiver builder and other builder become invalidated after the invocation of this method, and should be cleared (see clear) if they are to be used again.

    Also, combining two combiners c1 and c2 for which c1 eq c2 is true, that is, they are the same objects in memory:

    c1.combine(c2)

    always does nothing and returns c1.

    N

    the type of elements contained by the other builder

    NewTo

    the type of collection produced by the other builder

    other

    the other builder

    returns

    the parallel builder containing both the elements of this and the other builder

  4. abstract def result(): To

    Permalink

    Produces a collection from the added elements.

    Produces a collection from the added elements. The builder's contents are undefined after this operation.

    returns

    a collection containing the elements added to this builder.

    Definition Classes
    Builder
  5. abstract def size: Int

    Permalink
    Definition Classes
    Sizing

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++=(xs: TraversableOnce[Elem]): Combiner.this.type

    Permalink

    adds all elements produced by a TraversableOnce to this growable collection.

    adds all elements produced by a TraversableOnce to this growable collection.

    xs

    the TraversableOnce producing the elements to add.

    returns

    the growable collection itself.

    Definition Classes
    Growable
  4. def +=(elem1: Elem, elem2: Elem, elems: Elem*): Combiner.this.type

    Permalink

    adds two or more elements to this growable collection.

    adds two or more elements to this growable collection.

    elem1

    the first element to add.

    elem2

    the second element to add.

    elems

    the remaining elements to add.

    returns

    the growable collection itself

    Definition Classes
    Growable
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. var _combinerTaskSupport: TaskSupport

    Permalink
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def canBeShared: Boolean

    Permalink

    Returns true if this combiner has a thread-safe += and is meant to be shared across several threads constructing the collection.

    Returns true if this combiner has a thread-safe += and is meant to be shared across several threads constructing the collection.

    By default, this method returns false.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def combinerTaskSupport: TaskSupport

    Permalink
  11. def combinerTaskSupport_=(cts: TaskSupport): Unit

    Permalink
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def mapResult[NewTo](f: (To) ⇒ NewTo): Builder[Elem, NewTo]

    Permalink

    Creates a new builder by applying a transformation function to the results of this builder.

    Creates a new builder by applying a transformation function to the results of this builder.

    NewTo

    the type of collection returned by f.

    f

    the transformation function.

    returns

    a new builder which is the same as the current builder except that a transformation function is applied to this builder's result.

    Definition Classes
    Builder
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def resultWithTaskSupport: To

    Permalink

    Constructs the result and sets the appropriate tasksupport object to the resulting collection if this is applicable.

  23. def sizeHint(coll: TraversableLike[_, _], delta: Int): Unit

    Permalink

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection is known to have a cheap size method. Currently this is assumed to be the case if and only if the collection is of type IndexedSeqLike. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    coll

    the collection which serves as a hint for the result's size.

    delta

    a correction to add to the coll.size to produce the size hint.

    Definition Classes
    Builder
  24. def sizeHint(coll: TraversableLike[_, _]): Unit

    Permalink

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection is known to have a cheap size method. Currently this is assumed to be the case if and only if the collection is of type IndexedSeqLike. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    coll

    the collection which serves as a hint for the result's size.

    Definition Classes
    Builder
  25. def sizeHint(size: Int): Unit

    Permalink

    Gives a hint how many elements are expected to be added when the next result is called.

    Gives a hint how many elements are expected to be added when the next result is called. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    size

    the hint how many elements will be added.

    Definition Classes
    Builder
  26. def sizeHintBounded(size: Int, boundingColl: TraversableLike[_, _]): Unit

    Permalink

    Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection.

    Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    size

    the hint how many elements will be added.

    boundingColl

    the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.

    Definition Classes
    Builder
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Parallel

Inherited from Sizing

Inherited from Builder[Elem, To]

Inherited from Growable[Elem]

Inherited from Clearable

Inherited from AnyRef

Inherited from Any

Ungrouped