The type implementing this traversable
The type implementing this traversable
A class supporting filtered operations.
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
a class object corresponding to the runtime type of the receiver.
Creates a new builder for this collection type.
Creates a new builder for this collection type.
Test two objects for inequality.
Test two objects for inequality.
true
if !(this == that), false otherwise.
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
.
a hash value consistent with ==
[use case] Returns a new traversable collection containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new traversable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the traversable 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)
the element type of the returned collection.
the traversable to append.
a new traversable collection which contains all elements of this traversable collection
followed by all elements of that
.
As with ++
, returns a new collection containing the elements from the
left operand followed by the elements from the right operand.
As with ++
, returns a new collection containing the elements from the
left operand followed by the elements from the right operand.
It differs from ++
in that the right operand determines the type of
the resulting collection rather than the left one.
Mnemonic: the COLon is on the side of the new COLlection type.
Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
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.
the element type of the returned collection.
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.
the traversable to append.
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
.
a new collection of type That
which contains all elements
of this traversable collection followed by all elements of that
.
[use case] As with ++
, returns a new collection containing the elements from the left operand followed by the
elements from the right operand.
As with ++
, returns a new collection containing the elements from the left operand followed by the
elements from the right operand.
It differs from ++
in that the right operand determines the type of
the resulting collection rather than the left one.
Mnemonic: the COLon is on the side of the new COLlection type.
Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
the element type of the returned collection.
the traversable to append.
a new traversable collection which contains all elements of this traversable collection
followed by all elements of that
.
Applies a binary operator to a start value and all elements of this traversable collection, going left to right.
Applies a binary operator to a start value and all elements of this traversable 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.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this traversable 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 traversable collection.
Applies a binary operator to all elements of this traversable collection and a start value, going right to left.
Applies a binary operator to all elements of this traversable 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
the result type of the binary operator.
the start value
the binary operator
the result of inserting op
between consecutive elements of this traversable 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 traversable collection.
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)
.
true
if the receiver object is equivalent to the argument; false
otherwise.
Appends all elements of this traversable collection to a string builder.
Appends all elements of this traversable collection to a string builder.
The written text consists of the string representations (w.r.t. the method
toString
) of all elements of this traversable collection without any separator string.
Example:
scala> val a = LinkedList(1,2,3,4) a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> val h = a.addString(b) b: StringBuilder = 1234
the string builder to which elements are appended.
the string builder b
to which elements were appended.
Appends all elements of this traversable collection to a string builder using a separator string.
Appends all elements of this traversable 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 traversable collection, separated by the string sep
.
Example:
scala> val a = LinkedList(1,2,3,4) a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b, ", ") res0: StringBuilder = 1, 2, 3, 4
the string builder to which elements are appended.
the separator string.
the string builder b
to which elements were appended.
Appends all elements of this traversable collection to a string builder using start, end, and separator strings.
Appends all elements of this traversable 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 traversable collection are separated by the string sep
.
Example:
scala> val a = LinkedList(1,2,3,4) a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b, "LinkedList(", ", ", ")") res1: StringBuilder = LinkedList(1, 2, 3, 4)
the string builder to which elements are appended.
the starting string.
the separator string.
the ending string.
the string builder b
to which elements were appended.
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).
the type of accumulated results
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)
an operator used to accumulate results within a partition
an associative operator used to combine results from different partitions
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.
the receiver object.
if the receiver object is not an instance of the erasure of type T0
.
[use case] Builds a new collection by applying a partial function to all elements of this traversable collection on which the function is defined.
Builds a new collection by applying a partial function to all elements of this traversable collection on which the function is defined.
the element type of the returned collection.
the partial function which filters and maps the traversable collection.
a new traversable 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.
Finds the first element of the traversable collection for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the traversable 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.
the partial function
an option value containing pf applied to the first
value for which it is defined, or None
if none exists.
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
[use case] Copies elements of this traversable collection to an array.
Copies elements of this traversable collection to an array.
Fills the given array xs
with at most len
elements of
this traversable collection, starting at position start
.
Copying will stop once either the end of the current traversable 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.
the array to fill.
the starting index.
the maximal number of elements to copy.
[use case] Copies values of this traversable collection to an array.
Copies values of this traversable collection to an array.
Fills the given array xs
with values of this traversable collection.
Copying will stop once either the end of the current traversable collection is reached,
or the end of the array is reached.
Note: will not terminate for infinite-sized collections.
the array to fill.
[use case] Copies values of this traversable collection to an array.
Copies values of this traversable collection to an array.
Fills the given array xs
with values of this traversable collection, beginning at index start
.
Copying will stop once either the end of the current traversable collection is reached,
or the end of the array is reached.
Note: will not terminate for infinite-sized collections.
the array to fill.
the starting index.
Copies all elements of this traversable collection to a buffer.
Copies all elements of this traversable collection to a buffer.
Note: will not terminate for infinite-sized collections.
The buffer to which elements are copied.
Counts the number of elements in the traversable collection which satisfy a predicate.
Counts the number of elements in the traversable collection which satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p
.
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.
the number of elements to drop from this traversable collection.
a traversable collection consisting of all elements of this traversable collection except the first n
ones, or else the
empty traversable collection, if this traversable collection has less than n
elements.
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.
The predicate used to test elements.
the longest suffix of this traversable collection whose first element
does not satisfy the predicate p
.
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:
x
of type Any
, x.equals(x)
should return true
.x
and y
of type Any
, x.equals(y)
should return true
if and
only if y.equals(x)
returns true
.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 Int.
(o1.hashCode.equals(o2.hashCode)
).
true
if the receiver object is equivalent to the argument; false
otherwise.
Tests whether a predicate holds for some of the elements of this traversable collection.
Tests whether a predicate holds for some of the elements of this traversable collection.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
true
if the given predicate p
holds for some of the
elements of this traversable collection, otherwise false
.
Selects all elements of this traversable collection which satisfy a predicate.
Selects all elements of this traversable collection which satisfy a predicate.
the predicate used to test elements.
a new traversable collection consisting of all elements of this traversable collection that satisfy the given
predicate p
. The order of the elements is preserved.
Selects all elements of this traversable collection which do not satisfy a predicate.
Selects all elements of this traversable collection which do not satisfy a predicate.
the predicate used to test elements.
a new traversable collection consisting of all elements of this traversable collection that do not satisfy the given
predicate p
. The order of the elements is preserved.
Finds the first element of the traversable collection satisfying a predicate, if any.
Finds the first element of the traversable 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.
the predicate used to test elements.
an option value containing the first element in the traversable collection
that satisfies p
, or None
if none exists.
[use case] Builds a new collection by applying a function to all elements of this traversable collection and using the elements of the resulting collections.
Builds a new collection by applying a function to all elements of this traversable 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 traversable 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)
the element type of the returned collection.
the function to apply to each element.
a new traversable collection resulting from applying the given collection-valued function
f
to each element of this traversable collection and concatenating the results.
Folds the elements of this traversable collection using the specified associative binary operator.
Folds the elements of this traversable collection using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
a type parameter for the binary operator, a supertype of A
.
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.)
a binary operator that must be associative
the result of applying fold operator op
between all the elements and z
Applies a binary operator to a start value and all elements of this traversable collection, going left to right.
Applies a binary operator to a start value and all elements of this traversable 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.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this traversable 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 traversable collection.
Applies a binary operator to all elements of this traversable collection and a start value, going right to left.
Applies a binary operator to all elements of this traversable 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.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this traversable 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 traversable collection.
Tests whether a predicate holds for all elements of this traversable collection.
Tests whether a predicate holds for all elements of this traversable collection.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
true
if the given predicate p
holds for all elements
of this traversable collection, otherwise false
.
[use case] Applies a function f
to all elements of this traversable collection.
Applies a function f
to all elements of this traversable collection.
Note: this method underlies the implementation of most other bulk operations. It's important to implement this method in an efficient way.
the function that is applied for its side-effect to every element.
The result of function f
is discarded.
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).
Partitions this traversable collection into a map of traversable collections according to some discriminator function.
Partitions this traversable collection into a map of traversable 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 traversable collection.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to traversable 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 traversable collection of those elements x
for which f(x)
equals k
.
Tests whether this traversable collection is known to have a finite size.
Tests whether this traversable 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.
true
if this collection is known to have finite size,
false
otherwise.
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.
the hash code value for this object.
Selects the first element of this traversable collection.
Selects the first element of this traversable collection.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the first element of this traversable collection.
if the traversable collection is empty.
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.
the first element of this traversable collection if it is nonempty,
None
if it is empty.
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.
a traversable collection consisting of all elements of this traversable collection except the last one.
if the traversable collection is empty.
Iterates over the inits of this traversable collection.
Iterates over the inits of this traversable collection. The first value will be this
traversable collection and the final one will be an empty traversable collection, with the intervening
values the results of successive applications of init
.
an iterator over all the inits of this traversable collection
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Tests whether this traversable collection is empty.
Tests whether this traversable collection is empty.
true
if the traversable collection contain no elements, false
otherwise.
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.
true
if the receiver object is an instance of erasure of type T0
; false
otherwise.
Tests whether this traversable collection can be repeatedly traversed.
Tests whether this traversable collection can be repeatedly traversed.
true
Selects the last element.
Selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The last element of this traversable collection.
If the traversable collection is empty.
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.
the last element of this traversable collection$ if it is nonempty,
None
if it is empty.
[use case] Builds a new collection by applying a function to all elements of this traversable collection.
Builds a new collection by applying a function to all elements of this traversable collection.
the element type of the returned collection.
the function to apply to each element.
a new traversable collection resulting from applying the given function
f
to each element of this traversable collection and collecting the results.
[use case] Finds the largest element.
Finds the largest element.
the largest element of this traversable collection.
[use case] Finds the smallest element.
Finds the smallest element.
the smallest element of this traversable collection
Displays all elements of this traversable collection in a string.
Displays all elements of this traversable collection in a string.
a string representation of this traversable collection. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this traversable collection follow each other without any
separator string.
Displays all elements of this traversable collection in a string using a separator string.
Displays all elements of this traversable collection in a string using a separator string.
the separator string.
a string representation of this traversable collection. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this traversable collection are separated by the string sep
.
List(1, 2, 3).mkString("|") = "1|2|3"
Displays all elements of this traversable collection in a string using start, end, and separator strings.
Displays all elements of this traversable collection in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this traversable 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 traversable collection are separated by
the string sep
.
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Tests whether the traversable collection is not empty.
Tests whether the traversable collection is not empty.
true
if the traversable collection contains at least one element, false
otherwise.
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.
a parallel implementation of this collection
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.
a combiner for the parallel collection of type ParRepr
Partitions this traversable collection in two traversable collections according to a predicate.
Partitions this traversable collection in two traversable collections according to a predicate.
the predicate on which to partition.
a pair of traversable collections: the first traversable collection consists of all elements that
satisfy the predicate p
and the second traversable collection consists of all elements
that don't. The relative order of the elements in the resulting traversable collections
is the same as in the original traversable collection.
[use case] Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the product of all elements in this traversable 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 traversable collection and as result type of product
.
Examples of such types are: Long
, Float
, Double
, BigInt
.
Reduces the elements of this traversable collection using the specified associative binary operator.
Reduces the elements of this traversable collection using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
A type parameter for the binary operator, a supertype of A
.
A binary operator that must be associative.
The result of applying reduce operator op
between all the elements if the traversable collection is nonempty.
if this traversable collection is empty.
Optionally applies a binary operator to all elements of this traversable collection, going left to right.
Optionally applies a binary operator to all elements of this traversable 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.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceLeft(op)
is this traversable collection is nonempty,
None
otherwise.
Reduces the elements of this traversable collection, if any, using the specified associative binary operator.
Reduces the elements of this traversable collection, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
A type parameter for the binary operator, a supertype of A
.
A binary operator that must be associative.
An option value containing result of applying reduce operator op
between all
the elements if the collection is nonempty, and None
otherwise.
Applies a binary operator to all elements of this traversable collection, going right to left.
Applies a binary operator to all elements of this traversable 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.
the result type of the binary operator.
the binary operator.
the result of inserting op
between consecutive elements of this traversable 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 traversable collection.
if this traversable collection is empty.
Optionally applies a binary operator to all elements of this traversable collection, going right to left.
Optionally applies a binary operator to all elements of this traversable 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.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceRight(op)
is this traversable collection is nonempty,
None
otherwise.
The collection of type traversable collection underlying this TraversableLike
object.
The collection of type traversable collection underlying this TraversableLike
object.
By default this is implemented as the TraversableLike
object itself,
but this can be overridden.
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.
element type of the resulting collection
type of the resulting collection
neutral element for the operator op
the associative operator for the scan
combiner factory which provides a combiner
a new traversable collection containing the prefix scan of the elements in this traversable collection
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.
the type of the elements in the resulting collection
the actual type of the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
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
.
collection with intermediate results
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)
the type of the elements in the resulting collection
the actual type of the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
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
.
collection with intermediate results
(Changed in version 2.9.0) The behavior of scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
The size of this traversable collection.
The size of this traversable collection.
Note: will not terminate for infinite-sized collections.
the number of elements in this traversable collection.
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.
the lowest index to include from this traversable collection.
the lowest index to EXCLUDE from this traversable collection.
a traversable collection containing the elements greater than or equal to
index from
extending up to (but not including) index until
of this traversable collection.
Splits this traversable collection into a prefix/suffix pair according to a predicate.
Splits this traversable 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.
the test predicate
a pair consisting of the longest prefix of this traversable collection whose
elements all satisfy p
, and the rest of this traversable collection.
Splits this traversable collection into two at a given position.
Splits this traversable 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.
the position at which to split.
a pair of traversable collections consisting of the first n
elements of this traversable collection, and the other elements.
Defines the prefix of this object's toString
representation.
Defines the prefix of this object's toString
representation.
a string representation which starts the result of toString
applied to this traversable collection. By default the string prefix is the
simple name of the collection class traversable collection.
[use case] Sums up the elements of this collection.
Sums up the elements of this collection.
the sum of all elements in this traversable 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 traversable collection and as result type of sum
.
Examples of such types are: Long
, Float
, Double
, BigInt
.
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.
a traversable collection consisting of all elements of this traversable collection except the first one.
if the traversable collection is empty.
Iterates over the tails of this traversable collection.
Iterates over the tails of this traversable collection. The first value will be this
traversable collection and the final one will be an empty traversable collection, with the intervening
values the results of successive applications of tail
.
an iterator over all the tails of this traversable collection
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Selects first n elements.
Selects first n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Tt number of elements to take from this traversable collection.
a traversable collection consisting only of the first n
elements of this traversable collection,
or else the whole traversable collection, if it has less than n
elements.
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.
The predicate used to test elements.
the longest prefix of this traversable collection whose elements all satisfy
the predicate p
.
The underlying collection seen as an instance of Traversable
.
The underlying collection seen as an instance of Traversable
.
By default this is implemented as the current collection object itself,
but this can be overridden.
[use case] Converts this traversable collection to an array.
Converts this traversable collection to an array.
Note: will not terminate for infinite-sized collections.
an array containing all elements of this traversable collection.
An ArrayTag
must be available for the element type of this traversable collection.
Converts this traversable collection to a mutable buffer.
Converts this traversable collection to a mutable buffer.
Note: will not terminate for infinite-sized collections.
a buffer containing all elements of this traversable collection.
A conversion from collections of type Repr
to Traversable
objects.
A conversion from collections of type Repr
to Traversable
objects.
By default this is implemented as just a cast, but this can be overridden.
Converts this traversable collection to an indexed sequence.
Converts this traversable collection to an indexed sequence.
Note: will not terminate for infinite-sized collections.
an indexed sequence containing all elements of this traversable collection.
Converts this traversable collection to an iterable collection.
Converts this traversable 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.
an Iterable
containing all elements of this traversable collection.
Returns an Iterator over the elements in this traversable collection.
Returns an Iterator over the elements in this traversable collection. Will return the same Iterator if this instance is already an Iterator.
Note: will not terminate for infinite-sized collections.
an Iterator containing all elements of this traversable collection.
Converts this traversable collection to a list.
Converts this traversable collection to a list.
Note: will not terminate for infinite-sized collections.
a list containing all elements of this traversable collection.
[use case] Converts this traversable collection to a map.
Converts this traversable 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.
a map of type immutable.Map[T, U]
containing all key/value pairs of type (T, U)
of this traversable collection.
Converts this traversable collection to a sequence.
Converts this traversable 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.
a sequence containing all elements of this traversable collection.
Converts this traversable collection to a set.
Converts this traversable collection to a set.
Note: will not terminate for infinite-sized collections.
a set containing all elements of this traversable collection.
Converts this traversable collection to a stream.
Converts this traversable collection to a stream.
Note: will not terminate for infinite-sized collections.
a stream containing all elements of this traversable collection.
Converts this traversable collection to a string.
Converts this traversable collection to a string.
a string representation of this collection. By default this
string consists of the stringPrefix
of this traversable collection, followed
by all elements separated by commas and enclosed in parentheses.
Converts this traversable collection to an unspecified Traversable.
Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite-sized collections.
a Traversable containing all elements of this traversable collection.
Creates a non-strict view of a slice of this traversable collection.
Creates a non-strict view of a slice of this traversable collection.
Note: the difference between view
and slice
is that view
produces
a view of the current traversable collection, whereas slice
produces a new traversable 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.
the index of the first element of the view
the index of the element following the view
a non-strict view of a slice of this traversable collection, starting at index from
and extending up to (but not including) index until
.
Creates a non-strict view of this traversable collection.
Creates a non-strict view of this traversable collection.
a non-strict view of this traversable collection.
Creates a non-strict filter of this traversable collection.
Creates a non-strict filter of this traversable 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.
the predicate used to test elements.
an object of class WithFilter
, which supports
map
, flatMap
, foreach
, and withFilter
operations.
All these operations apply to those elements of this traversable collection
which satisfy the predicate p
.
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
(Since version 2.10.0) use fold instead
(Since version 2.10.0) Use leftOfArrow instead
(Since version 2.10.0) Use resultOfEnsuring instead
A template trait for traversable collections of type
Traversable[A]
.This is a base trait of all kinds of Scala collections. It implements the behavior common to all collections, in terms of a method
foreach
with signature:Collection classes mixing in this trait provide a concrete
foreach
method which traverses all the elements contained in the collection, applying a given function to each. They also need to provide a methodnewBuilder
which creates a builder for collections of the same kind.A traversable class might or might not have two properties: strictness and orderedness. Neither is represented as a type.
The instances of a strict collection class have all their elements computed before they can be used as values. By contrast, instances of a non-strict collection class may defer computation of some of their elements until after the instance is available as a value. A typical example of a non-strict collection class is a scala.collection.immutable/Stream. A more general class of examples are
TraversableViews
.If a collection is an instance of an ordered collection class, traversing its elements with
foreach
will always visit elements in the same order, even for different runs of the program. If the class is not ordered,foreach
can visit elements in different orders for different runs (but it will keep the same order in the same run).'A typical example of a collection class which is not ordered is a
HashMap
of objects. The traversal order for hash maps will depend on the hash codes of its elements, and these hash codes might differ from one run to the next. By contrast, aLinkedHashMap
is ordered because it'sforeach
method visits elements in the order they were inserted into theHashMap
.