A template trait for mutable parallel maps. This trait is to be mixed in with concrete parallel maps to override the representation type.
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 key type of the map
the value type of the map
2.9
Standard accessor task that iterates over the elements of the collection.
The implementation class of the set returned by keySet.
The implementation class of the iterable returned by values.
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.
The type implementing this traversable
Sequentially performs one task after another.
A stackable modification that ensures signal contexts get passed along the iterators.
A class supporting filtered operations.
o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
[use case] Adds key/value pairs to this map, returning a new map.
Adds key/value pairs to this map, returning a new map.
the remaining key/value pairs
a new map with the given bindings added to this map
Adds key/value pairs to this map, returning a new map.
Adds key/value pairs to this map, returning a new map.
This method takes two or more key/value pairs. Another overloaded variant of this method handles the case where a single key/value pair is added.
the type of the added values
the first key/value pair
the second key/value pair
the remaining key/value pairs
a new map with the given bindings added to this map
[use case] Adds a key/value pair to this map, returning a new map.
Adds a key/value pair to this map, returning a new map.
the key/value pair
a new map with the new binding added to this map
Adds a key/value pair to this map, returning a new map.
Adds a key/value pair to this map, returning a new map.
the type of the value in the key/value pair.
the key/value pair
a new map with the new binding added to this map
[use case] Concatenates this map with the elements of a traversable collection.
Concatenates this map with the elements of a traversable collection.
the element type of the returned collection.
the traversable to append.
a new map which contains all elements of this map
followed by all elements of that.
Concatenates this map with the elements of a traversable collection.
Concatenates this map 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 map followed by all elements of that.
[use case] Adds all key/value pairs in a traversable collection to this map, returning a new map.
Adds all key/value pairs in a traversable collection to this map, returning a new map.
a new map with the given bindings added to this map
Adds all key/value pairs in a traversable collection to this map, returning a new map.
Adds all key/value pairs in a traversable collection to this map, returning a new map.
the type of the added values
a new map with the given bindings added to this map
This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.
This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions. Since TraversableOnce has no '++' method, we have to implement that directly, but Traversable and down can use the overload.
[use case] Concatenates this map with the elements of a traversable collection.
Concatenates this map with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.
the element type of the returned collection.
the traversable to append.
a new map which contains all elements of this map
followed by all elements of that.
Concatenates this map with the elements of a traversable collection.
Concatenates this map with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.
the element type of the returned collection.
the class of the returned collection. Where possible, That is
the same class as the current collection class Repr, but this
depends on the element type B being admissible for that class,
which means that an implicit instance of type CanBuildFrom[Repr, B, That]
is found.
the traversable to append.
an implicit value of class CanBuildFrom which determines
the result class That from the current representation type Repr and
and the new element type B.
a new collection of type That which contains all elements
of this map followed by all elements of that.
Creates a new map from this map with some elements removed.
Creates a new map from this map with some elements removed.
This method takes two or more elements to be removed. Another overloaded variant of this method handles the case where a single element is removed.
the first element to remove.
the second element to remove.
the remaining elements to remove.
a new map that contains all elements of the current map except one less occurrence of each of the given elements.
[use case] Removes a key from this map, returning a new map.
Removes a key from this map, returning a new map.
the key to be removed
a new map without a binding for key
Removes a key from this map, returning a new map.
Removes a key from this map, returning a new map.
the key to be removed
a new map without a binding for key
Creates a new map from this map by removing all elements of another collection.
Creates a new map from this map by removing all elements of another collection.
a new map that contains all elements of the current map
except one less occurrence of each of the elements of elems.
Applies a binary operator to a start value and all elements of this map, going left to right.
Applies a binary operator to a start value and all elements of this map, going left to right.
Note: /: is alternate syntax for foldLeft; z /: xs is the same as
xs foldLeft z.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op between consecutive elements of this map,
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 map.
Applies a binary operator to all elements of this map and a start value, going right to left.
Applies a binary operator to all elements of this map and a start value, going right to left.
Note: :\ is alternate syntax for foldRight; xs :\ z is the same as
xs foldRight z.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the start value
the binary operator
the result of inserting op between consecutive elements of this map,
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 map.
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
Appends all bindings of this map to a string builder using start, end, and separator strings.
Appends all bindings of this map to a string builder using start, end, and separator strings.
The written text begins with the string start and ends with the string
end. Inside, the string representations of all bindings of this map
in the form of key -> value are separated by the string sep.
the builder to which strings are appended.
the starting string.
the separator string.
the ending string.
the string builder b to which elements were appended.
Appends all elements of this map to a string builder.
Appends all elements of this map to a string builder.
The written text consists of the string representations (w.r.t. the method
toString) of all elements of this map without any separator string.
the string builder to which elements are appended.
the string builder b to which elements were appended.
Appends all elements of this map to a string builder using a separator string.
Appends all elements of this map to a string builder using a separator
string. The written text consists of the string representations (w.r.t.
the method toString) of all elements of this map, separated by the
string sep.
the string builder to which elements are appended.
the separator string.
the string builder b to which elements were appended.
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 this partial function with a transformation function that gets applied to results of this partial function.
Composes this partial function with a transformation function that gets applied to results of this partial function.
the result type of the transformation function.
the transformation function
a partial function with the same domain as this partial function, which maps
arguments x to k(this(x)).
Retrieves the value which is associated with the given key.
Retrieves the value which is associated with the given key. This
method invokes the default method of the map if there is no mapping
from the given key to a value. Unless overridden, the default method throws a
NoSuchElementException.
the key
the value associated with the given key, or the result of the
map's default method, if none exists.
This method is used to cast the receiver object to be of type T0.
This method is used to 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 typed.
the receiver object.
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
The object with which this map should be compared
true, if this map can possibly equal that, false otherwise. The test
takes into consideration only the run-time types of objects but ignores their elements.
This method creates and returns a copy of the receiver object.
[use case] Builds a new collection by applying a partial function to all elements of this map on which the function is defined.
Builds a new collection by applying a partial function to all elements of this map on which the function is defined.
the element type of the returned collection.
the partial function which filters and maps the map.
a new map resulting from applying the given partial function
pf to each element on which it is defined and collecting the results.
The order of the elements is preserved.
Builds a new collection by applying a partial function to all elements of this map on which the function is defined.
Builds a new collection by applying a partial function to all elements of this map 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 map.
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.
Finds the first element of the map for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the map for which the given partial function is defined, and applies the partial function to it.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the partial function
an option value containing pf applied to the first
value for which it is defined, or None if none exists.
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
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))
Tests whether this map contains a binding for a key.
Tests whether this map contains a binding for a key.
the key
true if there is a binding for key in this map, false otherwise.
[use case] Copies elements of this map to an array.
Copies elements of this map to an array.
Fills the given array xs with at most len elements of
this map, starting at position start.
Copying will stop once either the end of the current map is reached,
or the end of the array is reached, or len elements have been copied.
the array to fill.
the starting index.
the maximal number of elements to copy.
Copies elements of this map to an array.
Copies elements of this map to an array.
Fills the given array xs with at most len elements of
this map, starting at position start.
Copying will stop once either the end of the current map is reached,
or the end of the array is reached, or len elements have been copied.
the array to fill.
the starting index.
the maximal number of elements to copy.
[use case] Copies values of this map to an array.
Copies values of this map to an array.
Fills the given array xs with values of this map.
Copying will stop once either the end of the current map is reached,
or the end of the array is reached.
the array to fill.
Copies values of this map to an array.
Copies values of this map to an array.
Fills the given array xs with values of this map.
Copying will stop once either the end of the current map is reached,
or the end of the array is reached.
the type of the elements of the array.
the array to fill.
[use case] Copies values of this map to an array.
Copies values of this map to an array.
Fills the given array xs with values of this map, after skipping start values.
Copying will stop once either the end of the current map is reached,
or the end of the array is reached.
the array to fill.
the starting index.
Copies values of this map to an array.
Copies values of this map to an array.
Fills the given array xs with values of this map, after skipping start values.
Copying will stop once either the end of the current map is reached,
or the end of the array is reached.
the type of the elements of the array.
the array to fill.
the starting index.
Copies all elements of this map to a buffer.
Copies all elements of this map to a buffer.
The buffer to which elements are copied.
Counts the number of elements in the map which satisfy a predicate.
Counts the number of elements in the map which satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p.
Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.
Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.
the given key value for which a binding is missing.
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 map.
a map consisting of all elements of this map except the first n ones, or else the
empty map, if this map has less than n elements.
Selects all elements except last n ones.
Selects all elements except last n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The number of elements to take
a map consisting of all elements of this map except the last n ones, or else the
empty map, if this map 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 map that satisfy the predicate pred
use iterator' instead
The empty map of the same type as this map
The empty map of the same type as this map
an empty map of type This.
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef:
* It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true.
* It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and
only if y.eq(x) returns true.
* It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true
and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties.
* It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.
* For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
* null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
Compares two maps structurally; i.
Tests whether a predicate holds for some element of this map.
Tests whether a predicate holds for some element of this map.
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 map which satisfy a predicate.
Selects all elements of this map which satisfy a predicate.
a new map consisting of all elements of this map that satisfy the given
predicate p. The order of the elements is preserved.
Filters this map by retaining only keys satisfying a predicate.
Filters this map by retaining only keys satisfying a predicate.
the predicate used to test keys
an immutable map consisting only of those key value pairs of this map where the key satisfies
the predicate p. The resulting map wraps the original map without copying any elements.
Selects all elements of this map which do not satisfy a predicate.
Selects all elements of this map which do not satisfy a predicate.
a new map consisting of all elements of this map that do not satisfy the given
predicate p. The order of the elements is preserved.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are 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 head' instead
None if iterable is empty.
None if iterable is empty.
use headOption' instead
[use case] Builds a new collection by applying a function to all elements of this map and concatenating the results.
Builds a new collection by applying a function to all elements of this map and concatenating the results.
the element type of the returned collection.
the function to apply to each element.
a new map resulting from applying the given collection-valued function
f to each element of this map and concatenating the results.
Builds a new collection by applying a function to all elements of this map and concatenating the results.
Builds a new collection by applying a function to all elements of this map 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 map and concatenating the results.
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 map, going left to right.
Applies a binary operator to a start value and all elements of this map, going left to right.
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 map,
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 map.
Applies a binary operator to all elements of this map and a start value, going right to left.
Applies a binary operator to all elements of this map and a start value, going right to left.
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 map,
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 map.
Tests whether a predicate holds for all elements of this map.
Tests whether a predicate holds for all elements of this map.
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 map in a sequential order.
Applies a function f to all the elements of map in a sequential order.
the result type of the function applied to each element, which is always discarded
function applied to each element
Optionally returns the value associated with a key.
Optionally returns the value associated with a key.
the key value
an option value containing the value associated with key in this map,
or None if none exists.
Returns a representation that corresponds to the dynamic class of the receiver object.
Returns 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.
[use case] Returns the value associated with a key, or a default value if the key is not contained in the map.
Returns the value associated with a key, or a default value if the key is not contained in the map.
the key.
a computation that yields a default value in case no binding for key is
found in the map.
the value associated with key if it exists,
otherwise the result of the default computation.
Returns the value associated with a key, or a default value if the key is not contained in the map.
Returns the value associated with a key, or a default value if the key is not contained in the map.
the result type of the default computation.
the key.
a computation that yields a default value in case no binding for key is
found in the map.
the value associated with key if it exists,
otherwise the result of the default computation.
Partitions this map into a map of maps according to some discriminator function.
Partitions this map into a map of maps 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 map.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to maps 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 map of those elements x
for which f(x) equals k.
Partitions elements in fixed size maps.
Partitions elements in fixed size maps.
the number of elements per group
An iterator producing maps of size size, except the
last will be truncated if the elements don't divide evenly.
Iterator#grouped
Tests whether this map is known to have a finite size.
Tests whether this map is known to have a finite size.
All strict collections are known to have finite size. For a non-strict collection
such as Stream, the predicate returns true if all elements have been computed.
It returns false if the stream is not yet evaluated to the end.
Note: many collection methods will not work on collections of infinite sizes.
true if this collection is known to have finite size, false otherwise.
Returns a hash code value for the object.
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet
not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0.
However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals method.
the hash code value for the object.
Selects the first element of this map.
Selects the first element of this map.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the first element of this map.
Optionally selects the first element.
Optionally selects the first element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the first element of this map if it is nonempty, None if it is empty.
Selects all elements except the last.
Selects all elements except the last.
Note: might return different results for different runs, unless the underlying collection type is ordered.
a map consisting of all elements of this map except the last one.
Iterates over the inits of this map.
Iterates over the inits of this map. The first value will be this
map and the final one will be an empty map, with the intervening
values the results of successive applications of init.
an iterator over all the inits of this map
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Tests whether this map contains a binding for a key.
Tests whether this map contains a binding for a key. This method,
which implements an abstract method of trait PartialFunction,
is equivalent to contains.
the key
true if there is a binding for key in this map, false otherwise.
Tests whether the map is empty.
Tests whether the map is empty.
true if the map does not contain any key/value binding, false otherwise.
This method is used to test whether the dynamic type of the receiver object is T0.
This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test 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 requested typed.
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 map can be repeatedly traversed.
Tests whether this map 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 parallelIterator method.
a split iterator
Collects all keys of this map in a set.
Collects all keys of this map in a set.
a set containing all keys of this map.
Creates an iterator for all keys.
Creates an iterator for all keys.
an iterator over all keys.
Creates an iterator for all keys.
Selects the last element.
Selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The last element of this map.
Optionally selects the last element.
Optionally selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the last element of this map$ if it is nonempty, None if it is empty.
Turns this partial function into an plain function returning an Option result.
Turns this partial function into an plain function returning an Option result.
a function that takes an argument x to Some(this(x)) if this
is defined for x, and to None otherwise.
Function.unlift
[use case] Builds a new collection by applying a function to all elements of this map.
Builds a new collection by applying a function to all elements of this map.
the element type of the returned collection.
the function to apply to each element.
a new map resulting from applying the given function
f to each element of this map and collecting the results.
Builds a new collection by applying a function to all elements of this map.
Builds a new collection by applying a function to all elements of this map.
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 map and collecting the results.
use mapValues' instead
Transforms this map by applying a function to every retrieved value.
Transforms this map by applying a function to every retrieved value.
the function used to transform values of this map.
a map view which maps every key of this map
to f(this(key)). The resulting map wraps the original map without copying any elements.
[use case] Finds the largest element.
Finds the largest element.
the largest element of this map.
Finds the largest element.
Finds the largest element.
the largest element of this map with respect to the ordering cmp.
[use case] Finds the smallest element.
Finds the smallest element.
the smallest element of this map
Finds the smallest element.
Finds the smallest element.
the smallest element of this map with respect to the ordering cmp.
Displays all elements of this map in a string.
Displays all elements of this map in a string.
a string representation of this map. In the resulting string
the string representations (w.r.t. the method toString)
of all elements of this map follow each other without any
separator string.
Displays all elements of this map in a string using a separator string.
Displays all elements of this map in a string using a separator string.
the separator string.
a string representation of this map. In the resulting string
the string representations (w.r.t. the method toString)
of all elements of this map are separated by the string sep.
List(1, 2, 3).mkString("|") = "1|2|3"
Displays all elements of this map in a string using start, end, and separator strings.
Displays all elements of this map in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this map. 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 map are separated by
the string sep.
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
The newBuilder operation returns a parallel builder assigned to this collection's fork/join pool.
The newBuilder operation returns a parallel builder assigned to this collection's fork/join pool.
This method forwards the call to newCombiner.
Tests whether the map is not empty.
Tests whether the map is not empty.
true if the map 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.
Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.
Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.
the argument type of the fallback function
the result type of the fallback function
the fallback function
a partial function which has as domain the union of the domains
of this partial function and that. The resulting partial function
takes x to this(x) where this is defined, and to that(x) where it is not.
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
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
Partitions this map in two maps according to a predicate.
Partitions this map in two maps according to a predicate.
a pair of maps: the first map consists of all elements that
satisfy the predicate p and the second map consists of all elements
that don't. The relative order of the elements in the resulting maps
is the same as in the original map.
[use case] Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the product of all elements in this map of numbers of type Int.
Instead of Int, any other type T with an implicit Numeric[T] implementation
can be used as element type of the map and as result type of product.
Examples of such types are: Long, Float, Double, BigInt.
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 map with respect to the * operator in num.
returns a projection that can be used to call non-strict filter,
map, and flatMap methods that build projections
of the collection.
returns a projection that can be used to call non-strict filter,
map, and flatMap methods that build projections
of the collection.
use view' instead
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 the operations on elements are performed 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.
Applies a binary operator to all elements of this map, going left to right.
Applies a binary operator to all elements of this map, going left to right.
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 map,
going left to right:
op(...(op(x,,1,,, x,,2,,), ... ) , x,,n,,)
where x,,1,,, ..., x,,n,, are the elements of this map.
Optionally applies a binary operator to all elements of this map, going left to right.
Optionally applies a binary operator to all elements of this map, going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceLeft(op) is this map 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 the operations on elements are performed 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 map, going right to left.
Applies a binary operator to all elements of this map, going right to left.
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 map,
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 map.
Optionally applies a binary operator to all elements of this map, going right to left.
Optionally applies a binary operator to all elements of this map, going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceRight(op) is this map is nonempty,
None otherwise.
The collection of type map underlying this TraversableLike object.
The collection of type map underlying this TraversableLike object.
By default this is implemented as the TraversableLike object itself,
but this can be overridden.
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 map.
Checks if the other iterable collection contains the same elements in the same order as this map.
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 map.
Checks if the other iterable collection contains the same elements in the same order as this map.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the type of the elements of collection that.
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 new map containing the prefix scan of the elements in this map
Computes a prefix scan of the elements of the collection.
Computes a prefix scan of the elements of the collection.
Note: The neutral element z may be applied more than once.
element type of the resulting collection
type of the resulting collection
neutral element for the operator op
the associative operator for the scan
combiner factory which provides a combiner
a 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: might return different results for different runs, unless the underlying collection type is ordered.
the type of the elements in the resulting collection
the actual type of the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
an implicit value of class CanBuildFrom which determines
the result class That from the current representation type Repr and
and the new element type B.
collection with intermediate results
Produces a collection containing 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: might return different results for different runs, unless the underlying collection type is ordered.
Example:
List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
the type of the elements in the resulting collection
the actual type of the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
an implicit value of class CanBuildFrom which determines
the result class That from the current representation type Repr and
and the new element type B.
collection with intermediate results
A version of this collection with all of the operations implemented sequentially (i.
A version of this collection with all of the operations implemented sequentially (i.e. in a single-threaded manner).
This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.
a sequential view of the collection.
The size of this map.
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 map containing the elements greater than or equal to
index from extending up to (but not including) index until
of this map.
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
the number of elements per group
An iterator producing maps of size size, except the
last and the only element will be truncated if there are
fewer elements than size.
Iterator#sliding
Splits this map into a prefix/suffix pair according to a predicate.
Splits this map 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 map into two at a given position.
Splits this map 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 maps consisting of the first n
elements of this map, and the other elements.
Defines the prefix of this object's toString representation.
Defines the prefix of this object's toString representation.
a string representation which starts the result of toString applied to this map.
Unless overridden in subclasses, the string prefix of every map is "Map".
[use case] Sums up the elements of this collection.
Sums up the elements of this collection.
the sum of all elements in this map of numbers of type Int.
Instead of Int, any other type T with an implicit Numeric[T] implementation
can be used as element type of the map and as result type of sum.
Examples of such types are: Long, Float, Double, BigInt.
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 map 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 map consisting of all elements of this map except the first one.
Iterates over the tails of this map.
Iterates over the tails of this map. The first value will be this
map and the final one will be an empty map, with the intervening
values the results of successive applications of tail.
an iterator over all the tails of this map
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Selects first n elements.
Selects first n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Tt number of elements to take from this map.
a map consisting only of the first n elements of this map,
or else the whole map, if it has less than n elements.
Selects last n elements.
Selects last n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the number of elements to take
a map consisting only of the last n elements of this map, or else the
whole map, 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 map of elements that satisy the predicate pred
The underlying collection seen as an instance of Map.
The underlying collection seen as an instance of Map.
By default this is implemented as the current collection object itself,
but this can be overridden.
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 map to an array.
Converts this map to an array.
an array containing all elements of this map.
A ClassManifest must be available for the element type of this map.
Converts this map to an array.
Converts this map to an array.
an array containing all elements of this map.
Converts this map to a mutable buffer.
Converts this map to a mutable buffer.
a buffer containing all elements of this map.
A conversion from collections of type Repr to Map objects.
A conversion from collections of type Repr to Map objects.
By default this is implemented as just a cast, but this can be overridden.
Converts this map to an indexed sequence.
Converts this map to an indexed sequence.
an indexed sequence containing all elements of this map.
Converts this map to an iterable collection.
Converts this map 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).
an Iterable containing all elements of this map.
Returns an Iterator over the elements in this map.
Returns an Iterator over the elements in this map. Will return the same Iterator if this instance is already an Iterator.
an Iterator containing all elements of this map.
Converts this map to a list.
Converts this map to a list.
a list containing all elements of this map.
[use case] Converts this map to a map.
Converts this map 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.
a map of type immutable.Map[T, U]
containing all key/value pairs of type (T, U) of this map.
Converts this map to a map.
Converts this map 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.
a map containing all elements of this map.
Converts this map to a sequence.
Converts this map to a sequence. As with toIterable, it's lazy
in this default implementation, as this TraversableOnce may be
lazy and unevaluated.
a sequence containing all elements of this map.
Converts this map to a set.
Converts this map to a set.
a set containing all elements of this map.
Converts this map to a stream.
Converts this map to a stream.
a stream containing all elements of this map.
Converts this map to a string.
Converts this map to a string.
a string representation of this collection. By default this
string consists of the stringPrefix of this map,
followed by all elements separated by commas and enclosed in parentheses.
Converts this map to an unspecified Traversable.
Converts this map to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
a Traversable containing all elements of this map.
[use case] Creates a new map obtained by updating this map with a given key/value pair.
Creates a new map obtained by updating this map with a given key/value pair.
the key
the value
A new map with the new key/value mapping added to this map.
Creates a new map obtained by updating this map with a given key/value pair.
Creates a new map obtained by updating this map with a given key/value pair.
the type of the added value
the key
the value
A new map with the new key/value mapping added to this map.
Collects all values of this map in an iterable collection.
Collects all values of this map in an iterable collection.
the values of this map as an iterable.
Creates an iterator for all values in this map.
Creates an iterator for all values in this map.
an iterator over all values that are associated with some key in this map.
Creates a non-strict view of this map.
Creates a non-strict view of this map.
a non-strict view of this map.
Creates a non-strict view of a slice of this map.
Creates a non-strict view of a slice of this map.
Note: the difference between view and slice is that view produces
a view of the current map, whereas slice produces a new map.
Note: view(from, to) is equivalent to view.slice(from, to)
Note: might return different results for different runs, unless the underlying collection type is ordered.
the index of the first element of the view
the index of the element following the view
a non-strict view of a slice of this map, starting at index from
and extending up to (but not including) index until.
Creates a non-strict filter of this map.
Creates a non-strict filter of this map.
Note: the difference between c filter p and c withFilter p is that
the former creates a new collection, whereas the latter only
restricts the domain of subsequent map, flatMap, foreach,
and withFilter operations.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the predicate used to test elements.
an object of class WithFilter, which supports
map, flatMap, foreach, and withFilter operations.
All these operations apply to those elements of this map which
satisfy the predicate p.
[use case] Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs.
Returns a map formed from this map 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 map containing pairs consisting of
corresponding elements of this map and that. The length
of the returned collection is the minimum of the lengths of this map and that.
Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs.
Returns a map formed from this map 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 map and that. The length
of the returned collection is the minimum of the lengths of this map and that.
[use case] Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs.
Returns a map formed from this map 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 type of the second half of the returned pairs
The iterable providing the second half of each result pair
the element to be used to fill up the result if this map is shorter than that.
the element to be used to fill up the result if that is shorter than this map.
a new map containing pairs consisting of
corresponding elements of this map and that. The length
of the returned collection is the maximum of the lengths of this map and that.
If this map is shorter than that, thisElem values are used to pad the result.
If that is shorter than this map, thatElem values are used to pad the result.
Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs.
Returns a map formed from this map 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 map is shorter than that.
the element to be used to fill up the result if that is shorter than this map.
a new collection of type That containing pairs consisting of
corresponding elements of this map and that. The length
of the returned collection is the maximum of the lengths of this map and that.
If this map is shorter than that, thisElem values are used to pad the result.
If that is shorter than this map, thatElem values are used to pad the result.
[use case] Zips this map with its indices.
Zips this map with its indices.
A new map containing pairs consisting of all elements of this
map paired with their index. Indices start at 0.
@example
List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))
Zips this map with its indices.
Zips this map 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
map paired with their index. Indices start at 0.
A template trait for mutable parallel maps. This trait is to be mixed in with concrete parallel maps to override the representation type.
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.