scala.collection.generic

# GenericParTemplate

#### trait GenericParTemplate [+A, +CC[X] <: ParIterable[X]] extends GenericTraversableTemplate[A, CC] with HasNewCombiner[A, CC[A]]

A template trait for collections having a companion.

A

  the element type of the collection

CC

  the type constructor representing the collection class

Source
  GenericParTemplate.scala
Since

  2.8

Linear Supertypes
HasNewCombiner[A, CC[A] @scala.annotation.unchecked.uncheckedVariance], GenericTraversableTemplate[A, CC], HasNewBuilder[A, CC[A]], AnyRef, Any
Known Subclasses
Appended, Appended, Forced, Forced, GenericParMapTemplate, Mapped, Mapped, ParArray, ParHashMap, ParHashMap, ParHashSet, ParHashSet, ParIterable, ParIterable, ParIterable, ParIterableView, ParIterableViewLike, ParMap, ParMap, ParMap, ParRange, ParSeq, ParSeq, ParSeq, ParSeqView, ParSeqViewLike, ParSet, ParSet, ParSet, ParVector, Patched, Prepended, Reversed, Sliced, Sliced, Transformed, Transformed, Zipped, Zipped, ZippedAll, ZippedAll
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. GenericParTemplate
2. HasNewCombiner
3. GenericTraversableTemplate
4. HasNewBuilder
5. AnyRef
6. Any

Visibility

1. Public
2. All

### Abstract Value Members

1. #### def companion : GenericCompanion[CC] with GenericParCompanion[CC]

   The factory companion object that builds instances of class CC.

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

   Attributes
     abstract
   Definition Classes
     GenericParTemplate → GenericTraversableTemplate

2. #### def foreach [U] (f: (A) ⇒ U): Unit

   Applies a function `f` to all elements of this collection.

   Applies a function `f` to all elements of this collection.

   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.

   Attributes
     abstract
   Definition Classes
     GenericTraversableTemplate

3. #### def head : A

   Selects the first element of this collection.

   Selects the first element of this collection.

   returns

     the first element of this collection.

   Attributes
     abstract
   Definition Classes
     GenericTraversableTemplate

4. #### def isEmpty : Boolean

   Tests whether this collection is empty.

   Tests whether this collection is empty.

   returns

     `true` if the collection contain no elements, `false` otherwise.

   Attributes
     abstract
   Definition Classes
     GenericTraversableTemplate

### Concrete Value Members

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

   Attributes
     final
   Definition Classes
     AnyRef

2. #### def != (arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

     `true` if !(this == that), false otherwise.

   Attributes
     final
   Definition Classes
     Any

3. #### 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 ==

   Attributes
     final
   Definition Classes
     AnyRef → Any

4. #### def == (arg0: AnyRef): Boolean

   Attributes
     final
   Definition Classes
     AnyRef

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

   Attributes
     final
   Definition Classes
     Any

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

   Attributes
     final
   Definition Classes
     Any

7. #### 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()

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

   Attributes
     final
   Definition Classes
     AnyRef

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

10. #### 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()

11. #### def flatten [B] : CC[B]

    [use case] Converts this collection of traversable collections into a collection in which all element collections are concatenated.

    [use case]

    Converts this collection of traversable collections into a collection in which all element collections are concatenated.

    B

      the type of the elements of each traversable collection.

    returns

      a new collection resulting from concatenating all element collections.

    Attributes
      abstract
    Definition Classes
      GenericTraversableTemplate

12. #### def flatten [B] (implicit asTraversable: (A) ⇒ TraversableOnce[B]): CC[B]

    Converts this collection of traversable collections into a collection in which all element collections are concatenated.

    Converts this collection of traversable collections into a collection in which all element collections are concatenated.

    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 new collection resulting from concatenating all element collections.

    Definition Classes
      GenericTraversableTemplate

13. #### def foreach (f: (A) ⇒ Unit): Unit

    [use case] Applies a function `f` to all elements of this collection.

    [use case]

    Applies a function `f` to all elements of this collection.

    f

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

    Attributes
      abstract
    Definition Classes
      GenericTraversableTemplate

14. #### def genericBuilder [B] : Combiner[B, CC[B]]

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

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

    Definition Classes
      GenericParTemplate → GenericTraversableTemplate

15. #### def genericCombiner [B] : Combiner[B, CC[B]]

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

    Attributes
      final
    Definition Classes
      AnyRef → Any

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

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

    Attributes
      final
    Definition Classes
      Any

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

    Attributes
      final
    Definition Classes
      AnyRef

20. #### def newBuilder : Builder[A, CC[A]]

    The builder that builds instances of type CC[A]

    The builder that builds instances of type CC[A]

    Attributes
      protected[this]
    Definition Classes
      GenericParTemplate → GenericTraversableTemplate → HasNewBuilder

21. #### def newCombiner : Combiner[A, CC[A]]

    Attributes
      protected[this]
    Definition Classes
      GenericParTemplate → HasNewCombiner

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

    Attributes
      final
    Definition Classes
      AnyRef

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

    Attributes
      final
    Definition Classes
      AnyRef

24. #### def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
      final
    Definition Classes
      AnyRef

25. #### def toString (): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

      a String representation of the object.

    Definition Classes
      AnyRef → Any

26. #### def transpose [B] (implicit asTraversable: (A) ⇒ TraversableOnce[B]): CC[CC[B]]

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

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

    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

      "As of 2.9, transpose throws an exception if collections are not uniformly sized."

27. #### def unzip [A1, A2] (implicit asPair: (A) ⇒ (A1, A2)): (CC[A1], CC[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.

    asPair

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

    returns

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

    Definition Classes
      GenericTraversableTemplate

28. #### def unzip3 [A1, A2, A3] (implicit asTriple: (A) ⇒ (A1, A2, A3)): (CC[A1], CC[A2], CC[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.

    returns

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

    Definition Classes
      GenericTraversableTemplate

29. #### def wait (): Unit

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

30. #### def wait (arg0: Long, arg1: Int): Unit

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

31. #### def wait (arg0: Long): Unit

    Attributes
      final
    Definition Classes
      AnyRef
    Annotations
      @throws()

### Inherited from HasNewCombiner[A, CC[A] @scala.annotation.unchecked.uncheckedVariance]

### Inherited from GenericTraversableTemplate[A, CC]

### Inherited from HasNewBuilder[A, CC[A]]

### Inherited from AnyRef

### Inherited from Any