class ImmutableMapAdaptor [A, B] extends Map[A, B] with Serializable

This class can be used as an adaptor to create mutable maps from immutable map implementations. Only method `empty` has to be redefined if the immutable map on which this mutable map is originally based is not empty. `empty` is supposed to return the representation of an empty map.

Source
Version

2.0, 01/01/2007

Since

1

Linear Supertypes
Serializable, Serializable, Map[A, B], MapLike[A, B, Map[A, B]], Cloneable[Map[A, B]], Shrinkable[A], Builder[(A, B), Map[A, B]], Growable[(A, B)], Map[A, B], MapLike[A, B, Map[A, B]], Subtractable[A, Map[A, B]], PartialFunction[A, B], (A) ⇒ B, GenMap[A, B], GenMapLike[A, B, Map[A, B]], Iterable[(A, B)], Iterable[(A, B)], IterableLike[(A, B), Map[A, B]], Equals, GenIterable[(A, B)], GenIterableLike[(A, B), Map[A, B]], Traversable[(A, B)], Mutable, Traversable[(A, B)], GenTraversable[(A, B)], GenericTraversableTemplate[(A, B), Iterable], TraversableLike[(A, B), Map[A, B]], GenTraversableLike[(A, B), Map[A, B]], Parallelizable[(A, B), ParMap[A, B]], TraversableOnce[(A, B)], GenTraversableOnce[(A, B)], FilterMonadic[(A, B), Map[A, B]], HasNewBuilder[(A, B), Map[A, B]], AnyRef, Any
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. Hide All
2. Show all
2. Serializable
3. Serializable
4. Map
5. MapLike
6. Cloneable
7. Shrinkable
8. Builder
9. Growable
10. Map
11. MapLike
12. Subtractable
13. PartialFunction
14. Function1
15. GenMap
16. GenMapLike
17. Iterable
18. Iterable
19. IterableLike
20. Equals
21. GenIterable
22. GenIterableLike
23. Traversable
24. Mutable
25. Traversable
26. GenTraversable
27. GenericTraversableTemplate
28. TraversableLike
29. GenTraversableLike
30. Parallelizable
31. TraversableOnce
32. GenTraversableOnce
34. HasNewBuilder
35. AnyRef
36. Any
Visibility
1. Public
2. All

Type Members

1. class DefaultKeySet extends Set[A]

The implementation class of the set returned by `keySet`.

2. class DefaultValuesIterable extends Iterable[B]

The implementation class of the iterable returned by `values`.

3. type Self = Map[A, B]

The type implementing this traversable

The type implementing this traversable

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

A class supporting filtered operations.

Value Members

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

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

Test two objects for inequality.

Test two objects for inequality.

returns

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

Attributes
final
Definition Classes
Any
3. def ## (): Int

Equivalent to `x.hashCode` except for boxed numeric types.

Equivalent to `x.hashCode` except for boxed numeric types. 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.

returns

a hash value consistent with ==

Attributes
final
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

elem2

elems

returns

a new map containing mappings of this map and two or more specified mappings.

Definition Classes
MapLikeMapLike
Annotations
@migration
Migration

"As of 2.8, this operation creates a new map. To add an element as a\n"+ "side effect to an existing map and return that map itself, use +=."

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

"As of 2.8, this operation creates a new map. To add an element as a\n"+ "side effect to an existing map and return that map itself, use +=."

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

Definition Classes
MapLikeMapLike
Annotations
@bridge()
7. 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

"As of 2.8, this operation creates a new map. To add the elements as a\n"+ "side effect to an existing map and return that map itself, use ++=."

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

Definition Classes
TraversableLike
Annotations
@bridge()
9. def ++ [B] (that: GenTraversableOnce[B]): Shrinkable[B]

[use case] Concatenates this shrinkable collection with the elements of a traversable collection.

[use case]

Concatenates this shrinkable collection with the elements of a traversable collection.

B

the element type of the returned collection.

that

the traversable to append.

returns

a new collection of type `That` which contains all elements of this shrinkable collection followed by all elements of `that`.

Attributes
abstract
Definition Classes
GenTraversableLike
10. def ++ [B >: (A, B), That] (that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Map[A, B], B, That]): That

