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
LazyCombiner, ResizableParArrayCombiner, UnrolledParArrayCombiner
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
    Definition Classes
    Builder → Growable
  2. abstract def clear(): Unit
    Definition Classes
    Builder → Growable → Clearable
  3. abstract def combine[N <: Elem, NewTo >: To](other: Combiner[N, NewTo]): Combiner[N, NewTo]

    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
    Definition Classes
    Builder
  5. abstract def size: Int
    Definition Classes
    Sizing

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++=(xs: TraversableOnce[Elem]): Combiner.this.type
    Definition Classes
    Growable
  4. def +=(elem1: Elem, elem2: Elem, elems: Elem*): Combiner.this.type
    Definition Classes
    Growable
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val _combinerTaskSupport: TaskSupport
    Annotations
    @transient() @volatile()
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def canBeShared: Boolean

    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
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def combinerTaskSupport: TaskSupport
  11. def combinerTaskSupport_=(cts: TaskSupport): Unit
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def fromSequential(seq: scala.TraversableOnce[Elem]): To

    Add all elements from a sequential collection and return the result.

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def mapResult[NewTo](f: (To) ⇒ NewTo): Builder[Elem, NewTo]
    Definition Classes
    Builder
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. def resultWithTaskSupport: To

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

  24. def sizeHint(coll: TraversableLike[_, _], delta: Int): Unit
    Definition Classes
    Builder
  25. def sizeHint(coll: TraversableLike[_, _]): Unit
    Definition Classes
    Builder
  26. def sizeHint(size: Int): Unit
    Definition Classes
    Builder
  27. def sizeHintBounded(size: Int, boundingColl: TraversableLike[_, _]): Unit
    Definition Classes
    Builder
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    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