Standard accessor task that iterates over the elements of the collection.
Used to iterate elements using indices
Performs two tasks in parallel, and waits for both to finish.
An iterator that can be split into arbitrary subsets of iterators.
Sequentially performs one task after another.
A stackable modification that ensures signal contexts get passed along the iterators.
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 ==
[use case] Returns a new immutable parallel vector containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new immutable parallel vector containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable parallel vector is the most specific superclass encompassing the element types of the two operands (see example).
the element type of the returned collection.
the traversable to append.
a new collection of type That
which contains all elements
of this immutable parallel vector followed by all elements of that
.
Returns a new immutable parallel vector containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new immutable parallel vector containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable parallel vector is the most specific superclass encompassing the element types of the two operands (see example).
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 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 immutable parallel vector followed by all elements of that
.
[use case] A copy of the immutable parallel vector with an element prepended.
A copy of the immutable parallel vector with an element prepended.
the prepended element
a new collection of type That
consisting of elem
followed
by all elements of this immutable parallel vector.
A copy of the immutable parallel vector with an element prepended.
A copy of the immutable parallel vector with an element prepended.
Note that :-ending operators are right associative (see example). Also, the original immutable parallel vector is not modified, so you will want to capture the result.
Example:
scala> val x = LinkedList(1) x: scala.collection.mutable.LinkedList[Int] = LinkedList(1) scala> val y = 2 +: x y: scala.collection.mutable.LinkedList[Int] = LinkedList(2, 1) scala> println(x) LinkedList(1)
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 prepended 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
.
a new collection of type That
consisting of elem
followed
by all elements of this immutable parallel vector.
Applies a binary operator to a start value and all elements of this immutable parallel vector, going left to right.
Applies a binary operator to a start value and all elements of this immutable parallel vector, 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 start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable parallel vector,
going left to right with the start value z
on the left:
op(...op(op(z, x1), x2), ..., xn)
where x_{1}, ..., x_{n}
are the elements of this immutable parallel vector.
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
[use case] A copy of this immutable parallel vector with an element appended.
A copy of this immutable parallel vector with an element appended.
the appended element
a new collection of type That
consisting of
all elements of this immutable parallel vector followed by elem
.
A copy of this immutable parallel vector with an element appended.
A copy of this immutable parallel vector with an element appended.
Note: will not terminate for infinite-sized collections.
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 appended 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
.
a new collection of type That
consisting of
all elements of this immutable parallel vector followed by elem
.
Applies a binary operator to all elements of this immutable parallel vector and a start value, going right to left.
Applies a binary operator to all elements of this immutable parallel vector 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 start value
the binary operator
the result of inserting op
between consecutive elements of this immutable parallel vector,
going right to left with the start value z
on the right:
op(x1, op(x2, ... op(xn, z)...))
where x_{1}, ..., x_{n}
are the elements of this immutable parallel vector.
Test two objects for equality.
Test two objects for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
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 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
Selects an element by its index in the immutable parallel vector.
Selects an element by its index in the immutable parallel vector.
Example:
scala> val x = LinkedList(1, 2, 3, 4, 5) x: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4, 5) scala> x(3) res1: Int = 4
The index to select.
the element of this immutable parallel vector at index idx
, where 0
indicates the first element.
if idx
does not satisfy 0 <= idx < length
.
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
.
Create a copy of the receiver object.
[use case] Builds a new collection by applying a partial function to all elements of this immutable parallel vector on which the function is defined.
Builds a new collection by applying a partial function to all elements of this immutable parallel vector on which the function is defined.
the element type of the returned collection.
the partial function which filters and maps the immutable parallel vector.
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.
Builds a new collection by applying a partial function to all elements of this immutable parallel vector on which the function is defined.
Builds a new collection by applying a partial function to all elements of this immutable parallel vector on which the function is defined.
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 partial function which filters and maps the immutable parallel vector.
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
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.
The factory companion object that builds instances of class immutable.
The factory companion object that builds instances of class immutable.ParVector.
(or its Iterable
superclass where class immutable.ParVector is not a Seq
.)
[use case] Copies values of this immutable parallel vector to an array.
Copies values of this immutable parallel vector to an array.
Fills the given array xs
with values of this immutable parallel vector, beginning at index start
.
Copying will stop once either the end of the current immutable parallel vector is reached,
or the end of the array is reached.
the array to fill.
the starting index.
Copies values of this immutable parallel vector to an array.
Copies values of this immutable parallel vector to an array.
Fills the given array xs
with values of this immutable parallel vector, beginning at index start
.
Copying will stop once either the end of the current immutable parallel vector 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.
[use case] Copies values of this immutable parallel vector to an array.
Copies values of this immutable parallel vector to an array.
Fills the given array xs
with values of this immutable parallel vector.
Copying will stop once either the end of the current immutable parallel vector is reached,
or the end of the array is reached.
the array to fill.
Copies values of this immutable parallel vector to an array.
Copies values of this immutable parallel vector to an array.
Fills the given array xs
with values of this immutable parallel vector.
Copying will stop once either the end of the current immutable parallel vector is reached,
or the end of the array is reached.
Note: will not terminate for infinite-sized collections.
the array to fill.
Tests whether every element of this immutable parallel vector relates to the corresponding element of another parallel sequence by satisfying a test predicate.
Tests whether every element of this immutable parallel vector relates to the corresponding element of another parallel sequence by satisfying a test predicate.
This method will use abort
signalling capabilities. This means
that splitters may send and read abort
signals.
the type of the elements of that
the other parallel sequence
the test predicate, which relates elements from both sequences
true
if both parallel sequences have the same length and
p(x, y)
is true
for all corresponding elements x
of this immutable parallel vector
and y
of that
, otherwise false
Counts the number of elements in the immutable parallel vector which satisfy a predicate.
Counts the number of elements in the immutable parallel vector which satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p
.
[use case] Computes the multiset difference between this immutable parallel vector and another sequence.
Computes the multiset difference between this immutable parallel vector and another sequence.
Note: will not terminate for infinite-sized collections.
the sequence of elements to remove
a new collection of type That
which contains all elements of this immutable parallel vector
except some of occurrences of elements that also appear in that
.
If an element value x
appears
n times in that
, then the first n occurrences of x
will not form
part of the result, but any following occurrences will.
Computes the multiset difference between this immutable parallel vector and another sequence.
Computes the multiset difference between this immutable parallel vector and another sequence.
Note: will not terminate for infinite-sized collections.
the sequence of elements to remove
a new collection of type That
which contains all elements of this immutable parallel vector
except some of occurrences of elements that also appear in that
.
If an element value x
appears
n times in that
, then the first n occurrences of x
will not form
part of the result, but any following occurrences will.
Builds a new immutable parallel vector from this immutable parallel vector without any duplicate elements.
Builds a new immutable parallel vector from this immutable parallel vector without any duplicate elements.
Note: will not terminate for infinite-sized collections.
A new immutable parallel vector which contains the first occurrence of every element of this immutable parallel vector.
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 immutable parallel vector.
a immutable parallel vector consisting of all elements of this immutable parallel vector except the first n
ones, or else the
empty immutable parallel vector, if this immutable parallel vector has less than n
elements.
Drops all elements in the longest prefix of elements that satisfy the predicate, and returns a collection composed of the remaining elements.
Drops all elements in the longest prefix of elements that satisfy the predicate, and returns a collection composed of the remaining elements.
This method will use indexFlag
signalling capabilities. This means
that splitters may set and read the indexFlag
state.
The index flag is initially set to maximum integer value.
the predicate used to test the elements
a collection composed of all the elements after the longest prefix of elements
in this immutable parallel vector that satisfy the predicate pred
Tests whether this immutable parallel vector ends with the given parallel sequence.
Tests whether this immutable parallel vector ends with the given parallel sequence.
This method will use abort
signalling capabilities. This means
that splitters may send and read abort
signals.
the type of the elements of that
sequence
the sequence to test
true
if this immutable parallel vector has that
as a suffix, false
otherwise
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 equals method for arbitrary sequences.
The equals method for arbitrary sequences. Compares this sequence to some other object.
The object to compare the sequence to
true
if that
is a sequence that has the same elements as
this sequence in the same order, false
otherwise
Tests whether a predicate holds for some element of this immutable parallel vector.
Tests whether a predicate holds for some element of this immutable parallel vector.
This method will use abort
signalling capabilities. This means
that splitters may send and read abort
signals.
true if p
holds for some element, false otherwise
Selects all elements of this immutable parallel vector which satisfy a predicate.
Selects all elements of this immutable parallel vector which satisfy a predicate.
a new immutable parallel vector consisting of all elements of this immutable parallel vector that satisfy the given
predicate p
. Their order may not be preserved.
Selects all elements of this immutable parallel vector which do not satisfy a predicate.
Selects all elements of this immutable parallel vector which do not satisfy a predicate.
a new immutable parallel vector consisting of all elements of this immutable parallel vector that do not satisfy the given
predicate p
. Their order may not be preserved.
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.
Finds some element in the collection for which the predicate holds, if such an element exists.
Finds some element in the collection for which the predicate holds, if such an element exists. The element may not necessarily be the first such element in the iteration order.
If there are multiple elements obeying the predicate, the choice is nondeterministic.
This method will use abort
signalling capabilities. This means
that splitters may send and read abort
signals.
an option value with the element if such an element exists, or None
otherwise
[use case] Builds a new collection by applying a function to all elements of this immutable parallel vector and using the elements of the resulting collections.
Builds a new collection by applying a function to all elements of this immutable parallel vector and using the elements of the resulting collections. For example:
the element type of the returned collection.
the function to apply to each element.
a new collection of type That
resulting from applying the given collection-valued function
f
to each element of this immutable parallel vector and concatenating the results.
Builds a new collection by applying a function to all elements of this immutable parallel vector and using the elements of the resulting collections.
Builds a new collection by applying a function to all elements of this immutable parallel vector 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 immutable parallel vector. 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 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 function to apply to each 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
.
a new collection of type That
resulting from applying the given collection-valued function
f
to each element of this immutable parallel vector and concatenating the results.
[use case] Converts this immutable parallel vector of traversable collections into a immutable parallel vector formed by the elements of these traversable collections.
Converts this immutable parallel vector of traversable collections into a immutable parallel vector formed by the elements of these traversable collections.
the type of the elements of each traversable collection.
a new immutable parallel vector resulting from concatenating all element immutable parallel vectors.
Converts this immutable parallel vector of traversable collections into a immutable parallel vector formed by the elements of these traversable collections.
Converts this immutable parallel vector of traversable collections into a immutable parallel vector formed by the elements of these traversable collections.
The resulting collection's type will be guided by the static type of immutable parallel vector. For example:
val xs = List(Set(1, 2, 3), Set(1, 2, 3)) // xs == List(1, 2, 3, 1, 2, 3) val ys = Set(List(1, 2, 3), List(3, 2, 1)) // ys == Set(1, 2, 3)
the type of the elements of each traversable collection.
an implicit conversion which asserts that the element
type of this immutable parallel vector is a Traversable
.
a new immutable parallel vector resulting from concatenating all element immutable parallel vectors.
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 type parameter for the binary operator, a supertype of 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 immutable parallel vector, going left to right.
Applies a binary operator to a start value and all elements of this immutable parallel vector, 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 start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable parallel vector,
going left to right with the start value z
on the left:
op(...op(z, x1), x2, ..., xn)
where x_{1}, ..., x_{n}
are the elements of this immutable parallel vector.
Applies a binary operator to all elements of this immutable parallel vector and a start value, going right to left.
Applies a binary operator to all elements of this immutable parallel vector 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 start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable parallel vector,
going right to left with the start value z
on the right:
op(x1, op(x2, ... op(xn, z)...))
where x_{1}, ..., x_{n}
are the elements of this immutable parallel vector.
Tests whether a predicate holds for all elements of this immutable parallel vector.
Tests whether a predicate holds for all elements of this immutable parallel vector.
This method will use abort
signalling capabilities. This means
that splitters may send and read abort
signals.
true if p
holds for all elements, false otherwise
Applies a function f
to all the elements of immutable parallel vector in a sequential order.
Applies a function f
to all the elements of immutable parallel vector in a sequential order.
the result type of the function applied to each element, which is always discarded
function applied to each element
The generic builder that builds instances of immutable.
The generic builder that builds instances of immutable.ParVector at arbitrary element types.
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.
not specified by SLS as a member of AnyRef
Partitions this immutable parallel vector into a map of immutable parallel vectors according to some discriminator function.
Partitions this immutable parallel vector into a map of immutable parallel vectors 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 immutable parallel vector.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to immutable parallel vectors 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 immutable parallel vector of those elements x
for which f(x)
equals k
.
Hashcodes for immutable.
Hashcodes for immutable.ParVector produce a value from the hashcodes of all the elements of the immutable parallel vector.
the hash code value for this object.
[use case] Finds index of first occurrence of some value in this immutable parallel vector after or at some start index.
Finds index of first occurrence of some value in this immutable parallel vector after or at some start index.
the element value to search for.
the start index
the index >= from
of the first element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
Finds index of first occurrence of some value in this immutable parallel vector after or at some start index.
Finds index of first occurrence of some value in this immutable parallel vector after or at some start index.
Note: may not terminate for infinite-sized collections.
the type of the element elem
.
the element value to search for.
the start index
the index >= from
of the first element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
[use case] Finds index of first occurrence of some value in this immutable parallel vector.
Finds index of first occurrence of some value in this immutable parallel vector.
the element value to search for.
the index of the first element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
Finds index of first occurrence of some value in this immutable parallel vector.
Finds index of first occurrence of some value in this immutable parallel vector.
Note: may not terminate for infinite-sized collections.
the type of the element elem
.
the element value to search for.
the index of the first element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
Finds the first element satisfying some predicate.
Finds the first element satisfying some predicate.
This method will use indexFlag
signalling capabilities. This means
that splitters may set and read the indexFlag
state.
The index flag is initially set to maximum integer value.
the predicate used to test the elements
the starting offset for the search
the index >= from
of the first element of this immutable parallel vector that satisfies the predicate p
,
or -1
, if none exists
Finds index of first element satisfying some predicate.
Finds index of first element satisfying some predicate.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
the index of the first element of this immutable parallel vector that satisfies the predicate p
,
or -1
, if none exists.
[use case] Computes the multiset intersection between this immutable parallel vector and another sequence.
Computes the multiset intersection between this immutable parallel vector and another sequence.
Note: may not terminate for infinite-sized collections.
the sequence of elements to intersect with.
a new collection of type That
which contains all elements of this immutable parallel vector
which also appear in that
.
If an element value x
appears
n times in that
, then the first n occurrences of x
will be retained
in the result, but any following occurrences will be omitted.
Computes the multiset intersection between this immutable parallel vector and another sequence.
Computes the multiset intersection between this immutable parallel vector and another sequence.
Note: may not terminate for infinite-sized collections.
the sequence of elements to intersect with.
a new collection of type That
which contains all elements of this immutable parallel vector
which also appear in that
.
If an element value x
appears
n times in that
, then the first n occurrences of x
will be retained
in the result, but any following occurrences will be omitted.
Tests whether this immutable parallel vector contains given index.
Tests whether this immutable parallel vector contains given index.
The implementations of methods apply
and isDefinedAt
turn a Seq[A]
into
a PartialFunction[Int, A]
.
the index to test
true
if this immutable parallel vector contains an element at position idx
, false
otherwise.
Tests whether the immutable parallel vector is empty.
Tests whether the immutable parallel vector is empty.
true
if the immutable parallel vector contains 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.
Denotes whether this parallel collection has strict splitters.
Denotes whether this parallel collection has strict splitters.
This is true in general, and specific collection instances may choose to
override this method. Such collections will fail to execute methods
which rely on splitters being strict, i.e. returning a correct value
in the remaining
method.
This method helps ensure that such failures occur on method invocations, rather than later on and in unpredictable ways.
Tests whether this immutable parallel vector can be repeatedly traversed.
Tests whether this immutable parallel vector can be repeatedly traversed.
true
Creates a new split iterator used to traverse the elements of this collection.
Creates a new split iterator used to traverse the elements of this collection.
By default, this method is implemented in terms of the protected splitter
method.
a split iterator
[use case] Finds index of last occurrence of some value in this immutable parallel vector before or at a given end index.
Finds index of last occurrence of some value in this immutable parallel vector before or at a given end index.
the element value to search for.
the end index.
the index <= end
of the last element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
Finds index of last occurrence of some value in this immutable parallel vector before or at a given end index.
Finds index of last occurrence of some value in this immutable parallel vector before or at a given end index.
the type of the element elem
.
the element value to search for.
the end index.
the index <= end
of the last element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
[use case] Finds index of last occurrence of some value in this immutable parallel vector.
Finds index of last occurrence of some value in this immutable parallel vector.
the element value to search for.
the index of the last element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
Finds index of last occurrence of some value in this immutable parallel vector.
Finds index of last occurrence of some value in this immutable parallel vector.
Note: will not terminate for infinite-sized collections.
the type of the element elem
.
the element value to search for.
the index of the last element of this immutable parallel vector that is equal (wrt ==
)
to elem
, or -1
, if none exists.
Finds the last element satisfying some predicate.
Finds the last element satisfying some predicate.
This method will use indexFlag
signalling capabilities. This means
that splitters may set and read the indexFlag
state.
The index flag is initially set to minimum integer value.
the predicate used to test the elements
the maximum offset for the search
the index <= end
of the first element of this immutable parallel vector that satisfies the predicate p
,
or -1
, if none exists
Finds index of last element satisfying some predicate.
Finds index of last element satisfying some predicate.
Note: will not terminate for infinite-sized collections.
the predicate used to test elements.
the index of the last element of this immutable parallel vector that satisfies the predicate p
,
or -1
, if none exists.
The length of the immutable parallel vector.
The length of the immutable parallel vector.
Note: will not terminate for infinite-sized collections.
Note: xs.length
and xs.size
yield the same result.
the number of elements in this immutable parallel vector.
[use case] Builds a new collection by applying a function to all elements of this immutable parallel vector.
Builds a new collection by applying a function to all elements of this immutable parallel vector.
the element type of the returned collection.
the function to apply to each element.
a new collection of type That
resulting from applying the given function
f
to each element of this immutable parallel vector and collecting the results.
Builds a new collection by applying a function to all elements of this immutable parallel vector.
Builds a new collection by applying a function to all elements of this immutable parallel vector.
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 function to apply to each 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
.
a new collection of type That
resulting from applying the given function
f
to each element of this immutable parallel vector and collecting the results.
[use case] Finds the largest element.
Finds the largest element.
the largest element of this immutable parallel vector with respect to the ordering cmp
.
Finds the largest element.
Finds the largest element.
the largest element of this immutable parallel vector with respect to the ordering cmp
.
[use case] Finds the smallest element.
Finds the smallest element.
the smallest element of this immutable parallel vector with respect to the ordering cmp
.
Finds the smallest element.
Finds the smallest element.
the smallest element of this immutable parallel vector with respect to the ordering cmp
.
Displays all elements of this immutable parallel vector in a string.
Displays all elements of this immutable parallel vector in a string.
a string representation of this immutable parallel vector. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this immutable parallel vector follow each other without any
separator string.
Displays all elements of this immutable parallel vector in a string using a separator string.
Displays all elements of this immutable parallel vector in a string using a separator string.
the separator string.
a string representation of this immutable parallel vector. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this immutable parallel vector are separated by the string sep
.
List(1, 2, 3).mkString("|") = "1|2|3"
Displays all elements of this immutable parallel vector in a string using start, end, and separator strings.
Displays all elements of this immutable parallel vector in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this immutable parallel vector. 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 immutable parallel vector 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.
The builder that builds instances of type immutable.
The builder that builds instances of type immutable.ParVector[A]
Tests whether the immutable parallel vector is not empty.
Tests whether the immutable parallel vector is not empty.
true
if the immutable parallel vector 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.
not specified by SLS as a member of AnyRef
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.
not specified by SLS as a member of AnyRef
[use case] A copy of this immutable parallel vector with an element value appended until a given target length is reached.
A copy of this immutable parallel vector with an element value appended until a given target length is reached.
the target length
the padding value
a new collection of type That
consisting of
all elements of this immutable parallel vector followed by the minimal number of occurrences of elem
so
that the resulting collection has a length of at least len
.
A copy of this immutable parallel vector with an element value appended until a given target length is reached.
A copy of this immutable parallel vector with an element value appended until a given target length is reached.
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 target length
the padding value
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
consisting of
all elements of this immutable parallel vector followed by the minimal number of occurrences of elem
so
that the resulting collection has a length of at least len
.
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 immutable parallel vector in two immutable parallel vectors according to a predicate.
Partitions this immutable parallel vector in two immutable parallel vectors according to a predicate.
a pair of immutable parallel vectors: the first immutable parallel vector consists of all elements that
satisfy the predicate p
and the second immutable parallel vector consists of all elements
that don't. The relative order of the elements in the resulting immutable parallel vectors
may not be preserved.
[use case] Produces a new immutable parallel vector where a slice of elements in this immutable parallel vector is replaced by another sequence.
Produces a new immutable parallel vector where a slice of elements in this immutable parallel vector is replaced by another sequence.
the index of the first replaced element
the number of elements to drop in the original immutable parallel vector
a new immutable parallel vector consisting of all elements of this immutable parallel vector
except that replaced
elements starting from from
are replaced
by patch
.
Produces a new immutable parallel vector where a slice of elements in this immutable parallel vector is replaced by another sequence.
Produces a new immutable parallel vector where a slice of elements in this immutable parallel vector is replaced by another sequence.
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 index of the first replaced element
the replacement sequence
the number of elements to drop in the original immutable parallel vector
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 immutable parallel vector consisting of all elements of this immutable parallel vector
except that replaced
elements starting from from
are replaced
by patch
.
Returns the length of the longest prefix whose elements all satisfy some predicate.
Returns the length of the longest prefix whose elements all satisfy some predicate.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
the length of the longest prefix of this immutable parallel vector
such that every element of the segment satisfies the predicate p
.
[use case] Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the product of all elements of this immutable parallel vector with respect to the *
operator in num
.
Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
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 immutable parallel vector 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 type parameter for the binary operator, a supertype of T
.
A binary operator that must be associative.
The result of applying reduce operator op
between all the elements if the collection is nonempty.
if this immutable parallel vector is empty.
Optionally applies a binary operator to all elements of this immutable parallel vector, going left to right.
Optionally applies a binary operator to all elements of this immutable parallel vector, 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 binary operator.
an option value containing the result of reduceLeft(op)
is this immutable parallel vector 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 type parameter for the binary operator, a supertype of 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 immutable parallel vector, going right to left.
Applies a binary operator to all elements of this immutable parallel vector, 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 binary operator.
the result of inserting op
between consecutive elements of this immutable parallel vector,
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 immutable parallel vector.
if this immutable parallel vector is empty.
Optionally applies a binary operator to all elements of this immutable parallel vector, going right to left.
Optionally applies a binary operator to all elements of this immutable parallel vector, 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 binary operator.
an option value containing the result of reduceRight(op)
is this immutable parallel vector is nonempty,
None
otherwise.
Optionally reuses an existing combiner for better performance.
Optionally reuses an existing combiner for better performance. By default it doesn't - subclasses may override this behaviour.
The provided combiner oldc
that can potentially be reused will be either some combiner from the previous computational task, or None
if there
was no previous phase (in which case this method must return newc
).
The combiner that is the result of the previous task, or None
if there was no previous task.
The new, empty combiner that can be used.
Either newc
or oldc
.
Returns new immutable parallel vector wih elements in reversed order.
Returns new immutable parallel vector wih elements in reversed order.
Note: will not terminate for infinite-sized collections.
A new immutable parallel vector with all elements of this immutable parallel vector in reversed order.
[use case] Builds a new collection by applying a function to all elements of this immutable parallel vector and collecting the results in reversed order.
Builds a new collection by applying a function to all elements of this immutable parallel vector and collecting the results in reversed order.
the element type of the returned collection.
the function to apply to each element.
a new collection of type That
resulting from applying the given function
f
to each element of this immutable parallel vector and collecting the results in reversed order.
Note: xs.reverseMap(f)
is the same as xs.reverse.map(f)
but might be more efficient.
Builds a new collection by applying a function to all elements of this immutable parallel vector and collecting the results in reversed order.
Builds a new collection by applying a function to all elements of this immutable parallel vector and collecting the results in reversed order.
Note: will not terminate for infinite-sized collections.
Note: xs.reverseMap(f)
is the same as xs.reverse.map(f)
but might be more efficient.
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 function to apply to each 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
.
a new collection of type That
resulting from applying the given function
f
to each element of this immutable parallel vector and collecting the results in reversed order.
[use case] Checks if the other iterable collection contains the same elements in the same order as this immutable parallel vector.
Checks if the other iterable collection contains the same elements in the same order as this immutable parallel vector.
the collection to compare with.
true
, if both collections contain the same elements in the same order, false
otherwise.
Checks if the other iterable collection contains the same elements in the same order as this immutable parallel vector.
Checks if the other iterable collection contains the same elements in the same order as this immutable parallel vector.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Note: will not terminate for infinite-sized collections.
the collection to compare with.
true
, if both collections contain the same elements in the same order, false
otherwise.
[use case] Computes a prefix scan of the elements of the collection.
Computes a prefix scan of the elements of the collection.
neutral element for the operator op
the associative operator for the scan
a collection containing the prefix scan of the elements in the original collection
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
a collection containing the prefix scan of the elements in the original collection
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.
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 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)
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
Returns the length of the longest segment of elements starting at a given position satisfying some predicate.
Returns the length of the longest segment of elements starting at a given position satisfying some predicate.
This method will use indexFlag
signalling capabilities. This means
that splitters may set and read the indexFlag
state.
The index flag is initially set to maximum integer value.
the predicate used to test the elements
the starting offset for the search
the length of the longest segment of elements starting at from
and
satisfying the predicate
The size of this immutable parallel vector.
The size of this immutable parallel vector.
Note: will not terminate for infinite-sized collections.
the number of elements in this immutable parallel vector.
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.
a immutable parallel vector containing the elements greater than or equal to
index from
extending up to (but not including) index until
of this immutable parallel vector.
Splits this immutable parallel vector into a prefix/suffix pair according to a predicate.
Splits this immutable parallel vector into a prefix/suffix pair according to a predicate.
This method will use indexFlag
signalling capabilities. This means
that splitters may set and read the indexFlag
state.
The index flag is initially set to maximum integer value.
the predicate used to test the elements
a pair consisting of the longest prefix of the collection for which all
the elements satisfy pred
, and the rest of the collection
Splits this immutable parallel vector into two at a given position.
Splits this immutable parallel vector 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 immutable parallel vectors consisting of the first n
elements of this immutable parallel vector, and the other elements.
A more refined version of the iterator found in the ParallelIterable
trait,
this iterator can be split into arbitrary subsets of iterators.
A more refined version of the iterator found in the ParallelIterable
trait,
this iterator can be split into arbitrary subsets of iterators.
an iterator that can be split into subsets of precise size
Tests whether this immutable parallel vector contains the given sequence at a given index.
Tests whether this immutable parallel vector contains the given sequence at a given index.
This method will use abort
signalling capabilities. This means
that splitters may send and read abort
signals.
the parallel sequence this sequence is being searched for
the starting offset for the search
true
if there is a sequence that
starting at offset
in this sequence, false
otherwise
Tests whether this immutable parallel vector starts with the given sequence.
Tests whether this immutable parallel vector starts with the given sequence.
the sequence to test
true
if this collection has that
as a prefix, false
otherwise.
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 immutable parallel vector. By default the string prefix is the
simple name of the collection class immutable parallel vector.
[use case] Sums up the elements of this collection.
Sums up the elements of this collection.
the sum of all elements of this immutable parallel vector with respect to the +
operator in num
.
Sums up the elements of this collection.
Sums up the elements of this collection.
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 immutable parallel vector with respect to the +
operator in num
.
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 immutable parallel vector consisting of all elements of this immutable parallel vector except the first one.
if the immutable parallel vector is empty.
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 immutable parallel vector.
a immutable parallel vector consisting only of the first n
elements of this immutable parallel vector,
or else the whole immutable parallel vector, if it has less than n
elements.
Takes the longest prefix of elements that satisfy the predicate.
Takes the longest prefix of elements that satisfy the predicate.
This method will use indexFlag
signalling capabilities. This means
that splitters may set and read the indexFlag
state.
The index flag is initially set to maximum integer value.
the predicate used to test the elements
the longest prefix of this immutable parallel vector of elements that satisy the predicate pred
Some minimal number of elements after which this collection should be handled sequentially by different processors.
Some minimal number of elements after which this collection should be handled sequentially by different processors.
This method depends on the size of the collection and the parallelism level, which are both specified as arguments.
the size based on which to compute the threshold
the parallelism level based on which to compute the threshold
the maximum number of elements for performing operations sequentially
[use case] Converts this immutable parallel vector to an array.
Converts this immutable parallel vector to an array.
Note: will not terminate for infinite-sized collections.
an array containing all elements of this immutable parallel vector.
Converts this immutable parallel vector to an array.
Converts this immutable parallel vector to an array.
Note: will not terminate for infinite-sized collections.
an array containing all elements of this immutable parallel vector.
Converts this immutable parallel vector to a mutable buffer.
Converts this immutable parallel vector to a mutable buffer.
Note: will not terminate for infinite-sized collections.
a buffer containing all elements of this immutable parallel vector.
Converts this immutable parallel vector to an indexed sequence.
Converts this immutable parallel vector to an indexed sequence.
Note: will not terminate for infinite-sized collections.
an indexed sequence containing all elements of this immutable parallel vector.
Converts this immutable parallel vector to an iterable collection.
Converts this immutable parallel vector 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 immutable parallel vector.
Returns an Iterator over the elements in this immutable parallel vector.
Returns an Iterator over the elements in this immutable parallel vector. 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 immutable parallel vector.
Converts this immutable parallel vector to a list.
Converts this immutable parallel vector to a list.
Note: will not terminate for infinite-sized collections.
a list containing all elements of this immutable parallel vector.
[use case] Converts this immutable parallel vector to a map.
Converts this immutable parallel vector 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 immutable parallel vector.
Converts this immutable parallel vector to a map.
Converts this immutable parallel vector 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 immutable parallel vector.
Converts this immutable parallel vector to a sequence.
Converts this immutable parallel vector 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 immutable parallel vector.
Converts this immutable parallel vector to a set.
Converts this immutable parallel vector to a set.
Note: will not terminate for infinite-sized collections.
a set containing all elements of this immutable parallel vector.
Converts this immutable parallel vector to a stream.
Converts this immutable parallel vector to a stream.
Note: will not terminate for infinite-sized collections.
a stream containing all elements of this immutable parallel vector.
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.
Converts this immutable parallel vector to an unspecified Traversable.
Converts this immutable parallel vector 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 immutable parallel vector.
Transposes this immutable parallel vector of traversable collections into a immutable parallel vector of immutable parallel vectors.
Transposes this immutable parallel vector of traversable collections into a immutable parallel vector of immutable parallel vectors.
the type of the elements of each traversable collection.
an implicit conversion which asserts that the
element type of this immutable parallel vector is a Traversable
.
a two-dimensional immutable parallel vector of immutable parallel vectors which has as nth row the nth column of this immutable parallel vector.
(Changed in version 2.9.0) transpose
throws an IllegalArgumentException
if collections are not uniformly sized.
if all collections in this immutable parallel vector are not of the same size.
[use case] Produces a new sequence which contains all elements of this immutable parallel vector and also all elements of a given sequence.
Produces a new sequence which contains all elements of this immutable parallel vector and also all elements of
a given sequence. xs union ys
is equivalent to xs ++ ys
.
Note: will not terminate for infinite-sized collections.
the sequence to add.
a new collection of type That
which contains all elements of this immutable parallel vector
followed by all elements of that
.
Produces a new sequence which contains all elements of this immutable parallel vector and also all elements of a given sequence.
Produces a new sequence which contains all elements of this immutable parallel vector and also all elements of
a given sequence. xs union ys
is equivalent to xs ++ ys
.
Note: will not terminate for infinite-sized collections.
Another way to express this
is that xs union ys
computes the order-presevring multi-set union of xs
and ys
.
union
is hence a counter-part of diff
and intersect
which also work on multi-sets.
Note: will not terminate for infinite-sized collections.
the element type of the returned immutable parallel vector.
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 sequence to add.
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 immutable parallel vector
followed by all elements of that
.
Converts this immutable parallel vector of pairs into two collections of the first and second half of each pair.
Converts this immutable parallel vector of pairs into two collections of the first and second half of each pair.
an implicit conversion which asserts that the element type of this immutable parallel vector is a pair.
a pair immutable parallel vectors, containing the first, respectively second half of each element pair of this immutable parallel vector.
Converts this immutable parallel vector of triples into three collections of the first, second, and third element of each triple.
Converts this immutable parallel vector of triples into three collections of the first, second, and third element of each triple.
an implicit conversion which asserts that the element type of this immutable parallel vector is a triple.
a triple immutable parallel vectors, containing the first, second, respectively third member of each element triple of this immutable parallel vector.
[use case] A copy of this immutable parallel vector with one single replaced element.
A copy of this immutable parallel vector with one single replaced element.
the position of the replacement
the replacing element
a new immutable parallel vector which is a copy of this immutable parallel vector with the element at position
index replaced by
elem.
A copy of this immutable parallel vector with one single replaced element.
A copy of this immutable parallel vector with one single replaced element.
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 position of the replacement
the replacing 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
.
a new immutable parallel vector which is a copy of this immutable parallel vector with the element at position
index replaced by
elem.
[use case] Returns a immutable parallel vector formed from this immutable parallel vector and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel vector formed from this immutable parallel vector 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.
the type of the second half of the returned pairs
The iterable providing the second half of each result pair
a new collection of type That
containing pairs consisting of
corresponding elements of this immutable parallel vector and that
. The length
of the returned collection is the minimum of the lengths of this immutable parallel vector and that
.
Returns a immutable parallel vector formed from this immutable parallel vector and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel vector formed from this immutable parallel vector 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.
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.
The iterable providing the second half of each result pair
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)
.
a new collection of type That
containing pairs consisting of
corresponding elements of this immutable parallel vector and that
. The length
of the returned collection is the minimum of the lengths of this immutable parallel vector and that
.
[use case] Returns a immutable parallel vector formed from this immutable parallel vector and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel vector formed from this immutable parallel vector 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.
the iterable providing the second half of each result pair
the element to be used to fill up the result if this immutable parallel vector is shorter than that
.
the element to be used to fill up the result if that
is shorter than this immutable parallel vector.
a new collection of type That
containing pairs consisting of
corresponding elements of this immutable parallel vector and that
. The length
of the returned collection is the maximum of the lengths of this immutable parallel vector and that
.
If this immutable parallel vector is shorter than that
, thisElem
values are used to pad the result.
If that
is shorter than this immutable parallel vector, thatElem
values are used to pad the result.
Returns a immutable parallel vector formed from this immutable parallel vector and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel vector formed from this immutable parallel vector 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.
the iterable providing the second half of each result pair
the element to be used to fill up the result if this immutable parallel vector is shorter than that
.
the element to be used to fill up the result if that
is shorter than this immutable parallel vector.
a new collection of type That
containing pairs consisting of
corresponding elements of this immutable parallel vector and that
. The length
of the returned collection is the maximum of the lengths of this immutable parallel vector and that
.
If this immutable parallel vector is shorter than that
, thisElem
values are used to pad the result.
If that
is shorter than this immutable parallel vector, thatElem
values are used to pad the result.
[use case] Zips this immutable parallel vector with its indices.
Zips this immutable parallel vector with its indices.
A new collection of type That
containing pairs consisting of all elements of this
immutable parallel vector paired with their index. Indices start at 0
.
Zips this immutable parallel vector with its indices.
Zips this immutable parallel vector with its indices.
Note: might return different results for different runs, unless the underlying collection type is ordered.
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.
A new collection of type That
containing pairs consisting of all elements of this
immutable parallel vector paired with their index. Indices start at 0
.
Immutable parallel vectors, based on vectors.
This is a base trait for Scala parallel collections. It defines behaviour common to all parallel collections. Concrete parallel collections should inherit this trait and
ParIterable
if they want to define specific combiner factories.Parallel operations are implemented with divide and conquer style algorithms that parallelize well. The basic idea is to split the collection into smaller parts until they are small enough to be operated on sequentially.
All of the parallel operations are implemented as tasks within this trait. Tasks rely on the concept of splitters, which extend iterators. Every parallel collection defines:
def splitter: IterableSplitter[T]
which returns an instance of
IterableSplitter[T]
, which is a subtype ofSplitter[T]
. Parallel iterators have a methodremaining
to check the remaining number of elements, and methodsplit
which is defined by splitters. Methodsplit
divides the splitters iterate over into disjunct subsets:which splits the splitter into a sequence of disjunct subsplitters. This is typically a very fast operation which simply creates wrappers around the receiver collection. This can be repeated recursively.
Method
newCombiner
produces a new combiner. Combiners are an extension of builders. They provide a methodcombine
which combines two combiners and returns a combiner containing elements of both combiners. This method can be implemented by aggressively copying all the elements into the new combiner or by lazily binding their results. It is recommended to avoid copying all of the elements for performance reasons, although that cost might be negligible depending on the use case. Standard parallel collection combiners avoid copying when merging results, relying either on a two-step lazy construction or specific data-structure properties.Methods:
produce the sequential or parallel implementation of the collection, respectively. Method
par
just returns a reference to this parallel collection. Methodseq
is efficient - it will not copy the elements. Instead, it will create a sequential version of the collection using the same underlying data structure. Note that this is not the case for sequential collections in general - they may copy the elements and produce a different underlying data structure.The combination of methods
toMap
,toSeq
ortoSet
along withpar
andseq
is a flexible way to change between different collection types.The method:
provides an estimate on the minimum number of elements the collection has before the splitting stops and depends on the number of elements in the collection. A rule of the thumb is the number of elements divided by 8 times the parallelism level. This method may be overridden in concrete implementations if necessary.
Since this trait extends the
Iterable
trait, methods likesize
must also be implemented in concrete collections, whileiterator
forwards tosplitter
by default.Each parallel collection is bound to a specific fork/join pool, on which dormant worker threads are kept. The fork/join pool contains other information such as the parallelism level, that is, the number of processors used. When a collection is created, it is assigned the default fork/join pool found in the
scala.parallel
package object.Parallel collections are not necessarily ordered in terms of the
foreach
operation (seeTraversable
). Parallel sequences have a well defined order for iterators - creating an iterator and traversing the elements linearly will always yield the same order. However, bulk operations such asforeach
,map
orfilter
always occur in undefined orders for all parallel collections.Existing parallel collection implementations provide strict parallel iterators. Strict parallel iterators are aware of the number of elements they have yet to traverse. It's also possible to provide non-strict parallel iterators, which do not know the number of elements remaining. To do this, the new collection implementation must override
isStrictSplitterCollection
tofalse
. This will make some operations unavailable.To create a new parallel collection, extend the
ParIterable
trait, and implementsize
,parallelIterator
,newCombiner
andseq
. Having an implicit combiner factory requires extending this trait in addition, as well as providing a companion object, as with regular collections.Method
size
is implemented as a constant time operation for parallel collections, and parallel collection operations rely on this assumption.The higher-order functions passed to certain operations may contain side-effects. Since implementations of bulk operations may not be sequential, this means that side-effects may not be predictable and may produce data-races, deadlocks or invalidation of state if care is not taken. It is up to the programmer to either avoid using side-effects or to use some form of synchronization when accessing mutable data.
the element type of the vector
2.9