# GenIterableLike

#### trait GenIterableLike[+A, +Repr] extends GenTraversableLike[A, Repr]

A template trait for all iterable collections which may possibly have their operations implemented in parallel.

This trait contains abstract methods and methods that can be implemented directly in terms of other methods.

Source
GenIterableLike.scala
Linear Supertypes
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. GenIterableLike
2. GenTraversableLike
3. Parallelizable
4. GenTraversableOnce
5. Any
Implicitly
1. by traversable2ops
2. by any2stringadd
3. by any2stringfmt
4. by any2ArrowAssoc
5. by any2Ensuring
1. Hide All
2. Show all
Learn more about member selection
Visibility
1. Public
2. All

### Abstract Value Members

1. #### abstract def /:[B](z: B)(op: (B, A) ⇒ B): B

Applies a binary operator to a start value and all elements of this general iterable collection , going left to right.

Applies a binary operator to a start value and all elements of this general iterable collection , 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-sized collections.

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 general iterable collection , going left to right with the start value `z` on the left:

`op(...op(op(z, x_1), x_2), ..., x_n)`

where `x1, ..., xn` are the elements of this general iterable collection .

Definition Classes
GenTraversableOnce
2. #### abstract def :\[B](z: B)(op: (A, B) ⇒ B): B

Applies a binary operator to all elements of this general iterable collection and a start value, going right to left.

Applies a binary operator to all elements of this general iterable collection 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-sized collections.

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 general iterable collection , going right to left with the start value `z` on the right:

`op(x_1, op(x_2, ... op(x_n, z)...))`

where `x1, ..., xn` are the elements of this general iterable collection .

Definition Classes
GenTraversableOnce
3. #### abstract def aggregate[B](z: B)(seqop: (B, A) ⇒ 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
GenTraversableOnce
4. #### abstract def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Unit

Definition Classes
GenTraversableOnce
5. #### abstract def count(p: (A) ⇒ Boolean): Int

Counts the number of elements in the general iterable collection which satisfy a predicate.

Counts the number of elements in the general iterable collection which satisfy a predicate.

p

the predicate used to test elements.

returns

the number of elements satisfying the predicate `p`.

Definition Classes
GenTraversableOnce
6. #### abstract def drop(n: Int): Repr

Selects all elements except first n ones.

Selects all elements except first n ones.

Note: might return different results for different runs, unless the underlying collection type is ordered.

n

the number of elements to drop from this general iterable collection .

returns

a general iterable collection consisting of all elements of this general iterable collection except the first `n` ones, or else the empty general iterable collection , if this general iterable collection has less than `n` elements.

Definition Classes
GenTraversableLike
7. #### abstract def dropWhile(pred: (A) ⇒ Boolean): Repr

Drops longest prefix of elements that satisfy a predicate.

Drops longest prefix of elements that satisfy a predicate.

Note: might return different results for different runs, unless the underlying collection type is ordered.

pred

The predicate used to test elements.

returns

the longest suffix of this general iterable collection whose first element does not satisfy the predicate `p`.

Definition Classes
GenTraversableLike
8. #### abstract def exists(pred: (A) ⇒ Boolean): Boolean

Definition Classes
GenTraversableOnce
9. #### abstract def filter(pred: (A) ⇒ Boolean): Repr

Selects all elements of this general iterable collection which satisfy a predicate.

Selects all elements of this general iterable collection which satisfy a predicate.

pred

the predicate used to test elements.

returns

a new general iterable collection consisting of all elements of this general iterable collection that satisfy the given predicate `p`. Their order may not be preserved.

Definition Classes
GenTraversableLike
10. #### abstract def filterNot(pred: (A) ⇒ Boolean): Repr

Selects all elements of this general iterable collection which do not satisfy a predicate.

Selects all elements of this general iterable collection which do not satisfy a predicate.

pred

the predicate used to test elements.

returns

a new general iterable collection consisting of all elements of this general iterable collection that do not satisfy the given predicate `p`. Their order may not be preserved.

Definition Classes
GenTraversableLike
11. #### abstract def find(pred: (A) ⇒ Boolean): Option[A]

Finds the first element of the general iterable collection satisfying a predicate, if any.

Finds the first element of the general iterable collection satisfying a predicate, if any.

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

pred

the predicate used to test elements.

