scala.collection.immutable

ListMap

class ListMap[A, +B] extends AbstractMap[A, B] with Map[A, B] with MapLike[A, B, ListMap[A, B]] with Serializable

This class implements immutable maps using a list-based data structure. Instances of ListMap represent empty maps; they can be either created by calling the constructor directly, or by applying the function ListMap.empty.

A

the type of the keys in this list map.

B

the type of the values associated with the keys.

Annotations
@SerialVersionUID( uid = 301002838095710379L )
Source
ListMap.scala
Version

2.0, 01/01/2007

Since

1

Linear Supertypes
Serializable, java.io.Serializable, AbstractMap[A, B], Map[A, B], MapLike[A, B, ListMap[A, B]], Iterable[(A, B)], Traversable[(A, B)], Immutable, collection.AbstractMap[A, B], collection.Map[A, B], collection.MapLike[A, B, ListMap[A, B]], Subtractable[A, ListMap[A, B]], PartialFunction[A, B], (A) ⇒ B, GenMap[A, B], GenMapLike[A, B, ListMap[A, B]], AbstractIterable[(A, B)], collection.Iterable[(A, B)], IterableLike[(A, B), ListMap[A, B]], Equals, GenIterable[(A, B)], GenIterableLike[(A, B), ListMap[A, B]], AbstractTraversable[(A, B)], collection.Traversable[(A, B)], GenTraversable[(A, B)], GenericTraversableTemplate[(A, B), Iterable], TraversableLike[(A, B), ListMap[A, B]], GenTraversableLike[(A, B), ListMap[A, B]], Parallelizable[(A, B), ParMap[A, B]], TraversableOnce[(A, B)], GenTraversableOnce[(A, B)], FilterMonadic[(A, B), ListMap[A, B]], HasNewBuilder[(A, B), ListMap[A, B]], AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ListMap
  2. Serializable
  3. Serializable
  4. AbstractMap
  5. Map
  6. MapLike
  7. Iterable
  8. Traversable
  9. Immutable
  10. AbstractMap
  11. Map
  12. MapLike
  13. Subtractable
  14. PartialFunction
  15. Function1
  16. GenMap
  17. GenMapLike
  18. AbstractIterable
  19. Iterable
  20. IterableLike
  21. Equals
  22. GenIterable
  23. GenIterableLike
  24. AbstractTraversable
  25. Traversable
  26. GenTraversable
  27. GenericTraversableTemplate
  28. TraversableLike
  29. GenTraversableLike
  30. Parallelizable
  31. TraversableOnce
  32. GenTraversableOnce
  33. FilterMonadic
  34. HasNewBuilder
  35. AnyRef
  36. Any
Implicitly
  1. by traversable2ops
  2. by MonadOps
  3. by any2stringadd
  4. by any2stringfmt
  5. by any2ArrowAssoc
  6. by any2Ensuring
  7. by alternateImplicit
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ListMap()

