Packages

final class Map2[K, +V] extends AbstractMap[K, V] with StrictOptimizedIterableOps[(K, V), Iterable, Map[K, V]] with Serializable

Annotations
@SerialVersionUID()
Source
Map.scala
Linear Supertypes
java.io.Serializable, StrictOptimizedIterableOps[(K, V), Iterable, Map[K, V]], AbstractMap[K, V], Map[K, V], MapOps[K, V, Map, Map[K, V]], Iterable[(K, V)], collection.AbstractMap[K, V], collection.Map[K, V], Equals, MapFactoryDefaults[K, V, [x, y]Map[x, y], [x]Iterable[x]], collection.MapOps[K, V, [_, _]Map[_, _], Map[K, V]], PartialFunction[K, V], (K) => V, AbstractIterable[(K, V)], collection.Iterable[(K, V)], IterableFactoryDefaults[(K, V), [x]Iterable[x]], IterableOps[(K, V), [_]Iterable[_], Map[K, V]], IterableOnceOps[(K, V), [_]Iterable[_], Map[K, V]], IterableOnce[(K, V)], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Map2
  2. Serializable
  3. StrictOptimizedIterableOps
  4. AbstractMap
  5. Map
  6. MapOps
  7. Iterable
  8. AbstractMap
  9. Map
  10. Equals
  11. MapFactoryDefaults
  12. MapOps
  13. PartialFunction
  14. Function1
  15. AbstractIterable
  16. Iterable
  17. IterableFactoryDefaults
  18. IterableOps
  19. IterableOnceOps
  20. IterableOnce
  21. AnyRef
  22. Any
Implicitly
  1. by UnliftOps
  2. by iterableOnceExtensionMethods
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Map2(key1: K, value1: V, key2: K, value2: V)

Type Members

  1. trait GenKeySet extends AnyRef

    A generic trait that is reused by keyset implementations

    A generic trait that is reused by keyset implementations

    Attributes
    protected
    Definition Classes
    MapOps
  2. class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

    The implementation class of the set returned by keySet.

    The implementation class of the set returned by keySet.

    Attributes
    protected
    Definition Classes
    MapOps
  3. class ImmutableKeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

    The implementation class of the set returned by keySet

    The implementation class of the set returned by keySet

    Attributes
    protected[immutable]
    Definition Classes
    MapOps