returns

an option value containing the first element in the general iterable collection

that satisfies `p`, or `None` if none exists.

Definition Classes
GenTraversableOnce
12. #### abstract def fold[A1 >: A](z: A1)(op: (A1, A1) ⇒ A1): A1

Folds the elements of this general iterable collection using the specified associative binary operator.

Folds the elements of this general iterable collection 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`.

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
GenTraversableOnce
13. #### abstract def foldLeft[B](z: B)(op: (B, A) ⇒ B): B

Applies a binary operator to a start value and all elements of this general iterable collection , going left to right.

Applies a binary operator to a start value and all elements of this general iterable collection , going left to right.

Note: will not terminate for infinite-sized collections.

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 general iterable collection , going left to right with the start value `z` on the left:

`op(...op(z, x_1), x_2, ..., x_n)`

where `x1, ..., xn` are the elements of this general iterable collection .

Definition Classes
GenTraversableOnce
14. #### abstract def foldRight[B](z: B)(op: (A, B) ⇒ B): B

Applies a binary operator to all elements of this general iterable collection and a start value, going right to left.

Applies a binary operator to all elements of this general iterable collection and a start value, going right to left.

Note: will not terminate for infinite-sized collections.

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 general iterable collection , going right to left with the start value `z` on the right:

`op(x_1, op(x_2, ... op(x_n, z)...))`

where `x1, ..., xn` are the elements of this general iterable collection .

Definition Classes
GenTraversableOnce
15. #### abstract def forall(pred: (A) ⇒ Boolean): Boolean

Definition Classes
GenTraversableOnce
16. #### abstract def getClass(): Class[_]

Returns the runtime class representation of the object.

Returns the runtime class representation of the object.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
Any
17. #### abstract def groupBy[K](f: (A) ⇒ K): GenMap[K, Repr]

Partitions this general iterable collection into a map of general iterable collection s according to some discriminator function.

Partitions this general iterable collection into a map of general iterable collection s according to some discriminator function.

Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new general iterable collection .

K

the type of keys returned by the discriminator function.

f

the discriminator function.

returns

A map from keys to general iterable collection s such that the following invariant holds:

`(xs partition f)(k) = xs filter (x => f(x) == k)`

That is, every key `k` is bound to a general iterable collection of those elements `x` for which `f(x)` equals `k`.

Definition Classes
GenTraversableLike
18. #### abstract def hasDefiniteSize: Boolean

Definition Classes
GenTraversableOnce
19. #### abstract def head: A

Selects the first element of this general iterable collection .

Selects the first element of this general iterable collection .

Note: might return different results for different runs, unless the underlying collection type is ordered.

returns

the first element of this general iterable collection .

Definition Classes
GenTraversableLike
Exceptions thrown
`NoSuchElementException`

if the general iterable collection is empty.

20. #### abstract def headOption: Option[A]

Optionally selects the first element.

Optionally selects the first element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

returns

the first element of this general iterable collection if it is nonempty, `None` if it is empty.

Definition Classes
GenTraversableLike
21. #### abstract def init: Repr

Selects all elements except the last.

Selects all elements except the last.

Note: might return different results for different runs, unless the underlying collection type is ordered.

returns

a general iterable collection consisting of all elements of this general iterable collection

except the last one.

Definition Classes
GenTraversableLike
Exceptions thrown
`UnsupportedOperationException`

if the general iterable collection is empty.

22. #### abstract def isEmpty: Boolean

Tests whether the general iterable collection is empty.

Tests whether the general iterable collection is empty.

returns

`true` if the general iterable collection contains no elements, `false` otherwise.

Definition Classes
GenTraversableOnce
23. #### abstract def isTraversableAgain: Boolean

Tests whether this general iterable collection can be repeatedly traversed.

Tests whether this general iterable collection can be repeatedly traversed.

returns

`true`

Definition Classes
GenTraversableLikeGenTraversableOnce

25. #### abstract def last: A

Selects the last element.

Selects the last element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

returns

The last element of this general iterable collection .

Definition Classes
GenTraversableLike
Exceptions thrown
NoSuchElementException

If the general iterable collection is empty.

26. #### abstract def lastOption: Option[A]

Optionally selects the last element.

Optionally selects the last element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

returns

the last element of this general iterable collection \$ if it is nonempty, `None` if it is empty.

Definition Classes
GenTraversableLike
27. #### abstract def maxBy[B](f: (A) ⇒ B)(implicit cmp: Ordering[B]): A

Definition Classes
GenTraversableOnce
28. #### abstract def minBy[B](f: (A) ⇒ B)(implicit cmp: Ordering[B]): A

Definition Classes
GenTraversableOnce
29. #### abstract def mkString: String

Displays all elements of this general iterable collection in a string.

Displays all elements of this general iterable collection in a string.

returns

a string representation of this general iterable collection . In the resulting string the string representations (w.r.t. the method `toString`) of all elements of this general iterable collection follow each other without any separator string.

Definition Classes
GenTraversableOnce
30. #### abstract def mkString(sep: String): String

Displays all elements of this general iterable collection in a string using a separator string.

Displays all elements of this general iterable collection in a string using a separator string.

sep

the separator string.

returns

a string representation of this general iterable collection . In the resulting string the string representations (w.r.t. the method `toString`) of all elements of this general iterable collection are separated by the string `sep`.

Definition Classes
GenTraversableOnce
Example:
1. `List(1, 2, 3).mkString("|") = "1|2|3"`

31. #### abstract def mkString(start: String, sep: String, end: String): String

Displays all elements of this general iterable collection in a string using start, end, and separator strings.

Displays all elements of this general iterable collection 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 general iterable collection . 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 general iterable collection are separated by the string `sep`.

Definition Classes
GenTraversableOnce
Example:
1. `List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"`