Type Members

  1. class DefaultKeySet extends AbstractSet[A] with Set[A] with Serializable

    The implementation class of the set returned by keySet.

  2. class DefaultValuesIterable extends AbstractIterable[B] with Iterable[B] with Serializable

    The implementation class of the iterable returned by values.

  3. class FilteredKeys extends AbstractMap[A, B] with DefaultMap[A, B]

    Attributes
    protected
    Definition Classes
    MapLike
  4. class ImmutableDefaultKeySet extends DefaultKeySet with Set[A]

    Attributes
    protected
    Definition Classes
    MapLike
  5. class MappedValues[C] extends AbstractMap[A, C] with DefaultMap[A, C]

    Attributes
    protected
    Definition Classes
    MapLike
  6. class Node[B1 >: B] extends ListMap[A, B1] with Serializable

    This class represents an entry in the ListMap.

  7. type Self = ListMap[A, B]

    The type implementing this traversable

    The type implementing this traversable

    Attributes
    protected
    Definition Classes
    TraversableLike
  8. class WithFilter extends FilterMonadic[A, Repr]

    A class supporting filtered operations.

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

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

    Definition Classes
    Any
  3. 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
  4. def +[B1 >: B](elem1: (A, B1), elem2: (A, B1), elems: (A, B1)*): ListMap[A, B1]

    Adds two or more elements to this collection and returns either the collection itself (if it is mutable), or a new collection with the added elements.

    Adds two or more elements to this collection and returns either the collection itself (if it is mutable), or a new collection with the added elements.

    B1

    the type of the added values

    elem1

    the first element to add.

    elem2

    the second element to add.

    elems

    the remaining elements to add.

    returns

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

    Definition Classes
    ListMapMapLikeMapLike
  5. def +[B1 >: B](kv: (A, B1)): ListMap[A, B1]

    Add a key/value pair to this map.

    Add a key/value pair to this map.

    B1

    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
    ListMapMapMapLikeMapLikeGenMapLike
  6. def ++[B1 >: B](xs: GenTraversableOnce[(A, B1)]): ListMap[A, B1]

    Adds a number of elements provided by a traversable object and returns a new collection with the added elements.

    Adds a number of elements provided by a traversable object and returns a new collection with the added elements.

    B1

    the type of the added values

    xs

    the traversable object.

    returns

    a new immutable map with the bindings of this map and those from xs.

    Definition Classes
    ListMapMapLikeMapLike
  7. def ++[B](that: GenTraversableOnce[B]): ListMap[B]

    [use case] Returns a new immutable list map containing the elements from the left hand operand followed by the elements from the right hand operand.

    [use case]

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

    Example:

    scala> val a = LinkedList(1)
    a: scala.collection.mutable.LinkedList[Int] = LinkedList(1)
    
    scala> val b = LinkedList(2)
    b: scala.collection.mutable.LinkedList[Int] = LinkedList(2)
    
    scala> val c = a ++ b
    c: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
    
    scala> val d = LinkedList('a')
    d: scala.collection.mutable.LinkedList[Char] = LinkedList(a)
    
    scala> val e = c ++ d
    e: scala.collection.mutable.LinkedList[AnyVal] = LinkedList(1, 2, a)
    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
    Full Signature

    def ++[B >: (A, B), That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

  8. def ++:[B >: (A, B), That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

    As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

    Example:

    scala> val x = List(1)
    x: List[Int] = List(1)
    
    scala> val y = LinkedList(2)
    y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)
    
    scala> val z = x ++: y
    z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

    This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

    Since TraversableOnce has no ++ method, we have to implement that directly, but Traversable and down can use the overload.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the traversable to append.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That which contains all elements of this immutable list map followed by all elements of that.

    Definition Classes
    TraversableLike
  9. def ++:[B](that: TraversableOnce[B]): ListMap[B]

    [use case] As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    [use case]

    As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

    Example:

    scala> val x = List(1)
    x: List[Int] = List(1)
    
    scala> val y = LinkedList(2)
    y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)
    
    scala> val z = x ++: y
    z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

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

    Definition Classes
    TraversableLike
    Full Signature

    def ++:[B >: (A, B), That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

  10. def -(key: A): ListMap[A, B]

    This creates a new mapping without the given key.

    This creates a new mapping without the given key. If the map does not contain a mapping for the given key, the method returns the same map.

    key

    a map without a mapping for the given key.

    returns

    a new map without a binding for key

    Definition Classes
    ListMapMapLikeSubtractableGenMapLike
  11. def -(elem1: A, elem2: A, elems: A*): ListMap[A, B]

    Creates a new immutable list map from this immutable list map with some elements removed.

    Creates a new immutable list map from this immutable list map with some elements removed.

    This method takes two or more elements to be removed. Another overloaded variant of this method handles the case where a single element is removed.

    elem1

    the first element to remove.

    elem2

    the second element to remove.

    elems

    the remaining elements to remove.

    returns

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

    Definition Classes
    Subtractable
  12. def --(xs: GenTraversableOnce[A]): ListMap[A, B]

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

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

    xs

    the collection containing the removed elements.

    returns

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

    Definition Classes
    Subtractable
  13. def ->[B](y: B): (ListMap[A, B], B)

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to ArrowAssoc[ListMap[A, B]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  14. def /:[B](z: B)(op: (B, (A, B)) ⇒ B): B

    Applies a binary operator to a start value and all elements of this immutable list map, going left to right.

    Applies a binary operator to a start value and all elements of this immutable list map, going left to right.

    Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.

    Examples:

    Note that the folding function used to compute b is equivalent to that used to compute c.

    scala> val a = LinkedList(1,2,3,4)
    a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)
    
    scala> val b = (5 /: a)(_+_)
    b: Int = 15
    
    scala> val c = (5 /: a)((x,y) => x + y)
    c: Int = 15

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

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable list map, going left to right with the start value z on the left:

    op(...op(op(z, x_1), x_2), ..., x_n)

    where x1, ..., xn are the elements of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
  15. def :\[B](z: B)(op: ((A, B), B) ⇒ B): B

    Applies a binary operator to all elements of this immutable list map and a start value, going right to left.

    Applies a binary operator to all elements of this immutable list map and a start value, going right to left.

    Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.

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

    Examples:

    Note that the folding function used to compute b is equivalent to that used to compute c.

    scala> val a = LinkedList(1,2,3,4)
    a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)
    
    scala> val b = (a :\ 5)(_+_)
    b: Int = 15
    
    scala> val c = (a :\ 5)((x,y) => x + y)
    c: Int = 15
    B

    the result type of the binary operator.

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this immutable list map, going right to left with the start value z on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))

    where x1, ..., xn are the elements of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
  16. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. 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
    Any
  18. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

    Appends all bindings of this map to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations of all bindings of this map in the form of key -> value are separated by the string sep.

    b

    the builder to which strings are appended.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    MapLikeTraversableOnce
  19. def addString(b: StringBuilder): StringBuilder

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

    Appends all elements of this immutable list 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 list map without any separator string.

    Example:

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

    the string builder to which elements are appended.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    TraversableOnce
  20. def addString(b: StringBuilder, sep: String): StringBuilder

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

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

    Example:

    scala> val a = LinkedList(1,2,3,4)
    a: scala.collection.mutable.LinkedList[Int] = LinkedList(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
    TraversableOnce
  21. def aggregate[B](z: B)(seqop: (B, (A, B)) ⇒ 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.

    This is a more general form of fold and reduce. It has similar semantics, but does not require the result to be a supertype of the element type. It traverses the elements in different partitions sequentially, using seqop to update the result, and then applies combop to results from different partitions. The implementation of this operation may operate on an arbitrary number of collection partitions, so combop may be invoked an arbitrary number of times.

    For example, one might want to process some elements and then produce a Set. In this case, seqop would process an element and append it to the list, while combop would concatenate two lists from different partitions together. The initial value z would be an empty set.

    pc.aggregate(Set[Int]())(_ += process(_), _ ++ _)

    Another example is calculating geometric mean from a collection of doubles (one would typically require big doubles for this).

    B

    the type of accumulated results

    z

    the initial value for the accumulated result of the partition - this will typically be the neutral element for the seqop operator (e.g. Nil for list concatenation or 0 for summation)

    seqop

    an operator used to accumulate results within a partition

    combop

    an associative operator used to combine results from different partitions

    Definition Classes
    TraversableOnceGenTraversableOnce
  22. def andThen[C](k: (B) ⇒ C): PartialFunction[A, 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.

    C

    the result type of the transformation function.

    k

    the transformation function

    returns

    a partial function with the same domain as this partial function, which maps arguments x to k(this(x)).

    Definition Classes
    PartialFunctionFunction1
  23. def apply(key: A): B

    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
    MapLikeGenMapLikeFunction1
  24. def applyOrElse[A1 <: A, B1 >: B](x: A1, default: (A1) ⇒ B1): B1

    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 compiler generates 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
    PartialFunction
    Since

    2.10

  25. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  26. def asParIterable: ParIterable[(A, B)]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  27. def asParSeq: ParSeq[(A, B)]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  28. def canEqual(that: Any): Boolean

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    that

    The object with which this immutable list map should be compared

    returns

    true, if this immutable list map can possibly equal that, false otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.

    Definition Classes
    IterableLikeEquals
  29. 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  30. def collect[B](pf: PartialFunction[A, B]): ListMap[B]

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

    [use case]

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

    B

    the element type of the returned collection.

    pf

    the partial function which filters and maps the immutable list map.

    returns

    a new immutable list 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
    TraversableLikeGenTraversableLike
    Full Signature

    def collect[B, That](pf: PartialFunction[(A, B), B])(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

  31. def collectFirst[B](pf: PartialFunction[(A, B), B]): Option[B]

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

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

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

    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
    TraversableOnce
    Example:
    1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

  32. def companion: GenericCompanion[Iterable]

    The factory companion object that builds instances of class immutable.

    The factory companion object that builds instances of class immutable.ListMap. (or its Iterable superclass where class immutable.ListMap is not a Seq.)

    Definition Classes
    IterableIterableGenIterableTraversableTraversableGenTraversableGenericTraversableTemplate
  33. def compose[A](g: (A) ⇒ A): (A) ⇒ B

    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()
  34. def contains(key: A): 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
    MapLikeGenMapLike
  35. def copyToArray(xs: Array[A], start: Int, len: Int): Unit

    [use case] Copies elements of this immutable list map to an array.

    [use case]

    Copies elements of this immutable list map to an array. Fills the given array xs with at most len elements of this immutable list map, starting at position start. Copying will stop once either the end of the current immutable list map is reached, or the end of the array is reached, or len elements have been copied.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
    Full Signature

    def copyToArray[B >: (A, B)](xs: Array[B], start: Int, len: Int): Unit

  36. def copyToArray(xs: Array[A]): Unit

    [use case] Copies values of this immutable list map to an array.

    [use case]

    Copies values of this immutable list map to an array. Fills the given array xs with values of this immutable list map. Copying will stop once either the end of the current immutable list map is reached, or the end of the array is reached.

    xs

    the array to fill.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def copyToArray[B >: (A, B)](xs: Array[B]): Unit

  37. def copyToArray(xs: Array[A], start: Int): Unit

    [use case] Copies values of this immutable list map to an array.

    [use case]

    Copies values of this immutable list map to an array. Fills the given array xs with values of this immutable list map, beginning at index start. Copying will stop once either the end of the current immutable list map is reached, or the end of the array is reached.

    xs

    the array to fill.

    start

    the starting index.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def copyToArray[B >: (A, B)](xs: Array[B], start: Int): Unit

  38. def copyToBuffer[B >: (A, B)](dest: Buffer[B]): Unit

    Copies all elements of this immutable list map to a buffer.

    Copies all elements of this immutable list map to a buffer.

    dest

    The buffer to which elements are copied.

    Definition Classes
    TraversableOnce
  39. def count(p: ((A, B)) ⇒ Boolean): Int

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

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

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    Definition Classes
    TraversableOnceGenTraversableOnce
  40. def default(key: A): B

    Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.

    Defines the default value computation for the map, returned when a key is not found The method implemented here throws an exception, but it might be overridden in subclasses.

    key

    the given key value for which a binding is missing.

    Definition Classes
    MapLikeGenMapLike
    Exceptions thrown
    `NoSuchElementException`

  41. def drop(n: Int): ListMap[A, B]

    Selects all elements except first n ones.

    Selects all elements except first n ones.

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

    n

    the number of elements to drop from this immutable list map.

    returns

    a immutable list map consisting of all elements of this immutable list map except the first n ones, or else the empty immutable list map, if this immutable list map has less than n elements.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  42. def dropRight(n: Int): ListMap[A, B]

    Selects all elements except last n ones.

    Selects all elements except last n ones.

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

    n

    The number of elements to take

    returns

    a immutable list map consisting of all elements of this immutable list map except the last n ones, or else the empty immutable list map, if this immutable list map has less than n elements.

    Definition Classes
    IterableLike
  43. def dropWhile(p: ((A, B)) ⇒ Boolean): ListMap[A, B]

    Drops longest prefix of elements that satisfy a predicate.

    Drops longest prefix of elements that satisfy a predicate.

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

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  44. def empty: ListMap[A, Nothing]

    The empty map of the same type as this map

    The empty map of the same type as this map

    returns

    an empty map of type This.

    Definition Classes
    ListMapMapMapMapLike
  45. def ensuring(cond: (ListMap[A, B]) ⇒ Boolean, msg: ⇒ Any): ListMap[A, B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to Ensuring[ListMap[A, B]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  46. def ensuring(cond: (ListMap[A, B]) ⇒ Boolean): ListMap[A, B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to Ensuring[ListMap[A, B]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  47. def ensuring(cond: Boolean, msg: ⇒ Any): ListMap[A, B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to Ensuring[ListMap[A, B]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  48. def ensuring(cond: Boolean): ListMap[A, B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to Ensuring[ListMap[A, B]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  49. final def eq(arg0: AnyRef): Boolean

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

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

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

    • 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
  50. def equals(that: Any): Boolean

    Compares two maps structurally; i.

    Compares two maps structurally; i.e. checks if all mappings contained in this map are also contained in the other map, and vice versa.

    that

    the other map

    returns

    true if both maps contain exactly the same mappings, false otherwise.

    Definition Classes
    GenMapLikeEquals → AnyRef → Any
  51. def exists(p: ((A, B)) ⇒ Boolean): Boolean

    Tests whether a predicate holds for some of the elements of this immutable list map.

    Tests whether a predicate holds for some of the elements of this immutable list map.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for some of the elements of this immutable list map, otherwise false.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  52. def filter(p: ((A, B)) ⇒ Boolean): ListMap[A, B]

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

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

    p

    the predicate used to test elements.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  53. def filterKeys(p: (A) ⇒ Boolean): Map[A, B]

    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
    MapLikeMapLikeGenMapLike
  54. def filterNot(p: ((A, B)) ⇒ Boolean): ListMap[A, B]

    Returns a new map obtained by removing all key/value pairs for which the predicate p returns true.

    Returns a new map obtained by removing all key/value pairs for which the predicate p returns true.

    Note: This method works by successively removing elements for which the predicate is true from this set. If removal is slow, or you expect that most elements of the set will be removed, you might consider using filter with a negated predicate instead.

    p

    A predicate over key-value pairs

    returns

    A new map containing elements not satisfying the predicate.

    Definition Classes
    MapLikeTraversableLikeGenTraversableLike
  55. 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  56. def find(p: ((A, B)) ⇒ Boolean): Option[(A, B)]

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

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

    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 list map that satisfies p, or None if none exists.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  57. def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): ListMap[B]

    [use case] Builds a new collection by applying a function to all elements of this immutable list map and using the elements of the resulting collections.

    [use case]

    Builds a new collection by applying a function to all elements of this immutable list 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 list 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 => word.toSeq)
    
    // xs will be a an Iterable[Int]
    val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)
    
    // ys will be a Map[Int, Int]
    val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLikeFilterMonadic
    Full Signature

    def flatMap[B, That](f: ((A, B)) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

  58. def flatten[B]: ListMap[B]

    [use case] Converts this immutable list map of traversable collections into a immutable list map formed by the elements of these traversable collections.

    [use case]

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

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

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

    the type of the elements of each traversable collection.

    returns

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

    Definition Classes
    GenericTraversableTemplate
    Full Signature

    def flatten[B](implicit asTraversable: ((A, B)) ⇒ GenTraversableOnce[B]): Iterable[B]

  59. def fold[A1 >: (A, B)](z: A1)(op: (A1, A1) ⇒ A1): A1

    Folds the elements of this immutable list map using the specified associative binary operator.

    Folds the elements of this immutable list map using the specified associative binary operator.

    The order in which operations are performed on elements is unspecified and may be nondeterministic.

    A1

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

    z

    a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication.)

    op

    a binary operator that must be associative

    returns

    the result of applying fold operator op between all the elements and z

    Definition Classes
    TraversableOnceGenTraversableOnce
  60. def foldLeft[B](z: B)(op: (B, (A, B)) ⇒ B): B

    Applies a binary operator to a start value and all elements of this immutable list map, going left to right.

    Applies a binary operator to a start value and all elements of this immutable list map, going left to right.

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

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable list map, going left to right with the start value z on the left:

    op(...op(z, x_1), x_2, ..., x_n)

    where x1, ..., xn are the elements of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
  61. def foldRight[B](z: B)(op: ((A, B), B) ⇒ B): B

    Applies a binary operator to all elements of this immutable list map and a start value, going right to left.

    Applies a binary operator to all elements of this immutable list map and a start value, going right to left.

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

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable list map, going right to left with the start value z on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))

    where x1, ..., xn are the elements of this immutable list map.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
  62. def forall(p: ((A, B)) ⇒ Boolean): Boolean

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

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

    p

    the predicate used to test elements.

    returns

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

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  63. def foreach(f: ((A, B)) ⇒ Unit): Unit

    [use case] Applies a function f to all elements of this immutable list map.

    [use case]

    Applies a function f to all elements of this immutable list map.

    Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLikeTraversableOnceGenTraversableOnceFilterMonadic
    Full Signature

    def foreach[U](f: ((A, B)) ⇒ U): Unit

  64. 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 information
    This member is added by an implicit conversion from ListMap[A, B] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  65. def genericBuilder[B]: Builder[B, Iterable[B]]

    The generic builder that builds instances of immutable.

    The generic builder that builds instances of immutable.ListMap at arbitrary element types.

    Definition Classes
    GenericTraversableTemplate
  66. def get(key: A): Option[B]

    Checks if this map maps key to a value and return the value if it exists.

    Checks if this map maps key to a value and return the value if it exists.

    key

    the key of the mapping of interest

    returns

    the value of the mapping, if it exists

    Definition Classes
    ListMapMapLikeGenMapLike
  67. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  68. def getOrElse(key: A, default: ⇒ B): B

    [use case] Returns the value associated with a key, or a default value if the key is not contained in the map.

    [use case]

    Returns the value associated with a key, or a default value if the key is not contained in the map.

    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
    MapLikeGenMapLike
    Full Signature

    def getOrElse[B1 >: B](key: A, default: ⇒ B1): B1

  69. def groupBy[K](f: ((A, B)) ⇒ K): Map[K, ListMap[A, B]]

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

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

    Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new immutable list map.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

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

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

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

    Definition Classes
    TraversableLikeGenTraversableLike
  70. def grouped(size: Int): Iterator[ListMap[A, B]]

    Partitions elements in fixed size immutable list maps.

    Partitions elements in fixed size immutable list maps.

    size

    the number of elements per group

    returns

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

    Definition Classes
    IterableLike
    See also

    scala.collection.Iterator, method grouped

  71. def hasDefiniteSize: Boolean

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

    Tests whether this immutable list map is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end.

    Note: many collection methods will not work on collections of infinite sizes.

    returns

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

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
  72. 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
    GenMapLike → AnyRef → Any
  73. def head: (A, B)

    Selects the first element of this immutable list map.

    Selects the first element of this immutable list map.

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

    returns

    the first element of this immutable list map.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
    Exceptions thrown
    `NoSuchElementException`

    if the immutable list map is empty.

  74. def headOption: Option[(A, B)]

    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 list map if it is nonempty, None if it is empty.

    Definition Classes
    TraversableLikeGenTraversableLike
  75. def ifParSeq[R](isbody: (ParSeq[(A, B)]) ⇒ R): (TraversableOps[(A, B)])#Otherwise[R]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  76. def init: ListMap[A, B]

    Selects all elements except the last.

    Selects all elements except the last.

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

    returns

    a immutable list map consisting of all elements of this immutable list map except the last one.

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown
    `UnsupportedOperationException`

    if the immutable list map is empty.

  77. def inits: Iterator[ListMap[A, B]]

    Iterates over the inits of this immutable list map.

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

    returns

    an iterator over all the inits of this immutable list map

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

  78. def isDefinedAt(key: A): 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
    MapLikeGenMapLikePartialFunction
  79. def isEmpty: Boolean

    Tests whether the map is empty.

    Tests whether the map is empty.

    returns

    true if the map does not contain any key/value binding, false otherwise.

    Definition Classes
    MapLikeIterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  80. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

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

    Definition Classes
    Any
  81. def isParIterable: Boolean

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  82. def isParSeq: Boolean

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  83. def isParallel: Boolean

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  84. final def isTraversableAgain: Boolean

    Tests whether this immutable list map can be repeatedly traversed.

    Tests whether this immutable list map can be repeatedly traversed.

    returns

    true

    Definition Classes
    TraversableLikeGenTraversableLikeGenTraversableOnce
  85. def iterator: Iterator[(A, B)]

    Returns an iterator over key-value pairs.

    Returns an iterator over key-value pairs.

    returns

    the new iterator

    Definition Classes
    ListMapMapLikeIterableLikeGenIterableLike
  86. def key: A

    Attributes
    protected
  87. def keySet: Set[A]

    Collects all keys of this map in a set.

    Collects all keys of this map in a set.

    returns

    a set containing all keys of this map.

    Definition Classes
    MapLikeMapLikeGenMapLike
  88. def keys: collection.Iterable[A]

    Collects all keys of this map in an iterable collection.

    Collects all keys of this map in an iterable collection.

    returns

    the keys of this map as an iterable.

    Definition Classes
    MapLikeGenMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) keys returns Iterable[A] rather than Iterator[A].

  89. def keysIterator: Iterator[A]

    Creates an iterator for all keys.

    Creates an iterator for all keys.

    returns

    an iterator over all keys.

    Definition Classes
    MapLikeGenMapLike
  90. def last: (A, B)

    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 list map.

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown
    NoSuchElementException

    If the immutable list map is empty.

  91. def lastOption: Option[(A, B)]

    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 list map$ if it is nonempty, None if it is empty.

    Definition Classes
    TraversableLikeGenTraversableLike
  92. def lift: (A) ⇒ Option[B]

    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

  93. def map[B](f: (A) ⇒ B): ListMap[B]

    [use case] Builds a new collection by applying a function to all elements of this immutable list map.

    [use case]

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

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLikeFilterMonadic
    Full Signature

    def map[B, That](f: ((A, B)) ⇒ B)(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

  94. def mapValues[C](f: (B) ⇒ C): Map[A, C]

    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
    MapLikeMapLikeGenMapLike
  95. def max: A

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def max[B >: (A, B)](implicit cmp: Ordering[B]): (A, B)

  96. def maxBy[B](f: ((A, B)) ⇒ B)(implicit cmp: Ordering[B]): (A, B)

    Definition Classes
    TraversableOnceGenTraversableOnce
  97. def min: A

    [use case] Finds the smallest element.

    [use case]

    Finds the smallest element.

    returns

    the smallest element of this immutable list map

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def min[B >: (A, B)](implicit cmp: Ordering[B]): (A, B)

  98. def minBy[B](f: ((A, B)) ⇒ B)(implicit cmp: Ordering[B]): (A, B)

    Definition Classes
    TraversableOnceGenTraversableOnce
  99. def mkString: String

    Displays all elements of this immutable list map in a string.

    Displays all elements of this immutable list map in a string.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  100. def mkString(sep: String): String

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

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

    sep

    the separator string.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
    Example:
    1. List(1, 2, 3).mkString("|") = "1|2|3"

  101. def mkString(start: String, sep: String, end: String): String

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

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

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

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

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

  102. 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
  103. def newBuilder: Builder[(A, B), ListMap[A, B]]

    A common implementation of newBuilder for all maps in terms of empty.

    A common implementation of newBuilder for all maps in terms of empty. Overridden for mutable maps in mutable.MapLike.

    Attributes
    protected[this]
    Definition Classes
    MapLikeTraversableLikeHasNewBuilder
  104. def nonEmpty: Boolean

    Tests whether the immutable list map is not empty.

    Tests whether the immutable list map is not empty.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  105. 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
    Note

    not specified by SLS as a member of AnyRef

  106. 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
    Note

    not specified by SLS as a member of AnyRef

  107. def orElse[A1 <: A, B1 >: B](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
  108. def par: ParMap[A, B]

    Returns a parallel implementation of this collection.

    Returns a parallel implementation of this collection.

    For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

    Specific collections (e.g. ParArray or mutable.ParHashMap) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

    All parallel collections return a reference to themselves.

    returns

    a parallel implementation of this collection

    Definition Classes
    Parallelizable
  109. def parCombiner: Combiner[(A, B), ParMap[A, B]]

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    returns

    a combiner for the parallel collection of type ParRepr

    Attributes
    protected[this]
    Definition Classes
    MapLikeMapLikeTraversableLikeParallelizable
  110. def partition(p: ((A, B)) ⇒ Boolean): (ListMap[A, B], ListMap[A, B])

    Partitions this immutable list map in two immutable list maps according to a predicate.

    Partitions this immutable list map in two immutable list maps according to a predicate.

    p

    the predicate on which to partition.

    returns

    a pair of immutable list maps: the first immutable list map consists of all elements that satisfy the predicate p and the second immutable list map consists of all elements that don't. The relative order of the elements in the resulting immutable list maps is the same as in the original immutable list map.

    Definition Classes
    TraversableLikeGenTraversableLike
  111. def product: A

    [use case] Multiplies up the elements of this collection.

    [use case]

    Multiplies up the elements of this collection.

    returns

    the product of all elements in this immutable list map of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the immutable list map and as result type of product. Examples of such types are: Long, Float, Double, BigInt.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def product[B >: (A, B)](implicit num: Numeric[B]): B

  112. def reduce[A1 >: (A, B)](op: (A1, A1) ⇒ A1): A1

    Reduces the elements of this immutable list map using the specified associative binary operator.

    Reduces the elements of this immutable list map using the specified associative binary operator.

    The order in which operations are performed on elements is unspecified and may be nondeterministic.

    A1

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

    op

    A binary operator that must be associative.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
    Exceptions thrown
    UnsupportedOperationException

    if this immutable list map is empty.

  113. def reduceLeft[B >: (A, B)](op: (B, (A, B)) ⇒ B): B

    Applies a binary operator to all elements of this immutable list map, going left to right.

    Applies a binary operator to all elements of this immutable list map, going left to right.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable list map, going left to right:

    op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

    where x1, ..., xn are the elements of this immutable list map.

    Definition Classes
    TraversableOnce
    Exceptions thrown
    `UnsupportedOperationException`

    if this immutable list map is empty.

  114. def reduceLeftOption[B >: (A, B)](op: (B, (A, B)) ⇒ B): Option[B]

    Optionally applies a binary operator to all elements of this immutable list map, going left to right.

    Optionally applies a binary operator to all elements of this immutable list map, going left to right.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    an option value containing the result of reduceLeft(op) is this immutable list map is nonempty, None otherwise.

    Definition Classes
    TraversableOnceGenTraversableOnce
  115. def reduceOption[A1 >: (A, B)](op: (A1, A1) ⇒ A1): Option[A1]

    Reduces the elements of this immutable list map, if any, using the specified associative binary operator.

    Reduces the elements of this immutable list map, if any, using the specified associative binary operator.

    The order in which operations are performed on elements is unspecified and may be nondeterministic.

    A1

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

    op

    A binary operator that must be associative.

    returns

    An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.

    Definition Classes
    TraversableOnceGenTraversableOnce
  116. def reduceRight[B >: (A, B)](op: ((A, B), B) ⇒ B): B

    Applies a binary operator to all elements of this immutable list map, going right to left.

    Applies a binary operator to all elements of this immutable list map, going right to left.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable list map, going right to left:

    op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

    where x1, ..., xn are the elements of this immutable list map.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
    Exceptions thrown
    `UnsupportedOperationException`

    if this immutable list map is empty.

  117. def reduceRightOption[B >: (A, B)](op: ((A, B), B) ⇒ B): Option[B]

    Optionally applies a binary operator to all elements of this immutable list map, going right to left.

    Optionally applies a binary operator to all elements of this immutable list map, going right to left.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    an option value containing the result of reduceRight(op) is this immutable list map is nonempty, None otherwise.

    Definition Classes
    TraversableOnceGenTraversableOnce
  118. def repr: ListMap[A, B]

    The collection of type immutable list map underlying this TraversableLike object.

    The collection of type immutable list map underlying this TraversableLike object. By default this is implemented as the TraversableLike object itself, but this can be overridden.

    Definition Classes
    TraversableLikeGenTraversableLike
  119. def reversed: scala.List[(A, B)]

    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  120. def runWith[U](action: (B) ⇒ U): (A) ⇒ 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
    Since

    2.10

    See also

    applyOrElse.

  121. def sameElements(that: GenIterable[A]): Boolean

    [use case] Checks if the other iterable collection contains the same elements in the same order as this immutable list map.

    [use case]

    Checks if the other iterable collection contains the same elements in the same order as this immutable list map.

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

    that

    the collection to compare with.

    returns

    true, if both collections contain the same elements in the same order, false otherwise.

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def sameElements[B >: (A, B)](that: GenIterable[B]): Boolean

  122. def scan[B >: (A, B), That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[ListMap[A, B], B, That]): That

    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

    That

    type of the resulting collection

    z

    neutral element for the operator op

    op

    the associative operator for the scan

    cbf

    combiner factory which provides a combiner

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  123. def scanLeft[B, That](z: B)(op: (B, (A, B)) ⇒ B)(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

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

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

    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

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    collection with intermediate results

    Definition Classes
    TraversableLikeGenTraversableLike
  124. def scanRight[B, That](z: B)(op: ((A, B), B) ⇒ B)(implicit bf: CanBuildFrom[ListMap[A, B], B, That]): That

    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: might return different results for different runs, unless the underlying collection type is ordered.

    Example:

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

    the type of the elements in the resulting collection

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    collection with intermediate results

    Definition Classes
    TraversableLikeGenTraversableLike
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.

  125. def seq: Map[A, B]

    A version of this collection with all of the operations implemented sequentially (i.

    A version of this collection with all of the operations implemented sequentially (i.e. in a single-threaded manner).

    This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

    returns

    a sequential view of the collection.

    Definition Classes
    MapMapGenMapGenMapLikeIterableIterableGenIterableTraversableTraversableGenTraversableParallelizableTraversableOnceGenTraversableOnce
  126. def size: Int

    Returns the number of mappings in this map.

    Returns the number of mappings in this map.

    returns

    number of mappings in this map.

    Definition Classes
    ListMapGenTraversableLikeTraversableOnceGenTraversableOnce
  127. def slice(from: Int, until: Int): ListMap[A, B]

    Selects an interval of elements.

    Selects an interval of elements. The returned collection is made up of all elements x which satisfy the invariant:

    from <= indexOf(x) < until

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

    returns

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

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  128. def sliding(size: Int, step: Int): Iterator[ListMap[A, B]]

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

    size

    the number of elements per group

    step

    the distance between the first elements of successive groups (defaults to 1)

    returns

    An iterator producing immutable list maps of size size, except the last and the only element will be truncated if there are fewer elements than size.

    Definition Classes
    IterableLike
    See also

    scala.collection.Iterator, method sliding

  129. def sliding(size: Int): Iterator[ListMap[A, B]]

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

    size

    the number of elements per group

    returns

    An iterator producing immutable list maps of size size, except the last and the only element will be truncated if there are fewer elements than size.

    Definition Classes
    IterableLike
    See also

    scala.collection.Iterator, method sliding

  130. def span(p: ((A, B)) ⇒ Boolean): (ListMap[A, B], ListMap[A, B])

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

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

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  131. def splitAt(n: Int): (ListMap[A, B], ListMap[A, B])

    Splits this immutable list map into two at a given position.

    Splits this immutable list map into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

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

    n

    the position at which to split.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  132. def stringPrefix: String

    Defines the prefix of this object's toString representation.

    Defines the prefix of this object's toString representation.

    returns

    a string representation which starts the result of toString applied to this immutable list map. Unless overridden in subclasses, the string prefix of every map is "Map".

    Definition Classes
    MapLikeTraversableLikeGenTraversableLike
  133. def sum: A

    [use case] Sums up the elements of this collection.

    [use case]

    Sums up the elements of this collection.

    returns

    the sum of all elements in this immutable list map of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the immutable list map and as result type of sum. Examples of such types are: Long, Float, Double, BigInt.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def sum[B >: (A, B)](implicit num: Numeric[B]): B

  134. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  135. def tail: ListMap[A, B]

    Selects all elements except the first.

    Selects all elements except the first.

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

    returns

    a immutable list map consisting of all elements of this immutable list map except the first one.

    Definition Classes
    ListMapTraversableLikeGenTraversableLike
    Exceptions thrown
    `UnsupportedOperationException`

    if the immutable list map is empty.

  136. def tails: Iterator[ListMap[A, B]]

    Iterates over the tails of this immutable list map.

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

    returns

    an iterator over all the tails of this immutable list map

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

  137. def take(n: Int): ListMap[A, B]

    Selects first n elements.

    Selects 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 list map.

    returns

    a immutable list map consisting only of the first n elements of this immutable list map, or else the whole immutable list map, if it has less than n elements.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  138. def takeRight(n: Int): ListMap[A, B]

    Selects last n elements.

    Selects last n elements.

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

    n

    the number of elements to take

    returns

    a immutable list map consisting only of the last n elements of this immutable list map, or else the whole immutable list map, if it has less than n elements.

    Definition Classes
    IterableLike
  139. def takeWhile(p: ((A, B)) ⇒ Boolean): ListMap[A, B]

    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.

    returns

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

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  140. def thisCollection: collection.Iterable[(A, B)]

    The underlying collection seen as an instance of immutable.ListMap.

    The underlying collection seen as an instance of immutable.ListMap. By default this is implemented as the current collection object itself, but this can be overridden.

    Attributes
    protected[this]
    Definition Classes
    IterableLikeTraversableLike
  141. def to[Col[_]]: Col[A]

    [use case] Converts this immutable list map into another by copying all elements.

    [use case]

    Converts this immutable list map into another by copying all elements.

    Col

    The collection type to build.

    returns

    a new collection containing all elements of this immutable list map.

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
    Full Signature

    def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, (A, B), Col[(A, B)]]): Col[(A, B)]

  142. def toArray: Array[A]

    [use case] Converts this immutable list map to an array.

    [use case]

    Converts this immutable list map to an array.

    returns

    an array containing all elements of this immutable list map. An ClassTag must be available for the element type of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def toArray[B >: (A, B)](implicit arg0: ClassTag[B]): Array[B]

  143. def toBuffer[C >: (A, B)]: Buffer[C]

    Converts this immutable list map to a mutable buffer.

    Converts this immutable list map to a mutable buffer.

    returns

    a buffer containing all elements of this immutable list map.

    Definition Classes
    MapLikeTraversableOnceGenTraversableOnce
  144. def toCollection(repr: ListMap[A, B]): collection.Iterable[(A, B)]

    A conversion from collections of type Repr to immutable.ListMap objects.

    A conversion from collections of type Repr to immutable.ListMap objects. By default this is implemented as just a cast, but this can be overridden.

    Attributes
    protected[this]
    Definition Classes
    IterableLikeTraversableLike
  145. def toIndexedSeq: IndexedSeq[(A, B)]

    Converts this immutable list map to an indexed sequence.

    Converts this immutable list map to an indexed sequence.

    returns

    an indexed sequence containing all elements of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
  146. def toIterable: collection.Iterable[(A, B)]

    Converts this immutable list map to an iterable collection.

    Converts this immutable list map to an iterable collection. Note that the choice of target Iterable is lazy in this default implementation as this TraversableOnce may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).

    returns

    an Iterable containing all elements of this immutable list map.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
  147. def toIterator: Iterator[(A, B)]

    Returns an Iterator over the elements in this immutable list map.

    Returns an Iterator over the elements in this immutable list map. Will return the same Iterator if this instance is already an Iterator.

    returns

    an Iterator containing all elements of this immutable list map.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableOnce
  148. def toList: scala.List[(A, B)]

    Converts this immutable list map to a list.

    Converts this immutable list map to a list.

    returns

    a list containing all elements of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
  149. def toMap[T, U]: collection.Map[T, U]

    [use case] Converts this immutable list map to a map.

    [use case]

    Converts this immutable list map to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

    returns

    a map of type immutable.Map[T, U] containing all key/value pairs of type (T, U) of this immutable list map.

    Definition Classes
    MapTraversableOnceGenTraversableOnce
    Full Signature

    def toMap[T, U](implicit ev: <:<[(A, B), (T, U)]): Map[T, U]

  150. def toParArray: ParArray[(A, B)]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  151. def toSeq: collection.Seq[(A, B)]

    Converts this immutable list map to a sequence.

    Converts this immutable list map to a sequence. As with toIterable, it's lazy in this default implementation, as this TraversableOnce may be lazy and unevaluated.

    returns

    a sequence containing all elements of this immutable list map.

    Definition Classes
    MapLikeTraversableOnceGenTraversableOnce
  152. def toSet[B >: (A, B)]: Set[B]

    Converts this immutable list map to a set.

    Converts this immutable list map to a set.

    returns

    a set containing all elements of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
  153. def toStream: Stream[(A, B)]

    Converts this immutable list map to a stream.

    Converts this immutable list map to a stream.

    returns

    a stream containing all elements of this immutable list map.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableOnce
  154. def toString(): String

    Converts this immutable list map to a string.

    Converts this immutable list map to a string.

    returns

    a string representation of this collection. By default this string consists of the stringPrefix of this immutable list map, followed by all elements separated by commas and enclosed in parentheses.

    Definition Classes
    MapLikeTraversableLikeFunction1 → AnyRef → Any
  155. def toTraversable: collection.Traversable[(A, B)]

    Converts this immutable list map to an unspecified Traversable.

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

    returns

    a Traversable containing all elements of this immutable list map.

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
  156. def toVector: scala.Vector[(A, B)]

    Converts this immutable list map to a Vector.

    Converts this immutable list map to a Vector.

    returns

    a vector containing all elements of this immutable list map.

    Definition Classes
    TraversableOnceGenTraversableOnce
  157. def transform[C, That](f: (A, B) ⇒ C)(implicit bf: CanBuildFrom[ListMap[A, B], (A, C), That]): That

    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
    MapLike
  158. def transpose[B](implicit asTraversable: ((A, B)) ⇒ GenTraversableOnce[B]): Iterable[Iterable[B]]

    Transposes this immutable list map of traversable collections into a immutable list map of immutable list maps.

    Transposes this immutable list map of traversable collections into a immutable list map of immutable list maps.

    B

    the type of the elements of each traversable collection.

    asTraversable

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

    returns

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

    Definition Classes
    GenericTraversableTemplate
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.

    Exceptions thrown
    `IllegalArgumentException`

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

  159. def unzip[A1, A2](implicit asPair: ((A, B)) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])

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

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

    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 list map is a pair.

    returns

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

    Definition Classes
    GenericTraversableTemplate
  160. def unzip3[A1, A2, A3](implicit asTriple: ((A, B)) ⇒ (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

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

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

    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 list map is a triple.

    returns

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

    Definition Classes
    GenericTraversableTemplate
  161. def updated[B1 >: B](key: A, value: B1): ListMap[A, B1]

    This method allows one to create a new map with an additional mapping from key to value.

    This method allows one to create a new map with an additional mapping from key to value. If the map contains already a mapping for key, it will be overridden by this function.

    B1

    the type of the added value

    key

    the key element of the updated entry.

    value

    the value element of the updated entry.

    returns

    A new map with the new binding added to this map

    Definition Classes
    ListMapMapMapLikeMapLikeGenMap
  162. def value: B

    Attributes
    protected
  163. def values: collection.Iterable[B]

    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
    MapLikeGenMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) values returns Iterable[B] rather than Iterator[B].

  164. def valuesIterator: Iterator[B]

    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
    MapLikeGenMapLike
  165. def view(from: Int, until: Int): IterableView[(A, B), ListMap[A, B]]

    Creates a non-strict view of a slice of this immutable list map.

    Creates a non-strict view of a slice of this immutable list map.

    Note: the difference between view and slice is that view produces a view of the current immutable list map, whereas slice produces a new immutable list map.

    Note: view(from, to) is equivalent to view.slice(from, to)

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

    from

    the index of the first element of the view

    until

    the index of the element following the view

    returns

    a non-strict view of a slice of this immutable list map, starting at index from and extending up to (but not including) index until.

    Definition Classes
    IterableLikeTraversableLike
  166. def view: IterableView[(A, B), ListMap[A, B]]

    Creates a non-strict view of this immutable list map.

    Creates a non-strict view of this immutable list map.

    returns

    a non-strict view of this immutable list map.

    Definition Classes
    IterableLikeTraversableLike
  167. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  168. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  169. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  170. def withDefault[B1 >: B](d: (A) ⇒ B1): Map[A, B1]

    The same map with a given default function.

    The same map with a given default function. Note: 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
  171. def withDefaultValue[B1 >: B](d: B1): Map[A, B1]

    The same map with a given default value.

    The same map with a given default value. Note: get, contains, iterator, keys, etc are not affected by withDefaultValue.

    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
  172. def withFilter(p: ((A, B)) ⇒ Boolean): FilterMonadic[(A, B), ListMap[A, B]]

    Creates a non-strict filter of this immutable list map.

    Creates a non-strict filter of this immutable list 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 list map which satisfy the predicate p.

    Definition Classes
    TraversableLikeFilterMonadic
  173. def zip[B](that: GenIterable[B]): ListMap[(A, B)]

    [use case] Returns a immutable list map formed from this immutable list map and another iterable collection by combining corresponding elements in pairs.

    [use case]

    Returns a immutable list map formed from this immutable list map and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

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

    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 list map containing pairs consisting of corresponding elements of this immutable list map and that. The length of the returned collection is the minimum of the lengths of this immutable list map and that.

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def zip[A1 >: (A, B), B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[ListMap[A, B], (A1, B), That]): That

  174. def zipAll[B](that: collection.Iterable[B], thisElem: A, thatElem: B): ListMap[(A, B)]

    [use case] Returns a immutable list map formed from this immutable list map and another iterable collection by combining corresponding elements in pairs.

    [use case]

    Returns a immutable list map formed from this immutable list map and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

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

    B

    the type of the second half of the returned pairs

    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 list map is shorter than that.

    thatElem

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

    returns

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

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def zipAll[B, A1 >: (A, B), That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[ListMap[A, B], (A1, B), That]): That

  175. def zipWithIndex: ListMap[(A, Int)]

    [use case] Zips this immutable list map with its indices.

    [use case]

    Zips this immutable list map with its indices.

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

    returns

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

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def zipWithIndex[A1 >: (A, B), That](implicit bf: CanBuildFrom[ListMap[A, B], (A1, Int), That]): That

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

  176. def [B](y: B): (ListMap[A, B], B)

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to ArrowAssoc[ListMap[A, B]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to StringAdd 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:
    (listMap: StringAdd).+(other)
    Definition Classes
    StringAdd
  2. def filter(p: ((A, B)) ⇒ Boolean): TraversableOnce[(A, B)]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to MonadOps[(A, B)] performed by method MonadOps in scala.collection.TraversableOnce.
    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:
    (listMap: MonadOps[(A, B)]).filter(p)
    Definition Classes
    MonadOps
  3. def flatMap[B](f: ((A, B)) ⇒ GenTraversableOnce[B]): TraversableOnce[B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to MonadOps[(A, B)] performed by method MonadOps in scala.collection.TraversableOnce.
    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:
    (listMap: MonadOps[(A, B)]).flatMap(f)
    Definition Classes
    MonadOps
  4. def map[B](f: ((A, B)) ⇒ B): TraversableOnce[B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to MonadOps[(A, B)] performed by method MonadOps in scala.collection.TraversableOnce.
    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:
    (listMap: MonadOps[(A, B)]).map(f)
    Definition Classes
    MonadOps
  5. val self: Any

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (listMap: StringAdd).self
    Definition Classes
    StringAdd
  6. val self: Any

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (listMap: StringFormat).self
    Definition Classes
    StringFormat
  7. def withFilter(p: ((A, B)) ⇒ Boolean): Iterator[(A, B)]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to MonadOps[(A, B)] performed by method MonadOps in scala.collection.TraversableOnce.
    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:
    (listMap: MonadOps[(A, B)]).withFilter(p)
    Definition Classes
    MonadOps

Deprecated Value Members

  1. def /:\[A1 >: (A, B)](z: A1)(op: (A1, A1) ⇒ A1): A1

    A syntactic sugar for out of order folding.

    A syntactic sugar for out of order folding. See fold.

    Example:

    scala> val a = LinkedList(1,2,3,4)
    a: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2, 3, 4)
    
    scala> val b = (a /:\ 5)(_+_)
    b: Int = 15
    Definition Classes
    GenTraversableOnce
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) use fold instead

  2. def x: ListMap[A, B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to ArrowAssoc[ListMap[A, B]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (listMap: ArrowAssoc[ListMap[A, B]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: ListMap[A, B]

    Implicit information
    This member is added by an implicit conversion from ListMap[A, B] to Ensuring[ListMap[A, B]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (listMap: Ensuring[ListMap[A, B]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from AbstractMap[A, B]

Inherited from Map[A, B]

Inherited from MapLike[A, B, ListMap[A, B]]

Inherited from Iterable[(A, B)]

Inherited from Traversable[(A, B)]

Inherited from Immutable

Inherited from collection.AbstractMap[A, B]

Inherited from collection.Map[A, B]

Inherited from collection.MapLike[A, B, ListMap[A, B]]

Inherited from Subtractable[A, ListMap[A, B]]

Inherited from PartialFunction[A, B]

Inherited from (A) ⇒ B

Inherited from GenMap[A, B]

Inherited from GenMapLike[A, B, ListMap[A, B]]

Inherited from AbstractIterable[(A, B)]

Inherited from collection.Iterable[(A, B)]

Inherited from IterableLike[(A, B), ListMap[A, B]]

Inherited from Equals

Inherited from GenIterable[(A, B)]

Inherited from GenIterableLike[(A, B), ListMap[A, B]]

Inherited from AbstractTraversable[(A, B)]

Inherited from collection.Traversable[(A, B)]

Inherited from GenTraversable[(A, B)]

Inherited from GenericTraversableTemplate[(A, B), Iterable]

Inherited from TraversableLike[(A, B), ListMap[A, B]]

Inherited from GenTraversableLike[(A, B), ListMap[A, B]]

Inherited from Parallelizable[(A, B), ParMap[A, B]]

Inherited from TraversableOnce[(A, B)]

Inherited from GenTraversableOnce[(A, B)]

Inherited from FilterMonadic[(A, B), ListMap[A, B]]

Inherited from HasNewBuilder[(A, B), ListMap[A, B]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion traversable2ops from ListMap[A, B] to TraversableOps[(A, B)]

Inherited by implicit conversion MonadOps from ListMap[A, B] to MonadOps[(A, B)]

Inherited by implicit conversion any2stringadd from ListMap[A, B] to StringAdd

Inherited by implicit conversion any2stringfmt from ListMap[A, B] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ListMap[A, B] to ArrowAssoc[ListMap[A, B]]

Inherited by implicit conversion any2Ensuring from ListMap[A, B] to Ensuring[ListMap[A, B]]

Inherited by implicit conversion alternateImplicit from ListMap[A, B] to ForceImplicitAmbiguity

Ungrouped