scala.collection.parallel.immutable
Standard accessor task that iterates over the elements of the collection.
Performs two tasks in parallel, and waits for both to finish.
Parallel iterators are split iterators that have additional accessor and
transformer methods defined in terms of methods next and hasNext.
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 ==
Computes the intersection between this set and another set.
Computes the intersection between this set and another set.
Note: Same as intersect.
the set to intersect with.
a new set consisting of all elements that are both in this
set and in the given set that.
The difference of this set and another set.
The difference of this set and another set.
Note: Same as diff.
the set of elements to exclude.
a set containing those elements of this
set that are not also contained in the given set that.
[use case] Concatenates this immutable parallel hash set with the elements of a traversable collection.
Concatenates this immutable parallel hash set with the elements of a traversable collection.
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 hash set followed by all elements of that.
Concatenates this immutable parallel hash set with the elements of a traversable collection.
Concatenates this immutable parallel hash set with the elements of a traversable collection.
the class of the returned collection. Where possible, That is
the same class as the current collection class Repr, but this
depends on the element type B being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, B, That]
is found.
the traversable to append.
an implicit value of class CanBuildFrom which determines
the result class That from the current representation type Repr and
and the new element type B.
a new collection of type That which contains all elements
of this immutable parallel hash set followed by all elements of that.
Applies a binary operator to a start value and all elements of this immutable parallel hash set, going left to right.
Applies a binary operator to a start value and all elements of this immutable parallel hash set, 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 start value.
the binary operator.
the result of inserting op between consecutive elements of this immutable parallel hash set,
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 immutable parallel hash set.
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 immutable parallel hash set and a start value, going right to left.
Applies a binary operator to all elements of this immutable parallel hash set 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 start value
the binary operator
the result of inserting op between consecutive elements of this immutable parallel hash set,
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 immutable parallel hash set.
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
Composes two instances of Function1 in a new Function1, with this function applied first.
Composes two instances of Function1 in a new Function1, with this function applied first.
the result type of function g
a function R => A
a new function f such that f(x) == g(apply(x))
Tests if some element is contained in this set.
Tests if some element is contained in this set.
This method is equivalent to contains. It allows sets to be interpreted as predicates.
the element to test for membership.
true if elem is contained in this set, false otherwise.
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.
[use case] Builds a new collection by applying a partial function to all elements of this immutable parallel hash set on which the function is defined.
Builds a new collection by applying a partial function to all elements of this immutable parallel hash set on which the function is defined.
the element type of the returned collection.
the partial function which filters and maps the immutable parallel hash set.
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 hash set on which the function is defined.
Builds a new collection by applying a partial function to all elements of this immutable parallel hash set 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 hash set.
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.ParHashSet.
(or its Iterable superclass where class immutable.ParHashSet is not a Seq.)
Composes two instances of Function1 in a new Function1, with this function applied last.
Composes two instances of Function1 in a new Function1, with this function applied last.
the type to which function g can be applied
a function A => T1
a new function f such that f(x) == apply(g(x))
[use case] Copies values of this immutable parallel hash set to an array.
Copies values of this immutable parallel hash set to an array.
Fills the given array xs with values of this immutable parallel hash set, beginning at index start.
Copying will stop once either the end of the current immutable parallel hash set is reached,
or the end of the array is reached.
the array to fill.
the starting index.
Copies values of this immutable parallel hash set to an array.
Copies values of this immutable parallel hash set to an array.
Fills the given array xs with values of this immutable parallel hash set, beginning at index start.
Copying will stop once either the end of the current immutable parallel hash set 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 hash set to an array.
Copies values of this immutable parallel hash set to an array.
Fills the given array xs with values of this immutable parallel hash set.
Copying will stop once either the end of the current immutable parallel hash set is reached,
or the end of the array is reached.
the array to fill.
Copies values of this immutable parallel hash set to an array.
Copies values of this immutable parallel hash set to an array.
Fills the given array xs with values of this immutable parallel hash set.
Copying will stop once either the end of the current immutable parallel hash set is reached,
or the end of the array is reached.
Note: will not terminate for infinite-sized collections.
the array to fill.
Counts the number of elements in the immutable parallel hash set which satisfy a predicate.
Counts the number of elements in the immutable parallel hash set which satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p.
Computes the difference of this set and another set.
Computes the difference of this set and another set.
the set of elements to exclude.
a set containing those elements of this
set that are not also contained in the given set that.
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 hash set.
a immutable parallel hash set consisting of all elements of this immutable parallel hash set except the first n ones, or else the
empty immutable parallel hash set, if this immutable parallel hash set 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 hash set that satisfy the predicate pred
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.
Compares this set with another object for equality.
Compares this set with another object for equality.
Note: This operation contains an unchecked cast: if that
is a set, it will assume with an unchecked cast
that it has the same element type as this set.
Any subsequent ClassCastException is treated as a false result.
the other object
true if that is a set which contains the same elements
as this set.
Tests whether a predicate holds for some element of this immutable parallel hash set.
Tests whether a predicate holds for some element of this immutable parallel hash set.
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 hash set which satisfy a predicate.
Selects all elements of this immutable parallel hash set which satisfy a predicate.
a new immutable parallel hash set consisting of all elements of this immutable parallel hash set that satisfy the given
predicate p. Their order may not be preserved.
Selects all elements of this immutable parallel hash set which do not satisfy a predicate.
Selects all elements of this immutable parallel hash set which do not satisfy a predicate.
a new immutable parallel hash set consisting of all elements of this immutable parallel hash set 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 hash set and concatenating the results.
Builds a new collection by applying a function to all elements of this immutable parallel hash set and concatenating the results.
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 hash set and concatenating the results.
Builds a new collection by applying a function to all elements of this immutable parallel hash set and concatenating the results.
Builds a new collection by applying a function to all elements of this immutable parallel hash set and concatenating the results.
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 hash set and concatenating the results.
[use case] Converts this immutable parallel hash set of traversable collections into a immutable parallel hash set in which all element collections are concatenated.
Converts this immutable parallel hash set of traversable collections into a immutable parallel hash set in which all element collections are concatenated.
the type of the elements of each traversable collection.
a new immutable parallel hash set resulting from concatenating all element immutable parallel hash sets.
Converts this immutable parallel hash set of traversable collections into a immutable parallel hash set in which all element collections are concatenated.
Converts this immutable parallel hash set of traversable collections into a immutable parallel hash set in which all element collections are concatenated.
the type of the elements of each traversable collection.
an implicit conversion which asserts that the element
type of this immutable parallel hash set is a Traversable.
a new immutable parallel hash set resulting from concatenating all element immutable parallel hash sets.
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 hash set, going left to right.
Applies a binary operator to a start value and all elements of this immutable parallel hash set, 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 hash set,
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 immutable parallel hash set.
Applies a binary operator to all elements of this immutable parallel hash set and a start value, going right to left.
Applies a binary operator to all elements of this immutable parallel hash set 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 hash set,
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 immutable parallel hash set.
Tests whether a predicate holds for all elements of this immutable parallel hash set.
Tests whether a predicate holds for all elements of this immutable parallel hash set.
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 hash set in a sequential order.
Applies a function f to all the elements of immutable parallel hash set 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.ParHashSet 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.
Partitions this immutable parallel hash set into a map of immutable parallel hash sets according to some discriminator function.
Partitions this immutable parallel hash set into a map of immutable parallel hash sets 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 hash set.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to immutable parallel hash sets 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 hash set of those elements x
for which f(x) equals k.
The hashCode method for reference types.
The hashCode method for reference types. See hashCode in Any.
the hash code value for this object.
Computes the intersection between this set and another set.
Computes the intersection between this set and another set.
the set to intersect with.
a new set consisting of all elements that are both in this
set and in the given set that.
Tests whether the immutable parallel hash set is empty.
Tests whether the immutable parallel hash set is empty.
true if the immutable parallel hash set 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 hash set can be repeatedly traversed.
Tests whether this immutable parallel hash set 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] Builds a new collection by applying a function to all elements of this immutable parallel hash set.
Builds a new collection by applying a function to all elements of this immutable parallel hash set.
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 hash set and collecting the results.
Builds a new collection by applying a function to all elements of this immutable parallel hash set.
Builds a new collection by applying a function to all elements of this immutable parallel hash set.
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 hash set and collecting the results.
[use case] Finds the largest element.
Finds the largest element.
the largest element of this immutable parallel hash set with respect to the ordering cmp.
Finds the largest element.
Finds the largest element.
the largest element of this immutable parallel hash set with respect to the ordering cmp.
[use case] Finds the smallest element.
Finds the smallest element.
the smallest element of this immutable parallel hash set with respect to the ordering cmp.
Finds the smallest element.
Finds the smallest element.
the smallest element of this immutable parallel hash set with respect to the ordering cmp.
Displays all elements of this immutable parallel hash set in a string.
Displays all elements of this immutable parallel hash set in a string.
a string representation of this immutable parallel hash set. In the resulting string
the string representations (w.r.t. the method toString)
of all elements of this immutable parallel hash set follow each other without any
separator string.
Displays all elements of this immutable parallel hash set in a string using a separator string.
Displays all elements of this immutable parallel hash set in a string using a separator string.
the separator string.
a string representation of this immutable parallel hash set. In the resulting string
the string representations (w.r.t. the method toString)
of all elements of this immutable parallel hash set are separated by the string sep.
List(1, 2, 3).mkString("|") = "1|2|3"
Displays all elements of this immutable parallel hash set in a string using start, end, and separator strings.
Displays all elements of this immutable parallel hash set 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 hash set. 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 hash set 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.ParHashSet[A]
Tests whether the immutable parallel hash set is not empty.
Tests whether the immutable parallel hash set is not empty.
true if the immutable parallel hash set 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.
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 hash set in two immutable parallel hash sets according to a predicate.
Partitions this immutable parallel hash set in two immutable parallel hash sets according to a predicate.
a pair of immutable parallel hash sets: the first immutable parallel hash set consists of all elements that
satisfy the predicate p and the second immutable parallel hash set consists of all elements
that don't. The relative order of the elements in the resulting immutable parallel hash sets
may not be preserved.
[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 hash set 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 hash set 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.
Optionally applies a binary operator to all elements of this immutable parallel hash set, going left to right.
Optionally applies a binary operator to all elements of this immutable parallel hash set, 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 hash set 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 hash set, going right to left.
Applies a binary operator to all elements of this immutable parallel hash set, 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 hash set,
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 hash set.
Optionally applies a binary operator to all elements of this immutable parallel hash set, going right to left.
Optionally applies a binary operator to all elements of this immutable parallel hash set, 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 hash set 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.
[use case] Checks if the other iterable collection contains the same elements in the same order as this immutable parallel hash set.
Checks if the other iterable collection contains the same elements in the same order as this immutable parallel hash set.
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 hash set.
Checks if the other iterable collection contains the same elements in the same order as this immutable parallel hash set.
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
The size of this immutable parallel hash set.
The size of this immutable parallel hash set.
Note: will not terminate for infinite-sized collections.
the number of elements in this immutable parallel hash set.
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 hash set containing the elements greater than or equal to
index from extending up to (but not including) index until
of this immutable parallel hash set.
Splits this immutable parallel hash set into a prefix/suffix pair according to a predicate.
Splits this immutable parallel hash set 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 hash set into two at a given position.
Splits this immutable parallel hash set 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 hash sets consisting of the first n
elements of this immutable parallel hash set, and the other elements.
Creates a new parallel iterator used to traverse the elements of this parallel collection.
Creates a new parallel iterator used to traverse the elements of this parallel collection.
This iterator is more specific than the iterator of the returned by iterator, and augmented
with additional accessor and transformer methods.
a parallel iterator
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 hash set. By default the string prefix is the
simple name of the collection class immutable parallel hash set.
Tests whether this set is a subset of another set.
Tests whether this set is a subset of another set.
the set to test.
true if this set is a subset of that, i.e. if
every element of this set is also an element of that.
[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 hash set 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 hash set 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 hash set consisting of all elements of this immutable parallel hash set except the first one.
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 hash set.
a immutable parallel hash set consisting only of the first n elements of this immutable parallel hash set,
or else the whole immutable parallel hash set, 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 hash set 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 hash set to an array.
Converts this immutable parallel hash set to an array.
Note: will not terminate for infinite-sized collections.
an array containing all elements of this immutable parallel hash set.
Converts this immutable parallel hash set to an array.
Converts this immutable parallel hash set to an array.
Note: will not terminate for infinite-sized collections.
an array containing all elements of this immutable parallel hash set.
Converts this immutable parallel hash set to a mutable buffer.
Converts this immutable parallel hash set to a mutable buffer.
Note: will not terminate for infinite-sized collections.
a buffer containing all elements of this immutable parallel hash set.
Converts this immutable parallel hash set to an indexed sequence.
Converts this immutable parallel hash set to an indexed sequence.
Note: will not terminate for infinite-sized collections.
an indexed sequence containing all elements of this immutable parallel hash set.
Converts this immutable parallel hash set to an iterable collection.
Converts this immutable parallel hash set 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 hash set.
Returns an Iterator over the elements in this immutable parallel hash set.
Returns an Iterator over the elements in this immutable parallel hash set. 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 hash set.
Converts this immutable parallel hash set to a list.
Converts this immutable parallel hash set to a list.
Note: will not terminate for infinite-sized collections.
a list containing all elements of this immutable parallel hash set.
[use case] Converts this immutable parallel hash set to a map.
Converts this immutable parallel hash set 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 hash set.
Converts this immutable parallel hash set to a map.
Converts this immutable parallel hash set 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 hash set.
Converts this immutable parallel hash set to a sequence.
Converts this immutable parallel hash set 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 hash set.
Converts this immutable parallel hash set to a set.
Converts this immutable parallel hash set to a set.
Note: will not terminate for infinite-sized collections.
a set containing all elements of this immutable parallel hash set.
Converts this immutable parallel hash set to a stream.
Converts this immutable parallel hash set to a stream.
Note: will not terminate for infinite-sized collections.
a stream containing all elements of this immutable parallel hash set.
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 hash set to an unspecified Traversable.
Converts this immutable parallel hash set 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 hash set.
Transposes this immutable parallel hash set of traversable collections into a immutable parallel hash set of immutable parallel hash sets.
Transposes this immutable parallel hash set of traversable collections into a immutable parallel hash set of immutable parallel hash sets.
the type of the elements of each traversable collection.
an implicit conversion which asserts that the
element type of this immutable parallel hash set is a Traversable.
a two-dimensional immutable parallel hash set of immutable parallel hash sets which has as nth row the nth column of this immutable parallel hash set.
"As of 2.9, transpose throws an exception if collections are not uniformly sized."
Computes the union between of set and another set.
Computes the union between of set and another set.
the set to form the union with.
a new set consisting of all elements that are in this
set or in the given set that.
Converts this immutable parallel hash set of pairs into two collections of the first and second half of each pair.
Converts this immutable parallel hash set 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 hash set is a pair.
a pair immutable parallel hash sets, containing the first, respectively second half of each element pair of this immutable parallel hash set.
Converts this immutable parallel hash set of triples into three collections of the first, second, and third element of each triple.
Converts this immutable parallel hash set of triples into three collections of the first, second, and third element of each triple.
a triple immutable parallel hash sets, containing the first, second, respectively third member of each element triple of this immutable parallel hash set.
[use case] Returns a immutable parallel hash set formed from this immutable parallel hash set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel hash set formed from this immutable parallel hash set 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 hash set and that. The length
of the returned collection is the minimum of the lengths of this immutable parallel hash set and that.
Returns a immutable parallel hash set formed from this immutable parallel hash set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel hash set formed from this immutable parallel hash set 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 hash set and that. The length
of the returned collection is the minimum of the lengths of this immutable parallel hash set and that.
[use case] Returns a immutable parallel hash set formed from this immutable parallel hash set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel hash set formed from this immutable parallel hash set 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 hash set is shorter than that.
the element to be used to fill up the result if that is shorter than this immutable parallel hash set.
a new collection of type That containing pairs consisting of
corresponding elements of this immutable parallel hash set and that. The length
of the returned collection is the maximum of the lengths of this immutable parallel hash set and that.
If this immutable parallel hash set is shorter than that, thisElem values are used to pad the result.
If that is shorter than this immutable parallel hash set, thatElem values are used to pad the result.
Returns a immutable parallel hash set formed from this immutable parallel hash set and another iterable collection by combining corresponding elements in pairs.
Returns a immutable parallel hash set formed from this immutable parallel hash set 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 hash set is shorter than that.
the element to be used to fill up the result if that is shorter than this immutable parallel hash set.
a new collection of type That containing pairs consisting of
corresponding elements of this immutable parallel hash set and that. The length
of the returned collection is the maximum of the lengths of this immutable parallel hash set and that.
If this immutable parallel hash set is shorter than that, thisElem values are used to pad the result.
If that is shorter than this immutable parallel hash set, thatElem values are used to pad the result.
[use case] Zips this immutable parallel hash set with its indices.
Zips this immutable parallel hash set with its indices.
A new collection of type That containing pairs consisting of all elements of this
immutable parallel hash set paired with their index. Indices start at 0.
Zips this immutable parallel hash set with its indices.
Zips this immutable parallel hash set 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 hash set paired with their index. Indices start at 0.
Computes the union between this set and another set.
Computes the union between this set and another set.
Note: Same as union.
the set to form the union with.
a new set consisting of all elements that are in this
set or in the given set that.
Immutable parallel hash set, based on hash tries.
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
ParIterableif 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 methodremainingto check the remaining number of elements, and methodsplitwhich is defined by splitters. Methodsplitdivides the splitters iterate over into disjunct subsets:def split: Seq[Splitter]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
newCombinerproduces a new combiner. Combiners are an extension of builders. They provide a methodcombinewhich 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:
def seq: Sequential def par: Reprproduce the sequential or parallel implementation of the collection, respectively. Method
parjust returns a reference to this parallel collection. Methodseqis 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,toSeqortoSetalong withparandseqis a flexible way to change between different collection types.The method:
def threshold(sz: Int, p: Int): Intprovides 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
Iterabletrait, methods likesizemust also be implemented in concrete collections, whileiteratorforwards tosplitterby 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.parallelpackage object.Parallel collections are not necessarily ordered in terms of the
foreachoperation (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,maporfilteralways 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
isStrictSplitterCollectiontofalse. This will make some operations unavailable.To create a new parallel collection, extend the
ParIterabletrait, and implementsize,parallelIterator,newCombinerandseq. Having an implicit combiner factory requires extending this trait in addition, as well as providing a companion object, as with regular collections.Method
sizeis 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 set
2.9