32. #### abstract def nonEmpty: Boolean

Tests whether the general iterable collection is not empty.

Tests whether the general iterable collection is not empty.

returns

`true` if the general iterable collection contains at least one element, `false` otherwise.

Definition Classes
GenTraversableOnce
33. #### abstract def parCombiner: Combiner[A, ParIterable[A]]

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
Parallelizable
34. #### abstract def partition(pred: (A) ⇒ Boolean): (Repr, Repr)

Partitions this general iterable collection in two general iterable collection s according to a predicate.

Partitions this general iterable collection in two general iterable collection s according to a predicate.

pred

the predicate on which to partition.

returns

a pair of general iterable collection s: the first general iterable collection consists of all elements that satisfy the predicate `p` and the second general iterable collection consists of all elements that don't. The relative order of the elements in the resulting general iterable collection s may not be preserved.

Definition Classes
GenTraversableLike
35. #### abstract def reduce[A1 >: A](op: (A1, A1) ⇒ A1): A1

Reduces the elements of this general iterable collection using the specified associative binary operator.

Reduces the elements of this general iterable collection 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

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

Definition Classes
GenTraversableOnce
Exceptions thrown
UnsupportedOperationException

if this general iterable collection is empty.

36. #### abstract def reduceLeftOption[B >: A](op: (B, A) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this general iterable collection , going left to right.

Optionally applies a binary operator to all elements of this general iterable collection , going left to right.

Note: will not terminate for infinite-sized collections.

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 general iterable collection is nonempty, `None` otherwise.

Definition Classes
GenTraversableOnce
37. #### abstract def reduceOption[A1 >: A](op: (A1, A1) ⇒ A1): Option[A1]

Reduces the elements of this general iterable collection , if any, using the specified associative binary operator.

Reduces the elements of this general iterable collection , 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
GenTraversableOnce
38. #### abstract def reduceRight[B >: A](op: (A, B) ⇒ B): B

Applies a binary operator to all elements of this general iterable collection , going right to left.

Applies a binary operator to all elements of this general iterable collection , going right to left.

Note: will not terminate for infinite-sized collections.

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 general iterable collection , going right to left:

`op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))`

where `x1, ..., xn` are the elements of this general iterable collection .

Definition Classes
GenTraversableOnce
Exceptions thrown
`UnsupportedOperationException`

if this general iterable collection is empty.

39. #### abstract def reduceRightOption[B >: A](op: (A, B) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this general iterable collection , going right to left.

Optionally applies a binary operator to all elements of this general iterable collection , going right to left.

Note: will not terminate for infinite-sized collections.

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 general iterable collection is nonempty, `None` otherwise.

Definition Classes
GenTraversableOnce
40. #### abstract def repr: Repr

