scala.collection.mutable

MapLike

trait MapLike[A, B, +This <: MapLike[A, B, This] with Map[A, B]] extends collection.MapLike[A, B, This] with Builder[(A, B), This] with Growable[(A, B)] with Shrinkable[A] with Cloneable[This] with Parallelizable[(A, B), ParMap[A, B]]

A template trait for mutable maps.

Implementation note: This trait provides most of the operations of a mutable Map independently of its representation. It is typically inherited by concrete implementations of maps.

To implement a concrete mutable map, you need to provide implementations of the following methods:

def get(key: A): Option[B]
def iterator: Iterator[(A, B)]
def += (kv: (A, B)): This
def -= (key: A): This

If you wish that methods like take, drop, filter also return the same kind of map you should also override:

def empty: This

It is also good idea to override methods foreach and size for efficiency.

Self Type
MapLike[A, B, This]
Source
MapLike.scala
Since

2.8

Linear Supertypes
Cloneable[This], scala.Cloneable, java.lang.Cloneable, Shrinkable[A], Builder[(A, B), This], Growable[(A, B)], Clearable, collection.MapLike[A, B, This], Subtractable[A, This], GenMapLike[A, B, This], IterableLike[(A, B), This], GenIterableLike[(A, B), This], TraversableLike[(A, B), This], GenTraversableLike[(A, B), This], Parallelizable[(A, B), ParMap[A, B]], TraversableOnce[(A, B)], GenTraversableOnce[(A, B)], FilterMonadic[(A, B), This], HasNewBuilder[(A, B), This], Equals, PartialFunction[A, B], (A) ⇒ B, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MapLike
  2. Cloneable
  3. Cloneable
  4. Cloneable
  5. Shrinkable
  6. Builder
  7. Growable
  8. Clearable
  9. MapLike
  10. Subtractable
  11. GenMapLike
  12. IterableLike
  13. GenIterableLike
  14. TraversableLike
  15. GenTraversableLike
  16. Parallelizable
  17. TraversableOnce
  18. GenTraversableOnce
  19. FilterMonadic
  20. HasNewBuilder
  21. Equals
  22. PartialFunction
  23. Function1
  24. AnyRef
  25. 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

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 MappedValues[C] extends AbstractMap[A, C] with DefaultMap[A, C]

    Attributes
    protected
    Definition Classes
    MapLike
  5. type Self = This

    The type implementing this traversable

    The type implementing this traversable

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

    A class supporting filtered operations.

Abstract Value Members

  1. abstract def +=(kv: (A, B)): MapLike.this.type

    Adds a new key/value pair to this map.

    Adds a new key/value pair to this map. If the map already contains a mapping for the key, it will be overridden by the new value.

    kv

    the key/value pair.

    returns

    the map itself

    Definition Classes
    MapLikeBuilderGrowable
  2. abstract def -=(key: A): MapLike.this.type

    Removes a key from this map.

    Removes a key from this map.

    key

    the key to be removed

    returns

    the map itself.

    Definition Classes
    MapLikeShrinkable
  3. abstract def empty: This

    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
    MapLike
  4. abstract def get(key: A): Option[B]

    Optionally returns the value associated with a key.

    Optionally returns the value associated with a key.

    key

    the key value

    returns

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

    Definition Classes
    MapLikeGenMapLike
  5. abstract def iterator: Iterator[(A, B)]

    Creates a new iterator over all key/value pairs of this map

    Creates a new iterator over all key/value pairs of this map

    returns

    the new iterator

    Definition Classes
    MapLikeIterableLikeGenIterableLike
  6. abstract def seq: collection.Map[A, B]

    Definition Classes
    GenMapLikeParallelizableGenTraversableOnce