Concatenates this shrinkable collection with the elements of a traversable collection.

Concatenates this shrinkable collection with the elements of a traversable collection.

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
TraversableLikeGenTraversableLike
11. def ++: [B >: (A, B), That] (that: Traversable[B])(implicit bf: CanBuildFrom[Map[A, B], B, That]): That

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

This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions. Since TraversableOnce has no '++' method, we have to implement that directly, but Traversable and down can use the overload.

Definition Classes
TraversableLike
12. def ++: [B] (that: TraversableOnce[B]): Shrinkable[B]

[use case] Concatenates this shrinkable collection with the elements of a traversable collection.

[use case]

Concatenates this shrinkable collection with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

B

the element type of the returned collection.

that

the traversable to append.

returns

a new collection of type `That` which contains all elements of this shrinkable collection followed by all elements of `that`.

Attributes
abstract
Definition Classes
TraversableLike
13. def ++: [B >: (A, B), That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[Map[A, B], B, That]): That

Concatenates this shrinkable collection with the elements of a traversable collection.

Concatenates this shrinkable collection with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

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
14. def ++= (xs: TraversableOnce[(A, B)]): ImmutableMapAdaptor.this.type

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

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

returns

the shrinkable collection itself.

Definition Classes
Growable
15. def += (kv: (A, B)): ImmutableMapAdaptor.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
16. def += (elem1: (A, B), elem2: (A, B), elems: (A, B)*): ImmutableMapAdaptor.this.type

adds two or more elements to this shrinkable collection.

adds two or more elements to this shrinkable collection.

elem1

elem2

elems

returns

the shrinkable collection itself

Definition Classes
Growable
17. def - (elem1: A, elem2: A, elems: A*): Map[A, B]

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

"As of 2.8, this operation creates a new map. To remove an element as a\n"+ "side effect to an existing map and return that map itself, use -=."

18. def - (key: A): Map[A, B]

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

"As of 2.8, this operation creates a new map. To remove an element as a\n"+ "side effect to an existing map and return that map itself, use -=."

19. def -- (xs: TraversableOnce[A]): Map[A, B]

Definition Classes
MapLikeSubtractable
Annotations
@bridge()
20. def -- (xs: GenTraversableOnce[A]): Map[A, B]

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

"As of 2.8, this operation creates a new map. To remove the elements as a\n"+ "side effect to an existing map and return that map itself, use --=."

21. def --= (xs: TraversableOnce[A]): ImmutableMapAdaptor.this.type

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

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

returns

the shrinkable collection itself

Definition Classes
Shrinkable
22. def -= (key: A): ImmutableMapAdaptor.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
23. def -= (elem1: A, elem2: A, elems: A*): ImmutableMapAdaptor.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
24. 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`.

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 `x,,1,,, ..., x,,n,,` are the elements of this shrinkable collection.

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

Definition Classes
GenTraversableOnce
26. 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.

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 `x,,1,,, ..., x,,n,,` are the elements of this shrinkable collection.

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

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

Test two objects for equality.

Test two objects for equality.

returns

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

Attributes
final
Definition Classes
Any
29. def addString (b: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

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

b

the builder to which strings are appended.

start

the starting string.

sep

the separator string.

end

the ending string.

returns

the string builder `b` to which elements were appended.

Definition Classes
MapLikeTraversableOnce
30. def addString (b: StringBuilder): 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.

b

the string builder to which elements are appended.

returns

the string builder `b` to which elements were appended.

Definition Classes
TraversableOnce
31. def addString (b: StringBuilder, sep: String): 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`.

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

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
33. 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
34. 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
35. 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