Definition Classes
GenTraversableLike
41. #### abstract def scan[B >: A, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Repr, B, That]): That

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.

B

element type of the resulting collection

That

type of the resulting collection

z

neutral element for the operator `op`

op

the associative operator for the scan

cbf

combiner factory which provides a combiner

returns

a new general iterable collection containing the prefix scan of the elements in this general iterable collection

Definition Classes
GenTraversableLike
42. #### abstract def scanLeft[B, That](z: B)(op: (B, A) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

Produces a collection containing cumulative results of applying the operator going left to right.

Produces a collection containing cumulative results of applying the operator going left to right.

Note: will not terminate for infinite-sized collections.

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

That

the actual type of the resulting collection

z

the initial value

op

the binary operator applied to the intermediate result and the element

bf

an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and and the new element type `B`.

returns

collection with intermediate results

Definition Classes
GenTraversableLike
43. #### abstract def scanRight[B, That](z: B)(op: (A, B) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

Produces a collection containing cumulative results of applying the operator going right to left.

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Example:

`List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)`
B

the type of the elements in the resulting collection

That

the actual type of the resulting collection

z

the initial value

op

the binary operator applied to the intermediate result and the element

bf

an implicit value of class `CanBuildFrom` which determines the result class `That` from the current representation type `Repr` and and the new element type `B`.

returns

collection with intermediate results

Definition Classes
GenTraversableLike
Annotations
@migration
Migration

(Changed in version 2.9.0) The behavior of `scanRight` has changed. The previous behavior can be reproduced with scanRight.reverse.

44. #### abstract def seq: TraversableOnce[A]

Definition Classes
Parallelizable
45. #### abstract def size: Int

The size of this general iterable collection .

The size of this general iterable collection .

Note: will not terminate for infinite-sized collections.

returns

the number of elements in this general iterable collection .

Definition Classes
GenTraversableLikeGenTraversableOnce
46. #### abstract def slice(unc_from: Int, unc_until: Int): Repr

Selects an interval of elements.

Selects an interval of elements. The returned collection is made up of all elements `x` which satisfy the invariant:

`from <= indexOf(x) < until`

Note: might return different results for different runs, unless the underlying collection type is ordered.

unc_from

the lowest index to include from this general iterable collection .

unc_until

the lowest index to EXCLUDE from this general iterable collection .

returns

a general iterable collection containing the elements greater than or equal to index `from` extending up to (but not including) index `until` of this general iterable collection .

Definition Classes
GenTraversableLike
47. #### abstract def span(pred: (A) ⇒ Boolean): (Repr, Repr)

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

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

Note: `c span p` is equivalent to (but possibly more efficient than) `(c takeWhile p, c dropWhile p)`, provided the evaluation of the predicate `p` does not cause any side-effects.

Note: might return different results for different runs, unless the underlying collection type is ordered.

pred

the test predicate

returns

a pair consisting of the longest prefix of this general iterable collection whose elements all satisfy `p`, and the rest of this general iterable collection .

Definition Classes
GenTraversableLike
48. #### abstract def splitAt(n: Int): (Repr, Repr)

Splits this general iterable collection into two at a given position.

Splits this general iterable collection into two at a given position. Note: `c splitAt n` is equivalent to (but possibly more efficient than) `(c take n, c drop n)`.

Note: might return different results for different runs, unless the underlying collection type is ordered.

n

the position at which to split.

returns

a pair of general iterable collection s consisting of the first `n` elements of this general iterable collection , and the other elements.

Definition Classes
GenTraversableLike
49. #### abstract def stringPrefix: String

Defines the prefix of this object's `toString` representation.

Defines the prefix of this object's `toString` representation.

returns

a string representation which starts the result of `toString` applied to this general iterable collection . By default the string prefix is the simple name of the collection class general iterable collection .

Definition Classes
GenTraversableLike
50. #### abstract def tail: Repr

Selects all elements except the first.

Selects all elements except the first.

Note: might return different results for different runs, unless the underlying collection type is ordered.

returns

a general iterable collection consisting of all elements of this general iterable collection

except the first one.

Definition Classes
GenTraversableLike
Exceptions thrown
`UnsupportedOperationException`

if the general iterable collection is empty.

51. #### abstract def take(n: Int): Repr

Selects first n elements.

Selects first n elements.