Value Members

  1. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##: Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  3. def +[V1 >: V](kv: (K, V1)): Map[K, V1]

    Alias for updated

    Alias for updated

    V1

    the type of the value in the key/value pair.

    kv

    the key/value pair.

    returns

    A new map with the new binding added to this map.

    Definition Classes
    MapOpsMapOps
  4. def ++[V2 >: V](xs: IterableOnce[(K, V2)]): Map[K, V2]

    Alias for concat

    Alias for concat

    Definition Classes
    MapOps
  5. final def ++[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

    Alias for concat

    Alias for concat

    Definition Classes
    IterableOps
    Annotations
    @inline()
  6. final def -(key: K): Map[K, V]

    Alias for removed

    Alias for removed

    Definition Classes
    MapOps
    Annotations
    @inline()
  7. final def --(keys: IterableOnce[K]): Map[K, V]

    Alias for removedAll

    Alias for removedAll

    Definition Classes
    MapOpsMapOps
    Annotations
    @inline()
  8. def ->[B](y: B): (Map2[K, V], B)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toArrowAssoc[Map2[K, V]] performed by method ArrowAssoc in scala.Predef.This conversion will take place only if V is a subclass of Option[Nothing] (V <: Option[Nothing]).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  9. final def ==(arg0: Any): Boolean

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  10. def addString(sb: mutable.StringBuilder, start: String, sep: String, end: String): sb.type

    Appends all elements of this immutable map to a string builder using start, end, and separator strings.

    Appends all elements of this immutable 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 (w.r.t. the method toString) of all elements of this immutable map are separated by the string sep.

    Example:

    scala> val a = List(1,2,3,4)
    a: List[Int] = List(1, 2, 3, 4)
    
    scala> val b = new StringBuilder()
    b: StringBuilder =
    
    scala> a.addString(b , "List(" , ", " , ")")
    res5: StringBuilder = List(1, 2, 3, 4)
    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    MapOpsIterableOnceOps
  11. final def addString(b: mutable.StringBuilder): b.type

    Appends all elements of this immutable map to a string builder.

    Appends all elements of this immutable map to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this immutable map without any separator string.

    Example:

    scala> val a = List(1,2,3,4)
    a: List[Int] = List(1, 2, 3, 4)
    
    scala> val b = new StringBuilder()
    b: StringBuilder =
    
    scala> val h = a.addString(b)
    h: StringBuilder = 1234
    b

    the string builder to which elements are appended.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  12. final def addString(b: mutable.StringBuilder, sep: String): b.type

    Appends all elements of this immutable map to a string builder using a separator string.

    Appends all elements of this immutable 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 immutable map, separated by the string sep.

    Example:

    scala> val a = List(1,2,3,4)
    a: List[Int] = List(1, 2, 3, 4)
    
    scala> val b = new StringBuilder()
    b: StringBuilder =
    
    scala> a.addString(b, ", ")
    res0: StringBuilder = 1, 2, 3, 4
    b

    the string builder to which elements are appended.

    sep

    the separator string.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  13. def andThen[C](k: PartialFunction[V, C]): PartialFunction[K, C]

    Composes this partial function with another partial function that gets applied to results of this partial function.

    Composes this partial function with another partial function that gets applied to results of this partial function.

    Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

    C

    the result type of the transformation function.

    k

    the transformation function

    returns

    a partial function with the domain of this partial function narrowed by other partial function, which maps arguments x to k(this(x)).

    Definition Classes
    PartialFunction
  14. def andThen[C](k: (V) => C): PartialFunction[K, C]

    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.

    If the runtime type of the function is a PartialFunction then the other andThen method is used (note its cautions).

    C

    the result type of the transformation function.

    k

    the transformation function

    returns

    a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments x to k(this(x)).

    Definition Classes
    PartialFunctionFunction1
  15. def apply(key: K): V

    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.

    key

    the key

    returns

    the value associated with the given key, or the result of the map's default method, if none exists.

    Definition Classes
    Map2MapOpsFunction1
  16. def applyOrElse[K1 <: K, V1 >: V](x: K1, default: (K1) => V1): V1

    Applies this partial function to the given argument when it is contained in the function domain.

    Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.

    Note that expression pf.applyOrElse(x, default) is equivalent to

    if(pf isDefinedAt x) pf(x) else default(x)

    except that applyOrElse method can be implemented more efficiently. For all partial function literals the compiler generates an applyOrElse implementation which avoids double evaluation of pattern matchers and guards. This makes applyOrElse the basis for the efficient implementation for many operations and scenarios, such as:

    • combining partial functions into orElse/andThen chains does not lead to excessive apply/isDefinedAt evaluation
    • lift and unlift do not evaluate source functions twice on each invocation
    • runWith allows efficient imperative-style combining of partial functions with conditionally applied actions

    For non-literal partial function classes with nontrivial isDefinedAt method it is recommended to override applyOrElse with custom implementation that avoids double isDefinedAt evaluation. This may result in better performance and more predictable behavior w.r.t. side effects.

    x

    the function argument

    default

    the fallback function

    returns

    the result of this function or fallback function application.

    Definition Classes
    MapOpsPartialFunction
  17. final def asInstanceOf[T0]: T0

    Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.

    Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.

    This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.

    It is platform dependent whether asInstanceOf has any effect at runtime. It might do a runtime type test on the erasure of T0, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.

    In particular, asInstanceOf is not a type test. It does **not** mean:

    this match {
     case x: T0 => x
     case _     => throw ClassCastException("...")

    Use pattern matching or isInstanceOf for type testing instead.

    Situations where asInstanceOf is useful:

    • when flow analysis fails to deduce T0 automatically
    • when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.

    Be careful of using asInstanceOf when T0 is a primitive type. When T0 is primitive, asInstanceOf may insert a conversion instead of a type test. If your intent is to convert, use a toT method (x.toChar, x.toByte, etc.).

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver is not an instance of the erasure of T0, if that can be checked on this platform

  18. def canEqual(that: Any): Boolean

    Checks whether this instance can possibly equal that.

    Checks whether this instance can possibly equal that.

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

    that

    the value being probed for possible equality

    returns

    true if this instance can possibly equal that, otherwise false

    Definition Classes
    MapEquals
  19. def className: String

    Defines the prefix of this object's toString representation.

    Defines the prefix of this object's toString representation.

    It is recommended to return the name of the concrete collection type, but not implementation subclasses. For example, for ListMap this method should return "ListMap", not "Map" (the supertype) or "Node" (an implementation subclass).

    The default implementation returns "Iterable". It is overridden for the basic collection kinds "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" and "View".

    returns

    a string representation which starts the result of toString applied to this immutable map. By default the string prefix is the simple name of the collection class immutable map.

    Attributes
    protected[this]
    Definition Classes
    Iterable
  20. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  21. final def coll: Map2.this.type

    returns

    This collection as a C.

    Attributes
    protected
    Definition Classes
    IterableIterableOps
  22. def collect[B](pf: PartialFunction[(K, V), B]): Iterable[B]

    Builds a new immutable map by applying a partial function to all elements of this immutable map on which the function is defined.

    Builds a new immutable map by applying a partial function to all elements of this immutable map on which the function is defined.

    B

    the element type of the returned immutable map.

    pf

    the partial function which filters and maps the immutable map.

    returns

    a new immutable 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.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  23. def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)]): Map[K2, V2]

    Builds a new collection by applying a partial function to all elements of this immutable map on which the function is defined.

    Builds a new collection by applying a partial function to all elements of this immutable map on which the function is defined.

    K2

    the key type of the returned immutable map.

    V2

    the value type of the returned immutable map.

    pf

    the partial function which filters and maps the immutable map.

    returns

    a new immutable 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.

    Definition Classes
    MapOps
  24. def collectFirst[B](pf: PartialFunction[(K, V), B]): Option[B]

    Finds the first element of the immutable map for which the given partial function is defined, and applies the partial function to it.

    Finds the first element of the immutable map for which the given partial function is defined, and applies the partial function to it.

    Note: may not terminate for infinite-sized collections.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    pf

    the partial function

    returns

    an option value containing pf applied to the first value for which it is defined, or None if none exists.

    Definition Classes
    IterableOnceOps
    Example:
    1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

  25. def compose[R](k: PartialFunction[R, K]): PartialFunction[R, V]

    Composes another partial function k with this partial function so that this partial function gets applied to results of k.

    Composes another partial function k with this partial function so that this partial function gets applied to results of k.

    Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

    R

    the parameter type of the transformation function.

    k

    the transformation function

    returns

    a partial function with the domain of other partial function narrowed by this partial function, which maps arguments x to this(k(x)).

    Definition Classes
    PartialFunction
  26. def compose[A](g: (A) => K): (A) => V

    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.

    A

    the type to which function g can be applied

    g

    a function A => T1

    returns

    a new function f such that f(x) == apply(g(x))

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  27. def concat[V2 >: V](suffix: IterableOnce[(K, V2)]): Map[K, V2]

    Returns a new immutable map containing the elements from the left hand operand followed by the elements from the right hand operand.

    Returns a new immutable map containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable map is the most specific superclass encompassing the element types of the two operands.

    suffix

    the iterable to append.

    returns

    a new immutable map which contains all elements of this immutable map followed by all elements of suffix.

    Definition Classes
    MapOps
  28. def concat[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

    Returns a new immutable map containing the elements from the left hand operand followed by the elements from the right hand operand.

    Returns a new immutable map containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable map is the most specific superclass encompassing the element types of the two operands.

    B

    the element type of the returned collection.

    suffix

    the iterable to append.

    returns

    a new immutable map which contains all elements of this immutable map followed by all elements of suffix.

    Definition Classes
    IterableOps
  29. def contains(key: K): Boolean

    Tests whether this map contains a binding for a key.

    Tests whether this map contains a binding for a key.

    key

    the key

    returns

    true if there is a binding for key in this map, false otherwise.

    Definition Classes
    Map2MapOps
  30. def copyToArray[B >: (K, V)](xs: Array[B], start: Int, len: Int): Int

    Copy elements to an array, returning the number of elements written.

    Copy elements to an array, returning the number of elements written.

    Fills the given array xs starting at index start with at most len elements of this immutable map.

    Copying will stop once either all the elements of this immutable map have been copied, or the end of the array is reached, or len elements have been copied.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index of xs.

    len

    the maximal number of elements to copy.

    returns

    the number of elements written to the array

    Definition Classes
    IterableOnceOps
    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  31. def copyToArray[B >: (K, V)](xs: Array[B], start: Int): Int

    Copies elements to an array, returning the number of elements written.

    Copies elements to an array, returning the number of elements written.

    Fills the given array xs starting at index start with values of this immutable map.

    Copying will stop once either all the elements of this immutable map have been copied, or the end of the array is reached.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index of xs.

    returns

    the number of elements written to the array

    Definition Classes
    IterableOnceOps
    Annotations
    @deprecatedOverriding()
    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  32. def copyToArray[B >: (K, V)](xs: Array[B]): Int

    Copies elements to an array, returning the number of elements written.

    Copies elements to an array, returning the number of elements written.

    Fills the given array xs starting at index start with values of this immutable map.

    Copying will stop once either all the elements of this immutable map have been copied, or the end of the array is reached.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    returns

    the number of elements written to the array

    Definition Classes
    IterableOnceOps
    Annotations
    @deprecatedOverriding()
    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

  33. def corresponds[B](that: IterableOnce[B])(p: ((K, V), B) => Boolean): Boolean

    Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

    Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of that

    that

    the other collection

    p

    the test predicate, which relates elements from both collections

    returns

    true if both collections have the same length and p(x, y) is true for all corresponding elements x of this iterator and y of that, otherwise false

    Definition Classes
    IterableOnceOps
  34. def count(p: ((K, V)) => Boolean): Int

    Counts the number of elements in the immutable map which satisfy a predicate.

    Counts the number of elements in the immutable map which satisfy a predicate.

    Note: will not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    Definition Classes
    IterableOnceOps
  35. def default(key: K): V

    Defines the default value computation for the map, returned when a key is not found.

    Defines the default value computation for the map, returned when a key is not found.

    The method implemented here throws an exception, but it may be overridden by subclasses.

    key

    the given key value for which a binding is missing.

    Definition Classes
    MapOps
    Annotations
    @throws(cause = scala.this.throws.<init>$default$1[NoSuchElementException])
    Exceptions thrown

    NoSuchElementException if no default value is defined

  36. def drop(n: Int): Map[K, V]

    Selects all elements except the first n ones.

    Selects all elements except the first n ones.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    n

    the number of elements to drop from this immutable map.

    returns

    a immutable map consisting of all elements of this immutable map except the first n ones, or else the empty immutable map, if this immutable map has less than n elements. If n is negative, don't drop any elements.

    Definition Classes
    IterableOpsIterableOnceOps
  37. def dropRight(n: Int): Map[K, V]

    The rest of the collection without its n last elements.

    The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    n

    the number of elements to drop from this immutable map.

    returns

    a immutable map consisting of all elements of this immutable map except the last n ones, or else the empty immutable map, if this immutable map has less than n elements. If n is negative, don't drop any elements.

    Definition Classes
    StrictOptimizedIterableOpsIterableOps
  38. def dropWhile(p: ((K, V)) => Boolean): Map[K, V]

    Selects all elements except the longest prefix that satisfies a predicate.

    Selects all elements except the longest prefix that satisfies a predicate.

    The matching prefix starts with the first element of this immutable map, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire immutable map.

    Example:

    scala> List(1, 2, 3, 100, 4).dropWhile(n => n < 10)
    val res0: List[Int] = List(100, 4)
    
    scala> List(1, 2, 3, 100, 4).dropWhile(n => n == 0)
    val res1: List[Int] = List(1, 2, 3, 100, 4)

    Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the predicate.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    p

    The predicate used to test elements.

    returns

    the longest suffix of this immutable map whose first element does not satisfy the predicate p.

    Definition Classes
    IterableOpsIterableOnceOps
  39. def elementWise: ElementWiseExtractor[K, V]

    Returns an extractor object with a unapplySeq method, which extracts each element of a sequence data.

    Returns an extractor object with a unapplySeq method, which extracts each element of a sequence data.

    Definition Classes
    PartialFunction
    Example:
    1. val firstChar: String => Option[Char] = _.headOption
      
      Seq("foo", "bar", "baz") match {
        case firstChar.unlift.elementWise(c0, c1, c2) =>
          println(s"$c0, $c1, $c2") // Output: f, b, b
      }
  40. def empty: Map[K, V]

    The empty iterable of the same type as this iterable.

    The empty iterable of the same type as this iterable.

    returns

    an empty iterable of type C.

    Definition Classes
    MapFactoryDefaultsIterableOps
  41. def ensuring(cond: (Map2[K, V]) => Boolean, msg: => Any): Map2[K, V]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toEnsuring[Map2[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  42. def ensuring(cond: (Map2[K, V]) => Boolean): Map2[K, V]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toEnsuring[Map2[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  43. def ensuring(cond: Boolean, msg: => Any): Map2[K, V]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toEnsuring[Map2[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  44. def ensuring(cond: Boolean): Map2[K, V]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toEnsuring[Map2[K, V]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  45. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • 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).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  46. def equals(o: Any): Boolean

    Equality of maps is implemented using the lookup method get.

    Equality of maps is implemented using the lookup method get. This method returns true if

    • the argument o is a Map,
    • the two maps have the same size, and
    • for every (key, value) pair in this map, other.get(key) == Some(value).

    The implementation of equals checks the canEqual method, so subclasses of Map can narrow down the equality to specific map types. The Map implementations in the standard library can all be compared, their canEqual methods return true.

    Note: The equals method only respects the equality laws (symmetry, transitivity) if the two maps use the same key equivalence function in their lookup operation. For example, the key equivalence operation in a scala.collection.immutable.TreeMap is defined by its ordering. Comparing a TreeMap with a HashMap leads to unexpected results if ordering.equiv(k1, k2) (used for lookup in TreeMap) is different from k1 == k2 (used for lookup in HashMap).

    scala> import scala.collection.immutable._
    scala> val ord: Ordering[String] = _ compareToIgnoreCase _
    
    scala> TreeMap("A" -> 1)(ord) == HashMap("a" -> 1)
    val res0: Boolean = false
    
    scala> HashMap("a" -> 1) == TreeMap("A" -> 1)(ord)
    val res1: Boolean = true
    o

    The map to which this map is compared

    returns

    true if the two maps are equal according to the description

    Definition Classes
    MapEquals → AnyRef → Any
  47. def exists(p: ((K, V)) => Boolean): Boolean

    Tests whether a predicate holds for at least one element of this immutable map.

    Tests whether a predicate holds for at least one element of this immutable map.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p is satisfied by at least one element of this immutable map, otherwise false

    Definition Classes
    Map2IterableOnceOps
  48. def filter(pred: ((K, V)) => Boolean): Map[K, V]

    Selects all elements of this immutable map which satisfy a predicate.

    Selects all elements of this immutable map which satisfy a predicate.

    returns

    a new immutable map consisting of all elements of this immutable map that satisfy the given predicate p. The order of the elements is preserved.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  49. def filterImpl(pred: ((K, V)) => Boolean, isFlipped: Boolean): Map[K, V]
    Attributes
    protected[collection]
    Definition Classes
    Map2StrictOptimizedIterableOps
  50. def filterNot(pred: ((K, V)) => Boolean): Map[K, V]

    Selects all elements of this immutable map which do not satisfy a predicate.

    Selects all elements of this immutable map which do not satisfy a predicate.

    pred

    the predicate used to test elements.

    returns

    a new immutable map consisting of all elements of this immutable map that do not satisfy the given predicate pred. Their order may not be preserved.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  51. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
    Note

    not specified by SLS as a member of AnyRef

  52. def find(p: ((K, V)) => Boolean): Option[(K, V)]

    Finds the first element of the immutable map satisfying a predicate, if any.

    Finds the first element of the immutable map satisfying a predicate, if any.

    Note: may not terminate for infinite-sized collections.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    p

    the predicate used to test elements.

    returns

    an option value containing the first element in the immutable map that satisfies p, or None if none exists.

    Definition Classes
    IterableOnceOps
  53. def flatMap[B](f: ((K, V)) => IterableOnce[B]): Iterable[B]

    Builds a new immutable map by applying a function to all elements of this immutable map and using the elements of the resulting collections.

    Builds a new immutable map by applying a function to all elements of this immutable map and using the elements of the resulting collections.

    For example:

    def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

    The type of the resulting collection is guided by the static type of immutable map. This might cause unexpected results sometimes. For example:

    // lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
    def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)
    
    // lettersOf will return a Set[Char], not a Seq
    def lettersOf(words: Seq[String]) = words.toSet flatMap ((word: String) => word.toSeq)
    
    // xs will be an Iterable[Int]
    val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)
    
    // ys will be a Map[Int, Int]
    val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

    a new immutable map resulting from applying the given collection-valued function f to each element of this immutable map and concatenating the results.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  54. def flatMap[K2, V2](f: ((K, V)) => IterableOnce[(K2, V2)]): Map[K2, V2]

    Builds a new map by applying a function to all elements of this immutable map and using the elements of the resulting collections.

    Builds a new map by applying a function to all elements of this immutable map and using the elements of the resulting collections.

    f

    the function to apply to each element.

    returns

    a new immutable map resulting from applying the given collection-valued function f to each element of this immutable map and concatenating the results.

    Definition Classes
    MapOps
  55. def flatten[B](implicit toIterableOnce: ((K, V)) => IterableOnce[B]): Iterable[B]

    Converts this immutable map of iterable collections into a immutable map formed by the elements of these iterable collections.

    Converts this immutable map of iterable collections into a immutable map formed by the elements of these iterable collections.

    The resulting collection's type will be guided by the type of immutable map. For example:

    val xs = List(
               Set(1, 2, 3),
               Set(1, 2, 3)
             ).flatten
    // xs == List(1, 2, 3, 1, 2, 3)
    
    val ys = Set(
               List(1, 2, 3),
               List(3, 2, 1)
             ).flatten
    // ys == Set(1, 2, 3)
    B

    the type of the elements of each iterable collection.

    returns

    a new immutable map resulting from concatenating all element immutable maps.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  56. def fold[A1 >: (K, V)](z: A1)(op: (A1, A1) => A1): A1

    Applies the given binary operator op to the given initial value z and all elements of this immutable map.

    Applies the given binary operator op to the given initial value z and all elements of this immutable map.

    For each application of the operator, each operand is either an element of this immutable map, the initial value, or another such application of the operator.

    The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation. The initial value may be used an arbitrary number of times, but at least once.

    If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

    Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative. In either case, it is also necessary that the initial value be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.

    The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

    Note: will not terminate for infinite-sized collections.

    A1

    The type parameter for the binary operator, a supertype of A.

    z

    An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for op for the result to always be the same across runs.

    op

    A binary operator; must be associative for the result to always be the same across runs.

    returns

    The result of applying op between all the elements and z, or z if this immutable map is empty.

    Definition Classes
    IterableOnceOps
  57. def foldLeft[B](z: B)(op: (B, (K, V)) => B): B

    Applies the given binary operator op to the given initial value z and all elements of this immutable map, going left to right.

    Applies the given binary operator op to the given initial value z and all elements of this immutable map, going left to right. Returns the initial value if this immutable map is empty.

    "Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this immutable map, the result is op( op( ... op( op(z, x1), x2) ... ), xn).

    If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this immutable map and the initial value all appear exactly once in the computation.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator.

    z

    An initial value.

    op

    A binary operator.

    returns

    The result of applying op to z and all elements of this immutable map, going left to right. Returns z if this immutable map is empty.

    Definition Classes
    IterableOnceOps
  58. def foldRight[B](z: B)(op: ((K, V), B) => B): B

    Applies the given binary operator op to all elements of this immutable map and the given initial value z, going right to left.

    Applies the given binary operator op to all elements of this immutable map and the given initial value z, going right to left. Returns the initial value if this immutable map is empty.

    "Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this immutable map, the result is op(x1, op(x2, op( ... op(xn, z) ... ))).

    If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this immutable map and the initial value all appear exactly once in the computation.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator.

    z

    An initial value.

    op

    A binary operator.

    returns

    The result of applying op to all elements of this immutable map and z, going right to left. Returns z if this immutable map is empty.

    Definition Classes
    IterableOnceOps
  59. def forall(p: ((K, V)) => Boolean): Boolean

    Tests whether a predicate holds for all elements of this immutable map.

    Tests whether a predicate holds for all elements of this immutable map.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    true if this immutable map is empty or the given predicate p holds for all elements of this immutable map, otherwise false.

    Definition Classes
    Map2IterableOnceOps
  60. def foreach[U](f: ((K, V)) => U): Unit

    Applies f to each element for its side effects.

    Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

    Definition Classes
    Map2IterableOnceOps
  61. def foreachEntry[U](f: (K, V) => U): Unit

    Apply f to each key/value pair for its side effects Note: [U] parameter needed to help scalac's type inference.

    Apply f to each key/value pair for its side effects Note: [U] parameter needed to help scalac's type inference.

    Definition Classes
    MapOps
  62. def fromSpecific(coll: IterableOnce[(K, V)]): Map[K, V]

    Defines how to turn a given Iterable[A] into a collection of type C.

    Defines how to turn a given Iterable[A] into a collection of type C.

    This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.

    Attributes
    protected
    Definition Classes
    MapFactoryDefaultsIterableOps
    Note

    When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.

    ,

    As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as it is called with an Iterable[A] obtained from this collection (as it is the case in the implementations of operations where we use a View[A]), it is safe.

  63. def get(key: K): Option[V]

    Optionally returns the value associated with a key.

    Optionally returns the value associated with a key.

    key

    the key value

    returns

    an option value containing the value associated with key in this map, or None if none exists.

    Definition Classes
    Map2MapOps
  64. final def getClass(): Class[_ <: AnyRef]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

    a class object corresponding to the runtime type of the receiver.

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  65. def getOrElse[V1 >: V](key: K, default: => V1): V1

    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.

    V1

    the result type of the default computation.

    key

    the key.

    default

    a computation that yields a default value in case no binding for key is found in the map.

    returns

    the value associated with key if it exists, otherwise the result of the default computation.

    Definition Classes
    Map2MapOps
  66. def groupBy[K](f: ((K, V)) => K): Map[K, Map[K, V]]

    Partitions this immutable map into a map of immutable maps according to some discriminator function.

    Partitions this immutable map into a map of immutable maps according to some discriminator function.

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

    A map from keys to immutable maps such that the following invariant holds:

    (xs groupBy f)(k) = xs filter (x => f(x) == k)

    That is, every key k is bound to a immutable map of those elements x for which f(x) equals k.

    Definition Classes
    IterableOps
  67. def groupMap[K, B](key: ((K, V)) => K)(f: ((K, V)) => B): Map[K, Iterable[B]]

    Partitions this immutable map into a map of immutable maps according to a discriminator function key.

    Partitions this immutable map into a map of immutable maps according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

    It is equivalent to groupBy(key).mapValues(_.map(f)), but more efficient.

    case class User(name: String, age: Int)
    
    def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
      users.groupMap(_.age)(_.name)

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    K

    the type of keys returned by the discriminator function

    B

    the type of values returned by the transformation function

    key

    the discriminator function

    f

    the element transformation function

    Definition Classes
    IterableOps
  68. def groupMapReduce[K, B](key: ((K, V)) => K)(f: ((K, V)) => B)(reduce: (B, B) => B): Map[K, B]

    Partitions this immutable map into a map according to a discriminator function key.

    Partitions this immutable map into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.

    It is equivalent to groupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.

    def occurrences[A](as: Seq[A]): Map[A, Int] =
      as.groupMapReduce(identity)(_ => 1)(_ + _)

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    Definition Classes
    IterableOps
  69. def grouped(size: Int): Iterator[Map[K, V]]

    Partitions elements in fixed size immutable maps.

    Partitions elements in fixed size immutable maps.

    size

    the number of elements per group

    returns

    An iterator producing immutable maps of size size, except the last will be less than size size if the elements don't divide evenly.

    Definition Classes
    IterableOps
    See also

    scala.collection.Iterator, method grouped

  70. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    Map2Map → AnyRef → Any
  71. def head: (K, V)

    Selects the first element of this immutable map.

    Selects the first element of this immutable map.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    the first element of this immutable map.

    Definition Classes
    IterableOps
    Exceptions thrown

    NoSuchElementException if the immutable map is empty.

  72. def headOption: Option[(K, V)]

    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.

    returns

    the first element of this immutable map if it is nonempty, None if it is empty.

    Definition Classes
    IterableOps
  73. def init: Map[K, V]

    The initial part of the collection without its last element.

    The initial part of the collection without its last element.

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    Definition Classes
    IterableOps
  74. def inits: Iterator[Map[K, V]]

    Iterates over the inits of this immutable map.

    Iterates over the inits of this immutable map. The first value will be this immutable map and the final one will be an empty immutable map, with the intervening values the results of successive applications of init.

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    returns

    an iterator over all the inits of this immutable map

    Definition Classes
    IterableOps
    Example:
    1. List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

  75. def isDefinedAt(key: K): Boolean

    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.

    key

    the key

    returns

    true if there is a binding for key in this map, false otherwise.

    Definition Classes
    MapOpsPartialFunction
  76. def isEmpty: Boolean

    Tests whether the immutable map is empty.

    Tests whether the immutable map is empty.

    Note: The default implementation creates and discards an iterator.

    Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when isEmpty is called.

    returns

    true if the immutable map contains no elements, false otherwise.

    Definition Classes
    Map2IterableOnceOps
  77. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Depending on what T0 is, the test is done in one of the below ways:

    • T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
    • T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
    • T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
    • T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
    • T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
    • T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

    This is exactly equivalent to the type pattern _: T0

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  78. def isTraversableAgain: Boolean

    Tests whether this immutable map can be repeatedly traversed.

    Tests whether this immutable map can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

    returns

    true if it is repeatedly traversable, false otherwise.

    Definition Classes
    IterableOpsIterableOnceOps
  79. def iterableFactory: IterableFactory[Iterable]

    The companion object of this immutable map, providing various factory methods.

    The companion object of this immutable map, providing various factory methods.

    Definition Classes
    IterableIterableIterableOps
    Note

    When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).

  80. def iterator: Iterator[(K, V)]

    An scala.collection.Iterator over the elements of this immutable map.

    An scala.collection.Iterator over the elements of this immutable map.

    If an IterableOnce object is in fact an scala.collection.Iterator, this method always returns itself, in its current state, but if it is an scala.collection.Iterable, this method always returns a new scala.collection.Iterator.

    Definition Classes
    Map2IterableOnce
  81. def keySet: Set[K]

    A set representing the keys contained by this map.

    A set representing the keys contained by this map.

    For efficiency the resulting set may be a view (maintaining a reference to the map and reflecting modifications to the map), but it may also be a strict collection without reference to the map.

    • To ensure an independent strict collection, use m.keysIterator.toSet
    • To obtain a view on the keys, use scala.collection.View.fromIteratorProvider(m.keysIterator)
    returns

    a set representing the keys contained by this map

    Definition Classes
    MapOpsMapOps
  82. def keyStepper[S <: Stepper[_]](implicit shape: StepperShape[K, S]): S

    Returns a Stepper for the keys of this map.

    Returns a Stepper for the keys of this map. See method stepper.

    Definition Classes
    MapOps
  83. def keys: collection.Iterable[K]

    An Iterable collection of the keys contained by this map.

    An Iterable collection of the keys contained by this map.

    For efficiency the resulting collection may be a view (maintaining a reference to the map and reflecting modifications to the map), but it may also be a strict collection without reference to the map.

    • To ensure an independent strict collection, use m.keysIterator.toSet
    • To obtain a view on the keys, use scala.collection.View.fromIteratorProvider(m.keysIterator)
    returns

    an Iterable collection of the keys contained by this map

    Definition Classes
    MapOps
    Annotations
    @deprecatedOverriding()
  84. def keysIterator: Iterator[K]

    An Iterator of the keys contained by this map.

    An Iterator of the keys contained by this map.

    returns

    an Iterator of the keys contained by this map

    Definition Classes
    Map2MapOps
  85. def knownSize: Int

    The number of elements in this immutable map, if it can be cheaply computed, -1 otherwise.

    The number of elements in this immutable map, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

    Definition Classes
    Map2IterableOnce
  86. def last: (K, V)

    Selects the last element.

    Selects the last element.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    returns

    The last element of this immutable map.

    Definition Classes
    IterableOps
    Exceptions thrown

    NoSuchElementException If the immutable map is empty.

  87. def lastOption: Option[(K, V)]

    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.

    returns

    the last element of this immutable map$ if it is nonempty, None if it is empty.

    Definition Classes
    IterableOps
  88. def lazyZip[B](that: collection.Iterable[B]): LazyZip2[(K, V), B, Map2.this.type]

    Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

    Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

    Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.

    val xs = List(1, 2, 3)
    val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
    // res == List(4, 8, 12)
    B

    the type of the second element in each eventual pair

    that

    the iterable providing the second element of each eventual pair

    returns

    a decorator LazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip. Implicit conversion to Iterable[(A, B)] is also supported.

    Definition Classes
    Iterable
  89. def lift: (K) => Option[V]

    Turns this partial function into a plain function returning an Option result.

    Turns this partial function into a plain function returning an Option result.

    returns

    a function that takes an argument x to Some(this(x)) if this is defined for x, and to None otherwise.

    Definition Classes
    PartialFunction
    See also

    Function.unlift

  90. def map[B](f: ((K, V)) => B): Iterable[B]

    Builds a new immutable map by applying a function to all elements of this immutable map.

    Builds a new immutable map by applying a function to all elements of this immutable map.

    B

    the element type of the returned immutable map.

    f

    the function to apply to each element.

    returns

    a new immutable map resulting from applying the given function f to each element of this immutable map and collecting the results.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  91. def map[K2, V2](f: ((K, V)) => (K2, V2)): Map[K2, V2]

    Builds a new map by applying a function to all elements of this immutable map.

    Builds a new map by applying a function to all elements of this immutable map.

    f

    the function to apply to each element.

    returns

    a new immutable map resulting from applying the given function f to each element of this immutable map and collecting the results.

    Definition Classes
    MapOps
  92. def mapFactory: MapFactory[Map]

    The companion object of this map, providing various factory methods.

    The companion object of this map, providing various factory methods.

    Definition Classes
    MapMapMapOps
    Note

    When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).

  93. final def mapFromIterable[K2, V2](it: collection.Iterable[(K2, V2)]): Map[K2, V2]

    Similar to fromIterable, but returns a Map collection type.

    Similar to fromIterable, but returns a Map collection type. Note that the return type is now CC[K2, V2].

    Attributes
    protected
    Definition Classes
    MapOps
    Annotations
    @inline()
  94. def max[B >: (K, V)](implicit ord: math.Ordering[B]): (K, V)

    Finds the largest element.

    Finds the largest element.

    Note: will not terminate for infinite-sized collections.

    B

    The type over which the ordering is defined.

    ord

    An ordering to be used for comparing elements.

    returns

    the largest element of this immutable map with respect to the ordering ord.

    Definition Classes
    IterableOnceOps
    Exceptions thrown

    UnsupportedOperationException if this immutable map is empty.

  95. def maxBy[B](f: ((K, V)) => B)(implicit ord: math.Ordering[B]): (K, V)

    Finds the first element which yields the largest value measured by function f.

    Finds the first element which yields the largest value measured by function f.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    returns

    the first element of this immutable map with the largest value measured by function f with respect to the ordering cmp.

    Definition Classes
    IterableOnceOps
    Exceptions thrown

    UnsupportedOperationException if this immutable map is empty.

  96. def maxByOption[B](f: ((K, V)) => B)(implicit ord: math.Ordering[B]): Option[(K, V)]

    Finds the first element which yields the largest value measured by function f.

    Finds the first element which yields the largest value measured by function f.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    returns

    an option value containing the first element of this immutable map with the largest value measured by function f with respect to the ordering cmp.

    Definition Classes
    IterableOnceOps
  97. def maxOption[B >: (K, V)](implicit ord: math.Ordering[B]): Option[(K, V)]

    Finds the largest element.

    Finds the largest element.

    Note: will not terminate for infinite-sized collections.

    B

    The type over which the ordering is defined.

    ord

    An ordering to be used for comparing elements.

    returns

    an option value containing the largest element of this immutable map with respect to the ordering ord.

    Definition Classes
    IterableOnceOps
  98. def min[B >: (K, V)](implicit ord: math.Ordering[B]): (K, V)

    Finds the smallest element.

    Finds the smallest element.

    Note: will not terminate for infinite-sized collections.

    B

    The type over which the ordering is defined.

    ord

    An ordering to be used for comparing elements.

    returns

    the smallest element of this immutable map with respect to the ordering ord.

    Definition Classes
    IterableOnceOps
    Exceptions thrown

    UnsupportedOperationException if this immutable map is empty.

  99. def minBy[B](f: ((K, V)) => B)(implicit ord: math.Ordering[B]): (K, V)

    Finds the first element which yields the smallest value measured by function f.

    Finds the first element which yields the smallest value measured by function f.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    returns

    the first element of this immutable map with the smallest value measured by function f with respect to the ordering cmp.

    Definition Classes
    IterableOnceOps
    Exceptions thrown

    UnsupportedOperationException if this immutable map is empty.

  100. def minByOption[B](f: ((K, V)) => B)(implicit ord: math.Ordering[B]): Option[(K, V)]

    Finds the first element which yields the smallest value measured by function f.

    Finds the first element which yields the smallest value measured by function f.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    returns

    an option value containing the first element of this immutable map with the smallest value measured by function f with respect to the ordering cmp.

    Definition Classes
    IterableOnceOps
  101. def minOption[B >: (K, V)](implicit ord: math.Ordering[B]): Option[(K, V)]

    Finds the smallest element.

    Finds the smallest element.

    Note: will not terminate for infinite-sized collections.

    B

    The type over which the ordering is defined.

    ord

    An ordering to be used for comparing elements.

    returns

    an option value containing the smallest element of this immutable map with respect to the ordering ord.

    Definition Classes
    IterableOnceOps
  102. final def mkString: String

    Displays all elements of this immutable map in a string.

    Displays all elements of this immutable map in a string.

    Delegates to addString, which can be overridden.

    returns

    a string representation of this immutable map. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable map follow each other without any separator string.

    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  103. final def mkString(sep: String): String

    Displays all elements of this immutable map in a string using a separator string.

    Displays all elements of this immutable map in a string using a separator string.

    Delegates to addString, which can be overridden.

    sep

    the separator string.

    returns

    a string representation of this immutable map. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable map are separated by the string sep.

    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
    Example:
    1. List(1, 2, 3).mkString("|") = "1|2|3"

  104. final def mkString(start: String, sep: String, end: String): String

    Displays all elements of this immutable map in a string using start, end, and separator strings.

    Displays all elements of this immutable map in a string using start, end, and separator strings.

    Delegates to addString, which can be overridden.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    a string representation of this immutable 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 immutable map are separated by the string sep.

    Definition Classes
    IterableOnceOps
    Example:
    1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

  105. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  106. def newSpecificBuilder: Builder[(K, V), Map[K, V]]

    returns

    a strict builder for the same collection type. Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList), it is possible to implement this method but the resulting Builder will break laziness. As a consequence, operations should preferably be implemented with fromSpecific instead of this method.

    Attributes
    protected
    Definition Classes
    MapFactoryDefaultsIterableOps
    Note

    When implementing a custom collection type and refining C to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case where C =:= CC[A], this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.

    ,

    As witnessed by the @uncheckedVariance annotation, using this method might be unsound. However, as long as the returned builder is only fed with A values taken from this instance, it is safe.

  107. def nonEmpty: Boolean

    Tests whether the immutable map is not empty.

    Tests whether the immutable map is not empty.

    returns

    true if the immutable map contains at least one element, false otherwise.

    Definition Classes
    IterableOnceOps
    Annotations
    @deprecatedOverriding()
  108. final def notify(): Unit

    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.

    Definition Classes
    AnyRef
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

  109. final def notifyAll(): Unit

    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.

    Definition Classes
    AnyRef
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

  110. def orElse[A1 <: K, B1 >: V](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

    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.

    A1

    the argument type of the fallback function

    B1

    the result type of the fallback function

    that

    the fallback function

    returns

    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.

    Definition Classes
    PartialFunction
  111. def partition(p: ((K, V)) => Boolean): (Map[K, V], Map[K, V])

    A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

    A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

    The two immutable map correspond to the result of filter and filterNot, respectively.

    The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.

    Definition Classes
    StrictOptimizedIterableOpsIterableOps
  112. def partitionMap[A1, A2](f: ((K, V)) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

    Applies a function f to each element of the immutable map and returns a pair of immutable maps: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

    Applies a function f to each element of the immutable map and returns a pair of immutable maps: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

    Example:

    val xs = `immutable.Map`(1, "one", 2, "two", 3, "three") partitionMap {
     case i: Int => Left(i)
     case s: String => Right(s)
    }
    // xs == (`immutable.Map`(1, 2, 3),
    //        `immutable.Map`(one, two, three))
    A1

    the element type of the first resulting collection

    A2

    the element type of the second resulting collection

    f

    the 'split function' mapping the elements of this immutable map to an scala.util.Either

    returns

    a pair of immutable maps: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

    Definition Classes
    StrictOptimizedIterableOpsIterableOps
  113. def product[B >: (K, V)](implicit num: math.Numeric[B]): B

    Multiplies together the elements of this collection.

    Multiplies together the elements of this collection.

    The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the * operator.

    num

    an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

    returns

    the product of all elements of this immutable map with respect to the * operator in num.

    Definition Classes
    IterableOnceOps
  114. def reduce[B >: (K, V)](op: (B, B) => B): B

    Applies the given binary operator op to all elements of this immutable map.

    Applies the given binary operator op to all elements of this immutable map.

    For each application of the operator, each operand is either an element of this immutable map or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

    If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

    Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

    The type parameter for the binary operator, a supertype of A.

    op

    A binary operator; must be associative for the result to always be the same across runs.

    returns

    The result of applying op between all the elements if the immutable map is nonempty.

    Definition Classes
    IterableOnceOps
    Exceptions thrown

    UnsupportedOperationException if this immutable map is empty.

  115. def reduceLeft[B >: (K, V)](op: (B, (K, V)) => B): B

    Applies the given binary operator op to all elements of this immutable map, going left to right.

    Applies the given binary operator op to all elements of this immutable map, going left to right.

    "Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this immutable map, the result is op( op( op( ... op(x1, x2) ... ), xn-1), xn).

    If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this immutable map and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

    Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of applying op to all elements of this immutable map, going left to right.

    Definition Classes
    IterableOnceOps
    Exceptions thrown

    UnsupportedOperationException if this immutable map is empty.

  116. def reduceLeftOption[B >: (K, V)](op: (B, (K, V)) => B): Option[B]

    If this immutable map is nonempty, reduces it with the given binary operator op, going left to right.

    If this immutable map is nonempty, reduces it with the given binary operator op, going left to right.

    The behavior is the same as reduceLeft except that the value is None if the immutable map is empty. Each element appears exactly once in the computation.

    Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of reducing this immutable map with op going left to right if the immutable map is nonempty, inside a Some, and None otherwise.

    Definition Classes
    IterableOnceOps
  117. def reduceOption[B >: (K, V)](op: (B, B) => B): Option[B]

    If this immutable map is nonempty, reduces it with the given binary operator op.

    If this immutable map is nonempty, reduces it with the given binary operator op.

    The behavior is the same as reduce except that the value is None if the immutable map is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

    Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

    A type parameter for the binary operator, a supertype of A.

    op

    A binary operator; must be associative for the result to always be the same across runs.

    returns

    The result of reducing this immutable map with op if the immutable map is nonempty, inside a Some, and None otherwise.

    Definition Classes
    IterableOnceOps
  118. def reduceRight[B >: (K, V)](op: ((K, V), B) => B): B

    Applies the given binary operator op to all elements of this immutable map, going right to left.

    Applies the given binary operator op to all elements of this immutable map, going right to left.

    "Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this immutable map, the result is op(x1, op(x2, op( ... op(xn-1, xn) ... ))).

    If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this immutable map and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

    Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of applying op to all elements of this immutable map, going right to left.

    Definition Classes
    IterableOnceOps
    Exceptions thrown

    UnsupportedOperationException if this immutable map is empty.

  119. def reduceRightOption[B >: (K, V)](op: ((K, V), B) => B): Option[B]

    If this immutable map is nonempty, reduces it with the given binary operator op, going right to left.

    If this immutable map is nonempty, reduces it with the given binary operator op, going right to left.

    The behavior is the same as reduceRight except that the value is None if the immutable map is empty. Each element appears exactly once in the computation.

    Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of reducing this immutable map with op going right to left if the immutable map is nonempty, inside a Some, and None otherwise.

    Definition Classes
    IterableOnceOps
  120. def removed(key: K): Map[K, V]

    Removes a key from this map, returning a new map.

    Removes a key from this map, returning a new map.

    key

    the key to be removed

    returns

    a new map without a binding for key

    Definition Classes
    Map2MapOps
  121. def removedAll(keys: IterableOnce[K]): Map[K, V]

    Creates a new immutable map from this immutable map by removing all elements of another collection.

    Creates a new immutable map from this immutable map by removing all elements of another collection.

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    keys

    the collection containing the removed elements.

    returns

    a new immutable map that contains all elements of the current immutable map except one less occurrence of each of the elements of elems.

    Definition Classes
    MapOps
  122. def reversed: collection.Iterable[(K, V)]
    Attributes
    protected
    Definition Classes
    IterableOnceOps
  123. def runWith[U](action: (V) => U): (K) => Boolean

    Composes this partial function with an action function which gets applied to results of this partial function.

    Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.

    Note that expression pf.runWith(action)(x) is equivalent to

    if(pf isDefinedAt x) { action(pf(x)); true } else false

    except that runWith is implemented via applyOrElse and thus potentially more efficient. Using runWith avoids double evaluation of pattern matchers and guards for partial function literals.

    action

    the action function

    returns

    a function which maps arguments x to isDefinedAt(x). The resulting function runs action(this(x)) where this is defined.

    Definition Classes
    PartialFunction
    See also

    applyOrElse.

  124. def scan[B >: (K, V)](z: B)(op: (B, B) => B): Iterable[B]

    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.

    B

    element type of the resulting collection

    z

    neutral element for the operator op

    op

    the associative operator for the scan

    returns

    a new immutable map containing the prefix scan of the elements in this immutable map

    Definition Classes
    IterableOps
  125. def scanLeft[B](z: B)(op: (B, (K, V)) => B): Iterable[B]

    Produces a immutable map containing cumulative results of applying the operator going left to right, including the initial value.

    Produces a immutable map containing cumulative results of applying the operator going left to right, including the initial value.

    Note: will not terminate for infinite-sized collections.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    B

    the type of the elements in the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    returns

    collection with intermediate results

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  126. def scanRight[B](z: B)(op: ((K, V), B) => B): Iterable[B]

    Produces a collection containing cumulative results of applying the operator going right to left.

    Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

    Note: will not terminate for infinite-sized collections.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    Example:

    List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
    B

    the type of the elements in the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    returns

    collection with intermediate results

    Definition Classes
    IterableOps
  127. def size: Int

    The size of this immutable map.

    The size of this immutable map.

    Note: will not terminate for infinite-sized collections.

    returns

    the number of elements in this immutable map.

    Definition Classes
    Map2IterableOnceOps
  128. def sizeCompare(that: collection.Iterable[_]): Int

    Compares the size of this immutable map to the size of another Iterable.

    Compares the size of this immutable map to the size of another Iterable.

    that

    the Iterable whose size is compared with this immutable map's size.

    returns

    A value x where

    x <  0       if this.size <  that.size
    x == 0       if this.size == that.size
    x >  0       if this.size >  that.size

    The method as implemented here does not call size directly; its running time is O(this.size min that.size) instead of O(this.size + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.

    Definition Classes
    IterableOps
  129. def sizeCompare(otherSize: Int): Int

    Compares the size of this immutable map to a test value.

    Compares the size of this immutable map to a test value.

    otherSize

    the test value that gets compared with the size.

    returns

    A value x where

    x <  0       if this.size <  otherSize
    x == 0       if this.size == otherSize
    x >  0       if this.size >  otherSize

    The method as implemented here does not call size directly; its running time is O(size min otherSize) instead of O(size). The method should be overridden if computing size is cheap and knownSize returns -1.

    Definition Classes
    IterableOps
    See also

    sizeIs

  130. final def sizeIs: SizeCompareOps

    Returns a value class containing operations for comparing the size of this immutable map to a test value.

    Returns a value class containing operations for comparing the size of this immutable map to a test value.

    These operations are implemented in terms of sizeCompare(Int), and allow the following more readable usages:

    this.sizeIs < size     // this.sizeCompare(size) < 0
    this.sizeIs <= size    // this.sizeCompare(size) <= 0
    this.sizeIs == size    // this.sizeCompare(size) == 0
    this.sizeIs != size    // this.sizeCompare(size) != 0
    this.sizeIs >= size    // this.sizeCompare(size) >= 0
    this.sizeIs > size     // this.sizeCompare(size) > 0
    Definition Classes
    IterableOps
    Annotations
    @inline()
  131. def slice(from: Int, until: Int): Map[K, V]

    Selects an interval of elements.

    Selects an interval of elements. The returned immutable map 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.

    from

    the lowest index to include from this immutable map.

    until

    the lowest index to EXCLUDE from this immutable map.

    returns

    a immutable map containing the elements greater than or equal to index from extending up to (but not including) index until of this immutable map.

    Definition Classes
    IterableOpsIterableOnceOps
  132. def sliding(size: Int, step: Int): Iterator[Map[K, V]]

    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 returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

    size

    the number of elements per group

    step

    the distance between the first elements of successive groups

    returns

    An iterator producing immutable maps of size size, except the last element (which may be the only element) will be smaller if there are fewer than size elements remaining to be grouped.

    Definition Classes
    IterableOps
    Examples:
    1. List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

    2. ,
    3. List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

    See also

    scala.collection.Iterator, method sliding

  133. def sliding(size: Int): Iterator[Map[K, V]]

    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).

    An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

    size

    the number of elements per group

    returns

    An iterator producing immutable maps of size size, except for a non-empty collection with less than size elements, which returns an iterator that produces the source collection itself as its only element.

    Definition Classes
    IterableOps
    Examples:
    1. List().sliding(2) = empty iterator

    2. ,
    3. List(1).sliding(2) = Iterator(List(1))

    4. ,
    5. List(1, 2).sliding(2) = Iterator(List(1, 2))

    6. ,
    7. List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

    See also

    scala.collection.Iterator, method sliding

  134. def span(p: ((K, V)) => Boolean): (Map[K, V], Map[K, V])

    Splits this immutable map into a prefix/suffix pair according to a predicate.

    Splits this immutable map 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.

    p

    the test predicate

    returns

    a pair consisting of the longest prefix of this immutable map whose elements all satisfy p, and the rest of this immutable map.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  135. def splitAt(n: Int): (Map[K, V], Map[K, V])

    Splits this immutable map into a prefix/suffix pair at a given position.

    Splits this immutable map into a prefix/suffix pair 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.

    n

    the position at which to split.

    returns

    a pair of immutable maps consisting of the first n elements of this immutable map, and the other elements.

    Definition Classes
    IterableOpsIterableOnceOps
  136. def stepper[S <: Stepper[_]](implicit shape: StepperShape[(K, V), S]): S

    Returns a scala.collection.Stepper for the elements of this collection.

    Returns a scala.collection.Stepper for the elements of this collection.

    The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.

    The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

    Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.

    Definition Classes
    IterableOnce
  137. final def strictOptimizedCollect[B, C2](b: Builder[B, C2], pf: PartialFunction[(K, V), B]): C2

    B

    Type of elements of the resulting collection (e.g. String)

    C2

    Type of the resulting collection (e.g. List[String])

    b

    Builder to use to build the resulting collection

    pf

    Element transformation partial function

    returns

    The resulting collection

    Attributes
    protected[this]
    Definition Classes
    StrictOptimizedIterableOps
    Annotations
    @inline()
  138. final def strictOptimizedConcat[B >: (K, V), C2](that: IterableOnce[B], b: Builder[B, C2]): C2

    B

    Type of elements of the resulting collections (e.g. Int)

    C2

    Type of the resulting collection (e.g. List[Int])

    that

    Elements to concatenate to this collection

    b

    Builder to use to build the resulting collection

    returns

    The resulting collection

    Attributes
    protected[this]
    Definition Classes
    StrictOptimizedIterableOps
    Annotations
    @inline()
  139. final def strictOptimizedFlatMap[B, C2](b: Builder[B, C2], f: ((K, V)) => IterableOnce[B]): C2

    B

    Type of elements of the resulting collection (e.g. String)

    C2

    Type of the resulting collection (e.g. List[String])

    b

    Builder to use to build the resulting collection

    f

    Element transformation function

    returns

    The resulting collection

    Attributes
    protected[this]
    Definition Classes
    StrictOptimizedIterableOps
    Annotations
    @inline()
  140. final def strictOptimizedFlatten[B, C2](b: Builder[B, C2])(implicit toIterableOnce: ((K, V)) => IterableOnce[B]): C2

    B

    Type of elements of the resulting collection (e.g. Int)

    C2

    Type of the resulting collection (e.g. List[Int])

    b

    Builder to use to build the resulting collection

    toIterableOnce

    Evidence that A can be seen as an IterableOnce[B]

    returns

    The resulting collection

    Attributes
    protected[this]
    Definition Classes
    StrictOptimizedIterableOps
    Annotations
    @inline()
  141. final def strictOptimizedMap[B, C2](b: Builder[B, C2], f: ((K, V)) => B): C2

    B

    Type of elements of the resulting collection (e.g. String)

    C2

    Type of the resulting collection (e.g. List[String])

    b

    Builder to use to build the resulting collection

    f

    Element transformation function

    returns

    The resulting collection

    Attributes
    protected[this]
    Definition Classes
    StrictOptimizedIterableOps
    Annotations
    @inline()
  142. final def strictOptimizedZip[B, C2](that: IterableOnce[B], b: Builder[((K, V), B), C2]): C2

    B

    Type of elements of the second collection (e.g. String)

    C2

    Type of the resulting collection (e.g. List[(Int, String)])

    that

    Collection to zip with this collection

    b

    Builder to use to build the resulting collection

    returns

    The resulting collection

    Attributes
    protected[this]
    Definition Classes
    StrictOptimizedIterableOps
    Annotations
    @inline()
  143. def stringPrefix: String
    Attributes
    protected[this]
    Definition Classes
    MapIterable
    Annotations
    @nowarn()
  144. def sum[B >: (K, V)](implicit num: math.Numeric[B]): B

    Sums the elements of this collection.

    Sums the elements of this collection.

    The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the + operator.

    num

    an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

    returns

    the sum of all elements of this immutable map with respect to the + operator in num.

    Definition Classes
    IterableOnceOps
  145. final def synchronized[T0](arg0: => T0): T0

    Executes the code in body with an exclusive lock on this.

    Executes the code in body with an exclusive lock on this.

    returns

    the result of body

    Definition Classes
    AnyRef
  146. def tail: Map[K, V]

    The rest of the collection without its first element.

    The rest of the collection without its first element.

    Definition Classes
    IterableOps
  147. def tails: Iterator[Map[K, V]]

    Iterates over the tails of this immutable map.

    Iterates over the tails of this immutable map. The first value will be this immutable map and the final one will be an empty immutable map, with the intervening values the results of successive applications of tail.

    returns

    an iterator over all the tails of this immutable map

    Definition Classes
    IterableOps
    Example:
    1. List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

  148. def take(n: Int): Map[K, V]

    Selects the first n elements.

    Selects the first n elements.

    Note: might return different results for different runs, unless the underlying collection type is ordered.

    n

    the number of elements to take from this immutable map.

    returns

    a immutable map consisting only of the first n elements of this immutable map, or else the whole immutable map, if it has less than n elements. If n is negative, returns an empty immutable map.

    Definition Classes
    IterableOpsIterableOnceOps
  149. def takeRight(n: Int): Map[K, V]

    A collection containing the last n elements of this collection.

    A collection containing the last n elements of this collection.

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    n

    the number of elements to take from this immutable map.

    returns

    a immutable map consisting only of the last n elements of this immutable map, or else the whole immutable map, if it has less than n elements. If n is negative, returns an empty immutable map.

    Definition Classes
    StrictOptimizedIterableOpsIterableOps
  150. def takeWhile(p: ((K, V)) => Boolean): Map[K, V]

    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.

    p

    The predicate used to test elements.

    returns

    the longest prefix of this immutable map whose elements all satisfy the predicate p.

    Definition Classes
    IterableOpsIterableOnceOps
  151. def tapEach[U](f: ((K, V)) => U): Map[K, V]

    Applies a side-effecting function to each element in this collection.

    Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

    U

    the return type of f

    f

    a function to apply to each element in this immutable map

    returns

    The same logical collection as this

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
  152. def to[C1](factory: Factory[(K, V), C1]): C1

    Given a collection factory factory, converts this immutable map to the appropriate representation for the current element type A.

    Given a collection factory factory, converts this immutable map to the appropriate representation for the current element type A. Example uses:

    xs.to(List)
    xs.to(ArrayBuffer)
    xs.to(BitSet) // for xs: Iterable[Int]
    Definition Classes
    IterableOnceOps
  153. def toArray[B >: (K, V)](implicit arg0: ClassTag[B]): Array[B]

    Converts this immutable map to an Array.

    Converts this immutable map to an Array.

    Implementation note: DO NOT call Array.from from this method.

    B

    The type of elements of the result, a supertype of A.

    returns

    This immutable map as an Array[B].

    Definition Classes
    IterableOnceOps
  154. final def toBuffer[B >: (K, V)]: Buffer[B]

    Converts this immutable map to a Buffer.

    Converts this immutable map to a Buffer.

    B

    The type of elements of the result, a supertype of A.

    returns

    This immutable map as a Buffer[B].

    Definition Classes
    IterableOnceOps
    Annotations
    @inline()
  155. def toIndexedSeq: IndexedSeq[(K, V)]

    Converts this immutable map to an IndexedSeq.

    Converts this immutable map to an IndexedSeq.

    returns

    This immutable map as an IndexedSeq[A].

    Definition Classes
    IterableOnceOps
  156. def toList: List[(K, V)]

    Converts this immutable map to a List.

    Converts this immutable map to a List.

    returns

    This immutable map as a List[A].

    Definition Classes
    IterableOnceOps
  157. final def toMap[K2, V2](implicit ev: <:<[(K, V), (K2, V2)]): Map[K2, V2]

    Converts this immutable map to a Map, given an implicit coercion from the immutable map's type to a key-value tuple.

    Converts this immutable map to a Map, given an implicit coercion from the immutable map's type to a key-value tuple.

    ev

    An implicit coercion from A to [K, V].

    returns

    This immutable map as a Map[K, V].

    Definition Classes
    MapIterableOnceOps
  158. def toSeq: Seq[(K, V)]

    returns

    This immutable map as a Seq[A]. This is equivalent to to(Seq) but might be faster.

    Definition Classes
    IterableOnceOps
  159. def toSet[B >: (K, V)]: Set[B]

    Converts this immutable map to a Set.

    Converts this immutable map to a Set.

    B

    The type of elements of the result, a supertype of A.

    returns

    This immutable map as a Set[B].

    Definition Classes
    IterableOnceOps
  160. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    MapFunction1Iterable → AnyRef → Any
  161. def toVector: Vector[(K, V)]

    Converts this immutable map to a Vector.

    Converts this immutable map to a Vector.

    returns

    This immutable map as a Vector[A].

    Definition Classes
    IterableOnceOps
  162. def transform[W](f: (K, V) => W): Map[K, W]

    This function transforms all the values of mappings contained in this map with function f.

    This function transforms all the values of mappings contained in this map with function f.

    f

    A function over keys and values

    returns

    the updated map

    Definition Classes
    Map2MapOps
  163. def transpose[B](implicit asIterable: ((K, V)) => collection.Iterable[B]): Iterable[Iterable[B]]

    Transposes this immutable map of iterable collections into a immutable map of immutable maps.

    Transposes this immutable map of iterable collections into a immutable map of immutable maps.

    The resulting collection's type will be guided by the static type of immutable map. For example:

    val xs = List(
               Set(1, 2, 3),
               Set(4, 5, 6)).transpose
    // xs == List(
    //         List(1, 4),
    //         List(2, 5),
    //         List(3, 6))
    
    val ys = Vector(
               List(1, 2, 3),
               List(4, 5, 6)).transpose
    // ys == Vector(
    //         Vector(1, 4),
    //         Vector(2, 5),
    //         Vector(3, 6))

    Note: Even when applied to a view or a lazy collection it will always force the elements.

    B

    the type of the elements of each iterable collection.

    asIterable

    an implicit conversion which asserts that the element type of this immutable map is an Iterable.

    returns

    a two-dimensional immutable map of immutable maps which has as nth row the nth column of this immutable map.

    Definition Classes
    IterableOps
    Exceptions thrown

    IllegalArgumentException if all collections in this immutable map are not of the same size.

  164. def unapply(a: K): Option[V]

    Tries to extract a B from an A in a pattern matching expression.

    Tries to extract a B from an A in a pattern matching expression.

    Definition Classes
    PartialFunction
  165. def unlift: PartialFunction[K, B]

    Converts an optional function to a partial function.

    Converts an optional function to a partial function.

    Implicit
    This member is added by an implicit conversion from Map2[K, V] toUnliftOps[K, B] performed by method UnliftOps in scala.Function1.This conversion will take place only if V is a subclass of Option[B] (V <: Option[B]).
    Definition Classes
    UnliftOps
    Example:
    1. Unlike Function.unlift, this UnliftOps.unlift method can be used in extractors.

      val of: Int => Option[String] = { i =>
        if (i == 2) {
          Some("matched by an optional function")
        } else {
          None
        }
      }
      
      util.Random.nextInt(4) match {
        case of.unlift(m) => // Convert an optional function to a pattern
          println(m)
        case _ =>
          println("Not matched")
      }
  166. def unzip[A1, A2](implicit asPair: ((K, V)) => (A1, A2)): (Iterable[A1], Iterable[A2])

    Converts this immutable map of pairs into two collections of the first and second half of each pair.

    Converts this immutable map of pairs into two collections of the first and second half of each pair.

    val xs = `immutable.Map`(
               (1, "one"),
               (2, "two"),
               (3, "three")).unzip
    // xs == (`immutable.Map`(1, 2, 3),
    //        `immutable.Map`(one, two, three))
    A1

    the type of the first half of the element pairs

    A2

    the type of the second half of the element pairs

    asPair

    an implicit conversion which asserts that the element type of this immutable map is a pair.

    returns

    a pair of immutable maps, containing the first, respectively second half of each element pair of this immutable map.

    Definition Classes
    StrictOptimizedIterableOpsIterableOps
  167. def unzip3[A1, A2, A3](implicit asTriple: ((K, V)) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

    Converts this immutable map of triples into three collections of the first, second, and third element of each triple.

    Converts this immutable map of triples into three collections of the first, second, and third element of each triple.

    val xs = `immutable.Map`(
               (1, "one", '1'),
               (2, "two", '2'),
               (3, "three", '3')).unzip3
    // xs == (`immutable.Map`(1, 2, 3),
    //        `immutable.Map`(one, two, three),
    //        `immutable.Map`(1, 2, 3))
    A1

    the type of the first member of the element triples

    A2

    the type of the second member of the element triples

    A3

    the type of the third member of the element triples

    asTriple

    an implicit conversion which asserts that the element type of this immutable map is a triple.

    returns

    a triple of immutable maps, containing the first, second, respectively third member of each element triple of this immutable map.

    Definition Classes
    StrictOptimizedIterableOpsIterableOps
  168. def updated[V1 >: V](key: K, value: V1): Map[K, V1]

    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.

    V1

    the type of the added value

    key

    the key

    value

    the value

    returns

    A new map with the new key/value mapping added to this map.

    Definition Classes
    Map2MapOps
  169. def updatedWith[V1 >: V](key: K)(remappingFunction: (Option[V]) => Option[V1]): Map[K, V1]

    Update a mapping for the specified key and its current optionally mapped value (Some if there is current mapping, None if not).

    Update a mapping for the specified key and its current optionally mapped value (Some if there is current mapping, None if not).

    If the remapping function returns Some(v), the mapping is updated with the new value v. If the remapping function returns None, the mapping is removed (or remains absent if initially absent). If the function itself throws an exception, the exception is rethrown, and the current mapping is left unchanged.

    key

    the key value

    remappingFunction

    a function that receives current optionally mapped value and return a new mapping

    returns

    A new map with the updated mapping with the key

    Definition Classes
    MapOps
  170. def valueStepper[S <: Stepper[_]](implicit shape: StepperShape[V, S]): S

    Returns a Stepper for the values of this map.

    Returns a Stepper for the values of this map. See method stepper.

    Definition Classes
    MapOps
  171. def values: collection.Iterable[V]

    Collects all values of this map in an iterable collection.

    Collects all values of this map in an iterable collection.

    returns

    the values of this map as an iterable.

    Definition Classes
    MapOps
  172. def valuesIterator: Iterator[V]

    Creates an iterator for all values in this map.

    Creates an iterator for all values in this map.

    returns

    an iterator over all values that are associated with some key in this map.

    Definition Classes
    Map2MapOps
  173. def view: MapView[K, V]

    A view over the elements of this collection.

    A view over the elements of this collection.

    Definition Classes
    MapOpsIterableOps
  174. final def wait(): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  175. final def wait(arg0: Long, arg1: Int): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  176. final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  177. def withDefault[V1 >: V](d: (K) => V1): Map[K, V1]

    The same map with a given default function.

    The same map with a given default function. Note: The default is only used for apply. Other methods like get, contains, iterator, keys, etc. are not affected by withDefault.

    Invoking transformer methods (e.g. map) will not preserve the default value.

    d

    the function mapping keys to values, used for non-present keys

    returns

    a wrapper of the map with a default value

    Definition Classes
    Map
  178. def withDefaultValue[V1 >: V](d: V1): Map[K, V1]

    The same map with a given default value.

    The same map with a given default value. Note: The default is only used for apply. Other methods like get, contains, iterator, keys, etc. are not affected by withDefaultValue.

    Invoking transformer methods (e.g. map) will not preserve the default value.

    d

    default value used for non-present keys

    returns

    a wrapper of the map with a default value

    Definition Classes
    Map
  179. def withFilter(p: ((K, V)) => Boolean): MapOps.WithFilter[K, V, [x]Iterable[x], [x, y]Map[x, y]]

    Creates a non-strict filter of this immutable map.

    Creates a non-strict filter of this immutable 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.

    p

    the predicate used to test elements.

    returns

    an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this immutable map which satisfy the predicate p.

    Definition Classes
    MapFactoryDefaultsIterableOps
  180. def zip[B](that: IterableOnce[B]): Iterable[((K, V), B)]

    Returns a immutable map formed from this immutable map and another iterable collection by combining corresponding elements in pairs.

    Returns a immutable map formed from this immutable 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.

    B

    the type of the second half of the returned pairs

    that

    The iterable providing the second half of each result pair

    returns

    a new immutable map containing pairs consisting of corresponding elements of this immutable map and that. The length of the returned collection is the minimum of the lengths of this immutable map and that.

    Definition Classes
    StrictOptimizedIterableOpsIterableOps
  181. def zipAll[A1 >: (K, V), B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

    Returns a immutable map formed from this immutable map and another iterable collection by combining corresponding elements in pairs.

    Returns a immutable map formed from this immutable 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.

    that

    the iterable providing the second half of each result pair

    thisElem

    the element to be used to fill up the result if this immutable map is shorter than that.

    thatElem

    the element to be used to fill up the result if that is shorter than this immutable map.

    returns

    a new collection of type That containing pairs consisting of corresponding elements of this immutable map and that. The length of the returned collection is the maximum of the lengths of this immutable map and that. If this immutable map is shorter than that, thisElem values are used to pad the result. If that is shorter than this immutable map, thatElem values are used to pad the result.

    Definition Classes
    IterableOps
  182. def zipWithIndex: Iterable[((K, V), Int)]

    Zips this immutable map with its indices.

    Zips this immutable map with its indices.

    returns

    A new immutable map containing pairs consisting of all elements of this immutable map paired with their index. Indices start at 0.

    Definition Classes
    StrictOptimizedIterableOpsIterableOpsIterableOnceOps
    Example:
    1. List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Shadowed Implicit Value Members

  1. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toany2stringadd[Map2[K, V]] performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: any2stringadd[Map2[K, V]]).+(other)
    Definition Classes
    any2stringadd

Deprecated Value Members

  1. def +[V1 >: V](elem1: (K, V1), elem2: (K, V1), elems: (K, V1)*): Map[K, V1]
    Definition Classes
    MapOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use ++ with an explicit collection argument instead of + with varargs

  2. def ++:[V1 >: V](that: IterableOnce[(K, V1)]): Map[K, V1]
    Definition Classes
    MapOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use ++ instead of ++: for collections of type Iterable

  3. def ++:[B >: (K, V)](that: IterableOnce[B]): Iterable[B]
    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use ++ instead of ++: for collections of type Iterable

  4. def -(key1: K, key2: K, keys: K*): Map[K, V]
    Definition Classes
    MapOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -- with an explicit collection

  5. def /:[B](z: B)(op: (B, (K, V)) => B): B
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)])./:(z)(op)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldLeft instead

  6. final def /:[B](z: B)(op: (B, (K, V)) => B): B
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use foldLeft instead of /:

  7. def :\[B](z: B)(op: ((K, V), B) => B): B
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).:\(z)(op)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldRight instead

  8. final def :\[B](z: B)(op: ((K, V), B) => B): B
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use foldRight instead of :\

  9. def aggregate[B](z: => B)(seqop: (B, (K, V)) => B, combop: (B, B) => B): B

    Aggregates the results of applying an operator to subsequent elements.

    Aggregates the results of applying an operator to subsequent elements.

    Since this method degenerates to foldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to prefer foldLeft for that case.

    For parallel collections, use the aggregate method specified by scala.collection.parallel.ParIterableLike.

    B

    the result type, produced by seqop, combop, and by this function as a final result.

    z

    the start value, a neutral element for seqop.

    seqop

    the binary operator used to accumulate the result.

    combop

    an associative operator for combining sequential results, unused for sequential collections.

    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) For sequential collections, prefer foldLeft(z)(seqop). For parallel collections, use ParIterableLike#aggregate.

  10. def collectFirst[B](f: PartialFunction[(K, V), B]): Option[B]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).collectFirst(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.collectFirst(...) instead

  11. def companion: IterableFactory[[_]Iterable[_]]
    Definition Classes
    IterableOps
    Annotations
    @deprecated @deprecatedOverriding() @inline()
    Deprecated

    (Since version 2.13.0) Use iterableFactory instead

  12. def copyToBuffer(dest: Buffer[(K, V)]): Unit
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).copyToBuffer(dest)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.copyToBuffer(...) instead

  13. final def copyToBuffer[B >: (K, V)](dest: Buffer[B]): Unit
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use dest ++= coll instead

  14. def count(f: ((K, V)) => Boolean): Int
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).count(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.count(...) instead

  15. def exists(f: ((K, V)) => Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).exists(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.exists(...) instead

  16. def filter(f: ((K, V)) => Boolean): Iterator[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).filter(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.filter(...) instead

  17. def filterKeys(p: (K) => Boolean): MapView[K, V]

    Filters this map by retaining only keys satisfying a predicate.

    Filters this map by retaining only keys satisfying a predicate.

    p

    the predicate used to test keys

    returns

    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.

    Definition Classes
    MapOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .view.filterKeys(f). A future version will include a strict version of this method (for now, .view.filterKeys(p).toMap).

  18. def find(p: ((K, V)) => Boolean): Option[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).find(p)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.find instead

  19. def flatMap[B](f: ((K, V)) => IterableOnce[B]): IterableOnce[B]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).flatMap(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.flatMap instead or consider requiring an Iterable

  20. def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).fold(z)(op)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.fold instead

  21. def foldLeft[B](z: B)(op: (B, (K, V)) => B): B
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).foldLeft(z)(op)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldLeft instead

  22. def foldRight[B](z: B)(op: ((K, V), B) => B): B
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).foldRight(z)(op)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldRight instead

  23. def forall(f: ((K, V)) => Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).forall(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.forall(...) instead

  24. def foreach[U](f: ((K, V)) => U): Unit
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).foreach(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foreach(...) instead

  25. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit
    This member is added by an implicit conversion from Map2[K, V] toStringFormat[Map2[K, V]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  26. def hasDefiniteSize: Boolean

    Tests whether this immutable map is known to have a finite size.

    Tests whether this immutable 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. Non-empty Iterators usually return false even if they were created from a collection with a known finite size.

    Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns true. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

    returns

    true if this collection is known to have finite size, false otherwise.

    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)

    See also

    method knownSize for a more useful alternative

  27. def isEmpty: Boolean
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).isEmpty
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.isEmpty instead

  28. def map[B](f: ((K, V)) => B): IterableOnce[B]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).map(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.map instead or consider requiring an Iterable

  29. def mapValues[W](f: (V) => W): MapView[K, W]

    Transforms this map by applying a function to every retrieved value.

    Transforms this map by applying a function to every retrieved value.

    f

    the function used to transform values of this map.

    returns

    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.

    Definition Classes
    MapOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .view.mapValues(f). A future version will include a strict version of this method (for now, .view.mapValues(f).toMap).

  30. def max(implicit ord: math.Ordering[(K, V)]): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).max(ord)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.max instead

  31. def maxBy[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).maxBy(f)(cmp)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.maxBy(...) instead

  32. def min(implicit ord: math.Ordering[(K, V)]): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).min(ord)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.min instead

  33. def minBy[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).minBy(f)(cmp)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.minBy(...) instead

  34. def mkString: String
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).mkString
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.mkString instead

  35. def mkString(sep: String): String
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).mkString(sep)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.mkString instead

  36. def mkString(start: String, sep: String, end: String): String
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).mkString(start, sep, end)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.mkString instead

  37. def nonEmpty: Boolean
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).nonEmpty
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.nonEmpty instead

  38. def product(implicit num: math.Numeric[(K, V)]): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).product(num)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.product instead

  39. def reduce(f: ((K, V), (K, V)) => (K, V)): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).reduce(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduce(...) instead

  40. def reduceLeft(f: ((K, V), (K, V)) => (K, V)): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).reduceLeft(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceLeft(...) instead

  41. def reduceLeftOption(f: ((K, V), (K, V)) => (K, V)): Option[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).reduceLeftOption(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceLeftOption(...) instead

  42. def reduceOption(f: ((K, V), (K, V)) => (K, V)): Option[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).reduceOption(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceOption(...) instead

  43. def reduceRight(f: ((K, V), (K, V)) => (K, V)): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).reduceRight(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceRight(...) instead

  44. def reduceRightOption(f: ((K, V), (K, V)) => (K, V)): Option[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).reduceRightOption(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceRightOption(...) instead

  45. final def repr: Map[K, V]
    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use coll instead of repr in a collection implementation, use the collection value itself from the outside

  46. def sameElements[B >: A](that: IterableOnce[B]): Boolean
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.sameElements instead

  47. def seq: Map2.this.type
    Definition Classes
    Iterable
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Iterable.seq always returns the iterable itself

  48. def size: Int
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).size
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.size instead

  49. def sum(implicit num: math.Numeric[(K, V)]): (K, V)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).sum(num)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.sum instead

  50. def to[C1](factory: Factory[(K, V), C1]): C1
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).to(factory)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(factory) instead

  51. def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toArray(arg0)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.toArray

  52. def toBuffer[B >: A]: Buffer[B]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toBuffer
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(ArrayBuffer) instead

  53. def toIndexedSeq: collection.IndexedSeq[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toIndexedSeq
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.toIndexedSeq instead

  54. final def toIterable: collection.Iterable[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toIterable
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Iterable) instead

  55. final def toIterable: Map2.this.type

    returns

    This collection as an Iterable[A]. No new collection will be built if this is already an Iterable[A].

    Definition Classes
    IterableIterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections

  56. def toIterator: Iterator[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toIterator
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator instead

  57. final def toIterator: Iterator[(K, V)]
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator instead of .toIterator

  58. def toList: List[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toList
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(List) instead

  59. def toMap[K, V](implicit ev: <:<[(K, V), (K, V)]): Map[K, V]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toMap(ev)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Map) instead

  60. def toSeq: Seq[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toSeq
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Seq) instead

  61. def toSet[B >: A]: Set[B]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toSet
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Set) instead

  62. def toStream: Stream[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toStream
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(LazyList) instead

  63. final def toStream: Stream[(K, V)]
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .to(LazyList) instead of .toStream

  64. final def toTraversable: collection.Traversable[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toTraversable
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Iterable) instead

  65. final def toTraversable: collection.Traversable[(K, V)]

    Converts this immutable map to an unspecified Iterable.

    Converts this immutable map to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

    returns

    An Iterable containing all elements of this immutable map.

    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) toTraversable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections

  66. def toVector: Vector[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).toVector
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Vector) instead

  67. def view(from: Int, until: Int): View[(K, V)]

    A view over a slice of the elements of this collection.

    A view over a slice of the elements of this collection.

    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .view.slice(from, until) instead of .view(from, until)

  68. def withFilter(f: ((K, V)) => Boolean): Iterator[(K, V)]
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toIterableOnceExtensionMethods[(K, V)] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (map2: IterableOnceExtensionMethods[(K, V)]).withFilter(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.withFilter(...) instead

  69. def [B](y: B): (Map2[K, V], B)
    Implicit
    This member is added by an implicit conversion from Map2[K, V] toArrowAssoc[Map2[K, V]] performed by method ArrowAssoc in scala.Predef.This conversion will take place only if V is a subclass of Option[Nothing] (V <: Option[Nothing]).
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from java.io.Serializable

Inherited from StrictOptimizedIterableOps[(K, V), Iterable, Map[K, V]]

Inherited from AbstractMap[K, V]

Inherited from Map[K, V]

Inherited from MapOps[K, V, Map, Map[K, V]]

Inherited from Iterable[(K, V)]

Inherited from collection.AbstractMap[K, V]

Inherited from collection.Map[K, V]

Inherited from Equals

Inherited from MapFactoryDefaults[K, V, [x, y]Map[x, y], [x]Iterable[x]]

Inherited from collection.MapOps[K, V, [_, _]Map[_, _], Map[K, V]]

Inherited from PartialFunction[K, V]

Inherited from (K) => V

Inherited from AbstractIterable[(K, V)]

Inherited from collection.Iterable[(K, V)]

Inherited from IterableFactoryDefaults[(K, V), [x]Iterable[x]]

Inherited from IterableOps[(K, V), [_]Iterable[_], Map[K, V]]

Inherited from IterableOnceOps[(K, V), [_]Iterable[_], Map[K, V]]

Inherited from IterableOnce[(K, V)]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion UnliftOps fromMap2[K, V] to UnliftOps[K, B]

Inherited by implicit conversion iterableOnceExtensionMethods fromMap2[K, V] to IterableOnceExtensionMethods[(K, V)]

Inherited by implicit conversion any2stringadd fromMap2[K, V] to any2stringadd[Map2[K, V]]

Inherited by implicit conversion StringFormat fromMap2[K, V] to StringFormat[Map2[K, V]]

Inherited by implicit conversion Ensuring fromMap2[K, V] to Ensuring[Map2[K, V]]

Inherited by implicit conversion ArrowAssoc fromMap2[K, V] to ArrowAssoc[Map2[K, V]]

Ungrouped