scala.collection.MapLike

DefaultValuesIterable

class DefaultValuesIterable extends Iterable[B]

The implementation class of the iterable returned by values.

Attributes
protected
Source
MapLike.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. DefaultValuesIterable
  2. Iterable
  3. IterableLike
  4. Equals
  5. GenIterable
  6. GenIterableLike
  7. Traversable
  8. GenTraversable
  9. GenericTraversableTemplate
  10. TraversableLike
  11. GenTraversableLike
  12. Parallelizable
  13. TraversableOnce
  14. GenTraversableOnce
  15. FilterMonadic
  16. HasNewBuilder
  17. AnyRef
  18. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultValuesIterable ()

Type Members

  1. type Self = Iterable[B]

    The type implementing this traversable

    The type implementing this traversable

    Attributes
    protected
    Definition Classes
    TraversableLike
  2. class WithFilter extends FilterMonadic[A, Repr]

    A class supporting filtered operations.

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 ++ [B >: B, That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

    Definition Classes
    TraversableLike
    Annotations
    @bridge()
  5. def ++ [B] (that: GenTraversableOnce[B]): Iterable[B]

    [use case] Concatenates this iterable collection with the elements of a traversable collection.

    [use case]

    Concatenates this iterable collection with the elements of a traversable collection.

    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

    a new collection of type That which contains all elements of this iterable collection followed by all elements of that.

    Attributes
    abstract
    Definition Classes
    GenTraversableLike
  6. def ++ [B >: B, That] (that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

    Concatenates this iterable collection with the elements of a traversable collection.

    Concatenates this iterable collection with the elements of a traversable collection.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the traversable to append.

    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

    a new collection of type That which contains all elements of this iterable collection followed by all elements of that.

    Definition Classes
    TraversableLike → GenTraversableLike
  7. def ++: [B >: B, That] (that: Traversable[B])(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

    This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

    This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions. Since TraversableOnce has no '++' method, we have to implement that directly, but Traversable and down can use the overload.

    Definition Classes
    TraversableLike
  8. def ++: [B] (that: TraversableOnce[B]): Iterable[B]

    [use case] Concatenates this iterable collection with the elements of a traversable collection.

    [use case]

    Concatenates this iterable collection with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

    a new collection of type That which contains all elements of this iterable collection followed by all elements of that.

    Attributes
    abstract
    Definition Classes
    TraversableLike
  9. def ++: [B >: B, That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

    Concatenates this iterable collection with the elements of a traversable collection.

    Concatenates this iterable collection with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the traversable to append.

    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

    a new collection of type That which contains all elements of this iterable collection followed by all elements of that.

    Definition Classes
    TraversableLike
  10. def /: [B] (z: B)(op: (B, B) ⇒ B): B

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

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

    Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft 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.

    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 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 x,,1,,, ..., x,,n,, are the elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  11. def /:\ [A1 >: B] (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.

    Definition Classes
    GenTraversableOnce
  12. def :\ [B] (z: B)(op: (B, B) ⇒ B): B

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

    Applies a binary operator to all elements of this 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.

    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 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 x,,1,,, ..., x,,n,, are the elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  13. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  14. 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
  15. def addString (b: StringBuilder): StringBuilder

    Appends all elements of this iterable collection to a string builder.

    Appends all elements of this iterable collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this iterable collection without any separator string.

    b

    the string builder to which elements are appended.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    TraversableOnce
  16. def addString (b: StringBuilder, sep: String): StringBuilder

    Appends all elements of this iterable collection to a string builder using a separator string.

    Appends all elements of this iterable collection to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this iterable collection, separated by the string sep.

    b

    the string builder to which elements are appended.

    sep

    the separator string.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    TraversableOnce
  17. def addString (b: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Appends all elements of this iterable collection to a string builder using start, end, and separator strings.

    Appends all elements of this iterable collection to a string builder using start, end, and separator strings. The written text 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 iterable collection are separated by the string sep.

    b

    the string builder to which elements are appended.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    TraversableOnce
  18. def aggregate [B] (z: B)(seqop: (B, B) ⇒ 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 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).

    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
    TraversableOnceGenTraversableOnce
  19. 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
  20. def canEqual (that: Any): Boolean

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    that

    The object with which this iterable collection should be compared

    returns

    true, if this iterable collection can possibly equal that, false otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.

    Definition Classes
    IterableLikeEquals
  21. 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()
  22. def collect [B] (pf: PartialFunction[B, B]): Iterable[B]

    [use case] Builds a new collection by applying a partial function to all elements of this iterable collection on which the function is defined.

    [use case]

    Builds a new collection by applying a partial function to all elements of this 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 iterable collection.

    returns

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

    Attributes
    abstract
    Definition Classes
    GenTraversableLike
  23. def collect [B, That] (pf: PartialFunction[B, B])(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

    Builds a new collection by applying a partial function to all elements of this iterable collection on which the function is defined.

    Builds a new collection by applying a partial function to all elements of this iterable collection on which the function is defined.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    pf

    the partial function which filters and maps the iterable collection.

    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

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

    Definition Classes
    TraversableLike → GenTraversableLike
  24. def collectFirst [B] (pf: PartialFunction[B, B]): Option[B]

    Finds the first element of the iterable collection for which the given partial function is defined, and applies the partial function to it.

    Finds the first element of the iterable collection for which the given partial function is defined, and applies the partial function to it.

    Note: may not terminate for infinite-sized collections.

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

    pf

    the partial function

    returns

    an option value containing pf applied to the first value for which it is defined, or None if none exists.

    Definition Classes
    TraversableOnce
    Example:
    1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

  25. def companion : GenericCompanion[Iterable]

    The factory companion object that builds instances of class Iterable.

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

    Definition Classes
    IterableGenIterableTraversableGenTraversableGenericTraversableTemplate
  26. def copyToArray (xs: Array[B], start: Int, len: Int): Unit

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

    [use case]

    Copies elements of this iterable collection to an array. Fills the given array xs with at most len elements of this iterable collection, starting at position start. Copying will stop once either the end of the current iterable collection is reached, or the end of the array is reached, or len elements have been copied.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    Attributes
    abstract
    Definition Classes
    TraversableLike
  27. def copyToArray [B >: B] (xs: Array[B], start: Int, len: Int): Unit

    Copies elements of this iterable collection to an array.

    Copies elements of this iterable collection to an array. Fills the given array xs with at most len elements of this iterable collection, starting at position start. Copying will stop once either the end of the current iterable collection is reached, or the end of the array is reached, or len elements have been copied.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  28. def copyToArray (xs: Array[B]): Unit

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

    [use case]

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

    xs

    the array to fill.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  29. def copyToArray [B >: B] (xs: Array[B]): Unit

    Copies values of this iterable collection to an array.

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

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    Definition Classes
    TraversableOnceGenTraversableOnce
  30. def copyToArray (xs: Array[B], start: Int): Unit

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

    [use case]

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

    xs

    the array to fill.

    start

    the starting index.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  31. def copyToArray [B >: B] (xs: Array[B], start: Int): Unit

    Copies values of this iterable collection to an array.

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

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index.

    Definition Classes
    TraversableOnceGenTraversableOnce
  32. def copyToBuffer [B >: B] (dest: Buffer[B]): Unit

    Copies all elements of this iterable collection to a buffer.

    Copies all elements of this iterable collection to a buffer.

    Note: will not terminate for infinite-sized collections.

    dest

    The buffer to which elements are copied.

    Definition Classes
    TraversableOnce
  33. def count (p: (B) ⇒ Boolean): Int

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

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

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    Definition Classes
    TraversableOnceGenTraversableOnce
  34. def drop (n: Int): Iterable[B]

    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 iterable collection.

    returns

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

    Definition Classes
    IterableLikeTraversableLike → GenTraversableLike
  35. def dropRight (n: Int): Iterable[B]

    Selects all elements except last n ones.

    Selects all elements except last n ones.

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

    n

    The number of elements to take

    returns

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

    Definition Classes
    IterableLike
  36. def dropWhile (p: (B) ⇒ Boolean): Iterable[B]

    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.

    p

    The predicate used to test elements.

    returns

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

    Definition Classes
    TraversableLike → GenTraversableLike
  37. 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
  38. 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
  39. def exists (p: (B) ⇒ Boolean): Boolean

    Tests whether a predicate holds for some of the elements of this iterable collection.

    Tests whether a predicate holds for some of the elements of this iterable collection.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for some of the elements of this iterable collection, otherwise false.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  40. def filter (p: (B) ⇒ Boolean): Iterable[B]

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

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

    p

    the predicate used to test elements.

    returns

    a new iterable collection consisting of all elements of this iterable collection that satisfy the given predicate p. The order of the elements is preserved.

    Definition Classes
    TraversableLike → GenTraversableLike
  41. def filterNot (p: (B) ⇒ Boolean): Iterable[B]

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

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

    p

    the predicate used to test elements.

    returns

    a new iterable collection consisting of all elements of this iterable collection that do not satisfy the given predicate p. The order of the elements is preserved.

    Definition Classes
    TraversableLike → GenTraversableLike
  42. 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()
  43. def find (p: (B) ⇒ Boolean): Option[B]

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

    Finds the first element of the 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.

    p

    the predicate used to test elements.

    returns

    an option value containing the first element in the iterable collection that satisfies p, or None if none exists.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  44. def flatMap [B] (f: (B) ⇒ GenTraversableOnce[B]): Iterable[B]

    [use case] Builds a new collection by applying a function to all elements of this iterable collection and concatenating the results.

    [use case]

    Builds a new collection by applying a function to all elements of this iterable collection and concatenating the results.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

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

    Attributes
    abstract
    Definition Classes
    GenTraversableLike
  45. def flatMap [B, That] (f: (B) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

    Builds a new collection by applying a function to all elements of this iterable collection and concatenating the results.

    Builds a new collection by applying a function to all elements of this iterable collection and concatenating the results.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each 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

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

    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic
  46. def flatten [B] : Iterable[B]

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

    [use case]

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

    B

    the type of the elements of each traversable collection.

    returns

    a new iterable collection resulting from concatenating all element iterable collections.

    Attributes
    abstract
    Definition Classes
    GenericTraversableTemplate
  47. def flatten [B] (implicit asTraversable: (B) ⇒ TraversableOnce[B]): Traversable[B]

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

    Converts this iterable collection of traversable collections into a iterable 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 iterable collection is a Traversable.

    returns

    a new iterable collection resulting from concatenating all element iterable collections.

    Definition Classes
    TraversableGenericTraversableTemplate
    Annotations
    @bridge()
  48. def fold [A1 >: B] (z: A1)(op: (A1, A1) ⇒ A1): A1

    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.

    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
    TraversableOnceGenTraversableOnce
  49. def foldLeft [B] (z: B)(op: (B, B) ⇒ B): B

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

    Applies a binary operator to a start value and all elements of this 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 iterable collection, going left to right with the start value z on the left:

                op(...op(z, x,,1,,), x,,2,,, ..., x,,n,,)
    

    where x,,1,,, ..., x,,n,, are the elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  50. def foldRight [B] (z: B)(op: (B, B) ⇒ B): B

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

    Applies a binary operator to all elements of this 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 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 x,,1,,, ..., x,,n,, are the elements of this iterable collection.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
  51. def forall (p: (B) ⇒ Boolean): Boolean

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

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

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for all elements of this iterable collection, otherwise false.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  52. def foreach (f: (B) ⇒ Unit): Unit

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

    [use case]

    Applies a function f to all elements of this iterable 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
    IterableLike
  53. def foreach [C] (f: (B) ⇒ C): Unit

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

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

    Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.

    f

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

    Definition Classes
    DefaultValuesIterableIterableLikeGenericTraversableTemplateTraversableLike → GenTraversableLike → TraversableOnceGenTraversableOnceFilterMonadic
  54. def genericBuilder [B] : Builder[B, Iterable[B]]

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

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

    Definition Classes
    GenericTraversableTemplate
  55. def getClass (): java.lang.Class[_ <: java.lang.Object]

    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
  56. def groupBy [K] (f: (B) ⇒ K): Map[K, Iterable[B]]

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

    Partitions this iterable collection into a map of iterable collections 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 iterable collection.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

    A map from keys to iterable collections 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 iterable collection of those elements x for which f(x) equals k.

    Definition Classes
    TraversableLike → GenTraversableLike
  57. def grouped (size: Int): Iterator[Iterable[B]]

    Partitions elements in fixed size iterable collections.

    Partitions elements in fixed size iterable collections.

    size

    the number of elements per group

    returns

    An iterator producing iterable collections of size size, except the last will be truncated if the elements don't divide evenly.

    Definition Classes
    IterableLike
    See also

    Iterator#grouped

  58. def hasDefiniteSize : Boolean

    Tests whether this iterable collection is known to have a finite size.

    Tests whether this iterable collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end.

    Note: many collection methods will not work on collections of infinite sizes.

    returns

    true if this collection is known to have finite size, false otherwise.

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
  59. 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
  60. def head : B

    Selects the first element of this iterable collection.

    Selects the first element of this iterable collection.

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

    returns

    the first element of this iterable collection.

    Definition Classes
    IterableLike → GenIterableLike → TraversableLike → GenTraversableLike
  61. def headOption : Option[B]

    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 iterable collection if it is nonempty, None if it is empty.

    Definition Classes
    TraversableLike
  62. def init : Iterable[B]

    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 iterable collection consisting of all elements of this iterable collection except the last one.

    Definition Classes
    TraversableLike
  63. def inits : Iterator[Iterable[B]]

    Iterates over the inits of this iterable collection.

    Iterates over the inits of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of init.

    returns

    an iterator over all the inits of this iterable collection

    Definition Classes
    TraversableLike
    Example:
    1. List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

  64. def isEmpty : Boolean

    Tests whether the iterable collection is empty.

    Tests whether the iterable collection is empty.

    returns

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

    Definition Classes
    IterableLike → GenIterableLike → TraversableLikeTraversableOnceGenTraversableOnce
  65. 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
  66. def isTraversableAgain : Boolean

    Tests whether this iterable collection can be repeatedly traversed.

    Tests whether this iterable collection can be repeatedly traversed.

    returns

    true

    Attributes
    final
    Definition Classes
    GenTraversableLike → GenTraversableOnce
  67. def iterator : Iterator[B]

    Creates a new iterator over all elements contained in this iterable object.

    Creates a new iterator over all elements contained in this iterable object.

    returns

    the new iterator

    Definition Classes
    DefaultValuesIterableIterableLike → GenIterableLike
  68. def last : B

    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 iterable collection.

    Definition Classes
    TraversableLike
  69. def lastOption : Option[B]

    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 iterable collection$ if it is nonempty, None if it is empty.

    Definition Classes
    TraversableLike
  70. def map [B] (f: (B) ⇒ B): Iterable[B]

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

    [use case]

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

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

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

    Attributes
    abstract
    Definition Classes
    GenTraversableLike
  71. def map [B, That] (f: (B) ⇒ B)(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

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

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

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each 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

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

    Definition Classes
    TraversableLike → GenTraversableLike → FilterMonadic
  72. def max : B

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this iterable collection with respect to the ordering cmp.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  73. def max [B >: B] (implicit cmp: Ordering[B]): B

    Finds the largest element.

    Finds the largest element.

    B

    The type over which the ordering is defined.

    cmp

    An ordering to be used for comparing elements.

    returns

    the largest element of this iterable collection with respect to the ordering cmp.

    Definition Classes
    TraversableOnceGenTraversableOnce
  74. def maxBy [B] (f: (B) ⇒ B)(implicit cmp: Ordering[B]): B

    Definition Classes
    TraversableOnceGenTraversableOnce
  75. def min : B

    [use case] Finds the smallest element.

    [use case]

    Finds the smallest element.

    returns

    the smallest element of this iterable collection with respect to the ordering cmp.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  76. def min [B >: B] (implicit cmp: Ordering[B]): B

    Finds the smallest element.

    Finds the smallest element.

    B

    The type over which the ordering is defined.

    cmp

    An ordering to be used for comparing elements.

    returns

    the smallest element of this iterable collection with respect to the ordering cmp.

    Definition Classes
    TraversableOnceGenTraversableOnce
  77. def minBy [B] (f: (B) ⇒ B)(implicit cmp: Ordering[B]): B

    Definition Classes
    TraversableOnceGenTraversableOnce
  78. def mkString : String

    Displays all elements of this iterable collection in a string.

    Displays all elements of this iterable collection in a string.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  79. def mkString (sep: String): String

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

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

    sep

    the separator string.

    returns

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

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

  80. def mkString (start: String, sep: String, end: String): String

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

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

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

  81. 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
  82. def newBuilder : Builder[B, Iterable[B]]

    The builder that builds instances of type Iterable[A]

    The builder that builds instances of type Iterable[A]

    Attributes
    protected[this]
    Definition Classes
    GenericTraversableTemplateHasNewBuilder
  83. def nonEmpty : Boolean

    Tests whether the iterable collection is not empty.

    Tests whether the iterable collection is not empty.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  84. 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
  85. 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
  86. def par : ParIterable[B]

    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
  87. def parCombiner : Combiner[B, ParIterable[B]]

    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
    TraversableLikeParallelizable
  88. def partition (p: (B) ⇒ Boolean): (Iterable[B], Iterable[B])

    Partitions this iterable collection in two iterable collections according to a predicate.

    Partitions this iterable collection in two iterable collections according to a predicate.

    p

    the predicate on which to partition.

    returns

    a pair of iterable collections: the first iterable collection consists of all elements that satisfy the predicate p and the second iterable collection consists of all elements that don't. The relative order of the elements in the resulting iterable collections is the same as in the original iterable collection.

    Definition Classes
    TraversableLike → GenTraversableLike
  89. def product : B

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

    [use case]

    Multiplies up the elements of this collection.

    returns

    the product of all elements of this iterable collection with respect to the * operator in num.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  90. def product [B >: B] (implicit num: Numeric[B]): B

    Multiplies up the elements of this collection.

    Multiplies up the elements of this collection.

    B

    the result type of the * operator.

    num

    an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

    returns

    the product of all elements of this iterable collection with respect to the * operator in num.

    Definition Classes
    TraversableOnceGenTraversableOnce
  91. def reduce [A1 >: B] (op: (A1, A1) ⇒ A1): A1

    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.

    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
    TraversableOnceGenTraversableOnce
  92. def reduceLeft [B >: B] (op: (B, B) ⇒ B): B

    Definition Classes
    TraversableOnce
  93. def reduceLeftOption [B >: B] (op: (B, B) ⇒ B): Option[B]

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

    Optionally applies a binary operator to all elements of this 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 iterable collection is nonempty, None otherwise.

    Definition Classes
    TraversableOnceGenTraversableOnce
  94. def reduceOption [A1 >: B] (op: (A1, A1) ⇒ A1): Option[A1]

    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.

    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
    TraversableOnceGenTraversableOnce
  95. def reduceRight [B >: B] (op: (B, B) ⇒ B): B

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

    Applies a binary operator to all elements of this 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 iterable collection, going right to left:

                op(x,,1,,, op(x,,2,,, ..., op(x,,n-1,,, x,,n,,)...))
    

    where x,,1,,, ..., x,,n,, are the elements of this iterable collection.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
  96. def reduceRightOption [B >: B] (op: (B, B) ⇒ B): Option[B]

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

    Optionally applies a binary operator to all elements of this 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 iterable collection is nonempty, None otherwise.

    Definition Classes
    TraversableOnceGenTraversableOnce
  97. def repr : Iterable[B]

    The collection of type iterable collection underlying this TraversableLike object.

    The collection of type iterable collection underlying this TraversableLike object. By default this is implemented as the TraversableLike object itself, but this can be overridden.

    Definition Classes
    TraversableLike → GenTraversableLike
  98. def reversed : List[B]

    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  99. def sameElements [B >: B] (that: Iterable[B]): Boolean

    Definition Classes
    IterableLike
    Annotations
    @bridge()
  100. def sameElements (that: GenIterable[B]): Boolean

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

    [use case]

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

    that

    the collection to compare with.

    returns

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

    Attributes
    abstract
    Definition Classes
    GenIterableLike
  101. def sameElements [B >: B] (that: GenIterable[B]): Boolean

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

    Checks if the other iterable collection contains the same elements in the same order as this 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.

    B

    the type of the elements of collection that.

    that

    the collection to compare with.

    returns

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

    Definition Classes
    IterableLike → GenIterableLike
  102. def scan [B >: B, That] (z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Iterable[B], 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 iterable collection containing the prefix scan of the elements in this iterable collection

    Definition Classes
    TraversableLike → GenTraversableLike
  103. def scanLeft [B, That] (z: B)(op: (B, B) ⇒ B)(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

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

    Produces a collection containing cummulative 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
    TraversableLike → GenTraversableLike
  104. def scanRight [B, That] (z: B)(op: (B, B) ⇒ B)(implicit bf: CanBuildFrom[Iterable[B], B, That]): That

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

    Produces a collection containing cummulative results of applying the operator going right to left. The head of the collection is the last cummulative 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
    TraversableLike → GenTraversableLike
    Annotations
    @migration
    Migration

    "This scanRight definition has changed in 2.9.\n" + "The previous behavior can be reproduced with scanRight.reverse."

  105. def seq : Iterable[B]

    A version of this collection with all of the operations implemented sequentially (i.

    A version of this collection with all of the operations implemented sequentially (i.e. in a single-threaded manner).

    This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

    returns

    a sequential view of the collection.

    Definition Classes
    IterableGenIterableTraversableGenTraversableParallelizableTraversableOnceGenTraversableOnce
  106. def size : Int

    The size of this iterable collection.

    The size of this iterable collection.

    Note: will not terminate for infinite-sized collections.

    returns

    the number of elements in this iterable collection.

    Definition Classes
    DefaultValuesIterable → GenTraversableLike → TraversableOnceGenTraversableOnce
  107. def slice (from: Int, until: Int): Iterable[B]

    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.

    from

    the lowest index to include from this iterable collection.

    until

    the highest index to EXCLUDE from this iterable collection.

    returns

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

    Definition Classes
    IterableLikeTraversableLike → GenTraversableLike
  108. def sliding [B >: B] (size: Int, step: Int): Iterator[Iterable[B]]

    Definition Classes
    IterableLike
  109. def sliding [B >: B] (size: Int): Iterator[Iterable[B]]

    Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.

    Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)

    size

    the number of elements per group

    returns

    An iterator producing iterable collections of size size, except the last and the only element will be truncated if there are fewer elements than size.

    Definition Classes
    IterableLike
    See also

    Iterator#sliding

  110. def span (p: (B) ⇒ Boolean): (Iterable[B], Iterable[B])

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

    Splits this 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.

    p

    the test predicate

    returns

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

    Definition Classes
    TraversableLike → GenTraversableLike
  111. def splitAt (n: Int): (Iterable[B], Iterable[B])

    Splits this iterable collection into two at a given position.

    Splits this 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 iterable collections consisting of the first n elements of this iterable collection, and the other elements.

    Definition Classes
    TraversableLike → GenTraversableLike
  112. 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 iterable collection. By default the string prefix is the simple name of the collection class iterable collection.

    Definition Classes
    TraversableLike → GenTraversableLike
  113. def sum : B

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

    [use case]

    Sums up the elements of this collection.

    returns

    the sum of all elements of this iterable collection with respect to the + operator in num.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  114. def sum [B >: B] (implicit num: Numeric[B]): B

    Sums up the elements of this collection.

    Sums up the elements of this collection.

    B

    the result type of the + operator.

    num

    an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

    returns

    the sum of all elements of this iterable collection with respect to the + operator in num.

    Definition Classes
    TraversableOnceGenTraversableOnce
  115. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  116. def tail : Iterable[B]

    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 iterable collection consisting of all elements of this iterable collection except the first one.

    Definition Classes
    TraversableLike → GenTraversableLike
  117. def tails : Iterator[Iterable[B]]

    Iterates over the tails of this iterable collection.

    Iterates over the tails of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of tail.

    returns

    an iterator over all the tails of this iterable collection

    Definition Classes
    TraversableLike
    Example:
    1. List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

  118. def take (n: Int): Iterable[B]

    Selects first n elements.

    Selects first n elements.

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

    n

    Tt number of elements to take from this iterable collection.

    returns

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

    Definition Classes
    IterableLikeTraversableLike → GenTraversableLike
  119. def takeRight (n: Int): Iterable[B]

    Selects last n elements.

    Selects last n elements.

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

    n

    the number of elements to take

    returns

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

    Definition Classes
    IterableLike
  120. def takeWhile (p: (B) ⇒ Boolean): Iterable[B]

    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.

    p

    The predicate used to test elements.

    returns

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

    Definition Classes
    IterableLikeTraversableLike → GenTraversableLike
  121. def thisCollection : Iterable[B]

    The underlying collection seen as an instance of Iterable.

    The underlying collection seen as an instance of Iterable. By default this is implemented as the current collection object itself, but this can be overridden.

    Attributes
    protected[this]
    Definition Classes
    IterableLikeTraversableLike
  122. def toArray : Array[B]

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

    [use case]

    Converts this iterable collection to an array.

    Note: will not terminate for infinite-sized collections.

    returns

    an array containing all elements of this iterable collection.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  123. def toArray [B >: B] (implicit arg0: ClassManifest[B]): Array[B]

    Converts this iterable collection to an array.

    Converts this iterable collection to an array.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array. A ClassManifest for this type must be available.

    returns

    an array containing all elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  124. def toBuffer [B >: B] : Buffer[B]

    Converts this iterable collection to a mutable buffer.

    Converts this iterable collection to a mutable buffer.

    Note: will not terminate for infinite-sized collections.

    returns

    a buffer containing all elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  125. def toCollection (repr: Iterable[B]): Iterable[B]

    A conversion from collections of type Repr to Iterable objects.

    A conversion from collections of type Repr to Iterable objects. By default this is implemented as just a cast, but this can be overridden.

    Attributes
    protected[this]
    Definition Classes
    IterableLikeTraversableLike
  126. def toIndexedSeq [B >: B] : IndexedSeq[B]

    Converts this iterable collection to an indexed sequence.

    Converts this iterable collection to an indexed sequence.

    Note: will not terminate for infinite-sized collections.

    returns

    an indexed sequence containing all elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  127. def toIterable : Iterable[B]

    Converts this iterable collection to an iterable collection.

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

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
  128. def toIterator : Iterator[B]

    Returns an Iterator over the elements in this iterable collection.

    Returns an Iterator over the elements in this 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 iterable collection.

    Definition Classes
    TraversableLikeGenTraversableOnce
  129. def toList : List[B]

    Converts this iterable collection to a list.

    Converts this iterable collection to a list.

    Note: will not terminate for infinite-sized collections.

    returns

    a list containing all elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  130. def toMap [T, U] : Map[T, U]

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

    [use case]

    Converts this 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 containing all elements of this iterable collection.

    Attributes
    abstract
    Definition Classes
    GenTraversableOnce
  131. def toMap [T, U] (implicit ev: <:<[B, (T, U)]): Map[T, U]

    Converts this iterable collection to a map.

    Converts this 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 containing all elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  132. def toSeq : Seq[B]

    Converts this iterable collection to a sequence.

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  133. def toSet [B >: B] : Set[B]

    Converts this iterable collection to a set.

    Converts this iterable collection to a set.

    Note: will not terminate for infinite-sized collections.

    returns

    a set containing all elements of this iterable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  134. def toStream : Stream[B]

    Converts this iterable collection to a stream.

    Converts this iterable collection to a stream.

    Note: will not terminate for infinite-sized collections.

    returns

    a stream containing all elements of this iterable collection.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableOnce
  135. def toString (): String

    Converts this iterable collection to a string.

    Converts this iterable collection to a string.

    returns

    a string representation of this collection. By default this string consists of the stringPrefix of this iterable collection, followed by all elements separated by commas and enclosed in parentheses.

    Definition Classes
    TraversableLike → AnyRef → Any
  136. def toTraversable : Traversable[B]

    Converts this iterable collection to an unspecified Traversable.

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

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
  137. def transpose [B] (implicit asTraversable: (B) ⇒ TraversableOnce[B]): Traversable[Traversable[B]]

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

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

    B

    the type of the elements of each traversable collection.

    asTraversable

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

    returns

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

    Definition Classes
    TraversableGenericTraversableTemplate
    Annotations
    @bridge()
  138. def unzip [A1, A2] (implicit asPair: (B) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])

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

    Converts this iterable 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 iterable collection is a pair.

    returns

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

    Definition Classes
    GenericTraversableTemplate
  139. def unzip3 [A1, A2, A3] (implicit asTriple: (B) ⇒ (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

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

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

    returns

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

    Definition Classes
    GenericTraversableTemplate
  140. def view (from: Int, until: Int): IterableView[B, Iterable[B]]

    Creates a non-strict view of a slice of this iterable collection.

    Creates a non-strict view of a slice of this iterable collection.

    Note: the difference between view and slice is that view produces a view of the current iterable collection, whereas slice produces a new iterable collection.

    Note: view(from, to) is equivalent to view.slice(from, to)

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

    from

    the index of the first element of the view

    until

    the index of the element following the view

    returns

    a non-strict view of a slice of this iterable collection, starting at index from and extending up to (but not including) index until.

    Definition Classes
    IterableLikeTraversableLike
  141. def view : IterableView[B, Iterable[B]]

    Creates a non-strict view of this iterable collection.

    Creates a non-strict view of this iterable collection.

    returns

    a non-strict view of this iterable collection.

    Definition Classes
    IterableLikeTraversableLike
  142. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  145. def withFilter (p: (B) ⇒ Boolean): FilterMonadic[B, Iterable[B]]

    Creates a non-strict filter of this iterable collection.

    Creates a non-strict filter of this iterable collection.

    Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

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

    p

    the predicate used to test elements.

    returns

    an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this iterable collection which satisfy the predicate p.

    Definition Classes
    TraversableLikeFilterMonadic
  146. def zip [A1 >: B, B, That] (that: Iterable[B])(implicit bf: CanBuildFrom[Iterable[B], (A1, B), That]): That

    Definition Classes
    IterableLike
    Annotations
    @bridge()
  147. def zip [B] (that: GenIterable[B]): Iterable[(B, B)]

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

    [use case]

    Returns a iterable collection formed from this 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.

    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 collection of type That containing pairs consisting of corresponding elements of this iterable collection and that. The length of the returned collection is the minimum of the lengths of this iterable collection and that.

    Attributes
    abstract
    Definition Classes
    GenIterableLike
  148. def zip [A1 >: B, B, That] (that: GenIterable[B])(implicit bf: CanBuildFrom[Iterable[B], (A1, B), That]): That

    Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs.

    Returns a iterable collection formed from this 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.

    A1

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

    B

    the type of the second half of the returned pairs

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, B) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, B), That]. is found.

    that

    The iterable providing the second half of each result pair

    bf

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

    returns

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

    Definition Classes
    IterableLike → GenIterableLike
  149. def zipAll [B, A1 >: B, That] (that: Iterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Iterable[B], (A1, B), That]): That

    Definition Classes
    IterableLike
    Annotations
    @bridge()
  150. def zipAll [B] (that: Iterable[B], thisElem: B, thatElem: B): Iterable[(B, B)]

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

    [use case]

    Returns a iterable collection formed from this 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.

    that

    the iterable providing the second half of each result pair

    thisElem

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

    thatElem

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

    returns

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

    Attributes
    abstract
    Definition Classes
    GenIterableLike
  151. def zipAll [B, A1 >: B, That] (that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Iterable[B], (A1, B), That]): That

    Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs.

    Returns a iterable collection formed from this 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.

    that

    the iterable providing the second half of each result pair

    thisElem

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

    thatElem

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

    returns

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

    Definition Classes
    IterableLike → GenIterableLike
  152. def zipWithIndex : Iterable[(B, Int)]

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

    [use case]

    Zips this iterable collection with its indices.

    returns

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

    Attributes
    abstract
    Definition Classes
    GenIterableLike
  153. def zipWithIndex [A1 >: B, That] (implicit bf: CanBuildFrom[Iterable[B], (A1, Int), That]): That

    Zips this iterable collection with its indices.

    Zips this iterable collection with its indices.

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

    A1

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

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, Int) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, Int), That]. is found.

    returns

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

    Definition Classes
    IterableLike → GenIterableLike
  154. def elements : Iterator[B]

    Definition Classes
    IterableLike
    Annotations
    @deprecated
    Deprecated

    use iterator' instead

  155. def first : B

    Definition Classes
    IterableLike
    Annotations
    @deprecated
    Deprecated

    use head' instead

  156. def firstOption : Option[B]

    None if iterable is empty.

    None if iterable is empty.

    Definition Classes
    IterableLike
    Annotations
    @deprecated
    Deprecated

    use headOption' instead

  157. def projection : IterableView[B, Iterable[B]]

    returns a projection that can be used to call non-strict filter, map, and flatMap methods that build projections of the collection.

    returns a projection that can be used to call non-strict filter, map, and flatMap methods that build projections of the collection.

    Definition Classes
    IterableLike
    Annotations
    @deprecated
    Deprecated

    use view' instead

Inherited from Iterable[B]

Inherited from IterableLike[B, Iterable[B]]

Inherited from Equals

Inherited from GenIterable[B]

Inherited from GenIterableLike[B, Iterable[B]]

Inherited from Traversable[B]

Inherited from GenTraversable[B]

Inherited from GenericTraversableTemplate[B, Iterable]

Inherited from TraversableLike[B, Iterable[B]]

Inherited from GenTraversableLike[B, Iterable[B]]

Inherited from Parallelizable[B, ParIterable[B]]

Inherited from TraversableOnce[B]

Inherited from GenTraversableOnce[B]

Inherited from FilterMonadic[B, Iterable[B]]

Inherited from HasNewBuilder[B, Iterable[B]]

Inherited from AnyRef

Inherited from Any