Note: might return different results for different runs, unless the underlying collection type is ordered.

n

the number of elements to take from this general iterable collection .

returns

a general iterable collection consisting only of the first `n` elements of this general iterable collection , or else the whole general iterable collection , if it has less than `n` elements.

Definition Classes
GenTraversableLike
52. #### abstract def takeWhile(pred: (A) ⇒ Boolean): Repr

Takes longest prefix of elements that satisfy a predicate.

Takes longest prefix of elements that satisfy a predicate.

Note: might return different results for different runs, unless the underlying collection type is ordered.

pred

The predicate used to test elements.

returns

the longest prefix of this general iterable collection whose elements all satisfy the predicate `p`.

Definition Classes
GenTraversableLike
53. #### abstract def toBuffer[A1 >: A]: Buffer[A1]

Converts this general iterable collection to a mutable buffer.

Converts this general iterable collection to a mutable buffer.

Note: will not terminate for infinite-sized collections.

returns

a buffer containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
54. #### abstract def toIndexedSeq: immutable.IndexedSeq[A]

Converts this general iterable collection to an indexed sequence.

Converts this general iterable collection to an indexed sequence.

Note: will not terminate for infinite-sized collections.

returns

an indexed sequence containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
55. #### abstract def toIterable: GenIterable[A]

Converts this general iterable collection to an iterable collection.

Converts this general iterable collection 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-sized collections.

returns

an `Iterable` containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
56. #### abstract def toIterator: Iterator[A]

Returns an Iterator over the elements in this general iterable collection .

Returns an Iterator over the elements in this general iterable collection . Will return the same Iterator if this instance is already an Iterator.

Note: will not terminate for infinite-sized collections.

returns

an Iterator containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
57. #### abstract def toList: List[A]

Converts this general iterable collection to a list.

Converts this general iterable collection to a list.

Note: will not terminate for infinite-sized collections.

returns

a list containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
58. #### abstract def toSeq: GenSeq[A]

Converts this general iterable collection to a sequence.

Converts this general iterable collection 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-sized collections.

returns

a sequence containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
59. #### abstract def toSet[A1 >: A]: GenSet[A1]

Converts this general iterable collection to a set.

Converts this general iterable collection to a set.

Note: will not terminate for infinite-sized collections.

returns

a set containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
60. #### abstract def toStream: Stream[A]

Converts this general iterable collection to a stream.

Converts this general iterable collection to a stream.

Note: will not terminate for infinite-sized collections.

returns

a stream containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
61. #### abstract def toTraversable: GenTraversable[A]

Converts this general iterable collection to an unspecified Traversable.

Converts this general iterable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.

Note: will not terminate for infinite-sized collections.

returns

a Traversable containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
62. #### abstract def toVector: Vector[A]

Converts this general iterable collection to a Vector.

Converts this general iterable collection to a Vector.

Note: will not terminate for infinite-sized collections.

returns

a vector containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce

### Concrete Value Members

1. #### 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
2. #### final def ##(): Int

Equivalent to `x.hashCode` except for boxed numeric types and `null`.

Equivalent to `x.hashCode` except for boxed numeric types and `null`. 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. For `null` returns a hashcode where `null.hashCode` throws a `NullPointerException`.

returns

a hash value consistent with ==

Definition Classes
Any
3. #### def +(other: String): String

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
4. #### abstract def ++[B](that: GenTraversableOnce[B]): GenIterable[B]

[use case] Returns a new general iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand.

[use case]

Returns a new general iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the general iterable collection is the most specific superclass encompassing the element types of the two operands.

Example:

```scala> val a = LinkedList(1)
a: scala.collection.mutable.LinkedList[Int] = LinkedList(1)

scala> val b = LinkedList(2)
b: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val c = a ++ b
c: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

scala> val d = LinkedList('a')
d: scala.collection.mutable.LinkedList[Char] = LinkedList(a)

scala> val e = c ++ d
e: scala.collection.mutable.LinkedList[AnyVal] = LinkedList(1, 2, a)```
B

the element type of the returned collection.

that

the traversable to append.

returns

a new general iterable collection which contains all elements of this general iterable collection

followed by all elements of `that`.

Definition Classes
GenTraversableLike
Full Signature