Concrete 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)*): Map[A, B1]

    Creates a new map containing two or more key/value mappings and all the key/value mappings of this map.

    Creates a new map containing two or more key/value mappings and all the key/value mappings of this map.

    Specified mappings will override existing mappings from this map with the same keys.

    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 containing mappings of this map and two or more specified mappings.

    Definition Classes
    MapLikeMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) + creates a new map. Use += to add an element to this map and return that map itself.

  5. def +[B1 >: B](kv: (A, B1)): Map[A, B1]

    Creates a new map containing a new key/value mapping and all the key/value mappings of this map.

    Creates a new map containing a new key/value mapping and all the key/value mappings of this map.

    Mapping kv will override existing mappings from this map with the same key.

    B1

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

    kv

    the key/value mapping to be added

    returns

    a new map containing mappings of this map and the mapping kv.

    Definition Classes
    MapLikeMapLikeGenMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) + creates a new map. Use += to add an element to this map and return that map itself.

  6. def ++[B1 >: B](xs: GenTraversableOnce[(A, B1)]): Map[A, B1]

    Creates a new map containing the key/value mappings provided by the specified traversable object and all the key/value mappings of this map.

    Creates a new map containing the key/value mappings provided by the specified traversable object and all the key/value mappings of this map.

    Note that existing mappings from this map with the same key as those in xs will be overriden.

    B1

    the type of the added values

    xs

    the traversable object.

    returns

    a new map containing mappings of this map and those provided by xs.

    Definition Classes
    MapLikeMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) ++ creates a new map. Use ++= to add an element to this map and return that map itself.

  7. def ++[B](that: GenTraversableOnce[B]): Shrinkable[B]

    [use case] Returns a new shrinkable collection containing the elements from the left hand operand followed by the elements from the right hand operand.

    [use case]

    Returns a new shrinkable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the shrinkable collection 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 shrinkable collection which contains all elements of this shrinkable collection followed by all elements of that.

    Definition Classes
    TraversableLikeGenTraversableLike
    Full Signature

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

  8. def ++:[B >: (A, B), That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[This, 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 shrinkable collection followed by all elements of that.

    Definition Classes
    TraversableLike
  9. def ++:[B](that: TraversableOnce[B]): Shrinkable[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 shrinkable collection which contains all elements of this shrinkable collection followed by all elements of that.

    Definition Classes
    TraversableLike
    Full Signature

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

  10. def ++=(xs: TraversableOnce[(A, B)]): MapLike.this.type

    adds all elements produced by a TraversableOnce to this shrinkable collection.

    adds all elements produced by a TraversableOnce to this shrinkable collection.

    xs

    the TraversableOnce producing the elements to add.

    returns

    the shrinkable collection itself.

    Definition Classes
    Growable
  11. def +=(elem1: (A, B), elem2: (A, B), elems: (A, B)*): MapLike.this.type

    adds two or more elements to this shrinkable collection.

    adds two or more elements to this shrinkable collection.

    elem1

    the first element to add.

    elem2

    the second element to add.

    elems

    the remaining elements to add.

    returns

    the shrinkable collection itself

    Definition Classes
    Growable
  12. def -(elem1: A, elem2: A, elems: A*): This

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of the two or more specified keys.

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of the two or more specified keys.

    elem1

    the first element to remove.

    elem2

    the second element to remove.

    elems

    the remaining elements to remove.

    returns

    a new map containing all the mappings of this map except mappings with a key equal to elem1, elem2 or any of elems.

    Definition Classes
    MapLikeSubtractable
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) - creates a new map. Use -= to remove an element from this map and return that map itself.

  13. def -(key: A): This

    Creates a new map with all the key/value mappings of this map except the key/value mapping with the specified key.

    Creates a new map with all the key/value mappings of this map except the key/value mapping with the specified key.

    key

    the key to be removed

    returns

    a new map with all the mappings of this map except that with a key key.

    Definition Classes
    MapLikeMapLikeSubtractableGenMapLike
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) - creates a new map. Use -= to remove an element from this map and return that map itself.

  14. def --(xs: GenTraversableOnce[A]): This

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of those provided by the specified traversable object.

    Creates a new map with all the key/value mappings of this map except mappings with keys equal to any of those provided by the specified traversable object.

    xs

    the traversable object.

    returns

    a new map with all the key/value mappings of this map except mappings with a key equal to a key from xs.

    Definition Classes
    MapLikeSubtractable
    Annotations
    @migration
    Migration

    (Changed in version 2.8.0) -- creates a new map. Use --= to remove an element from this map and return that map itself.

  15. def --=(xs: TraversableOnce[A]): MapLike.this.type

    Removes all elements produced by an iterator from this shrinkable collection.

    Removes all elements produced by an iterator from this shrinkable collection.

    xs

    the iterator producing the elements to remove.

    returns

    the shrinkable collection itself

    Definition Classes
    Shrinkable
  16. def -=(elem1: A, elem2: A, elems: A*): MapLike.this.type

    Removes two or more elements from this shrinkable collection.

    Removes two or more elements from this shrinkable collection.

    elem1

    the first element to remove.

    elem2

    the second element to remove.

    elems

    the remaining elements to remove.

    returns

    the shrinkable collection itself

    Definition Classes
    Shrinkable
  17. def ->[B](y: B): (MapLike[A, B, This], B)

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

    Applies a binary operator to a start value and all elements of this shrinkable collection, going left to right.

    Applies a binary operator to a start value and all elements of this shrinkable collection, 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 shrinkable collection, 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 shrinkable collection.

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

    Applies a binary operator to all elements of this shrinkable collection and a start value, going right to left.

    Applies a binary operator to all elements of this shrinkable collection 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 shrinkable collection, 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 shrinkable collection.

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

    Definition Classes
    AnyRef
  21. 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
  22. def addString(b: scala.StringBuilder, start: String, sep: String, end: String): scala.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
  23. def addString(b: scala.StringBuilder): scala.StringBuilder

    Appends all elements of this shrinkable collection to a string builder.

    Appends all elements of this shrinkable collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this shrinkable collection 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
  24. def addString(b: scala.StringBuilder, sep: String): scala.StringBuilder

    Appends all elements of this shrinkable collection to a string builder using a separator string.

    Appends all elements of this shrinkable collection 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 shrinkable collection, 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
  25. 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
  26. 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
  27. 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
  28. 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

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

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

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

    Implicit information
    This member is added by an implicit conversion from MapLike[A, B, This] to TraversableOps[(A, B)] performed by method traversable2ops in scala.collection.parallel.
    Definition Classes
    TraversableOps
  32. 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 shrinkable collection should be compared

    returns

    true, if this shrinkable collection 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
  33. def clear(): Unit

    Removes all bindings from the map.

    Removes all bindings from the map. After this operation has completed, the map will be empty.

    Definition Classes
    MapLikeBuilderGrowableClearable
  34. def clone(): This

    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.

    Definition Classes
    MapLikeCloneable → AnyRef
    Note

    not specified by SLS as a member of AnyRef

  35. def collect[B](pf: PartialFunction[A, B]): Shrinkable[B]

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

    [use case]

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

    B

    the element type of the returned collection.

    pf

    the partial function which filters and maps the shrinkable collection.

    returns

    a new shrinkable collection 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[This, B, That]): That

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

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

    Finds the first element of the shrinkable collection 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)

  37. 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()
  38. 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
  39. def copyToArray(xs: Array[A], start: Int, len: Int): Unit

    [use case] Copies elements of this shrinkable collection to an array.

    [use case]

    Copies elements of this shrinkable collection to an array. Fills the given array xs with at most len elements of this shrinkable collection, starting at position start. Copying will stop once either the end of the current shrinkable collection 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

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

    [use case] Copies values of this shrinkable collection to an array.

    [use case]

    Copies values of this shrinkable collection to an array. Fills the given array xs with values of this shrinkable collection. Copying will stop once either the end of the current shrinkable collection 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

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

    [use case] Copies values of this shrinkable collection to an array.

    [use case]

    Copies values of this shrinkable collection to an array. Fills the given array xs with values of this shrinkable collection, beginning at index start. Copying will stop once either the end of the current shrinkable collection 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

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

    Copies all elements of this shrinkable collection to a buffer.

    Copies all elements of this shrinkable collection to a buffer.

    dest

    The buffer to which elements are copied.

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

    Counts the number of elements in the shrinkable collection which satisfy a predicate.

    Counts the number of elements in the shrinkable collection which satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    Definition Classes
    TraversableOnceGenTraversableOnce
  44. 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`

  45. def drop(n: Int): This

    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 shrinkable collection.

    returns

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

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  46. def dropRight(n: Int): This

    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 shrinkable collection consisting of all elements of this shrinkable collection except the last n ones, or else the empty shrinkable collection, if this shrinkable collection has less than n elements.

    Definition Classes
    IterableLike
  47. def dropWhile(p: ((A, B)) ⇒ Boolean): This

    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 shrinkable collection whose first element does not satisfy the predicate p.

    Definition Classes
    TraversableLikeGenTraversableLike
  48. def ensuring(cond: (MapLike[A, B, This]) ⇒ Boolean, msg: ⇒ Any): MapLike[A, B, This]

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

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

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

    Implicit information
    This member is added by an implicit conversion from MapLike[A, B, This] to Ensuring[MapLike[A, B, This]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  52. 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
  53. 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
  54. def exists(p: ((A, B)) ⇒ Boolean): Boolean

    Tests whether a predicate holds for some of the elements of this shrinkable collection.

    Tests whether a predicate holds for some of the elements of this shrinkable collection.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for some of the elements of this shrinkable collection, otherwise false.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  55. def filter(p: ((A, B)) ⇒ Boolean): This

    Selects all elements of this shrinkable collection which satisfy a predicate.

    Selects all elements of this shrinkable collection which satisfy a predicate.

    p

    the predicate used to test elements.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  56. def filterKeys(p: (A) ⇒ Boolean): collection.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
    MapLikeGenMapLike
  57. def filterNot(p: ((A, B)) ⇒ Boolean): This

    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
  58. 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()
    Note

    not specified by SLS as a member of AnyRef

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

    Finds the first element of the shrinkable collection satisfying a predicate, if any.

    Finds the first element of the shrinkable collection 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 shrinkable collection that satisfies p, or None if none exists.

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

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

    [use case]

    Builds a new collection by applying a function to all elements of this shrinkable collection 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 shrinkable collection. 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 shrinkable collection resulting from applying the given collection-valued function f to each element of this shrinkable collection and concatenating the results.

    Definition Classes
    TraversableLikeGenTraversableLikeFilterMonadic
    Full Signature

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

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

    Folds the elements of this shrinkable collection using the specified associative binary operator.

    Folds the elements of this shrinkable collection 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
  62. def foldLeft[B](z: B)(op: (B, (A, B)) ⇒ B): B

    Applies a binary operator to a start value and all elements of this shrinkable collection, going left to right.

    Applies a binary operator to a start value and all elements of this shrinkable collection, 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 shrinkable collection, 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 shrinkable collection.

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

    Applies a binary operator to all elements of this shrinkable collection and a start value, going right to left.

    Applies a binary operator to all elements of this shrinkable collection 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 shrinkable collection, 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 shrinkable collection.

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

    Tests whether a predicate holds for all elements of this shrinkable collection.

    Tests whether a predicate holds for all elements of this shrinkable collection.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for all elements of this shrinkable collection, otherwise false.

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

    [use case] Applies a function f to all elements of this shrinkable collection.

    [use case]

    Applies a function f to all elements of this shrinkable collection.

    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

  66. 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 MapLike[A, B, This] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  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 getOrElseUpdate(key: A, op: ⇒ B): B

    If given key is already in this map, returns associated value.

    If given key is already in this map, returns associated value.

    Otherwise, computes value from given expression op, stores with key in map and returns that value.

    key

    the key to test

    op

    the computation yielding the value to associate with key, if key is previously unbound.

    returns

    the value associated with key (either previously or as a result of executing the method).

  70. def groupBy[K](f: ((A, B)) ⇒ K): immutable.Map[K, This]

    Partitions this shrinkable collection into a map of shrinkable collections according to some discriminator function.

    Partitions this shrinkable collection into a map of shrinkable collections 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 shrinkable collection.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

    A map from keys to shrinkable collections 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 shrinkable collection of those elements x for which f(x) equals k.

    Definition Classes
    TraversableLikeGenTraversableLike
  71. def grouped(size: Int): Iterator[This]

    Partitions elements in fixed size shrinkable collections.

    Partitions elements in fixed size shrinkable collections.

    size

    the number of elements per group

    returns

    An iterator producing shrinkable collections 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

  72. def hasDefiniteSize: Boolean

    Tests whether this shrinkable collection is known to have a finite size.

    Tests whether this shrinkable collection 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
  73. 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
  74. def head: (A, B)

    Selects the first element of this shrinkable collection.

    Selects the first element of this shrinkable collection.

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

    returns

    the first element of this shrinkable collection.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
    Exceptions thrown
    `NoSuchElementException`

    if the shrinkable collection is empty.

  75. 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 shrinkable collection if it is nonempty, None if it is empty.

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

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

    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 shrinkable collection consisting of all elements of this shrinkable collection except the last one.

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown
    `UnsupportedOperationException`

    if the shrinkable collection is empty.

  78. def inits: Iterator[This]

    Iterates over the inits of this shrinkable collection.

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

    returns

    an iterator over all the inits of this shrinkable collection

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

  79. 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
  80. 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
  81. 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
  82. def isParIterable: Boolean

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

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

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

    Tests whether this shrinkable collection can be repeatedly traversed.

    Tests whether this shrinkable collection can be repeatedly traversed.

    returns

    true

    Definition Classes
    TraversableLikeGenTraversableLikeGenTraversableOnce
  86. def keySet: collection.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
    MapLikeGenMapLike
  87. 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].

  88. 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
  89. 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 shrinkable collection.

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown
    NoSuchElementException

    If the shrinkable collection is empty.

  90. 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 shrinkable collection$ if it is nonempty, None if it is empty.

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

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

    Turns this partial function into an 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

  92. def map[B](f: (A) ⇒ B): Shrinkable[B]

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

    [use case]

    Builds a new collection by applying a function to all elements of this shrinkable collection.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLikeFilterMonadic
    Full Signature

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

  93. def mapResult[NewTo](f: (This) ⇒ NewTo): Builder[(A, B), NewTo]

    Creates a new builder by applying a transformation function to the results of this builder.

    Creates a new builder by applying a transformation function to the results of this builder.

    NewTo

    the type of collection returned by f.

    f

    the transformation function.

    returns

    a new builder which is the same as the current builder except that a transformation function is applied to this builder's result.

    Definition Classes
    Builder
  94. def mapValues[C](f: (B) ⇒ C): collection.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
    MapLikeGenMapLike
  95. def max: A

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this shrinkable collection.

    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 shrinkable collection

    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 shrinkable collection in a string.

    Displays all elements of this shrinkable collection in a string.

    returns

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

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

    Displays all elements of this shrinkable collection in a string using a separator string.

    Displays all elements of this shrinkable collection in a string using a separator string.

    sep

    the separator string.

    returns

    a string representation of this shrinkable collection. In the resulting string the string representations (w.r.t. the method toString) of all elements of this shrinkable collection 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 shrinkable collection in a string using start, end, and separator strings.

    Displays all elements of this shrinkable collection 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 shrinkable collection. 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 shrinkable collection 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), This]

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

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

    Overrides MapLike implementation for better efficiency.

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

    Tests whether the shrinkable collection is not empty.

    Tests whether the shrinkable collection is not empty.

    returns

    true if the shrinkable collection 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): (This, This)

    Partitions this shrinkable collection in two shrinkable collections according to a predicate.

    Partitions this shrinkable collection in two shrinkable collections according to a predicate.

    p

    the predicate on which to partition.

    returns

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

    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 shrinkable collection 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 shrinkable collection 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 put(key: A, value: B): Option[B]

    Adds a new key/value pair to this map and optionally returns previously bound value.

    Adds a new key/value pair to this map and optionally returns previously bound value. If the map already contains a mapping for the key, it will be overridden by the new value.

    key

    the key to update

    value

    the new value

    returns

    an option value containing the value associated with the key before the put operation was executed, or None if key was not defined in the map before.

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

    Reduces the elements of this shrinkable collection using the specified associative binary operator.

    Reduces the elements of this shrinkable collection 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 shrinkable collection is nonempty.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Exceptions thrown
    UnsupportedOperationException

    if this shrinkable collection is empty.

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

    Applies a binary operator to all elements of this shrinkable collection, going left to right.

    Applies a binary operator to all elements of this shrinkable collection, 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 shrinkable collection, going left to right:

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

    where x1, ..., xn are the elements of this shrinkable collection.

    Definition Classes
    TraversableOnce
    Exceptions thrown
    `UnsupportedOperationException`

    if this shrinkable collection is empty.

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

    Optionally applies a binary operator to all elements of this shrinkable collection, going left to right.

    Optionally applies a binary operator to all elements of this shrinkable collection, 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 shrinkable collection is nonempty, None otherwise.

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

    Reduces the elements of this shrinkable collection, if any, using the specified associative binary operator.

    Reduces the elements of this shrinkable collection, 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
  117. def reduceRight[B >: (A, B)](op: ((A, B), B) ⇒ B): B

    Applies a binary operator to all elements of this shrinkable collection, going right to left.

    Applies a binary operator to all elements of this shrinkable collection, 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 shrinkable collection, going right to left:

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

    where x1, ..., xn are the elements of this shrinkable collection.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
    Exceptions thrown
    `UnsupportedOperationException`

    if this shrinkable collection is empty.

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

    Optionally applies a binary operator to all elements of this shrinkable collection, going right to left.

    Optionally applies a binary operator to all elements of this shrinkable collection, 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 shrinkable collection is nonempty, None otherwise.

    Definition Classes
    TraversableOnceGenTraversableOnce
  119. def remove(key: A): Option[B]

    Removes a key from this map, returning the value associated previously with that key as an option.

    Removes a key from this map, returning the value associated previously with that key as an option.

    key

    the key to be removed

    returns

    an option value containing the value associated previously with key, or None if key was not defined in the map before.

  120. def repr: This

    The collection of type shrinkable collection underlying this TraversableLike object.

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

    Definition Classes
    TraversableLikeGenTraversableLike
  121. def result(): This

    The result when this map is used as a builder

    The result when this map is used as a builder

    returns

    the map representation itself.

    Definition Classes
    MapLikeBuilder
  122. def retain(p: (A, B) ⇒ Boolean): MapLike.this.type

    Retains only those mappings for which the predicate p returns true.

    Retains only those mappings for which the predicate p returns true.

    p

    The test predicate

  123. def reversed: List[(A, B)]

    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  124. 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.

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

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

    [use case]

    Checks if the other iterable collection contains the same elements in the same order as this shrinkable collection.

    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

  126. def scan[B >: (A, B), That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[This, 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 shrinkable collection containing the prefix scan of the elements in this shrinkable collection

    Definition Classes
    TraversableLikeGenTraversableLike
  127. def scanLeft[B, That](z: B)(op: (B, (A, B)) ⇒ B)(implicit bf: CanBuildFrom[This, 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
  128. def scanRight[B, That](z: B)(op: ((A, B), B) ⇒ B)(implicit bf: CanBuildFrom[This, 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.

  129. def size: Int

    The size of this shrinkable collection.

    The size of this shrinkable collection.

    returns

    the number of elements in this shrinkable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  130. def sizeHint(coll: TraversableLike[_, _], delta: Int): Unit

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection is known to have a cheap size method. Currently this is assumed to be the case if and only if the collection is of type IndexedSeqLike. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    coll

    the collection which serves as a hint for the result's size.

    delta

    a correction to add to the coll.size to produce the size hint.

    Definition Classes
    Builder
  131. def sizeHint(coll: TraversableLike[_, _]): Unit

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

    Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection is known to have a cheap size method. Currently this is assumed to be the case if and only if the collection is of type IndexedSeqLike. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    coll

    the collection which serves as a hint for the result's size.

    Definition Classes
    Builder
  132. def sizeHint(size: Int): Unit

    Gives a hint how many elements are expected to be added when the next result is called.

    Gives a hint how many elements are expected to be added when the next result is called. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    size

    the hint how many elements will be added.

    Definition Classes
    Builder
  133. def sizeHintBounded(size: Int, boundingColl: TraversableLike[_, _]): Unit

    Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection.

    Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

    size

    the hint how many elements will be added.

    boundingColl

    the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.

    Definition Classes
    Builder
  134. def slice(from: Int, until: Int): This

    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 shrinkable collection containing the elements greater than or equal to index from extending up to (but not including) index until of this shrinkable collection.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  135. def sliding(size: Int, step: Int): Iterator[This]

    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 shrinkable collections 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

  136. def sliding(size: Int): Iterator[This]

    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 shrinkable collections 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

  137. def span(p: ((A, B)) ⇒ Boolean): (This, This)

    Splits this shrinkable collection into a prefix/suffix pair according to a predicate.

    Splits this shrinkable collection 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 shrinkable collection whose elements all satisfy p, and the rest of this shrinkable collection.

    Definition Classes
    TraversableLikeGenTraversableLike
  138. def splitAt(n: Int): (This, This)

    Splits this shrinkable collection into two at a given position.

    Splits this shrinkable collection 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 shrinkable collections consisting of the first n elements of this shrinkable collection, and the other elements.

    Definition Classes
    TraversableLikeGenTraversableLike
  139. 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 shrinkable collection. Unless overridden in subclasses, the string prefix of every map is "Map".

    Definition Classes
    MapLikeTraversableLikeGenTraversableLike
  140. 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 shrinkable collection 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 shrinkable collection 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

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

    Definition Classes
    AnyRef
  142. def tail: This

    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 shrinkable collection consisting of all elements of this shrinkable collection except the first one.

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown
    `UnsupportedOperationException`

    if the shrinkable collection is empty.

  143. def tails: Iterator[This]

    Iterates over the tails of this shrinkable collection.

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

    returns

    an iterator over all the tails of this shrinkable collection

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

  144. def take(n: Int): This

    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 shrinkable collection.

    returns

    a shrinkable collection consisting only of the first n elements of this shrinkable collection, or else the whole shrinkable collection, if it has less than n elements.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  145. def takeRight(n: Int): This

    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 shrinkable collection consisting only of the last n elements of this shrinkable collection, or else the whole shrinkable collection, if it has less than n elements.

    Definition Classes
    IterableLike
  146. def takeWhile(p: ((A, B)) ⇒ Boolean): This

    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 shrinkable collection whose elements all satisfy the predicate p.

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

    The underlying collection seen as an instance of Shrinkable.

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

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

    [use case] Converts this shrinkable collection into another by copying all elements.

    [use case]

    Converts this shrinkable collection into another by copying all elements.

    Col

    The collection type to build.

    returns

    a new collection containing all elements of this shrinkable collection.

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
    Full Signature

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

  149. def toArray: Array[A]

    [use case] Converts this shrinkable collection to an array.

    [use case]

    Converts this shrinkable collection to an array.

    returns

    an array containing all elements of this shrinkable collection. An ClassTag must be available for the element type of this shrinkable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

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

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

    Converts this shrinkable collection to a mutable buffer.

    Converts this shrinkable collection to a mutable buffer.

    returns

    a buffer containing all elements of this shrinkable collection.

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

    A conversion from collections of type Repr to Shrinkable objects.

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

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

    Converts this shrinkable collection to an indexed sequence.

    Converts this shrinkable collection to an indexed sequence.

    returns

    an indexed sequence containing all elements of this shrinkable collection.

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

    Converts this shrinkable collection to an iterable collection.

    Converts this shrinkable collection 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 shrinkable collection.

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

    Returns an Iterator over the elements in this shrinkable collection.

    Returns an Iterator over the elements in this shrinkable collection. Will return the same Iterator if this instance is already an Iterator.

    returns

    an Iterator containing all elements of this shrinkable collection.

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

    Converts this shrinkable collection to a list.

    Converts this shrinkable collection to a list.

    returns

    a list containing all elements of this shrinkable collection.

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

    [use case] Converts this shrinkable collection to a map.

    [use case]

    Converts this shrinkable collection 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 shrinkable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

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

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

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

    Converts this shrinkable collection to a sequence.

    Converts this shrinkable collection 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 shrinkable collection.

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

    Converts this shrinkable collection to a set.

    Converts this shrinkable collection to a set.

    returns

    a set containing all elements of this shrinkable collection.

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

    Converts this shrinkable collection to a stream.

    Converts this shrinkable collection to a stream.

    returns

    a stream containing all elements of this shrinkable collection.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableOnce
  161. def toString(): String

    Converts this shrinkable collection to a string.

    Converts this shrinkable collection to a string.

    returns

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

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

    Converts this shrinkable collection to an unspecified Traversable.

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

    returns

    a Traversable containing all elements of this shrinkable collection.

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

    Converts this shrinkable collection to a Vector.

    Converts this shrinkable collection to a Vector.

    returns

    a vector containing all elements of this shrinkable collection.

    Definition Classes
    TraversableOnceGenTraversableOnce
  164. def transform(f: (A, B) ⇒ B): MapLike.this.type

    Applies a transformation function to all values contained in this map.

    Applies a transformation function to all values contained in this map. The transformation function produces new values from existing keys associated values.

    f

    the transformation to apply

    returns

    the map itself.

  165. def update(key: A, value: B): Unit

    Adds a new key/value pair to this map.

    Adds a new key/value pair to this map. If the map already contains a mapping for the key, it will be overridden by the new value.

    key

    The key to update

    value

    The new value

  166. def updated[B1 >: B](key: A, value: B1): Map[A, B1]

    Creates a new map consisting of all key/value pairs of the current map plus a new pair of a given key and value.

    Creates a new map consisting of all key/value pairs of the current map plus a new pair of a given key and value.

    B1

    the type of the added value

    key

    The key to add

    value

    The new value

    returns

    A fresh immutable map with the binding from key to value added to this map.

    Definition Classes
    MapLikeMapLike
  167. 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].

  168. 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
  169. def view(from: Int, until: Int): IterableView[(A, B), This]

    Creates a non-strict view of a slice of this shrinkable collection.

    Creates a non-strict view of a slice of this shrinkable collection.

    Note: the difference between view and slice is that view produces a view of the current shrinkable collection, whereas slice produces a new shrinkable collection.

    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 shrinkable collection, starting at index from and extending up to (but not including) index until.

    Definition Classes
    IterableLikeTraversableLike
  170. def view: IterableView[(A, B), This]

    Creates a non-strict view of this shrinkable collection.

    Creates a non-strict view of this shrinkable collection.

    returns

    a non-strict view of this shrinkable collection.

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  174. def withFilter(p: ((A, B)) ⇒ Boolean): FilterMonadic[(A, B), This]

    Creates a non-strict filter of this shrinkable collection.

    Creates a non-strict filter of this shrinkable collection.

    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 shrinkable collection which satisfy the predicate p.

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

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

    [use case]

    Returns a shrinkable collection formed from this shrinkable collection 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 shrinkable collection containing pairs consisting of corresponding elements of this shrinkable collection and that. The length of the returned collection is the minimum of the lengths of this shrinkable collection and that.

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

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

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

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

    [use case]

    Returns a shrinkable collection formed from this shrinkable collection 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 shrinkable collection is shorter than that.

    thatElem

    the element to be used to fill up the result if that is shorter than this shrinkable collection.

    returns

    a new shrinkable collection containing pairs consisting of corresponding elements of this shrinkable collection and that. The length of the returned collection is the maximum of the lengths of this shrinkable collection and that. If this shrinkable collection is shorter than that, thisElem values are used to pad the result. If that is shorter than this shrinkable collection, 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[This, (A1, B), That]): That

  177. def zipWithIndex: Shrinkable[(A, Int)]

    [use case] Zips this shrinkable collection with its indices.

    [use case]

    Zips this shrinkable collection with its indices.

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

    returns

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

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

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

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

  178. def [B](y: B): (MapLike[A, B, This], B)

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

Shadowed Implict Value Members

  1. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from MapLike[A, B, This] 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:
    (mapLike: 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 MapLike[A, B, This] 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:
    (mapLike: 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 MapLike[A, B, This] 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:
    (mapLike: 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 MapLike[A, B, This] 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:
    (mapLike: MonadOps[(A, B)]).map(f)
    Definition Classes
    MonadOps
  5. val self: Any

    Implicit information
    This member is added by an implicit conversion from MapLike[A, B, This] 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:
    (mapLike: StringAdd).self
    Definition Classes
    StringAdd
  6. val self: Any

    Implicit information
    This member is added by an implicit conversion from MapLike[A, B, This] 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:
    (mapLike: 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 MapLike[A, B, This] 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:
    (mapLike: 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: MapLike[A, B, This]

    Implicit information
    This member is added by an implicit conversion from MapLike[A, B, This] to ArrowAssoc[MapLike[A, B, This]] 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:
    (mapLike: ArrowAssoc[MapLike[A, B, This]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: MapLike[A, B, This]

    Implicit information
    This member is added by an implicit conversion from MapLike[A, B, This] to Ensuring[MapLike[A, B, This]] 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:
    (mapLike: Ensuring[MapLike[A, B, This]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Cloneable[This]

Inherited from scala.Cloneable

Inherited from java.lang.Cloneable

Inherited from Shrinkable[A]

Inherited from Builder[(A, B), This]

Inherited from Growable[(A, B)]

Inherited from Clearable

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

Inherited from Subtractable[A, This]

Inherited from GenMapLike[A, B, This]

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

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

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

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

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

Inherited from TraversableOnce[(A, B)]

Inherited from GenTraversableOnce[(A, B)]

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

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

Inherited from Equals

Inherited from PartialFunction[A, B]

Inherited from (A) ⇒ B

Inherited from AnyRef

Inherited from Any

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

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

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

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

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

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

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

Ungrouped