Finds the first element of the traversable or iterator satisfying a predicate, if any.
Finds the first element of the traversable or iterator 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 or iterator
that satisfies p
, or None
if none exists.
Presently these are abstract because the Traversable versions use breakable/break, and I wasn't sure enough of how that's supposed to function to consolidate them with the Iterator versions.
Presently these are abstract because the Traversable versions use breakable/break, and I wasn't sure enough of how that's supposed to function to consolidate them with the Iterator versions.
Self-documenting abstract methods.
Self-documenting abstract methods.
Tests whether the traversable or iterator is empty.
Tests whether the traversable or iterator is empty.
true
if the traversable or iterator contains no elements, false
otherwise.
Tests whether this traversable or iterator can be repeatedly traversed.
Tests whether this traversable or iterator can be repeatedly traversed. Always true for Traversables and false for Iterators unless overridden.
true
if it is repeatedly traversable, false
otherwise.
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.
a sequential view of the collection.
Returns an Iterator over the elements in this traversable or iterator.
Returns an Iterator over the elements in this traversable or iterator. 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 or iterator.
Converts this traversable or iterator to a stream.
Converts this traversable or iterator to a stream.
Note: will not terminate for infinite-sized collections.
a stream containing all elements of this traversable or iterator.
Converts this traversable or iterator to an unspecified Traversable.
Converts this traversable or iterator 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 or iterator.
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.
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.
a hash value consistent with ==
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Applies a binary operator to a start value and all elements of this traversable or iterator, 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.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this traversable or iterator,
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 traversable or iterator.
A syntactic sugar for out of order folding.
A syntactic sugar for out of order folding. See fold
.
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Applies a binary operator to all elements of this traversable or iterator 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.
the result type of the binary operator.
the start value
the binary operator
the result of inserting op
between consecutive elements of this traversable or iterator,
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 traversable or iterator.
Test two objects for equality.
Test two objects for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
Appends all elements of this traversable or iterator to a string builder.
Appends all elements of this traversable or iterator to a string builder.
The written text consists of the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator without any separator string.
the string builder to which elements are appended.
the string builder b
to which elements were appended.
Appends all elements of this traversable or iterator to a string builder using a separator string.
Appends all elements of this traversable or iterator 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 or iterator, separated by the
string sep
.
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 or iterator to a string builder using start, end, and separator strings.
Appends all elements of this traversable or iterator 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 or iterator are separated by the string sep
.
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 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 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.
Create a copy of the receiver object.
Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the traversable or iterator 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 values of this traversable or iterator to an array.
Copies values of this traversable or iterator to an array.
Fills the given array xs
with values of this traversable or iterator.
Copying will stop once either the end of the current traversable or iterator is reached,
or the end of the array is reached.
the array to fill.
Copies values of this traversable or iterator to an array.
Copies values of this traversable or iterator to an array.
Fills the given array xs
with values of this traversable or iterator.
Copying will stop once either the end of the current traversable or iterator is reached,
or the end of the array is reached.
Note: will not terminate for infinite-sized collections.
the type of the elements of the array.
the array to fill.
[use case] Copies values of this traversable or iterator to an array.
Copies values of this traversable or iterator to an array.
Fills the given array xs
with values of this traversable or iterator, beginning at index start
.
Copying will stop once either the end of the current traversable or iterator is reached,
or the end of the array is reached.
the array to fill.
the starting index.
Copies values of this traversable or iterator to an array.
Copies values of this traversable or iterator to an array.
Fills the given array xs
with values of this traversable or iterator, beginning at index start
.
Copying will stop once either the end of the current traversable or iterator is reached,
or the end of the array is reached.
Note: will not terminate for infinite-sized collections.
the type of the elements of the array.
the array to fill.
the starting index.
Copies all elements of this traversable or iterator to a buffer.
Copies all elements of this traversable or iterator 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 or iterator which satisfy a predicate.
Counts the number of elements in the traversable or iterator which satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p
.
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:
x
and y
of type AnyRef
, multiple invocations of
x.eq(y)
consistently returns true
or consistently returns false
.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
).
true
if the argument is a reference to the receiver object; false
otherwise.
The equality method for reference types.
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.
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
.
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)
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 or iterator, going left to right.
Applies a binary operator to a start value and all elements of this traversable or iterator, 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 or iterator,
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 traversable or iterator.
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Applies a binary operator to all elements of this traversable or iterator 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 or iterator,
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 traversable or iterator.
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.
a representation that corresponds to the dynamic class of the receiver object.
The hashCode method for reference types.
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.
[use case] Finds the largest element.
Finds the largest element.
the largest element of this traversable or iterator with respect to the ordering cmp
.
Finds the largest element.
Finds the largest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the largest element of this traversable or iterator with respect to the ordering cmp
.
[use case] Finds the smallest element.
Finds the smallest element.
the smallest element of this traversable or iterator with respect to the ordering cmp
.
Finds the smallest element.
Finds the smallest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the smallest element of this traversable or iterator with respect to the ordering cmp
.
Displays all elements of this traversable or iterator in a string.
Displays all elements of this traversable or iterator in a string.
a string representation of this traversable or iterator. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this traversable or iterator follow each other without any
separator string.
Displays all elements of this traversable or iterator in a string using a separator string.
Displays all elements of this traversable or iterator in a string using a separator string.
the separator string.
a string representation of this traversable or iterator. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this traversable or iterator are separated by the string sep
.
List(1, 2, 3).mkString("|") = "1|2|3"
Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this traversable or iterator. 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 or iterator are separated by
the string sep
.
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Equivalent to !(this eq that)
.
Equivalent to !(this eq that)
.
true
if the argument is not a reference to the receiver object; false
otherwise.
Tests whether the traversable or iterator is not empty.
Tests whether the traversable or iterator is not empty.
true
if the traversable or iterator contains at least one element, false
otherwise.
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.
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.
[use case] Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the product of all elements of this traversable or iterator with respect to the *
operator in num
.
Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the result type of the *
operator.
an implicit parameter defining a set of numeric operations
which includes the *
operator to be used in forming the product.
the product of all elements of this traversable or iterator with respect to the *
operator in num
.
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
.
A binary operator that must be associative.
The result of applying reduce operator op
between all the elements if the collection is nonempty.
Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Optionally applies a binary operator to all elements of this traversable or iterator, 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 or iterator is nonempty,
None
otherwise.
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
.
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 or iterator, going right to left.
Applies a binary operator to all elements of this traversable or iterator, 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 or iterator,
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 traversable or iterator.
Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Optionally applies a binary operator to all elements of this traversable or iterator, 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 or iterator is nonempty,
None
otherwise.
The size of this traversable or iterator.
The size of this traversable or iterator.
Note: will not terminate for infinite-sized collections.
the number of elements in this traversable or iterator.
[use case] Sums up the elements of this collection.
Sums up the elements of this collection.
the sum of all elements of this traversable or iterator with respect to the +
operator in num
.
Sums up the elements of this collection.
Sums up the elements of this collection.
the result type of the +
operator.
an implicit parameter defining a set of numeric operations
which includes the +
operator to be used in forming the sum.
the sum of all elements of this traversable or iterator with respect to the +
operator in num
.
[use case] Converts this traversable or iterator to an array.
Converts this traversable or iterator to an array.
Note: will not terminate for infinite-sized collections.
an array containing all elements of this traversable or iterator.
Converts this traversable or iterator to an array.
Converts this traversable or iterator to an array.
Note: will not terminate for infinite-sized collections.
the type of the elements of the array. A ClassManifest
for
this type must be available.
an array containing all elements of this traversable or iterator.
Converts this traversable or iterator to a mutable buffer.
Converts this traversable or iterator to a mutable buffer.
Note: will not terminate for infinite-sized collections.
a buffer containing all elements of this traversable or iterator.
Converts this traversable or iterator to an indexed sequence.
Converts this traversable or iterator to an indexed sequence.
Note: will not terminate for infinite-sized collections.
an indexed sequence containing all elements of this traversable or iterator.
Converts this traversable or iterator to an iterable collection.
Converts this traversable or iterator 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 or iterator.
Converts this traversable or iterator to a list.
Converts this traversable or iterator to a list.
Note: will not terminate for infinite-sized collections.
a list containing all elements of this traversable or iterator.
[use case] Converts this traversable or iterator to a map.
Converts this traversable or iterator 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 containing all elements of this traversable or iterator.
Converts this traversable or iterator to a map.
Converts this traversable or iterator 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 containing all elements of this traversable or iterator.
Converts this traversable or iterator to a sequence.
Converts this traversable or iterator 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 or iterator.
Converts this traversable or iterator to a set.
Converts this traversable or iterator to a set.
Note: will not terminate for infinite-sized collections.
a set containing all elements of this traversable or iterator.
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
a String representation of the object.
A template trait for collections which can be traversed either once only or one or more times.
This trait exists primarily to eliminate code duplication between
Iterator
andTraversable
, and thus implements some of the common methods that can be implemented solely in terms of foreach without access to aBuilder
. It also includes a number of abstract methods whose implementations are provided byIterator
,Traversable
, etc. It contains implementations common toIterators
andTraversables
, such as folds, conversions, and other operations which traverse some or all of the elements and return a derived value. Directly subclassingTraversableOnce
is not recommended - instead, consider declaring anIterator
with anext
andhasNext
method, creating anIterator
with one of the methods on theIterator
object, or declaring a subclass ofTraversable
.the element type of the collection
2.8
2.8