5. #### def ->[B](y: B): (GenIterableLike[A, Repr], B)

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to ArrowAssoc[GenIterableLike[A, Repr]] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
()
6. #### final def ==(arg0: Any): Boolean

Test two objects for equality.

Test two objects for equality. The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

returns

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

Definition Classes
Any
7. #### 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`.

8. #### def asParIterable: ParIterable[A]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to TraversableOps[A] performed by method traversable2ops in scala.collection.parallel.
Definition Classes
TraversableOps
9. #### def asParSeq: ParSeq[A]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to TraversableOps[A] performed by method traversable2ops in scala.collection.parallel.
Definition Classes
TraversableOps
10. #### abstract def collect[B](pf: PartialFunction[A, B]): GenIterable[B]

[use case] Builds a new collection by applying a partial function to all elements of this general iterable collection

[use case]

Builds a new collection by applying a partial function to all elements of this general iterable collection

on which the function is defined.

B

the element type of the returned collection.

pf

the partial function which filters and maps the general iterable collection .

returns

a new general iterable collection resulting from applying the given partial function `pf` to each element on which it is defined and collecting the results. The order of the elements is preserved.

Definition Classes
GenTraversableLike
Full Signature

11. #### abstract def copyToArray(xs: Array[A], start: Int): Unit

[use case] Copies values of this general iterable collection to an array.

[use case]

Copies values of this general iterable collection to an array. Fills the given array `xs` with values of this general iterable collection , beginning at index `start`. Copying will stop once either the end of the current general iterable collection is reached, or the end of the array is reached.

Note: will not terminate for infinite-sized collections.

xs

the array to fill.

start

the starting index.

Definition Classes
GenTraversableOnce
Full Signature

12. #### abstract def copyToArray(xs: Array[A]): Unit

[use case] Copies values of this general iterable collection to an array.

[use case]

Copies values of this general iterable collection to an array. Fills the given array `xs` with values of this general iterable collection . Copying will stop once either the end of the current general iterable collection is reached, or the end of the array is reached.

Note: will not terminate for infinite-sized collections.

xs

the array to fill.

Definition Classes
GenTraversableOnce
Full Signature

13. #### def ensuring(cond: (GenIterableLike[A, Repr]) ⇒ Boolean, msg: ⇒ Any): GenIterableLike[A, Repr]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to Ensuring[GenIterableLike[A, Repr]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
14. #### def ensuring(cond: (GenIterableLike[A, Repr]) ⇒ Boolean): GenIterableLike[A, Repr]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to Ensuring[GenIterableLike[A, Repr]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
15. #### def ensuring(cond: Boolean, msg: ⇒ Any): GenIterableLike[A, Repr]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to Ensuring[GenIterableLike[A, Repr]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
16. #### def ensuring(cond: Boolean): GenIterableLike[A, Repr]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to Ensuring[GenIterableLike[A, Repr]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
17. #### def equals(arg0: Any): Boolean

Compares the receiver object (`this`) with the argument object (`that`) for equivalence.

Compares the receiver object (`this`) with the argument object (`that`) for equivalence.

Any implementation of this method should be an equivalence relation:

• It is reflexive: for any instance `x` of type `Any`, `x.equals(x)` should return `true`.
• It is symmetric: for any instances `x` and `y` of type `Any`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
• It is transitive: for any instances `x`, `y`, and `z` of type `AnyRef` if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override `hashCode` to ensure that objects which are "equal" (`o1.equals(o2)` returns `true`) hash to the same scala.Int. (`o1.hashCode.equals(o2.hashCode)`).

returns

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

Definition Classes
Any
18. #### abstract def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): GenIterable[B]

[use case] Builds a new collection by applying a function to all elements of this general iterable collection

[use case]

Builds a new collection by applying a function to all elements of this general iterable collection

and using the elements of the resulting collections.

For example:

`def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")`

The type of the resulting collection is guided by the static type of general iterable collection . This might cause unexpected results sometimes. For example:

```// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be a an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)```
B

the element type of the returned collection.

f

the function to apply to each element.

returns

a new general iterable collection resulting from applying the given collection-valued function `f` to each element of this general iterable collection and concatenating the results.

Definition Classes
GenTraversableLike
Full Signature

19. #### abstract def foreach(f: (A) ⇒ Unit): Unit

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

