The implementation class of the set returned by keySet
.
The implementation class of the iterable returned by values
.
The type implementing this traversable
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.
Creates a new map containing two or more key/value mappings and all the key/value mappings of this map.
Creates a new map containing two or more key/value mappings and all the key/value mappings of this map.
Specified mappings will override existing mappings from this map with the same keys.
the type of the added values
the first element to add.
the second element to add.
the remaining elements to add.
a new map containing mappings of this map and two or more specified mappings.
Creates a new map containing a new key/value mapping and all the key/value mappings of this map.
Creates a new map containing a new key/value mapping and all the key/value mappings of this map.
Mapping kv
will override existing mappings from this map with the same key.
the type of the value in the key/value pair.
the key/value mapping to be added
a new map containing mappings of this map and the mapping kv
.
Creates a new map containing the key/value mappings provided by the specified traversable object and all the key/value mappings of this map.
Creates a new map containing the key/value mappings provided by the specified traversable object and all the key/value mappings of this map.
Note that existing mappings from this map with the same key as those in xs
will be overriden.
the type of the added values
the traversable object.
a new map containing mappings of this map and those provided by xs
.
[use case] Concatenates this multimap with the elements of a traversable collection.
Concatenates this multimap with the elements of a traversable collection.
the traversable to append.
a new multimap which contains all elements of this multimap
followed by all elements of that
.
Concatenates this multimap with the elements of a traversable collection.
Concatenates this multimap with the elements of a traversable collection.
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 multimap
followed by all elements of that
.
adds all elements produced by a TraversableOnce to this multimap.
adds all elements produced by a TraversableOnce to this multimap.
the multimap itself.
adds two or more elements to this multimap.
adds two or more elements to this multimap.
the first element to add.
the second element to add.
the remaining elements to add.
the multimap itself
Adds a new key/value pair to this map.
Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of the two or more specified keys.
Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of the two or more specified keys.
the first element to remove.
the second element to remove.
the remaining elements to remove.
a new map containing all the mappings of this map except mappings
with a key equal to elem1
, elem2
or any of elems
.
Creates a new map with all the key/value mappings of this map except the key/value mapping with the specified key.
Creates a new map with all the key/value mappings of this map except the key/value mapping with the specified key.
the key to be removed
a new map with all the mappings of this map except that with a key key
.
Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of those provided by the specified traversable object.
Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of those provided by the specified traversable object.
the traversable object.
a new map with all the key/value mappings of this map except mappings
with a key equal to a key from xs
.
Removes all elements produced by an iterator from this multimap.
Removes all elements produced by an iterator from this multimap.
the multimap itself
Removes two or more elements from this multimap.
Removes two or more elements from this multimap.
the first element to remove.
the second element to remove.
the remaining elements to remove.
the multimap itself
Removes a key from this map.
Removes a key from this map.
the key to be removed
the map itself.
Applies a binary operator to a start value and all elements of this multimap, going left to right.
Applies a binary operator to a start value and all elements of this multimap, 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 multimap,
going left to right with the start value z
on the left:
op(...op(op(z, x1), x2), ..., xn)
where x,,1,,, ..., x,,n,,
are the elements of this multimap.
Applies a binary operator to all elements of this multimap and a start value, going right to left.
Applies a binary operator to all elements of this multimap 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 multimap,
going right to left with the start value z
on the right:
op(x1, op(x2, ... op(xn, z)...))
where x,,1,,, ..., x,,n,,
are the elements of this multimap.
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.
use addBinding instead
Assigns the specified value
to a specified key
, replacing
the existing value assigned to that key
if it is equal to
the specified value.
Assigns the specified value
to a specified key
, replacing
the existing value assigned to that key
if it is equal to
the specified value. Otherwise, simply adds another binding to
the key
.
The key to which to bind the new value.
The value to bind to the key.
A reference to this multimap.
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 multimap to a string builder.
Appends all elements of this multimap to a string builder.
The written text consists of the string representations (w.r.t. the method toString
)
of all elements of this multimap 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 multimap to a string builder using a separator string.
Appends all elements of this multimap 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 multimap, 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.
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 expression1.asInstanceOf[String]
will throw a ClassCastException
at runtime, while the expressionList(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 multimap should be compared
true
, if this multimap can possibly equal that
, false
otherwise. The test
takes into consideration only the run-time types of objects but ignores their elements.
Removes all bindings from the map.
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 multimap on which the function is defined.
Builds a new collection by applying a partial function to all elements of this multimap on which the function is defined.
the element type of the returned collection.
the partial function which filters and maps the multimap.
a new multimap 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 multimap on which the function is defined.
Builds a new collection by applying a partial function to all elements of this multimap on which the function is defined.
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 partial function which filters and maps the multimap.
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 MultiMap
The factory companion object that builds instances of class MultiMap
2.8
1 is not a Seq
.)
(f compose g)(x) == f(g(x))
(f compose g)(x) == f(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 multimap to an array.
Copies elements of this multimap to an array.
Fills the given array xs
with at most len
elements of
this multimap, starting at position start
.
Copying will stop once either the end of the current multimap 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 multimap to an array.
Copies elements of this multimap to an array.
Fills the given array xs
with at most len
elements of
this multimap, starting at position start
.
Copying will stop once either the end of the current multimap is reached,
or the end of the array is reached, or len
elements have been copied.
the type of the elements of the array.
the array to fill.
the starting index.
the maximal number of elements to copy.
[use case] Copies values of this multimap to an array.
Copies values of this multimap to an array.
Fills the given array xs
with values of this multimap.
Copying will stop once either the end of the current multimap is reached,
or the end of the array is reached.
the array to fill.
Copies values of this multimap to an array.
Copies values of this multimap to an array.
Fills the given array xs
with values of this multimap.
Copying will stop once either the end of the current multimap 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 multimap to an array.
Copies values of this multimap to an array.
Fills the given array xs
with values of this multimap, after skipping start
values.
Copying will stop once either the end of the current multimap is reached,
or the end of the array is reached.
the array to fill.
the starting index.
Copies values of this multimap to an array.
Copies values of this multimap to an array.
Fills the given array xs
with values of this multimap, after skipping start
values.
Copying will stop once either the end of the current multimap 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 multimap to a buffer.
Copies all elements of this multimap to a buffer.
The buffer to which elements are copied.
Counts the number of elements in the multimap which satisfy a predicate.
Counts the number of elements in the multimap 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 multimap.
a multimap consisting of all elements of this multimap except the first n
ones, or else the
empty multimap, if this multimap 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 multimap consisting of all elements of this multimap except the first n
ones, or else the
empty multimap, if this multimap has less than n
elements.
Drops longest prefix of elements that satisfy a predicate.
Drops longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The predicate used to test elements.
the longest suffix of this multimap whose first element
does not satisfy the predicate p
.
use iterator' instead
The empty map of the same type as this map
Checks if there exists a binding to key
such that it satisfies the predicate p
.
Checks if there exists a binding to key
such that it satisfies the predicate p
.
The key for which the predicate is checked.
The predicate which a value assigned to the key must satisfy.
A boolean if such a binding exists
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 of the elements of this multimap.
Tests whether a predicate holds for some of the elements of this multimap.
the predicate used to test elements.
true
if the given predicate p
holds for some of the elements
of this multimap, otherwise false
.
Selects all elements of this multimap which satisfy a predicate.
Selects all elements of this multimap which satisfy a predicate.
the predicate used to test elements.
a new multimap consisting of all elements of this multimap 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.
Returns a new map with all key/value pairs for which the predicate
p
returns true
.
Returns a new map with all key/value pairs for which the predicate
p
returns true
.
Note: This method works by successively removing elements fro which the
predicate is false from this set.
If removal is slow, or you expect that most elements of the set
will be removed, you might consider using filter
with a negated predicate instead.
A predicate over key-value pairs
A new map containing elements not satisfying the predicate.
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 the first element of the multimap satisfying a predicate, if any.
Finds the first element of the multimap satisfying a predicate, if any.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the predicate used to test elements.
an option value containing the first element in the multimap
that satisfies p
, or None
if none exists.
use head' instead
None
if iterable is empty.
[use case] Builds a new collection by applying a function to all elements of this multimap and concatenating the results.
Builds a new collection by applying a function to all elements of this multimap and concatenating the results.
the element type of the returned collection.
the function to apply to each element.
a new multimap resulting from applying the given collection-valued function
f
to each element of this multimap and concatenating the results.
Builds a new collection by applying a function to all elements of this multimap and concatenating the results.
Builds a new collection by applying a function to all elements of this multimap and concatenating the results.
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 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 multimap and concatenating the results.
[use case] Converts this multimap of traversable collections into a multimap in which all element collections are concatenated.
Converts this multimap of traversable collections into a multimap in which all element collections are concatenated.
the type of the elements of each traversable collection.
a new multimap resulting from concatenating all element multimaps.
Converts this multimap of traversable collections into a multimap in which all element collections are concatenated.
Converts this multimap of traversable collections into a multimap 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
multimap is a Traversable
.
a new multimap resulting from concatenating all element multimaps.
Applies a binary operator to a start value and all elements of this multimap, going left to right.
Applies a binary operator to a start value and all elements of this multimap, 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 start value.
the binary operator.
the result of inserting op
between consecutive elements of this multimap,
going left to right with the start value z
on the left:
op(...op(z, x1), x2, ..., xn)
where x,,1,,, ..., x,,n,,
are the elements of this multimap.
Applies a binary operator to all elements of this multimap and a start value, going right to left.
Applies a binary operator to all elements of this multimap 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 result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this multimap,
going right to left with the start value z
on the right:
op(x1, op(x2, ... op(xn, z)...))
where x,,1,,, ..., x,,n,,
are the elements of this multimap.
Tests whether a predicate holds for all elements of this multimap.
Tests whether a predicate holds for all elements of this multimap.
the predicate used to test elements.
true
if the given predicate p
holds for all elements
of this multimap, otherwise false
.
[use case] Applies a function f
to all elements of this multimap.
Applies a function f
to all elements of this multimap.
the function that is applied for its side-effect to every element.
The result of function f
is discarded.
Applies a function f
to all elements of this multimap.
Applies a function f
to all elements of this multimap.
Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.
the type parameter describing the result of function f
.
This result will always be ignored. Typically U
is Unit
,
but this is not necessary.
the function that is applied for its side-effect to every element.
The result of function f
is discarded.
The generic builder that builds instances of MultiMap
The generic builder that builds instances of MultiMap
2.8
1 at arbitrary element types.
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.
If given key is already in this map, returns associated value.
If given key is already in this map, returns associated value.
Otherwise, computes value from given expression op
, stores with key
in map and returns that value.
the key to test
the computation yielding the value to associate with key
, if
key
is previously unbound.
the value associated with key (either previously or as a result of executing the method).
Partitions this multimap into a map of multimaps according to some discriminator function.
Partitions this multimap into a map of multimaps 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 multimap.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to multimaps 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 multimap of those elements x
for which f(x)
equals k
.
Partitions elements in fixed size multimaps.
Partitions elements in fixed size multimaps.
the number of elements per group
An iterator producing multimaps of size size
, except the
last will be truncated if the elements don't divide evenly.
Iterator#grouped
Tests whether this multimap is known to have a finite size.
Tests whether this multimap 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 multimap.
Selects the first element of this multimap.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the first element of this multimap.
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 multimap 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 multimap consisting of all elements of this multimap except the last one.
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 expression1.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.
Tests whether this multimap can be repeatedly traversed.
Tests whether this multimap can be repeatedly traversed.
true
Creates a new iterator over all key/value pairs of this map
Creates a new iterator over all key/value pairs of this map
the new 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.
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 multimap.
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 multimap$ 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.
Creates a new set.
Creates a new set.
Classes that use this trait as a mixin can override this method
to have the desired implementation of sets assigned to new keys.
By default this is HashSet
.
An empty set of values of type B
.
[use case] Builds a new collection by applying a function to all elements of this multimap.
Builds a new collection by applying a function to all elements of this multimap.
the element type of the returned collection.
the function to apply to each element.
a new multimap resulting from applying the given function
f
to each element of this multimap and collecting the results.
Builds a new collection by applying a function to all elements of this multimap.
Builds a new collection by applying a function to all elements of this multimap.
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 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 multimap and collecting the results.
use mapValues' instead
Creates a new builder by applying a transformation function to the results of this builder.
Creates a new builder by applying a transformation function to the results of this builder.
the type of collection returned by f
.
the transformation function.
a new builder which is the same as the current builder except that a transformation function is applied to this builder's result.
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 multimap.
Finds the largest element.
Finds the largest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the largest element of this multimap with respect to the ordering cmp
.
[use case] Finds the smallest element.
Finds the smallest element.
the smallest element of this multimap
Finds the smallest element.
Finds the smallest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the smallest element of this multimap with respect to the ordering cmp
.
Displays all elements of this multimap in a string.
Displays all elements of this multimap in a string.
a string representation of this multimap. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this multimap follow each other without any separator string.
Displays all elements of this multimap in a string using a separator string.
Displays all elements of this multimap in a string using a separator string.
the separator string.
a string representation of this multimap. In the resulting string
the string representations (w.r.t. the method toString
)
of all elements of this multimap are separated by the string sep
.
Displays all elements of this multimap in a string using start, end, and separator strings.
Displays all elements of this multimap in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this multimap. 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 multimap are separated by the string sep
.
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.
A common implementation of newBuilder
for all mutable maps
in terms of empty
.
A common implementation of newBuilder
for all mutable maps
in terms of empty
.
Overrides MapLike
implementation for better efficiency.
Tests whether the multimap is not empty.
Tests whether the multimap is not empty.
true
if the multimap 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.
Partitions this multimap in two multimaps according to a predicate.
Partitions this multimap in two multimaps according to a predicate.
the predicate on which to partition.
a pair of multimaps: the first multimap consists of all elements that
satisfy the predicate p
and the second multimap consists of all elements
that don't. The relative order of the elements in the resulting multimaps
is the same as in the original multimap.
[use case] Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
the product of all elements in this multimap 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 multimap 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.
the result type of the *
operator.
an implicit parameter defining a set of numeric operations
which includes the *
operator to be used in forming the product.
the product of all elements of this multimap 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
Adds a new key/value pair to this map and optionally returns previously bound value.
Adds a new key/value pair to this map and optionally returns previously bound value. If the map already contains a mapping for the key, it will be overridden by the new value.
the key to update
the new value
an option value containing the value associated with the key
before the put
operation was executed, or None
if key
was not defined in the map before.
Applies a binary operator to all elements of this multimap, going left to right.
Applies a binary operator to all elements of this multimap, 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.
the result of inserting op
between consecutive elements of this multimap,
going left to right:
op(...(op(x1, x2), ... ) , xn)
where x,,1,,, ..., x,,n,,
are the elements of this multimap.
Optionally applies a binary operator to all elements of this multimap, going left to right.
Optionally applies a binary operator to all elements of this multimap, 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 multimap is nonempty,
None
otherwise.
Applies a binary operator to all elements of this multimap, going right to left.
Applies a binary operator to all elements of this multimap, 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.
the result of inserting op
between consecutive elements of this multimap,
going right to left:
op(x1, op(x2, ..., op(xn-1, xn)...))
where x,,1,,, ..., x,,n,,
are the elements of this multimap.
Optionally applies a binary operator to all elements of this multimap, going right to left.
Optionally applies a binary operator to all elements of this multimap, 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 multimap is nonempty,
None
otherwise.
Removes a key from this map, returning the value associated previously with that key as an option.
Removes a key from this map, returning the value associated previously with that key as an option.
the key to be removed
an option value containing the value associated previously with key
,
or None
if key
was not defined in the map before.
Removes the binding of value
to key
if it exists.
Removes the binding of value
to key
if it exists.
If this was the last value assigned to the specified key, the set assigned to that key will be removed as well.
The key of the binding.
The value to remove.
A reference to this multimap.
If given key is defined in this map, remove it and return associated value as an Option.
If given key is defined in this map, remove it and return associated value as an Option. If key is not present return None.
the key to be removed
Use remove' instead
The collection of type multimap underlying this TraversableLike
object.
The collection of type multimap underlying this TraversableLike
object.
By default this is implemented as the TraversableLike
object itself, but this can be overridden.
The result when this map is used as a builder
Retains only those mappings for which the predicate
p
returns true
.
Retains only those mappings for which the predicate
p
returns true
.
The test predicate
[use case] Checks if the other iterable collection contains the same elements in the same order as this multimap.
Checks if the other iterable collection contains the same elements in the same order as this multimap.
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 multimap.
Checks if the other iterable collection contains the same elements in the same order as this multimap.
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.
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.
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
The size of this multimap.
The size of this multimap.
the number of elements in this multimap.
Gives a hint that one expects the result
of this builder
to have the same size as the given collection, plus some delta.
Gives a hint that one expects the result
of this builder
to have the same size as the given collection, plus some delta. This will
provide a hint only if the collection is known to have a cheap
size
method. Currently this is assumed ot be the case if and only if
the collection is of type IndexedSeqLike
.
Some builder classes
will optimize their representation based on the hint. However,
builder implementations are still required to work correctly even if the hint is
wrong, i.e. a different number of elements is added.
the collection which serves as a hint for the result's size.
a correction to add to the coll.size
to produce the size hint.
Gives a hint how many elements are expected to be added
when the next result
is called.
Gives a hint how many elements are expected to be added
when the next result
is called. Some builder classes
will optimize their representation based on the hint. However,
builder implementations are still required to work correctly even if the hint is
wrong, i.e. a different number of elements is added.
the hint how many elements will be added.
Gives a hint how many elements are expected to be added
when the next result
is called, together with an upper bound
given by the size of some other collection.
Gives a hint how many elements are expected to be added
when the next result
is called, together with an upper bound
given by the size of some other collection. Some builder classes
will optimize their representation based on the hint. However,
builder implementations are still required to work correctly even if the hint is
wrong, i.e. a different number of elements is added.
the hint how many elements will be added.
the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.
Selects an interval of elements.
Selects an interval of elements.
Note: c.slice(from, to)
is equivalent to (but possibly more efficient than)
c.drop(from).take(to - from)
Note: might return different results for different runs, unless the underlying collection type is ordered.
the index of the first returned element in this multimap.
the index one past the last returned element in this multimap.
a multimap containing the elements starting at index from
and extending up to (but not including) index until
of this multimap.
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 multimaps of size size
, except the
last and the only element will be truncated if there are
fewer elements than size.
Iterator#sliding
Splits this multimap into a prefix/suffix pair according to a predicate.
Splits this multimap into a prefix/suffix pair according to a predicate.
Note: c span p
is equivalent to (but possibly more efficient than)
(c takeWhile p, c dropWhile p)
, provided the evaluation of the predicate p
does not cause any side-effects.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the test predicate
a pair consisting of the longest prefix of this multimap whose
elements all satisfy p
, and the rest of this multimap.
Splits this multimap into two at a given position.
Splits this multimap 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 multimaps consisting of the first n
elements of this multimap, 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 multimap.
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 multimap 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 multimap 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.
the result type of the +
operator.
an implicit parameter defining a set of numeric operations
which includes the +
operator to be used in forming the sum.
the sum of all elements of this multimap 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 multimap consisting of all elements of this multimap 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 multimap.
a multimap consisting only of the first n
elements of this multimap, or else the
whole multimap, 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 multimap consisting only of the last n
elements of this multimap, or else the
whole multimap, if it has less than n
elements.
Takes longest prefix of elements that satisfy a predicate.
Takes longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
The predicate used to test elements.
the longest prefix of this multimap whose elements all satisfy
the predicate p
.
The underlying collection seen as an instance of MultiMap
The underlying collection seen as an instance of MultiMap
2.8
1.
By default this is implemented as the current collection object itself,
but this can be overridden.
[use case] Converts this multimap to an array.
Converts this multimap to an array.
an array containing all elements of this multimap.
A ClassManifest
must be available for the element type of this multimap.
Converts this multimap to an array.
Converts this multimap to an array.
the type of the elements of the array. A ClassManifest
for this type must
be available.
an array containing all elements of this multimap.
Converts this multimap to a mutable buffer.
Converts this multimap to a mutable buffer.
a buffer containing all elements of this multimap.
A conversion from collections of type Repr
to MultiMap
A conversion from collections of type Repr
to MultiMap
2.8
1 objects.
By default this is implemented as just a cast, but this can be overridden.
Converts this multimap to an indexed sequence.
Converts this multimap to an indexed sequence.
an indexed sequence containing all elements of this multimap.
Converts this multimap to an iterable collection.
Converts this multimap 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 multimap.
Returns an Iterator over the elements in this multimap.
Returns an Iterator over the elements in this multimap. Will return the same Iterator if this instance is already an Iterator.
an Iterator containing all elements of this multimap.
Converts this multimap to a list.
Converts this multimap to a list.
a list containing all elements of this multimap.
Converts this multimap to a map.
Converts this multimap to a map. This method is unavailable unless the elements are members of Tuple2, each ((K, V)) 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 multimap.
Converts this multimap to a sequence.
Converts this multimap to a sequence.
a sequence containing all the elements of this multimap.
Converts this multimap to a set.
Converts this multimap to a set.
a set containing all elements of this multimap.
Converts this multimap to a stream.
Converts this multimap to a stream.
a stream containing all elements of this multimap.
Converts this multimap to a string.
Converts this multimap to a string.
a string representation of this collection. By default this
string consists of the stringPrefix
of this multimap,
followed by all elements separated by commas and enclosed in parentheses.
Converts this multimap to an unspecified Traversable.
Converts this multimap to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
a Traversable containing all elements of this multimap.
Applies a transformation function to all values contained in this map.
Applies a transformation function to all values contained in this map. The transformation function produces new values from existing keys associated values.
the transformation to apply
the map itself.
Transposes this multimap of traversable collections into a multimap of multimaps.
Transposes this multimap of traversable collections into a multimap of multimaps.
the type of the elements of each traversable collection.
an implicit conversion which asserts that the element type of this
multimap is a Traversable
.
a two-dimensional multimap of multimaps which has as nth row the nth column of this multimap.
Converts this multimap of pairs into two collections of the first and second halfs of each pair.
Converts this multimap of pairs into two collections of the first and second halfs of each pair.
an implicit conversion which asserts that the element type of this multimap is a pair.
a pair multimaps, containing the first, respectively second half of each element pair of this multimap.
Adds a new key/value pair to this map.
Adds a new key/value pair to this map. If the map already contains a mapping for the key, it will be overridden by the new value.
The key to update
The new value
Creates a new map consisting of all key/value pairs of the current map plus a new pair of a given key and value.
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 a slice of this multimap.
Creates a non-strict view of a slice of this multimap.
Note: the difference between view
and slice
is that view
produces
a view of the current multimap, whereas slice
produces a new multimap.
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 multimap, starting at index from
and extending up to (but not including) index until
.
Creates a non-strict view of this multimap.
Creates a non-strict view of this multimap.
a non-strict view of this multimap.
Creates a non-strict filter of this multimap.
Creates a non-strict filter of this multimap.
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 multimap which
satisfy the predicate p
.
[use case] Returns a multimap formed from this multimap and another iterable collection by combining corresponding elements in pairs.
Returns a multimap formed from this multimap 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 multimap containing pairs consisting of
corresponding elements of this multimap and that
. The length
of the returned collection is the minimum of the lengths of this multimap and that
.
Returns a multimap formed from this multimap and another iterable collection by combining corresponding elements in pairs.
Returns a multimap formed from this multimap 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 type of the first half of the returned pairs (this is always a supertype
of the collection's element type A
).
the type of the second half of the returned pairs
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 multimap and that
. The length
of the returned collection is the minimum of the lengths of this multimap and that
.
[use case] Returns a multimap formed from this multimap and another iterable collection by combining corresponding elements in pairs.
Returns a multimap formed from this multimap 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 multimap is shorter than that
.
the element to be used to fill up the result if that
is shorter than this multimap.
a new multimap containing pairs consisting of
corresponding elements of this multimap and that
. The length
of the returned collection is the maximum of the lengths of this multimap and that
.
If this multimap is shorter than that
, thisElem
values are used to pad the result.
If that
is shorter than this multimap, thatElem
values are used to pad the result.
Returns a multimap formed from this multimap and another iterable collection by combining corresponding elements in pairs.
Returns a multimap formed from this multimap 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 multimap is shorter than that
.
the element to be used to fill up the result if that
is shorter than this multimap.
a new collection of type That
containing pairs consisting of
corresponding elements of this multimap and that
. The length
of the returned collection is the maximum of the lengths of this multimap and that
.
If this multimap is shorter than that
, thisElem
values are used to pad the result.
If that
is shorter than this multimap, thatElem
values are used to pad the result.
[use case] Zips this multimap with its indices.
Zips this multimap with its indices.
A new multimap containing pairs consisting of all elements of this
multimap paired with their index. Indices start at 0
.
@example
List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))
Zips this multimap with its indices.
Zips this multimap with its indices.
Note: might return different results for different runs, unless the underlying collection type is ordered.
the type of the first half of the returned pairs (this is always a supertype
of the collection's element type A
).
the class of the returned collection. Where possible, That
is
the same class as the current collection class Repr
, but this
depends on the element type (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
multimap paired with their index. Indices start at 0
.
A trait for mutable maps with multiple values assigned to a key.
This class is typically used as a mixin. It turns maps which map
A
toSet[B]
objects into multi maps which mapA
toB
objects.