Attributes
final
Definition Classes
Any
36. 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
37. 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
38. def clone (): Map[A, B]

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
39. def collect [B] (pf: PartialFunction[(A, B), 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 collection of type `That` resulting from applying the partial function `pf` to each element on which it is defined and collecting the results. The order of the elements is preserved.

Attributes
abstract
Definition Classes
GenTraversableLike
40. def collect [B, That] (pf: PartialFunction[(A, B), B])(implicit bf: CanBuildFrom[Map[A, B], B, That]): That

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

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.

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.

pf

the partial function which filters and maps the shrinkable collection.

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` resulting from applying the partial function `pf` to each element on which it is defined and collecting the results. The order of the elements is preserved.

Definition Classes
TraversableLikeGenTraversableLike
41. 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)`

42. def companion : GenericCompanion[Iterable]

The factory companion object that builds instances of class Shrinkable.

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

Definition Classes
IterableIterableGenIterableTraversableTraversableGenTraversableGenericTraversableTemplate
43. 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
44. 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
45. def copyToArray (xs: Array[(A, B)], 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.

Attributes
abstract
Definition Classes
TraversableLike
46. def copyToArray [B >: (A, B)] (xs: Array[B], start: Int, len: Int): Unit

Copies elements of this shrinkable collection to an array.

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.

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index.

len

the maximal number of elements to copy.

Definition Classes
IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
47. def copyToArray (xs: Array[(A, B)]): 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.

Attributes
abstract
Definition Classes
GenTraversableOnce
48. def copyToArray [B >: (A, B)] (xs: Array[B]): Unit

Copies values of this shrinkable collection to an array.

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.

B

the type of the elements of the array.

xs

the array to fill.

Definition Classes
TraversableOnceGenTraversableOnce
49. def copyToArray (xs: Array[(A, B)], 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.

Attributes
abstract
Definition Classes
GenTraversableOnce
50. def copyToArray [B >: (A, B)] (xs: Array[B], start: Int): Unit

Copies values of this shrinkable collection to an array.

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.

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index.

Definition Classes
TraversableOnceGenTraversableOnce
51. 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
52. 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
53. 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
54. def drop (n: Int): Map[A, B]

Selects all elements except first n ones.

Selects all elements except first n ones.

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

n

the number of elements to drop from this 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
55. def dropRight (n: Int): Map[A, B]

Selects all elements except last n ones.

Selects all elements except last n ones.

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

n

The number of elements to take

returns

a 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
56. def dropWhile (p: ((A, B)) ⇒ Boolean): Map[A, B]

Drops longest prefix of elements that satisfy a predicate.

Drops longest prefix of elements that satisfy a predicate.

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

p

The predicate used to test elements.

returns

the longest suffix of this shrinkable collection whose first element does not satisfy the predicate `p`.

Definition Classes
TraversableLikeGenTraversableLike
57. def empty : Map[A, B]

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
MapMapMapLike
58. 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.

Attributes
final
Definition Classes
AnyRef
59. 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
60. 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
61. def filter (p: ((A, B)) ⇒ Boolean): Map[A, B]

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
62. def filterKeys (p: (A) ⇒ Boolean): Map[A, B]

Filters this map by retaining only keys satisfying a predicate.

Filters this map by retaining only keys satisfying a predicate.

p

the predicate used to test keys

returns

an immutable map consisting only of those key value pairs of this map where the key satisfies the predicate `p`. The resulting map wraps the original map without copying any elements.

Definition Classes
MapLike
63. def filterNot (p: ((A, B)) ⇒ Boolean): Map[A, B]

Returns a new map with all key/value pairs for which the predicate `p` returns `true`.

Returns a new map with all key/value pairs for which the predicate `p` returns `true`.

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

p

A predicate over key-value pairs

returns

A new map containing elements not satisfying the predicate.

Definition Classes
MapLikeTraversableLikeGenTraversableLike
64. def finalize (): Unit

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

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

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

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
()
65. 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
66. def flatMap [B] (f: ((A, B)) ⇒ GenTraversableOnce[B]): Shrinkable[B]

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

[use case]

Builds a new collection by applying a function to all elements of this shrinkable collection and concatenating the results.

B

the element type of the returned collection.

f

the function to apply to each element.

returns

a new collection of type `That` resulting from applying the given collection-valued function `f` to each element of this shrinkable collection and concatenating the results.

Attributes
abstract
Definition Classes
GenTraversableLike
67. def flatMap [B, That] (f: ((A, B)) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Map[A, B], B, That]): That

Builds a new collection by applying a function to all elements of this shrinkable collection and concatenating the results.

Builds a new collection by applying a function to all elements of this shrinkable collection and concatenating the results.

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.

f

the function to apply to each 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

a new collection of type `That` resulting from applying the given collection-valued function `f` to each element of this shrinkable collection and concatenating the results.

Definition Classes
68. def flatten [B] : Shrinkable[B]

[use case] Converts this shrinkable collection of traversable collections into a shrinkable collection in which all element collections are concatenated.

[use case]

Converts this shrinkable collection of traversable collections into a shrinkable collection in which all element collections are concatenated.

B

the type of the elements of each traversable collection.

returns

a new shrinkable collection resulting from concatenating all element shrinkable collections.

Attributes
abstract
Definition Classes
GenericTraversableTemplate
69. def flatten [B] (implicit asTraversable: ((A, B)) ⇒ TraversableOnce[B]): Traversable[B]

Converts this shrinkable collection of traversable collections into a shrinkable collection in which all element collections are concatenated.

Converts this shrinkable collection of traversable collections into a shrinkable collection in which all element collections are concatenated.

B

the type of the elements of each traversable collection.

asTraversable

an implicit conversion which asserts that the element type of this shrinkable collection is a `Traversable`.

returns

a new shrinkable collection resulting from concatenating all element shrinkable collections.

Definition Classes
TraversableGenericTraversableTemplate
Annotations
@bridge()
70. def fold [A1 >: (A, B)] (z: A1)(op: (A1, A1) ⇒ A1): A1

Folds the elements of this sequence using the specified associative binary operator.

Folds the elements of this sequence using the specified associative binary operator. The order in which the elements are reduced is unspecified and may be nondeterministic.

Note this method has a different signature than the `foldLeft` and `foldRight` methods of the trait `Traversable`. The result of folding may only be a supertype of this parallel collection's type parameter `T`.

z

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

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
71. 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 `x,,1,,, ..., x,,n,,` are the elements of this shrinkable collection.

Definition Classes
TraversableOnceGenTraversableOnce
72. 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 `x,,1,,, ..., x,,n,,` are the elements of this shrinkable collection.

Definition Classes
IterableLikeTraversableOnceGenTraversableOnce
73. 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
74. 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.

f

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

Attributes
abstract
Definition Classes
IterableLike
75. def foreach [U] (f: ((A, B)) ⇒ U): Unit

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

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.

U

the type parameter describing the result of function `f`. This result will always be ignored. Typically `U` is `Unit`, but this is not necessary.

f

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

Definition Classes
76. def genericBuilder [B] : Builder[B, Iterable[B]]

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

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

Definition Classes
GenericTraversableTemplate
77. 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
78. def getClass (): java.lang.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.

Attributes
final
Definition Classes
AnyRef → Any
79. 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.

Attributes
abstract
Definition Classes
MapLike
80. def getOrElse [B1 >: B] (key: A, default: ⇒ B1): B1

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

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

B1

the result type of the default computation.

key

the key.

default

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

returns

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

Definition Classes
MapLike
81. 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).

Definition Classes
MapLike
82. def groupBy [K] (f: ((A, B)) ⇒ K): Map[K, Map[A, B]]

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
83. def grouped (size: Int): Iterator[Map[A, B]]

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

Iterator#grouped

84. 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
85. def hashCode (): Int

The hashCode method for reference types.

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

returns

the hash code value for this object.

Definition Classes
GenMapLike → AnyRef → Any
86. 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
IterableLikeGenIterableLikeTraversableLikeGenTraversableLike
87. 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
TraversableLike

Attributes
protected
89. def init : Map[A, B]

Selects all elements except the last.

Selects all elements except the last.

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

returns

a shrinkable collection consisting of all elements of this shrinkable collection except the last one.

Definition Classes
TraversableLike
90. def inits : Iterator[Map[A, B]]

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

91. 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
92. 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
93. 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.

Attributes
final
Definition Classes
Any
94. def isTraversableAgain : Boolean

Tests whether this shrinkable collection can be repeatedly traversed.

Tests whether this shrinkable collection can be repeatedly traversed.

returns

`true`

Attributes
final
Definition Classes
GenTraversableLikeGenTraversableOnce
95. 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
96. def keySet : Set[A]

Collects all keys of this map in a set.

Collects all keys of this map in a set.

returns

a set containing all keys of this map.

Definition Classes
97. def keys : Iterable[A]

Creates an iterator for all keys.

Creates an iterator for all keys.

returns

an iterator over all keys.

Definition Classes
Annotations
@migration
Migration

"As of 2.8, keys returns Iterable[A] rather than Iterator[A]."

98. def keysIterator : Iterator[A]

Creates an iterator for all keys.

Creates an iterator for all keys.

returns

an iterator over all keys.

Definition Classes
99. 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
TraversableLike
100. 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
TraversableLike
101. 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

Function.unlift

102. def map [B] (f: ((A, B)) ⇒ 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 collection of type `That` resulting from applying the given function `f` to each element of this shrinkable collection and collecting the results.

Attributes
abstract
Definition Classes
GenTraversableLike
103. def map [B, That] (f: ((A, B)) ⇒ B)(implicit bf: CanBuildFrom[Map[A, B], B, That]): That

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

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

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.

f

the function to apply to each 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

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

Definition Classes
104. def mapResult [NewTo] (f: (Map[A, B]) ⇒ 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
105. def mapValues [C] (f: (B) ⇒ C): Map[A, C]

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

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

f

the function used to transform values of this map.

returns

a map view which maps every key of this map to `f(this(key))`. The resulting map wraps the original map without copying any elements.

Definition Classes
MapLike
106. def max : (A, B)

[use case] Finds the largest element.

[use case]

Finds the largest element.

returns

the largest element of this shrinkable collection with respect to the ordering `cmp`.

Attributes
abstract
Definition Classes
GenTraversableOnce
107. def max [B >: (A, B)] (implicit cmp: Ordering[B]): (A, B)

Finds the largest element.

Finds the largest element.

B

The type over which the ordering is defined.

cmp

An ordering to be used for comparing elements.

returns

the largest element of this shrinkable collection with respect to the ordering `cmp`.

Definition Classes
TraversableOnceGenTraversableOnce
108. def maxBy [B] (f: ((A, B)) ⇒ B)(implicit cmp: Ordering[B]): (A, B)

Definition Classes
TraversableOnceGenTraversableOnce
109. def min : (A, B)

[use case] Finds the smallest element.

[use case]

Finds the smallest element.

returns

the smallest element of this shrinkable collection with respect to the ordering `cmp`.

Attributes
abstract
Definition Classes
GenTraversableOnce
110. def min [B >: (A, B)] (implicit cmp: Ordering[B]): (A, B)

Finds the smallest element.

Finds the smallest element.

B

The type over which the ordering is defined.

cmp

An ordering to be used for comparing elements.

returns

the smallest element of this shrinkable collection with respect to the ordering `cmp`.

Definition Classes
TraversableOnceGenTraversableOnce
111. def minBy [B] (f: ((A, B)) ⇒ B)(implicit cmp: Ordering[B]): (A, B)

Definition Classes
TraversableOnceGenTraversableOnce
112. 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
113. 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"`

114. 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)"`

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

Attributes
final
Definition Classes
AnyRef
116. def newBuilder : Builder[(A, B), Map[A, B]]

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
117. 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
118. 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.

Attributes
final
Definition Classes
AnyRef
119. 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.

Attributes
final
Definition Classes
AnyRef
120. 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
121. 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
122. 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
123. def partition (p: ((A, B)) ⇒ Boolean): (Map[A, B], Map[A, B])

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
124. def product : (A, B)

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

[use case]

Multiplies up the elements of this collection.

returns

the product of all elements of this shrinkable collection with respect to the `*` operator in `num`.

Attributes
abstract
Definition Classes
GenTraversableOnce
125. def product [B >: (A, B)] (implicit num: Numeric[B]): B

Multiplies up the elements of this collection.

Multiplies up the elements of this collection.

B

the result type of the `*` operator.

num

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

returns

the product of all elements of this shrinkable collection with respect to the `*` operator in `num`.

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

Definition Classes
MapLike
127. def reduce [A1 >: (A, B)] (op: (A1, A1) ⇒ A1): A1

Reduces the elements of this sequence using the specified associative binary operator.

Reduces the elements of this sequence using the specified associative binary operator.

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

Note this method has a different signature than the `reduceLeft` and `reduceRight` methods of the trait `Traversable`. The result of reducing may only be a supertype of this parallel collection's type parameter `T`.

op

A binary operator that must be associative.

returns

The result of applying reduce operator `op` between all the elements if the collection is nonempty.

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

Definition Classes
TraversableOnce
129. 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
130. def reduceOption [A1 >: (A, B)] (op: (A1, A1) ⇒ A1): Option[A1]

Optionally reduces the elements of this sequence using the specified associative binary operator.

Optionally reduces the elements of this sequence using the specified associative binary operator.

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

Note this method has a different signature than the `reduceLeftOption` and `reduceRightOption` methods of the trait `Traversable`. The result of reducing may only be a supertype of this parallel collection's type parameter `T`.

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
131. 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 `x,,1,,, ..., x,,n,,` are the elements of this shrinkable collection.

Definition Classes
IterableLikeTraversableOnceGenTraversableOnce
132. 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
133. 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.

Definition Classes
MapLike
134. def repr : Map[A, B]

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
135. def result (): Map[A, B]

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
136. def retain (p: (A, B) ⇒ Boolean): ImmutableMapAdaptor.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

Definition Classes
137. def reversed : List[(A, B)]

Attributes
protected[this]
Definition Classes
TraversableOnce
138. def sameElements [B >: (A, B)] (that: Iterable[B]): Boolean

Definition Classes
IterableLike
Annotations
@bridge()
139. def sameElements (that: GenIterable[(A, B)]): 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.

that

the collection to compare with.

returns

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

Attributes
abstract
Definition Classes
GenIterableLike
140. def sameElements [B >: (A, B)] (that: GenIterable[B]): Boolean

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

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.

B

the type of the elements of collection `that`.

that

the collection to compare with.

returns

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

Definition Classes
IterableLikeGenIterableLike
141. def scan [B >: (A, B), That] (z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Map[A, B], B, That]): That

Computes a prefix scan of the elements of the collection.

Computes a prefix scan of the elements of the collection.

Note: The neutral element `z` may be applied more than once.

B

element type of the resulting collection

That

type of the resulting collection

z

neutral element for the operator `op`

op

the associative operator for the scan

cbf

combiner factory which provides a combiner

returns

a new shrinkable collection containing the prefix scan of the elements in this shrinkable collection

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

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

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

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

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
143. def scanRight [B, That] (z: B)(op: ((A, B), B) ⇒ B)(implicit bf: CanBuildFrom[Map[A, B], B, That]): That

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

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

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

Example:

```   List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
```
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

"This scanRight definition has changed in 2.9.\n" + "The previous behavior can be reproduced with scanRight.reverse."

144. def seq : Map[A, B]

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

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

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

returns

a sequential view of the collection.

Definition Classes
MapMapGenMapGenMapLikeIterableIterableGenIterableTraversableTraversableGenTraversableParallelizableTraversableOnceGenTraversableOnce
145. 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
146. def sizeHint (coll: scala.collection.TraversableLike[_, _], delta: Int = 0): 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
147. 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
148. def sizeHintBounded (size: Int, boundingColl: scala.collection.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
149. def slice (from: Int, until: Int): Map[A, B]

Selects an interval of elements.

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

```   from <= indexOf(x) < until
```

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

from

the lowest index to include from this shrinkable collection.

until

the highest index to EXCLUDE from this shrinkable collection.

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
150. def sliding [B >: (A, B)] (size: Int, step: Int): Iterator[Map[A, B]]

Definition Classes
IterableLike
151. def sliding [B >: (A, B)] (size: Int): Iterator[Map[A, B]]

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)

size

the number of elements per group

returns

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

Iterator#sliding

152. def span (p: ((A, B)) ⇒ Boolean): (Map[A, B], Map[A, B])

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.

p

the test predicate

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
153. def splitAt (n: Int): (Map[A, B], Map[A, B])

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
154. 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
155. def sum : (A, B)

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

[use case]

Sums up the elements of this collection.

returns

the sum of all elements of this shrinkable collection with respect to the `+` operator in `num`.

Attributes
abstract
Definition Classes
GenTraversableOnce
156. def sum [B >: (A, B)] (implicit num: Numeric[B]): B

Sums up the elements of this collection.

Sums up the elements of this collection.

B

the result type of the `+` operator.

num

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

returns

the sum of all elements of this shrinkable collection with respect to the `+` operator in `num`.

Definition Classes
TraversableOnceGenTraversableOnce
157. def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
158. def tail : Map[A, B]

Selects all elements except the first.

Selects all elements except the first.

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

returns

a shrinkable collection consisting of all elements of this shrinkable collection except the first one.

Definition Classes
TraversableLikeGenTraversableLike
159. def tails : Iterator[Map[A, B]]

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

160. def take (n: Int): Map[A, B]

Selects first n elements.

Selects first n elements.

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

n

Tt 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
161. def takeRight (n: Int): Map[A, B]

Selects last n elements.

Selects last n elements.

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

n

the number of elements to take

returns

a 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
162. def takeWhile (p: ((A, B)) ⇒ Boolean): Map[A, B]

Takes longest prefix of elements that satisfy a predicate.

Takes longest prefix of elements that satisfy a predicate.

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

p

The predicate used to test elements.

returns

the longest prefix of this shrinkable collection whose elements all satisfy the predicate `p`.

Definition Classes
IterableLikeTraversableLikeGenTraversableLike
163. def thisCollection : 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
164. def toArray : Array[(A, B)]

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

Attributes
abstract
Definition Classes
GenTraversableOnce
165. def toArray [B >: (A, B)] (implicit arg0: ClassManifest[B]): Array[B]

Converts this shrinkable collection to an array.

Converts this shrinkable collection to an array.

B

the type of the elements of the array. A `ClassManifest` for this type must be available.

returns

an array containing all elements of this shrinkable collection.

Definition Classes
TraversableOnceGenTraversableOnce
166. 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
167. def toCollection (repr: Map[A, B]): 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
168. def toIndexedSeq [B >: (A, B)] : IndexedSeq[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
169. def toIterable : 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
170. 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
TraversableLikeGenTraversableOnce
171. 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
172. def toMap [T, U] : 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 containing all elements of this shrinkable collection.

Attributes
abstract
Definition Classes
GenTraversableOnce
173. def toMap [T, U] (implicit ev: <:<[(A, B), (T, U)]): Map[T, U]

Converts this shrinkable collection to a map.

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 containing all elements of this shrinkable collection.

Definition Classes
TraversableOnceGenTraversableOnce
174. def toSeq : Seq[(A, B)]

Overridden for efficiency.

Overridden for efficiency.

returns

a sequence containing all elements of this shrinkable collection.

Definition Classes
MapLikeTraversableOnceGenTraversableOnce
175. def toSet [B >: (A, B)] : 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
176. def toStream : 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
177. 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
178. def toTraversable : 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
179. def transform (f: (A, B) ⇒ B): ImmutableMapAdaptor.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.

Definition Classes
180. def transpose [B] (implicit asTraversable: ((A, B)) ⇒ TraversableOnce[B]): Traversable[Traversable[B]]

Transposes this shrinkable collection of traversable collections into a shrinkable collection of shrinkable collections.

Transposes this shrinkable collection of traversable collections into a shrinkable collection of shrinkable collections.

B

the type of the elements of each traversable collection.

asTraversable

an implicit conversion which asserts that the element type of this shrinkable collection is a `Traversable`.

returns

a two-dimensional shrinkable collection of shrinkable collections which has as nth row the nth column of this shrinkable collection.

Definition Classes
TraversableGenericTraversableTemplate
Annotations
@bridge()
181. def unzip [A1, A2] (implicit asPair: ((A, B)) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])

Converts this shrinkable collection of pairs into two collections of the first and second half of each pair.

Converts this shrinkable collection of pairs into two collections of the first and second half of each pair.

asPair

an implicit conversion which asserts that the element type of this shrinkable collection is a pair.

returns

a pair shrinkable collections, containing the first, respectively second half of each element pair of this shrinkable collection.

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

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

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

returns

a triple shrinkable collections, containing the first, second, respectively third member of each element triple of this shrinkable collection.

Definition Classes
GenericTraversableTemplate
183. 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

Definition Classes
184. 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

value

The new value

returns

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

Definition Classes
MapLikeMapLike
185. def values : 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
Annotations
@migration
Migration

"As of 2.8, values returns Iterable[B] rather than Iterator[B]."

186. 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
187. def view (from: Int, until: Int): IterableView[(A, B), Map[A, B]]

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
188. def view : IterableView[(A, B), Map[A, B]]

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
189. def wait (): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
()
190. def wait (arg0: Long, arg1: Int): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
()
191. def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
()
192. def withDefault (d: (A) ⇒ B): Map[A, B]

The same map with a given default function.

The same map with a given default function.

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

d

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

returns

a wrapper of the map with a default value

Definition Classes
Map
193. def withDefaultValue (d: B): Map[A, B]

The same map with a given default value.

The same map with a given default value.

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

d

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

returns

a wrapper of the map with a default value

Definition Classes
Map
194. def withFilter (p: ((A, B)) ⇒ Boolean): FilterMonadic[(A, B), Map[A, B]]

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
195. def zip [A1 >: (A, B), B, That] (that: Iterable[B])(implicit bf: CanBuildFrom[Map[A, B], (A1, B), That]): That

Definition Classes
IterableLike
Annotations
@bridge()
196. def zip [B] (that: GenIterable[B]): Shrinkable[((A, B), 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.

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 collection of type `That` 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`.

Attributes
abstract
Definition Classes
GenIterableLike
197. def zip [A1 >: (A, B), B, That] (that: GenIterable[B])(implicit bf: CanBuildFrom[Map[A, B], (A1, B), That]): That

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

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.

A1

the type of the first half of the returned pairs (this is always a supertype of the collection's element type `A`).

B

the type of the second half of the returned pairs

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 `(A1, B)` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, (A1, B), That]`. is found.

that

The iterable providing the second half of each result pair

bf

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

returns

a new collection of type `That` 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
198. def zipAll [B, A1 >: (A, B), That] (that: Iterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Map[A, B], (A1, B), That]): That

Definition Classes
IterableLike
Annotations
@bridge()
199. def zipAll [B] (that: Iterable[B], thisElem: (A, B), thatElem: B): Shrinkable[((A, B), 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.

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 collection of type `That` 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.

Attributes
abstract
Definition Classes
GenIterableLike
200. def zipAll [B, A1 >: (A, B), That] (that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Map[A, B], (A1, B), That]): That

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

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.

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 collection of type `That` 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
201. def zipWithIndex : Shrinkable[((A, B), Int)]

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

[use case]

Zips this shrinkable collection with its indices.

returns

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

Attributes
abstract
Definition Classes
GenIterableLike
202. def zipWithIndex [A1 >: (A, B), That] (implicit bf: CanBuildFrom[Map[A, B], (A1, Int), That]): That

Zips this shrinkable collection with its indices.

Zips this shrinkable collection with its indices.

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

A1

the type of the first half of the returned pairs (this is always a supertype of the collection's element type `A`).

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 `(A1, Int)` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, (A1, Int), That]`. is found.

returns

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

Definition Classes
IterableLikeGenIterableLike

Deprecated Value Members

1. def elements : Iterator[(A, B)]

Definition Classes
Annotations
Deprecated

use `iterator' instead`

2. def first : (A, B)

Definition Classes
IterableLike
Annotations
Deprecated

use `head' instead`

3. def firstOption : Option[(A, B)]

`None` if iterable is empty.

`None` if iterable is empty.

Definition Classes
IterableLike
Annotations
Deprecated

use `headOption' instead`

4. def mapElements [C] (f: (B) ⇒ C): Map[A, C]

Definition Classes
MapLike
Annotations
Deprecated

use `mapValues' instead`

5. def projection : IterableView[(A, B), Map[A, B]]

returns a projection that can be used to call non-strict `filter`, `map`, and `flatMap` methods that build projections of the collection.

returns a projection that can be used to call non-strict `filter`, `map`, and `flatMap` methods that build projections of the collection.

Definition Classes
IterableLike
Annotations
Deprecated

use `view' instead`

6. def removeKey (key: A): Option[B]

If given key is defined in this map, remove it and return associated value as an Option.

If given key is defined in this map, remove it and return associated value as an Option. If key is not present return None.

key

the key to be removed

Definition Classes
MapLike
Annotations
Deprecated

Use `remove' instead`