[use case]

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

f

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

Definition Classes
GenTraversableLikeGenTraversableOnce
Full Signature

20. #### def formatted(fmtstr: String): String

Returns string formatted according to given `format` string.

Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to StringFormat performed by method any2stringfmt in scala.Predef.
Definition Classes
StringFormat
Annotations
()
21. #### def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (`o1.hashCode.equals(o2.hashCode)`) yet not be equal (`o1.equals(o2)` returns `false`). A degenerate implementation could always return `0`. However, it is required that if two objects are equal (`o1.equals(o2)` returns `true`) that they have identical hash codes (`o1.hashCode.equals(o2.hashCode)`). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the `equals` method.

returns

the hash code value for this object.

Definition Classes
Any
22. #### def ifParSeq[R](isbody: (ParSeq[A]) ⇒ R): (TraversableOps[A])#Otherwise[R]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to TraversableOps[A] performed by method traversable2ops in scala.collection.parallel.
Definition Classes
TraversableOps
23. #### 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
24. #### def isParIterable: Boolean

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to TraversableOps[A] performed by method traversable2ops in scala.collection.parallel.
Definition Classes
TraversableOps
25. #### def isParSeq: Boolean

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to TraversableOps[A] performed by method traversable2ops in scala.collection.parallel.
Definition Classes
TraversableOps
26. #### def isParallel: Boolean

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to TraversableOps[A] performed by method traversable2ops in scala.collection.parallel.
Definition Classes
TraversableOps
27. #### abstract def map[B](f: (A) ⇒ B): GenIterable[B]

[use case] Builds a new collection by applying a function to all elements of this general iterable collection .

[use case]

Builds a new collection by applying a function to all elements of this general iterable collection .

B

the element type of the returned collection.

f

the function to apply to each element.

returns

a new general iterable collection resulting from applying the given function `f` to each element of this general iterable collection and collecting the results.

Definition Classes
GenTraversableLike
Full Signature

28. #### abstract def max: A

[use case] Finds the largest element.

[use case]

Finds the largest element.

returns

the largest element of this general iterable collection .

Definition Classes
GenTraversableOnce
Full Signature

29. #### abstract def min: A

[use case] Finds the smallest element.

[use case]

Finds the smallest element.

returns

the smallest element of this general iterable collection

Definition Classes
GenTraversableOnce
Full Signature

30. #### def par: ParIterable[A]

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
Parallelizable
31. #### abstract def product: A

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

[use case]

Multiplies up the elements of this collection.

returns

the product of all elements in this general iterable collection of numbers of type `Int`. Instead of `Int`, any other type `T` with an implicit `Numeric[T]` implementation can be used as element type of the general iterable collection and as result type of `product`. Examples of such types are: `Long`, `Float`, `Double`, `BigInt`.

Definition Classes
GenTraversableOnce
Full Signature

32. #### abstract def sameElements(that: GenIterable[A]): Boolean

[use case] Checks if the other iterable collection contains the same elements in the same order as this general iterable collection .

[use case]

Checks if the other iterable collection contains the same elements in the same order as this general iterable collection .

Note: might return different results for different runs, unless the underlying collection type is ordered.

Note: will not terminate for infinite-sized collections.

that

the collection to compare with.

returns

`true`, if both collections contain the same elements in the same order, `false` otherwise.

Full Signature

33. #### abstract def sum: A

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

[use case]

Sums up the elements of this collection.

returns

the sum of all elements in this general iterable collection of numbers of type `Int`. Instead of `Int`, any other type `T` with an implicit `Numeric[T]` implementation can be used as element type of the general iterable collection and as result type of `sum`. Examples of such types are: `Long`, `Float`, `Double`, `BigInt`.

Definition Classes
GenTraversableOnce
Full Signature

34. #### abstract def to[Col[_]]: Col[A]

[use case] Converts this general iterable collection into another by copying all elements.

[use case]

Converts this general iterable collection into another by copying all elements.

Note: will not terminate for infinite-sized collections.

Col

The collection type to build.

returns

a new collection containing all elements of this general iterable collection .

Definition Classes
GenTraversableOnce
Full Signature

35. #### abstract def toArray: Array[A]

[use case] Converts this general iterable collection to an array.

[use case]

Converts this general iterable collection to an array.

Note: will not terminate for infinite-sized collections.

returns

an array containing all elements of this general iterable collection . An `ClassTag` must be available for the element type of this general iterable collection .

Definition Classes
GenTraversableOnce
Full Signature

36. #### abstract def toMap[T, U]: Map[T, U]

[use case] Converts this general iterable collection to a map.

[use case]

Converts this general iterable collection 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-sized collections.

returns

a map of type `immutable.Map[T, U]` containing all key/value pairs of type `(T, U)` of this general iterable collection .

Definition Classes
GenTraversableOnce
Full Signature

37. #### def toParArray: ParArray[A]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to TraversableOps[A] performed by method traversable2ops in scala.collection.parallel.
Definition Classes
TraversableOps
38. #### def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

returns

a string representation of the object.

Definition Classes
Any
39. #### abstract def zip[B](that: GenIterable[B]): GenIterable[(A, B)]

[use case] Returns a general iterable collection formed from this general iterable collection and another iterable collection by combining corresponding elements in pairs.

[use case]

Returns a general iterable collection formed from this general iterable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

Note: might return different results for different runs, unless the underlying collection type is ordered.

B

the type of the second half of the returned pairs

that

The iterable providing the second half of each result pair

returns

a new general iterable collection containing pairs consisting of corresponding elements of this general iterable collection and `that`. The length of the returned collection is the minimum of the lengths of this general iterable collection and `that`.

Full Signature

40. #### abstract def zipAll[B](that: Iterable[B], thisElem: A, thatElem: B): GenIterable[(A, B)]

[use case] Returns a general iterable collection formed from this general iterable collection and another iterable collection by combining corresponding elements in pairs.

[use case]

Returns a general iterable collection formed from this general iterable collection and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

Note: might return different results for different runs, unless the underlying collection type is ordered.

B

the type of the second half of the returned pairs

that

The iterable providing the second half of each result pair

thisElem

the element to be used to fill up the result if this general iterable collection is shorter than `that`.

thatElem

the element to be used to fill up the result if `that` is shorter than this general iterable collection .

returns

a new general iterable collection containing pairs consisting of corresponding elements of this general iterable collection and `that`. The length of the returned collection is the maximum of the lengths of this general iterable collection and `that`. If this general iterable collection is shorter than `that`, `thisElem` values are used to pad the result. If `that` is shorter than this general iterable collection , `thatElem` values are used to pad the result.

Full Signature

41. #### abstract def zipWithIndex: GenIterable[(A, Int)]

[use case] Zips this general iterable collection with its indices.

[use case]

Zips this general iterable collection with its indices.

Note: might return different results for different runs, unless the underlying collection type is ordered.

returns

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

Full Signature

#### abstract def zipWithIndex[A1 >: A, That](implicit bf: CanBuildFrom[Repr, (A1, Int), That]): That

Example:
1. `List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))`

42. #### def →[B](y: B): (GenIterableLike[A, Repr], B)

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to ArrowAssoc[GenIterableLike[A, Repr]] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

### Shadowed Implicit Value Members

1. #### val self: Any

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to StringAdd performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
`(genIterableLike: StringAdd).self`
Definition Classes
StringAdd
2. #### val self: Any

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to StringFormat performed by method any2stringfmt in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
`(genIterableLike: StringFormat).self`
Definition Classes
StringFormat

### Deprecated Value Members

1. #### def /:\[A1 >: A](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
Annotations
Deprecated

(Since version 2.10.0) use fold instead

2. #### def x: GenIterableLike[A, Repr]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to ArrowAssoc[GenIterableLike[A, Repr]] performed by method any2ArrowAssoc in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
`(genIterableLike: ArrowAssoc[GenIterableLike[A, Repr]]).x`
Definition Classes
ArrowAssoc
Annotations
Deprecated

(Since version 2.10.0) Use `leftOfArrow instead`

3. #### def x: GenIterableLike[A, Repr]

Implicit information
This member is added by an implicit conversion from GenIterableLike[A, Repr] to Ensuring[GenIterableLike[A, Repr]] performed by method any2Ensuring in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
`(genIterableLike: Ensuring[GenIterableLike[A, Repr]]).x`
Definition Classes
Ensuring
Annotations
Deprecated

(Since version 2.10.0) Use `resultOfEnsuring instead`