scala.collection.concurrent.TrieMap

final class TrieMap[K, V] extends Map[K, V] with mutable.MapLike[K, V, TrieMap[K, V]] with CustomParallelizable[(K, V), ParTrieMap[K, V]] with Serializable

A concurrent hash-trie or TrieMap is a concurrent thread-safe lock-free implementation of a hash array mapped trie. It is used to implement the concurrent map abstraction. It has particularly scalable concurrent insert and remove operations and is memory-efficient. It supports O(1), atomic, lock-free snapshots which are used to implement linearizable lock-free size, iterator and clear operations. The cost of evaluating the (lazy) snapshot is distributed across subsequent updates, thus making snapshot evaluation horizontally scalable.

For details, see: http://lampwww.epfl.ch/~prokopec/ctries-snapshot.pdf

• Annotations
  • @ SerialVersionUID ()
• Source
  • TrieMap.scala - Blame
  • TrieMap.scala - History
• Since
  • 2.10

Type Members

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

The implementation class of the set returned by keySet .

• Attributes
  • protected
• Definition Classes
  • MapLike

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

The implementation class of the iterable returned by values .

• Attributes
  • protected
• Definition Classes
  • MapLike

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

• Attributes
  • protected
• Definition Classes
  • MapLike

class MappedValues[C] extends AbstractMap[A, C] with DefaultMap[A, C]

• Attributes
  • protected
• Definition Classes
  • MapLike

type Self = TrieMap[K, V]

The type implementing this traversable

• Attributes
  • protected[this]
• Definition Classes
  • TraversableLike

class WithFilter extends FilterMonadic[A, Repr]

A class supporting filtered operations. Instances of this class are returned by method withFilter .

• Definition Classes
  • TraversableLike

Value Members From scala.Function1

def compose[A](g: (A) ⇒ K): (A) ⇒ V

Composes two instances of Function1 in a new Function1, with this function applied last.

• A
  • the type to which function g can be applied
• g
  • a function A => T1
• returns
  • a new function f such that f(x) == apply(g(x))
• Definition Classes
  • Function1
• Annotations
  • @ unspecialized ()

(defined at scala.Function1)

Value Members From scala.PartialFunction

def andThen[C](k: (V) ⇒ C): PartialFunction[K, C]

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

• 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
  • PartialFunction → Function1

(defined at scala.PartialFunction)

def applyOrElse[A1 <: K, B1 >: V](x: A1, default: (A1) ⇒ B1): B1

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

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

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

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

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

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

• x
  • the function argument
• default
  • the fallback function
• returns
  • the result of this function or fallback function application.
• Definition Classes
  • PartialFunction
• Since
  • 2.10

(defined at scala.PartialFunction)

def lift: (K) ⇒ Option[V]

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

• returns
  • a function that takes an argument x to Some(this(x)) if this is defined for x , and to None otherwise.
• Definition Classes
  • PartialFunction
• See also
  • Function.unlift

(defined at scala.PartialFunction)

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

Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

• 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

(defined at scala.PartialFunction)

def runWith[U](action: (V) ⇒ U): (K) ⇒ Boolean

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

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

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

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

• action
  • the action function
• returns
  • a function which maps arguments x to isDefinedAt(x) . The resulting function runs action(this(x)) where this is defined.
• Definition Classes
  • PartialFunction
• Since
  • 2.10
• See also
  • applyOrElse .

(defined at scala.PartialFunction)

Value Members From scala.collection.CustomParallelizable

def parCombiner: Combiner[(K, V), ParTrieMap[K, V]]

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
  • CustomParallelizable → Parallelizable

(defined at scala.collection.CustomParallelizable)

Value Members From scala.collection.GenMapLike

def equals(that: Any): Boolean

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
  • GenMapLike → Equals → AnyRef → Any

(defined at scala.collection.GenMapLike)

Value Members From scala.collection.IterableLike

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.

• that
  • The object with which this iterable collection should be compared
• returns
  • true , if this iterable 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
  • IterableLike → Equals

(defined at scala.collection.IterableLike)

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

[use case]

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

• xs
  • the array to fill.
• start
  • the starting index.
• len
  • the maximal number of elements to copy.
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def drop(n: Int): TrieMap[K, V]

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 iterable collection.
• returns
  • a iterable collection consisting of all elements of this iterable collection except the first n ones, or else the empty iterable collection, if this iterable collection has less than n elements.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IterableLike)

def dropRight(n: Int): TrieMap[K, V]

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

(defined at scala.collection.IterableLike)

def exists(p: ((K, V)) ⇒ Boolean): Boolean

Tests whether a predicate holds for at least one element of this iterable collection.

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • false if this iterable collection is empty, otherwise true if the given predicate p holds for some of the elements of this iterable collection, otherwise false
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def find(p: ((K, V)) ⇒ Boolean): Option[(K, V)]

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

Note: may not terminate for infinite-sized collections.

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

• p
  • the predicate used to test elements.
• returns
  • an option value containing the first element in the iterable collection that satisfies p , or None if none exists.
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def foldRight[B](z: B)(op: ((K, V), B) ⇒ B): B

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

Note: will not terminate for infinite-sized collections.

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 iterable collection, going right to left with the start value z on the right:

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

where `x1, ..., xn` are the elements of this iterable collection. Returns
 `z` if this iterable collection is empty.

• Definition Classes
  • IterableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def forall(p: ((K, V)) ⇒ Boolean): Boolean

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

Note: may not terminate for infinite-sized collections.

• p
  • the predicate used to test elements.
• returns
  • true if this iterable collection is empty or the given predicate p holds for all elements of this iterable collection, otherwise false .
• Definition Classes
  • IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def foreach[U](f: ((K, V)) ⇒ U): Unit

[use case]

Applies a function f to all elements of this concurrent map.

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

• f
  • the function that is applied for its side-effect to every element. The result of function f is discarded.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic

(defined at scala.collection.IterableLike)

def grouped(size: Int): Iterator[TrieMap[K, V]]

Partitions elements in fixed size iterable collections.

• size
  • the number of elements per group
• returns
  • An iterator producing iterable collections of size size , except the last will be less than size size if the elements don’t divide evenly.
• Definition Classes
  • IterableLike
• See also
  • scala.collection.Iterator, method grouped

(defined at scala.collection.IterableLike)

def head: (K, V)

Selects the first element of this iterable collection.

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

• returns
  • the first element of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableLike
• Exceptions thrown
  • NoSuchElementException if the iterable collection is empty.

(defined at scala.collection.IterableLike)

def reduceRight[B >: (K, V)](op: ((K, V), B) ⇒ B): B

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

Note: will not terminate for infinite-sized collections.

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 iterable collection, going right to left:

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

where `x1, ..., xn` are the elements of this iterable collection.

• Definition Classes
  • IterableLike → TraversableOnce → GenTraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this iterable collection is empty.

(defined at scala.collection.IterableLike)

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

[use case]

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

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

• that
  • the collection to compare with.
• returns
  • true , if both collections contain the same elements in the same order, false otherwise.
• Definition Classes
  • IterableLike → GenIterableLike

(defined at scala.collection.IterableLike)

def slice(from: Int, until: Int): TrieMap[K, V]

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

from <= indexOf(x) < until

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

• returns
  • a iterable collection containing the elements greater than or equal to index from extending up to (but not including) index until of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IterableLike)

def sliding(size: Int): Iterator[TrieMap[K, V]]

Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.) “Sliding window” step is 1 by default.

• size
  • the number of elements per group
• returns
  • An iterator producing iterable collections of size size , except the last and the only element will be truncated if there are fewer elements than size.
• Definition Classes
  • IterableLike
• See also
  • scala.collection.Iterator, method sliding

(defined at scala.collection.IterableLike)

def sliding(size: Int, step: Int): Iterator[TrieMap[K, V]]

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

• size
  • the number of elements per group
• step
  • the distance between the first elements of successive groups
• returns
  • An iterator producing iterable collections of size size , except the last and the only element will be truncated if there are fewer elements than size.
• Definition Classes
  • IterableLike
• See also
  • scala.collection.Iterator, method sliding

(defined at scala.collection.IterableLike)

def take(n: Int): TrieMap[K, V]

Selects first n elements.

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

• n
  • the number of elements to take from this iterable collection.
• returns
  • a iterable collection consisting only of the first n elements of this iterable collection, or else the whole iterable collection, if it has less than n elements.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IterableLike)

def takeRight(n: Int): TrieMap[K, V]

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

(defined at scala.collection.IterableLike)

def takeWhile(p: ((K, V)) ⇒ Boolean): TrieMap[K, V]

Takes longest prefix of elements that satisfy a predicate.

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

• returns
  • the longest prefix of this iterable collection whose elements all satisfy the predicate p .
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IterableLike)

def thisCollection: Iterable[(K, V)]

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

• Attributes
  • protected[this]
• Definition Classes
  • IterableLike → TraversableLike

(defined at scala.collection.IterableLike)

def toCollection(repr: TrieMap[K, V]): Iterable[(K, V)]

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

• Attributes
  • protected[this]
• Definition Classes
  • IterableLike → TraversableLike

(defined at scala.collection.IterableLike)

def toIterable: Iterable[(K, V)]

Returns this iterable collection as an iterable collection.

A new collection will not be built; lazy collections will stay lazy.

Note: will not terminate for infinite-sized collections.

• returns
  • an Iterable containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def toIterator: Iterator[(K, V)]

Returns an Iterator over the elements in this iterable collection. Produces the same result as iterator .

Note: will not terminate for infinite-sized collections.

• returns
  • an Iterator containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.IterableLike)

def toStream: immutable.Stream[(K, V)]

Converts this iterable collection to a stream.

• returns
  • a stream containing all elements of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableOnce

(defined at scala.collection.IterableLike)

def view(from: Int, until: Int): IterableView[(K, V), TrieMap[K, V]]

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

Note: the difference between view and slice is that view produces a view of the current iterable collection, whereas slice produces a new iterable 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 iterable collection, starting at index from and extending up to (but not including) index until .
• Definition Classes
  • IterableLike → TraversableLike

(defined at scala.collection.IterableLike)

def view: IterableView[(K, V), TrieMap[K, V]]

Creates a non-strict view of this iterable collection.

• returns
  • a non-strict view of this iterable collection.
• Definition Classes
  • IterableLike → TraversableLike

(defined at scala.collection.IterableLike)

def zipAll[B, A1 >: (K, V), That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[TrieMap[K, V], (A1, B), That]): That

[use case]

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

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

• B
  • the type of the second half of the returned pairs
• that
  • The iterable providing the second half of each result pair
• thisElem
  • the element to be used to fill up the result if this concurrent map is shorter than that .
• thatElem
  • the element to be used to fill up the result if that is shorter than this concurrent map.
• returns
  • a new concurrent map containing pairs consisting of corresponding elements of this concurrent map and that . The length of the returned collection is the maximum of the lengths of this concurrent map and that . If this concurrent map is shorter than that , thisElem values are used to pad the result. If that is shorter than this concurrent map, thatElem values are used to pad the result.
• Definition Classes
  • IterableLike → GenIterableLike

(defined at scala.collection.IterableLike)

def zipWithIndex[A1 >: (K, V), That](implicit bf: CanBuildFrom[TrieMap[K, V], (A1, Int), That]): That

[use case]

Zips this concurrent map with its indices.

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

• returns
  • A new concurrent map containing pairs consisting of all elements of this concurrent map paired with their index. Indices start at 0 .
• Definition Classes
  • IterableLike → GenIterableLike

Example:

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

(defined at scala.collection.IterableLike)

def zip[A1 >: (K, V), B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[TrieMap[K, V], (A1, B), That]): That

[use case]

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

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

• B
  • the type of the second half of the returned pairs
• that
  • The iterable providing the second half of each result pair
• returns
  • a new concurrent map containing pairs consisting of corresponding elements of this concurrent map and that . The length of the returned collection is the minimum of the lengths of this concurrent map and that .
• Definition Classes
  • IterableLike → GenIterableLike

(defined at scala.collection.IterableLike)

Value Members From scala.collection.MapLike

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. 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
  • MapLike → TraversableOnce

(defined at scala.collection.MapLike)

def contains(key: K): Boolean

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
  • MapLike → GenMapLike

(defined at scala.collection.MapLike)

def default(key: K): V

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
  • MapLike → GenMapLike
• Exceptions thrown *

(defined at scala.collection.MapLike)

def filterKeys(p: (K) ⇒ Boolean): collection.Map[K, V]

Filters this map by retaining only keys satisfying a predicate.

Note : the predicate must accept any key of type A , not just those already present in the map, as the predicate is tested before the underlying map is queried.

• 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 → GenMapLike

(defined at scala.collection.MapLike)

def filterNot(p: ((K, V)) ⇒ Boolean): TrieMap[K, V]

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

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

• p
  • A predicate over key-value pairs
• returns
  • A new map containing elements not satisfying the predicate.
• Definition Classes
  • MapLike → TraversableLike → GenTraversableLike

(defined at scala.collection.MapLike)

def getOrElse[B1 >: V](key: K, default: ⇒ B1): B1

[use case]

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

• key
  • the key.
• default
  • a computation that yields a default value in case no binding for key is found in the map.
• returns
  • the value associated with key if it exists, otherwise the result of the default computation.
• Definition Classes
  • MapLike → GenMapLike

(defined at scala.collection.MapLike)

def isDefinedAt(key: K): Boolean

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
  • MapLike → GenMapLike → PartialFunction

(defined at scala.collection.MapLike)

def keySet: Set[K]

Collects all keys of this map in a set.

• returns
  • a set containing all keys of this map.
• Definition Classes
  • MapLike → GenMapLike

(defined at scala.collection.MapLike)

def keys: Iterable[K]

Collects all keys of this map in an iterable collection.

• returns
  • the keys of this map as an iterable.
• Definition Classes
  • MapLike → GenMapLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) keys returns Iterable[A] rather than Iterator[A] .

(defined at scala.collection.MapLike)

def keysIterator: Iterator[K]

Creates an iterator for all keys.

• returns
  • an iterator over all keys.
• Definition Classes
  • MapLike → GenMapLike

(defined at scala.collection.MapLike)

def mapValues[C](f: (V) ⇒ C): collection.Map[K, C]

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 → GenMapLike

(defined at scala.collection.MapLike)

def toBuffer[C >: (K, V)]: Buffer[C]

Uses the contents of this map to create a new mutable buffer.

• returns
  • a buffer containing all elements of this map.
• Definition Classes
  • MapLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.MapLike)

def values: Iterable[V]

Collects all values of this map in an iterable collection.

• returns
  • the values of this map as an iterable.
• Definition Classes
  • MapLike → GenMapLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) values returns Iterable[B] rather than Iterator[B] .

(defined at scala.collection.MapLike)

def valuesIterator: Iterator[V]

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
  • MapLike → GenMapLike

(defined at scala.collection.MapLike)

Value Members From scala.collection.TraversableLike

def ++:[B >: (K, V), That](that: Traversable[B])(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

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

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

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

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

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

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

• B
  • the element type of the returned collection.
• That
  • the class of the returned collection. Where possible, That is the same class as the current collection class Repr , but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.
• that
  • the traversable to append.
• bf
  • an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B .
• returns
  • a new collection of type That which contains all elements of this traversable collection followed by all elements of that .
• Definition Classes
  • TraversableLike

(defined at scala.collection.TraversableLike)

def ++:[B >: (K, V), That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

[use case]

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

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

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

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

• B
  • the element type of the returned collection.
• that
  • the traversable to append.
• returns
  • a new concurrent map which contains all elements of this concurrent map followed by all elements of that .
• Definition Classes
  • TraversableLike

(defined at scala.collection.TraversableLike)

def ++[B >: (K, V), That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

[use case]

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

Example:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = List(2)
b: List[Int] = List(2)

scala> val c = a ++ b
c: List[Int] = List(1, 2)

scala> val d = List('a')
d: List[Char] = List(a)

scala> val e = c ++ d
e: List[AnyVal] = List(1, 2, a)

• B
  • the element type of the returned collection.
• that
  • the traversable to append.
• returns
  • a new concurrent map which contains all elements of this concurrent map followed by all elements of that .
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def collect[B, That](pf: PartialFunction[(K, V), B])(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

[use case]

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

• B
  • the element type of the returned collection.
• pf
  • the partial function which filters and maps the concurrent map.
• returns
  • a new concurrent map resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def dropWhile(p: ((K, V)) ⇒ Boolean): TrieMap[K, V]

Drops longest prefix of elements that satisfy a predicate.

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

• returns
  • the longest suffix of this traversable collection whose first element does not satisfy the predicate p .
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def filter(p: ((K, V)) ⇒ Boolean): TrieMap[K, V]

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

• p
  • the predicate used to test elements.
• returns
  • a new traversable collection consisting of all elements of this traversable collection that satisfy the given predicate p . The order of the elements is preserved.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def flatMap[B, That](f: ((K, V)) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

[use case]

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

For example:

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

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

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)

• B
  • the element type of the returned collection.
• f
  • the function to apply to each element.
• returns
  • a new concurrent map resulting from applying the given collection-valued function f to each element of this concurrent map and concatenating the results.
• Definition Classes
  • TraversableLike → GenTraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

def groupBy[K](f: ((K, V)) ⇒ K): immutable.Map[K, TrieMap[K, V]]

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

• K
  • the type of keys returned by the discriminator function.
• f
  • the discriminator function.
• returns
  • A map from keys to traversable collections such that the following invariant holds:

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

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

• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def headOption: Option[(K, V)]

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 traversable collection if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def init: TrieMap[K, V]

Selects all elements except the last.

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

• returns
  • a traversable collection consisting of all elements of this traversable collection except the last one.
• Definition Classes
  • TraversableLike → GenTraversableLike
• Exceptions thrown
  • UnsupportedOperationException if the traversable collection is empty.

(defined at scala.collection.TraversableLike)

def inits: Iterator[TrieMap[K, V]]

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

• returns
  • an iterator over all the inits of this traversable collection
• Definition Classes
  • TraversableLike

Example:

List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

(defined at scala.collection.TraversableLike)

def last: (K, V)

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 traversable collection.
• Definition Classes
  • TraversableLike → GenTraversableLike
• Exceptions thrown
  • NoSuchElementException If the traversable collection is empty.

(defined at scala.collection.TraversableLike)

def lastOption: Option[(K, V)]

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 traversable collection$ if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def map[B, That](f: ((K, V)) ⇒ B)(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

[use case]

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

• B
  • the element type of the returned collection.
• f
  • the function to apply to each element.
• returns
  • a new concurrent map resulting from applying the given function f to each element of this concurrent map and collecting the results.
• Definition Classes
  • TraversableLike → GenTraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

def partition(p: ((K, V)) ⇒ Boolean): (TrieMap[K, V], TrieMap[K, V])

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

• p
  • the predicate on which to partition.
• returns
  • a pair of traversable collections: the first traversable collection consists of all elements that satisfy the predicate p and the second traversable collection consists of all elements that don’t. The relative order of the elements in the resulting traversable collections is the same as in the original traversable collection.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def repr: TrieMap[K, V]

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

• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def scanLeft[B, That](z: B)(op: (B, (K, V)) ⇒ B)(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

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

Note: will not terminate for infinite-sized collections.

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

• B
  • the type of the elements in the resulting collection
• 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
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def scanRight[B, That](z: B)(op: ((K, V), B) ⇒ B)(implicit bf: CanBuildFrom[TrieMap[K, V], B, That]): That

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

Note: will not terminate for infinite-sized collections.

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

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
  • TraversableLike → GenTraversableLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.

(defined at scala.collection.TraversableLike)

def scan[B >: (K, V), That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[TrieMap[K, V], B, That]): That

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 traversable collection containing the prefix scan of the elements in this traversable collection
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def span(p: ((K, V)) ⇒ Boolean): (TrieMap[K, V], TrieMap[K, V])

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

Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p) , provided the evaluation of the predicate p does not cause any side-effects.

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

• returns
  • a pair consisting of the longest prefix of this traversable collection whose elements all satisfy p , and the rest of this traversable collection.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def splitAt(n: Int): (TrieMap[K, V], TrieMap[K, V])

Splits this traversable 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 traversable collections consisting of the first n elements of this traversable collection, and the other elements.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def tail: TrieMap[K, V]

Selects all elements except the first.

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

• returns
  • a traversable collection consisting of all elements of this traversable collection except the first one.
• Definition Classes
  • TraversableLike → GenTraversableLike
• Exceptions thrown
  • UnsupportedOperationException if the traversable collection is empty.

(defined at scala.collection.TraversableLike)

def tails: Iterator[TrieMap[K, V]]

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

• returns
  • an iterator over all the tails of this traversable collection
• Definition Classes
  • TraversableLike

Example:

List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

(defined at scala.collection.TraversableLike)

def toTraversable: Traversable[(K, V)]

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

Note: will not terminate for infinite-sized collections.

• returns
  • a Traversable containing all elements of this traversable collection.
• Definition Classes
  • TraversableLike → TraversableOnce → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.TraversableLike)

def withFilter(p: ((K, V)) ⇒ Boolean): FilterMonadic[(K, V), TrieMap[K, V]]

Creates a non-strict filter of this traversable 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 traversable collection which satisfy the predicate p .
• Definition Classes
  • TraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

Value Members From scala.collection.TraversableOnce

def /:[B](z: B)(op: (B, (K, V)) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.

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

Examples:

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

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15

Note: will not terminate for infinite-sized collections.

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 traversable or iterator, going left to right with the start value z on the left:

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

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def :\[B](z: B)(op: ((K, V), B) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.

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

Note: will not terminate for infinite-sized collections.

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

Examples:

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

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15

• B
  • the result type of the binary operator.
• z
  • the start value
• op
  • the binary operator
• returns
  • the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right:

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

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder): StringBuilder

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

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234

• b
  • the string builder to which elements are appended.
• returns
  • the string builder b to which elements were appended.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder, sep: String): StringBuilder

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

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4

• b
  • the string builder to which elements are appended.
• sep
  • the separator string.
• returns
  • the string builder b to which elements were appended.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def aggregate[B](z: ⇒ B)(seqop: (B, (K, V)) ⇒ B, combop: (B, B) ⇒ B): B

Aggregates the results of applying an operator to subsequent elements.

This is a more general form of fold and reduce . It is similar to foldLeft in that it doesn’t require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.

aggregate splits the traversable or iterator into partitions and processes each partition by sequentially applying seqop , starting with z (like foldLeft ). Those intermediate results are then combined by using combop (like fold ). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop may be invoked an arbitrary number of times (even 0).

As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop transforms each input character to an Int and adds it to the sum (of the partition). Then, combop just needs to sum up the intermediate results of the partitions:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })

• B
  • the type of accumulated results
• z
  • the initial value for the accumulated result of the partition - this will typically be the neutral element for the seqop operator (e.g. Nil for list concatenation or 0 for summation) and may be evaluated more than once
• seqop
  • an operator used to accumulate results within a partition
• combop
  • an associative operator used to combine results from different partitions
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def collectFirst[B](pf: PartialFunction[(K, V), B]): Option[B]

Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.

Note: may not terminate for infinite-sized collections.

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

• pf
  • the partial function
• returns
  • an option value containing pf applied to the first value for which it is defined, or None if none exists.
• Definition Classes
  • TraversableOnce

Example:

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

(defined at scala.collection.TraversableOnce)

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

[use case]

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

• xs
  • the array to fill.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

[use case]

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

• xs
  • the array to fill.
• start
  • the starting index.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def copyToBuffer[B >: (K, V)](dest: Buffer[B]): Unit

Copies all elements of this traversable or iterator to a buffer.

Note: will not terminate for infinite-sized collections.

• dest
  • The buffer to which elements are copied.
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def count(p: ((K, V)) ⇒ Boolean): Int

Counts the number of elements in the traversable or iterator which satisfy a predicate.

• p
  • the predicate used to test elements.
• returns
  • the number of elements satisfying the predicate p .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def foldLeft[B](z: B)(op: (B, (K, V)) ⇒ B): B

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

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 traversable or iterator, going left to right with the start value z on the left:

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

where `x1, ..., xn` are the elements of this traversable or iterator.
Returns `z` if this traversable or iterator is empty.

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def fold[A1 >: (K, V)](z: A1)(op: (A1, A1) ⇒ A1): A1

Folds the elements of this traversable or iterator using the specified associative binary operator.

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

Note: will not terminate for infinite-sized collections.

• A1
  • a type parameter for the binary operator, a supertype of A .
• z
  • a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication).
• op
  • a binary operator that must be associative.
• returns
  • the result of applying the fold operator op between all the elements and z , or z if this traversable or iterator is empty.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def maxBy[B](f: ((K, V)) ⇒ B)(implicit cmp: Ordering[B]): (K, V)

[use case]

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

• B
  • The result type of the function f.
• f
  • The measuring function.
• returns
  • the first element of this concurrent map with the largest value measured by function f.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def minBy[B](f: ((K, V)) ⇒ B)(implicit cmp: Ordering[B]): (K, V)

[use case]

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

• B
  • The result type of the function f.
• f
  • The measuring function.
• returns
  • the first element of this concurrent map with the smallest value measured by function f.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def mkString(sep: String): String

Displays all elements of this traversable or iterator in a string using a separator string.

• sep
  • the separator string.
• returns
  • a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator are separated by the string sep .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

Example:

List(1, 2, 3).mkString("|") = "1|2|3"

(defined at scala.collection.TraversableOnce)

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

Displays all elements of this traversable or iterator 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 traversable or iterator. 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 traversable or iterator are separated by the string sep .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

Example:

List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

(defined at scala.collection.TraversableOnce)

def reduceLeftOption[B >: (K, V)](op: (B, (K, V)) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

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) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduceLeft[B >: (K, V)](op: (B, (K, V)) ⇒ B): B

Applies a binary operator to all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

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 traversable or iterator, going left to right:

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

where `x1, ..., xn` are the elements of this traversable or iterator.

• Definition Classes
  • TraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this traversable or iterator is empty.

(defined at scala.collection.TraversableOnce)

def reduceOption[A1 >: (K, V)](op: (A1, A1) ⇒ A1): Option[A1]

Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.

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

• A1
  • A type parameter for the binary operator, a supertype of A .
• op
  • A binary operator that must be associative.
• returns
  • An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduceRightOption[B >: (K, V)](op: ((K, V), B) ⇒ B): Option[B]

Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.

Note: will not terminate for infinite-sized collections.

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) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduce[A1 >: (K, V)](op: (A1, A1) ⇒ A1): A1

Reduces the elements of this traversable or iterator using the specified associative binary operator.

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

• A1
  • A type parameter for the binary operator, a supertype of A .
• op
  • A binary operator that must be associative.
• returns
  • The result of applying reduce operator op between all the elements if the traversable or iterator is nonempty.
• Definition Classes
  • TraversableOnce → GenTraversableOnce
• Exceptions thrown
  • UnsupportedOperationException if this traversable or iterator is empty.

(defined at scala.collection.TraversableOnce)

def reversed: List[(K, V)]

• Attributes
  • protected[this]
• Definition Classes
  • TraversableOnce

(defined at scala.collection.TraversableOnce)

def toIndexedSeq: immutable.IndexedSeq[(K, V)]

Converts this traversable or iterator to an indexed sequence.

Note: will not terminate for infinite-sized collections.

• returns
  • an indexed sequence containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toList: List[(K, V)]

Converts this traversable or iterator to a list.

Note: will not terminate for infinite-sized collections.

• returns
  • a list containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

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

[use case]

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

• returns
  • a map of type immutable.Map[T, U] containing all key/value pairs of type (T, U) of this concurrent map.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toSet[B >: (K, V)]: immutable.Set[B]

Converts this traversable or iterator to a set.

Note: will not terminate for infinite-sized collections.

• returns
  • a set containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def toVector: Vector[(K, V)]

Converts this traversable or iterator to a Vector.

Note: will not terminate for infinite-sized collections.

• returns
  • a vector containing all elements of this traversable or iterator.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

Deprecated Value Members From scala.collection.concurrent.TrieMap

def CAS_ROOT(ov: AnyRef, nv: AnyRef): Boolean

• Annotations
  • @ deprecated
• Deprecated
  • (Since version 2.12.0) This method will be made private

(defined at scala.collection.concurrent.TrieMap)

def RDCSS_READ_ROOT(abort: Boolean = false): INode[K, V]

• Annotations
  • @ deprecated
• Deprecated
  • (Since version 2.12.0) This method will be made private

(defined at scala.collection.concurrent.TrieMap)

def readRoot(abort: Boolean = false): INode[K, V]

• Annotations
  • @ deprecated
• Deprecated
  • (Since version 2.12.0) This method will be made private

(defined at scala.collection.concurrent.TrieMap)

Instance Constructors From scala.collection.concurrent.TrieMap

new TrieMap()

(defined at scala.collection.concurrent.TrieMap)

Value Members From scala.collection.concurrent.TrieMap

def +=(kv: (K, V)): TrieMap.this.type

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
  • TrieMap → MapLike → Builder → Growable

(defined at scala.collection.concurrent.TrieMap)

def -=(k: K): TrieMap.this.type

Removes a key from this map.

• returns
  • the map itself.
• Definition Classes
  • TrieMap → MapLike → Shrinkable

(defined at scala.collection.concurrent.TrieMap)

def apply(k: K): V

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 .

• returns
  • the value associated with the given key, or the result of the map’s default method, if none exists.
• Definition Classes
  • TrieMap → MapLike → Function1 → GenMapLike

(defined at scala.collection.concurrent.TrieMap)

def computeHash(k: K): Int

(defined at scala.collection.concurrent.TrieMap)

def empty: TrieMap[K, V]

The empty map of the same type as this map

• returns
  • an empty map of type This .
• Definition Classes
  • TrieMap → Map → Map → MapLike

(defined at scala.collection.concurrent.TrieMap)

def get(k: K): Option[V]

Optionally returns the value associated with a key.

• returns
  • an option value containing the value associated with key in this map, or None if none exists.
• Definition Classes
  • TrieMap → MapLike → GenMapLike

(defined at scala.collection.concurrent.TrieMap)

def getOrElseUpdate(k: K, op: ⇒ V): V

If the specified key is not already in the map, computes its value using the given thunk op and enters it into the map.

Since concurrent maps cannot contain null for keys or values, a NullPointerException is thrown if the thunk op returns null .

If the specified mapping function throws an exception, that exception is rethrown.

Note: This method will invoke op at most once. However, op may be invoked without the result being added to the map if a concurrent process is also trying to add a value corresponding to the same key k .

• k
  • the key to modify
• op
  • the expression that computes the value
• returns
  • the newly added value
• Definition Classes
  • TrieMap → Map → MapLike

(defined at scala.collection.concurrent.TrieMap)

def hashing: Hashing[K]

(defined at scala.collection.concurrent.TrieMap)

def lookup(k: K): V

(defined at scala.collection.concurrent.TrieMap)

def par: ParTrieMap[K, V]

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
  • TrieMap → CustomParallelizable → Parallelizable

(defined at scala.collection.concurrent.TrieMap)

def put(key: K, value: V): Option[V]

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
  • TrieMap → MapLike

(defined at scala.collection.concurrent.TrieMap)

def putIfAbsent(k: K, v: V): Option[V]

Associates the given key with a given value, unless the key was already associated with some other value.

This is an atomic operation.

• k
  • key with which the specified value is to be associated with
• v
  • value to be associated with the specified key
• returns
  • Some(oldvalue) if there was a value oldvalue previously associated with the specified key, or None if there was no mapping for the specified key
• Definition Classes
  • TrieMap → Map

(defined at scala.collection.concurrent.TrieMap)

def readOnlySnapshot(): collection.Map[K, V]

Returns a read-only snapshot of this TrieMap. This operation is lock-free and linearizable.

The snapshot is lazily updated - the first time some branch of this TrieMap are accessed, it is rewritten. The work of creating the snapshot is thus distributed across subsequent updates and accesses on this TrieMap by all threads. Note that the snapshot itself is never rewritten unlike when calling the snapshot method, but the obtained snapshot cannot be modified.

This method is used by other methods such as size and iterator .

• Annotations
  • @ tailrec ()

(defined at scala.collection.concurrent.TrieMap)

def remove(k: K): Option[V]

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

• returns
  • an option value containing the value associated previously with key , or None if key was not defined in the map before.
• Definition Classes
  • TrieMap → MapLike

(defined at scala.collection.concurrent.TrieMap)

def remove(k: K, v: V): Boolean

Removes the entry for the specified key if it’s currently mapped to the specified value.

This is an atomic operation.

• k
  • key for which the entry should be removed
• v
  • value expected to be associated with the specified key if the removal is to take place
• returns
  • true if the removal took place, false otherwise
• Definition Classes
  • TrieMap → Map

(defined at scala.collection.concurrent.TrieMap)

def replace(k: K, v: V): Option[V]

Replaces the entry for the given key only if it was previously mapped to some value.

This is an atomic operation.

• k
  • key for which the entry should be replaced
• v
  • value to be associated with the specified key
• returns
  • Some(v) if the given key was previously mapped to some value v , or None otherwise
• Definition Classes
  • TrieMap → Map

(defined at scala.collection.concurrent.TrieMap)

def replace(k: K, oldvalue: V, newvalue: V): Boolean

Replaces the entry for the given key only if it was previously mapped to a given value.

This is an atomic operation.

• k
  • key for which the entry should be replaced
• oldvalue
  • value expected to be associated with the specified key if replacing is to happen
• newvalue
  • value to be associated with the specified key
• returns
  • true if the entry was replaced, false otherwise
• Definition Classes
  • TrieMap → Map

(defined at scala.collection.concurrent.TrieMap)

def seq: TrieMap[K, V]

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
  • TrieMap → Map → Map → GenMap → GenMapLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

(defined at scala.collection.concurrent.TrieMap)

def snapshot(): TrieMap[K, V]

Returns a snapshot of this TrieMap. This operation is lock-free and linearizable.

The snapshot is lazily updated - the first time some branch in the snapshot or this TrieMap are accessed, they are rewritten. This means that the work of rebuilding both the snapshot and this TrieMap is distributed across all the threads doing updates or accesses subsequent to the snapshot creation.

• Annotations
  • @ tailrec ()

(defined at scala.collection.concurrent.TrieMap)

def update(k: K, v: V): Unit

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.

• Definition Classes
  • TrieMap → MapLike

(defined at scala.collection.concurrent.TrieMap)

Value Members From scala.collection.generic.GenericTraversableTemplate

def flatten[B](implicit asTraversable: ((K, V)) ⇒ GenTraversableOnce[B]): mutable.Iterable[B]

[use case]

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

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

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

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

• B
  • the type of the elements of each traversable collection.
• returns
  • a new concurrent map resulting from concatenating all element concurrent maps.
• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

def genericBuilder[B]: Builder[B, mutable.Iterable[B]]

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

• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

def transpose[B](implicit asTraversable: ((K, V)) ⇒ GenTraversableOnce[B]): mutable.Iterable[mutable.Iterable[B]]

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

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

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

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

• B
  • the type of the elements of each traversable collection.
• asTraversable
  • an implicit conversion which asserts that the element type of this collection is a Traversable .
• returns
  • a two-dimensional collection of collections which has as n th row the n th column of this collection.
• Definition Classes
  • GenericTraversableTemplate
• Annotations
  • @migration
• Migration
  • (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.
• Exceptions thrown
  • IllegalArgumentException if all collections in this collection are not of the same size.

(defined at scala.collection.generic.GenericTraversableTemplate)

def unzip3[A1, A2, A3](implicit asTriple: ((K, V)) ⇒ (A1, A2, A3)): (mutable.Iterable[A1], mutable.Iterable[A2], mutable.Iterable[A3])

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

val xs = Traversable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three),
//        Traversable(1, 2, 3))

• A1
  • the type of the first member of the element triples
• A2
  • the type of the second member of the element triples
• A3
  • the type of the third member of the element triples
• asTriple
  • an implicit conversion which asserts that the element type of this collection is a triple.
• returns
  • a triple of collections, containing the first, second, respectively third member of each element triple of this collection.
• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

def unzip[A1, A2](implicit asPair: ((K, V)) ⇒ (A1, A2)): (mutable.Iterable[A1], mutable.Iterable[A2])

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

val xs = Traversable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three))

• A1
  • the type of the first half of the element pairs
• A2
  • the type of the second half of the element pairs
• asPair
  • an implicit conversion which asserts that the element type of this collection is a pair.
• returns
  • a pair of collections, containing the first, respectively second half of each element pair of this collection.
• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

Value Members From scala.collection.generic.Growable

def ++=(xs: TraversableOnce[(K, V)]): TrieMap.this.type

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

• xs
  • the TraversableOnce producing the elements to add.
• returns
  • the growable collection itself.
• Definition Classes
  • Growable

(defined at scala.collection.generic.Growable)

def +=(elem1: (K, V), elem2: (K, V), elems: (K, V)*): TrieMap.this.type

adds two or more elements to this growable collection.

• elem1
  • the first element to add.
• elem2
  • the second element to add.
• elems
  • the remaining elements to add.
• returns
  • the growable collection itself
• Definition Classes
  • Growable

(defined at scala.collection.generic.Growable)

Value Members From scala.collection.generic.Shrinkable

def --=(xs: TraversableOnce[K]): TrieMap.this.type

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

• xs
  • the iterator producing the elements to remove.
• returns
  • the shrinkable collection itself
• Definition Classes
  • Shrinkable

(defined at scala.collection.generic.Shrinkable)

def -=(elem1: K, elem2: K, elems: K*): TrieMap.this.type

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

(defined at scala.collection.generic.Shrinkable)

Value Members From scala.collection.mutable.Builder

def mapResult[NewTo](f: (TrieMap[K, V]) ⇒ NewTo): Builder[(K, V), NewTo]

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
• Note
  • The original builder should no longer be used after mapResult is called.

(defined at scala.collection.mutable.Builder)

def sizeHint(size: Int): Unit

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

(defined at scala.collection.mutable.Builder)

def sizeHint(coll: TraversableLike[_, _]): Unit

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

• coll
  • the collection which serves as a hint for the result’s size.
• Definition Classes
  • Builder

(defined at scala.collection.mutable.Builder)

def sizeHint(coll: TraversableLike[_, _], delta: Int): Unit

Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. 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

(defined at scala.collection.mutable.Builder)

def sizeHintBounded(size: Int, boundingColl: TraversableLike[_, _]): Unit

Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection. 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

(defined at scala.collection.mutable.Builder)

Value Members From scala.collection.mutable.Iterable

def companion: GenericCompanion[mutable.Iterable]

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

• Definition Classes
  • Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → GenericTraversableTemplate

(defined at scala.collection.mutable.Iterable)

Value Members From scala.collection.mutable.Map

def withDefault(d: (K) ⇒ V): mutable.Map[K, V]

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

(defined at scala.collection.mutable.Map)

def withDefaultValue(d: V): mutable.Map[K, V]

The same map with a given default value.

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

• d
  • default value used for non-present keys
• returns
  • a wrapper of the map with a default value
• Definition Classes
  • Map

(defined at scala.collection.mutable.Map)

Value Members From scala.collection.mutable.MapLike

def ++[B1 >: V](xs: GenTraversableOnce[(K, B1)]): mutable.Map[K, 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.

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

• 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
  • MapLike → MapLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) ++ creates a new map. Use ++= to add an element to this map and return that map itself.

(defined at scala.collection.mutable.MapLike)

def +[B1 >: V](kv: (K, B1)): mutable.Map[K, B1]

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
  • MapLike → MapLike → GenMapLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) + creates a new map. Use += to add an element to this map and return that map itself.

(defined at scala.collection.mutable.MapLike)

def +[B1 >: V](elem1: (K, B1), elem2: (K, B1), elems: (K, B1)*): mutable.Map[K, B1]

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

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

• B1
  • the type of the added values
• elem1
  • the first element to add.
• elem2
  • the second element to add.
• elems
  • the remaining elements to add.
• returns
  • a new map containing mappings of this map and two or more specified mappings.
• Definition Classes
  • MapLike → MapLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) + creates a new map. Use += to add an element to this map and return that map itself.

(defined at scala.collection.mutable.MapLike)

def -(key: K): TrieMap[K, V]

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
  • MapLike → MapLike → Subtractable → GenMapLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) - creates a new map. Use -= to remove an element from this map and return that map itself.

(defined at scala.collection.mutable.MapLike)

def -(elem1: K, elem2: K, elems: K*): TrieMap[K, V]

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
  • MapLike → Subtractable
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) - creates a new map. Use -= to remove an element from this map and return that map itself.

(defined at scala.collection.mutable.MapLike)

def --(xs: GenTraversableOnce[K]): TrieMap[K, V]

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
  • MapLike → Subtractable
• Annotations
  • @migration
• Migration
  • (Changed in version 2.8.0) -- creates a new map. Use --= to remove an element from this map and return that map itself.

(defined at scala.collection.mutable.MapLike)

def clone(): TrieMap[K, V]

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
  • MapLike → Cloneable → AnyRef
• Note
  • not specified by SLS as a member of AnyRef

(defined at scala.collection.mutable.MapLike)

def newBuilder: Builder[(K, V), TrieMap[K, V]]

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

Overrides MapLike implementation for better efficiency.

• Attributes
  • protected[this]
• Definition Classes
  • MapLike → MapLike → TraversableLike → HasNewBuilder

(defined at scala.collection.mutable.MapLike)

def result(): TrieMap[K, V]

The result when this map is used as a builder

• returns
  • the map representation itself.
• Definition Classes
  • MapLike → Builder

(defined at scala.collection.mutable.MapLike)

def retain(p: (K, V) ⇒ Boolean): TrieMap.this.type

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

• p
  • The test predicate
• Definition Classes
  • MapLike

(defined at scala.collection.mutable.MapLike)

def toSeq: Seq[(K, V)]

Converts this mutable map to a sequence.

Note : assumes a fast size method. Subclasses should override if this is not true.

• returns
  • a sequence containing all elements of this mutable map.
• Definition Classes
  • MapLike → MapLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.mutable.MapLike)

def transform(f: (K, V) ⇒ V): TrieMap.this.type

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
  • MapLike

(defined at scala.collection.mutable.MapLike)

def updated[B1 >: V](key: K, value: B1): mutable.Map[K, 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.

• B1
  • the type of the added value
• key
  • The key to add
• value
  • The new value
• returns
  • A fresh immutable map with the binding from key to value added to this map.
• Definition Classes
  • MapLike → MapLike

(defined at scala.collection.mutable.MapLike)

Value Members From Implicit scala.collection.parallel.CollectionsHaveToParArray ——————————————————————————–

def toParArray: ParArray[T]

• Implicit information
  • This member is added by an implicit conversion from TrieMap [K, V] to CollectionsHaveToParArray [TrieMap [K, V], T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (TrieMap [K, V]) ⇒ GenTraversableOnce [T] is in scope.
• Definition Classes
  • CollectionsHaveToParArray (added by implicit convertion: scala.collection.parallel.CollectionsHaveToParArray)

Full Source:

/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2003-2013, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */

package scala
package collection
package concurrent

import java.util.concurrent.atomic._
import scala.collection.parallel.mutable.ParTrieMap
import scala.util.hashing.Hashing
import scala.util.control.ControlThrowable
import generic._
import scala.annotation.tailrec

private[collection] final class INode[K, V](bn: MainNode[K, V], g: Gen) extends INodeBase[K, V](g) {
  import INodeBase._

  WRITE(bn)

  def this(g: Gen) = this(null, g)

  def WRITE(nval: MainNode[K, V]) = INodeBase.updater.set(this, nval)

  def CAS(old: MainNode[K, V], n: MainNode[K, V]) = INodeBase.updater.compareAndSet(this, old, n)

  def gcasRead(ct: TrieMap[K, V]): MainNode[K, V] = GCAS_READ(ct)

  def GCAS_READ(ct: TrieMap[K, V]): MainNode[K, V] = {
    val m = /*READ*/mainnode
    val prevval = /*READ*/m.prev
    if (prevval eq null) m
    else GCAS_Complete(m, ct)
  }

  @tailrec private def GCAS_Complete(m: MainNode[K, V], ct: TrieMap[K, V]): MainNode[K, V] = if (m eq null) null else {
    // complete the GCAS
    val prev = /*READ*/m.prev
    val ctr = ct.readRoot(abort = true)

    prev match {
      case null =>
        m
      case fn: FailedNode[_, _] => // try to commit to previous value
        if (CAS(m, fn.prev)) fn.prev
        else GCAS_Complete(/*READ*/mainnode, ct)
      case vn: MainNode[_, _] =>
        // Assume that you've read the root from the generation G.
        // Assume that the snapshot algorithm is correct.
        // ==> you can only reach nodes in generations <= G.
        // ==> `gen` is <= G.
        // We know that `ctr.gen` is >= G.
        // ==> if `ctr.gen` = `gen` then they are both equal to G.
        // ==> otherwise, we know that either `ctr.gen` > G, `gen` < G,
        //     or both
        if ((ctr.gen eq gen) && ct.nonReadOnly) {
          // try to commit
          if (m.CAS_PREV(prev, null)) m
          else GCAS_Complete(m, ct)
        } else {
          // try to abort
          m.CAS_PREV(prev, new FailedNode(prev))
          GCAS_Complete(/*READ*/mainnode, ct)
        }
    }
  }

  def GCAS(old: MainNode[K, V], n: MainNode[K, V], ct: TrieMap[K, V]): Boolean = {
    n.WRITE_PREV(old)
    if (CAS(old, n)) {
      GCAS_Complete(n, ct)
      /*READ*/n.prev eq null
    } else false
  }

  private def equal(k1: K, k2: K, ct: TrieMap[K, V]) = ct.equality.equiv(k1, k2)

  private def inode(cn: MainNode[K, V]) = {
    val nin = new INode[K, V](gen)
    nin.WRITE(cn)
    nin
  }

  def copyToGen(ngen: Gen, ct: TrieMap[K, V]) = {
    val nin = new INode[K, V](ngen)
    val main = GCAS_READ(ct)
    nin.WRITE(main)
    nin
  }

  /** Inserts a key value pair, overwriting the old pair if the keys match.
   *
   *  @return        true if successful, false otherwise
   */
  @tailrec def rec_insert(k: K, v: V, hc: Int, lev: Int, parent: INode[K, V], startgen: Gen, ct: TrieMap[K, V]): Boolean = {
    val m = GCAS_READ(ct) // use -Yinline!

    m match {
      case cn: CNode[K, V] => // 1) a multiway node
        val idx = (hc >>> lev) & 0x1f
        val flag = 1 << idx
        val bmp = cn.bitmap
        val mask = flag - 1
        val pos = Integer.bitCount(bmp & mask)
        if ((bmp & flag) != 0) {
          // 1a) insert below
          cn.array(pos) match {
            case in: INode[K, V] =>
              if (startgen eq in.gen) in.rec_insert(k, v, hc, lev + 5, this, startgen, ct)
              else {
                if (GCAS(cn, cn.renewed(startgen, ct), ct)) rec_insert(k, v, hc, lev, parent, startgen, ct)
                else false
              }
            case sn: SNode[K, V] =>
              if (sn.hc == hc && equal(sn.k, k, ct)) GCAS(cn, cn.updatedAt(pos, new SNode(k, v, hc), gen), ct)
              else {
                val rn = if (cn.gen eq gen) cn else cn.renewed(gen, ct)
                val nn = rn.updatedAt(pos, inode(CNode.dual(sn, sn.hc, new SNode(k, v, hc), hc, lev + 5, gen)), gen)
                GCAS(cn, nn, ct)
              }
          }
        } else {
          val rn = if (cn.gen eq gen) cn else cn.renewed(gen, ct)
          val ncnode = rn.insertedAt(pos, flag, new SNode(k, v, hc), gen)
          GCAS(cn, ncnode, ct)
        }
      case tn: TNode[K, V] =>
        clean(parent, ct, lev - 5)
        false
      case ln: LNode[K, V] => // 3) an l-node
        val nn = ln.inserted(k, v)
        GCAS(ln, nn, ct)
    }
  }

  /** Inserts a new key value pair, given that a specific condition is met.
   *
   *  @param cond        null - don't care if the key was there; KEY_ABSENT - key wasn't there; KEY_PRESENT - key was there; other value `v` - key must be bound to `v`
   *  @return            null if unsuccessful, Option[V] otherwise (indicating previous value bound to the key)
   */
  @tailrec def rec_insertif(k: K, v: V, hc: Int, cond: AnyRef, lev: Int, parent: INode[K, V], startgen: Gen, ct: TrieMap[K, V]): Option[V] = {
    val m = GCAS_READ(ct)  // use -Yinline!

    m match {
      case cn: CNode[K, V] => // 1) a multiway node
        val idx = (hc >>> lev) & 0x1f
        val flag = 1 << idx
        val bmp = cn.bitmap
        val mask = flag - 1
        val pos = Integer.bitCount(bmp & mask)
        if ((bmp & flag) != 0) {
          // 1a) insert below
          cn.array(pos) match {
            case in: INode[K, V] =>
              if (startgen eq in.gen) in.rec_insertif(k, v, hc, cond, lev + 5, this, startgen, ct)
              else {
                if (GCAS(cn, cn.renewed(startgen, ct), ct)) rec_insertif(k, v, hc, cond, lev, parent, startgen, ct)
                else null
              }
            case sn: SNode[K, V] => cond match {
              case null =>
                if (sn.hc == hc && equal(sn.k, k, ct)) {
                  if (GCAS(cn, cn.updatedAt(pos, new SNode(k, v, hc), gen), ct)) Some(sn.v) else null
                } else {
                  val rn = if (cn.gen eq gen) cn else cn.renewed(gen, ct)
                  val nn = rn.updatedAt(pos, inode(CNode.dual(sn, sn.hc, new SNode(k, v, hc), hc, lev + 5, gen)), gen)
                  if (GCAS(cn, nn, ct)) None
                  else null
                }
              case INode.KEY_ABSENT =>
                if (sn.hc == hc && equal(sn.k, k, ct)) Some(sn.v)
                else {
                  val rn = if (cn.gen eq gen) cn else cn.renewed(gen, ct)
                  val nn = rn.updatedAt(pos, inode(CNode.dual(sn, sn.hc, new SNode(k, v, hc), hc, lev + 5, gen)), gen)
                  if (GCAS(cn, nn, ct)) None
                  else null
                }
              case INode.KEY_PRESENT =>
                if (sn.hc == hc && equal(sn.k, k, ct)) {
                  if (GCAS(cn, cn.updatedAt(pos, new SNode(k, v, hc), gen), ct)) Some(sn.v) else null
                } else None
              case otherv =>
                if (sn.hc == hc && equal(sn.k, k, ct) && sn.v == otherv) {
                  if (GCAS(cn, cn.updatedAt(pos, new SNode(k, v, hc), gen), ct)) Some(sn.v) else null
                } else None
            }
          }
        } else cond match {
          case null | INode.KEY_ABSENT =>
            val rn = if (cn.gen eq gen) cn else cn.renewed(gen, ct)
            val ncnode = rn.insertedAt(pos, flag, new SNode(k, v, hc), gen)
            if (GCAS(cn, ncnode, ct)) None else null
          case INode.KEY_PRESENT => None
          case otherv => None
        }
      case sn: TNode[K, V] =>
        clean(parent, ct, lev - 5)
        null
      case ln: LNode[K, V] => // 3) an l-node
        def insertln() = {
          val nn = ln.inserted(k, v)
          GCAS(ln, nn, ct)
        }
        cond match {
          case null =>
            val optv = ln.get(k)
            if (insertln()) optv else null
          case INode.KEY_ABSENT =>
            ln.get(k) match {
              case None => if (insertln()) None else null
              case optv => optv
            }
          case INode.KEY_PRESENT =>
            ln.get(k) match {
              case Some(v0) => if (insertln()) Some(v0) else null
              case None => None
            }
          case otherv =>
            ln.get(k) match {
              case Some(v0) if v0 == otherv => if (insertln()) Some(otherv.asInstanceOf[V]) else null
              case _ => None
            }
        }
    }
  }

  /** Looks up the value associated with the key.
   *
   *  @return          null if no value has been found, RESTART if the operation wasn't successful, or any other value otherwise
   */
  @tailrec def rec_lookup(k: K, hc: Int, lev: Int, parent: INode[K, V], startgen: Gen, ct: TrieMap[K, V]): AnyRef = {
    val m = GCAS_READ(ct) // use -Yinline!

    m match {
      case cn: CNode[K, V] => // 1) a multinode
        val idx = (hc >>> lev) & 0x1f
        val flag = 1 << idx
        val bmp = cn.bitmap
        if ((bmp & flag) == 0) null // 1a) bitmap shows no binding
        else { // 1b) bitmap contains a value - descend
          val pos = if (bmp == 0xffffffff) idx else Integer.bitCount(bmp & (flag - 1))
          val sub = cn.array(pos)
          sub match {
            case in: INode[K, V] =>
              if (ct.isReadOnly || (startgen eq in.gen)) in.rec_lookup(k, hc, lev + 5, this, startgen, ct)
              else {
                if (GCAS(cn, cn.renewed(startgen, ct), ct)) rec_lookup(k, hc, lev, parent, startgen, ct)
                else RESTART // used to be throw RestartException
              }
            case sn: SNode[K, V] => // 2) singleton node
              if (sn.hc == hc && equal(sn.k, k, ct)) sn.v.asInstanceOf[AnyRef]
              else null
          }
        }
      case tn: TNode[K, V] => // 3) non-live node
        def cleanReadOnly(tn: TNode[K, V]) = if (ct.nonReadOnly) {
          clean(parent, ct, lev - 5)
          RESTART // used to be throw RestartException
        } else {
          if (tn.hc == hc && tn.k == k) tn.v.asInstanceOf[AnyRef]
          else null
        }
        cleanReadOnly(tn)
      case ln: LNode[K, V] => // 5) an l-node
        ln.get(k).asInstanceOf[Option[AnyRef]].orNull
    }
  }

  /** Removes the key associated with the given value.
   *
   *  @param v         if null, will remove the key irregardless of the value; otherwise removes only if binding contains that exact key and value
   *  @return          null if not successful, an Option[V] indicating the previous value otherwise
   */
  def rec_remove(k: K, v: V, hc: Int, lev: Int, parent: INode[K, V], startgen: Gen, ct: TrieMap[K, V]): Option[V] = {
    val m = GCAS_READ(ct) // use -Yinline!

    m match {
      case cn: CNode[K, V] =>
        val idx = (hc >>> lev) & 0x1f
        val bmp = cn.bitmap
        val flag = 1 << idx
        if ((bmp & flag) == 0) None
        else {
          val pos = Integer.bitCount(bmp & (flag - 1))
          val sub = cn.array(pos)
          val res = sub match {
            case in: INode[K, V] =>
              if (startgen eq in.gen) in.rec_remove(k, v, hc, lev + 5, this, startgen, ct)
              else {
                if (GCAS(cn, cn.renewed(startgen, ct), ct)) rec_remove(k, v, hc, lev, parent, startgen, ct)
                else null
              }
            case sn: SNode[K, V] =>
              if (sn.hc == hc && equal(sn.k, k, ct) && (v == null || sn.v == v)) {
                val ncn = cn.removedAt(pos, flag, gen).toContracted(lev)
                if (GCAS(cn, ncn, ct)) Some(sn.v) else null
              } else None
          }

          if (res == None || (res eq null)) res
          else {
            @tailrec def cleanParent(nonlive: AnyRef) {
              val pm = parent.GCAS_READ(ct)
              pm match {
                case cn: CNode[K, V] =>
                  val idx = (hc >>> (lev - 5)) & 0x1f
                  val bmp = cn.bitmap
                  val flag = 1 << idx
                  if ((bmp & flag) == 0) {} // somebody already removed this i-node, we're done
                  else {
                    val pos = Integer.bitCount(bmp & (flag - 1))
                    val sub = cn.array(pos)
                    if (sub eq this) nonlive match {
                      case tn: TNode[K, V] =>
                        val ncn = cn.updatedAt(pos, tn.copyUntombed, gen).toContracted(lev - 5)
                        if (!parent.GCAS(cn, ncn, ct))
                          if (ct.readRoot().gen == startgen) cleanParent(nonlive)
                    }
                  }
                case _ => // parent is no longer a cnode, we're done
              }
            }

            if (parent ne null) { // never tomb at root
              val n = GCAS_READ(ct)
              if (n.isInstanceOf[TNode[_, _]])
                cleanParent(n)
            }

            res
          }
        }
      case tn: TNode[K, V] =>
        clean(parent, ct, lev - 5)
        null
      case ln: LNode[K, V] =>
        if (v == null) {
          val optv = ln.get(k)
          val nn = ln.removed(k, ct)
          if (GCAS(ln, nn, ct)) optv else null
        } else ln.get(k) match {
          case optv @ Some(v0) if v0 == v =>
            val nn = ln.removed(k, ct)
            if (GCAS(ln, nn, ct)) optv else null
          case _ => None
        }
    }
  }

  private def clean(nd: INode[K, V], ct: TrieMap[K, V], lev: Int) {
    val m = nd.GCAS_READ(ct)
    m match {
      case cn: CNode[K, V] => nd.GCAS(cn, cn.toCompressed(ct, lev, gen), ct)
      case _ =>
    }
  }

  def isNullInode(ct: TrieMap[K, V]) = GCAS_READ(ct) eq null

  def cachedSize(ct: TrieMap[K, V]): Int = {
    val m = GCAS_READ(ct)
    m.cachedSize(ct)
  }

  /* this is a quiescent method! */
  def string(lev: Int) = "%sINode -> %s".format("  " * lev, mainnode match {
    case null => "<null>"
    case tn: TNode[_, _] => "TNode(%s, %s, %d, !)".format(tn.k, tn.v, tn.hc)
    case cn: CNode[_, _] => cn.string(lev)
    case ln: LNode[_, _] => ln.string(lev)
    case x => "<elem: %s>".format(x)
  })

}


private[concurrent] object INode {
  val KEY_PRESENT = new AnyRef
  val KEY_ABSENT = new AnyRef

  def newRootNode[K, V] = {
    val gen = new Gen
    val cn = new CNode[K, V](0, new Array(0), gen)
    new INode[K, V](cn, gen)
  }
}


private[concurrent] final class FailedNode[K, V](p: MainNode[K, V]) extends MainNode[K, V] {
  WRITE_PREV(p)

  def string(lev: Int) = throw new UnsupportedOperationException

  def cachedSize(ct: AnyRef): Int = throw new UnsupportedOperationException

  override def toString = "FailedNode(%s)".format(p)
}


private[concurrent] trait KVNode[K, V] {
  def kvPair: (K, V)
}


private[collection] final class SNode[K, V](final val k: K, final val v: V, final val hc: Int)
extends BasicNode with KVNode[K, V] {
  final def copy = new SNode(k, v, hc)
  final def copyTombed = new TNode(k, v, hc)
  final def copyUntombed = new SNode(k, v, hc)
  final def kvPair = (k, v)
  final def string(lev: Int) = ("  " * lev) + "SNode(%s, %s, %x)".format(k, v, hc)
}


private[collection] final class TNode[K, V](final val k: K, final val v: V, final val hc: Int)
extends MainNode[K, V] with KVNode[K, V] {
  final def copy = new TNode(k, v, hc)
  final def copyTombed = new TNode(k, v, hc)
  final def copyUntombed = new SNode(k, v, hc)
  final def kvPair = (k, v)
  final def cachedSize(ct: AnyRef): Int = 1
  final def string(lev: Int) = ("  " * lev) + "TNode(%s, %s, %x, !)".format(k, v, hc)
}


private[collection] final class LNode[K, V](final val listmap: immutable.ListMap[K, V])
extends MainNode[K, V] {
  def this(k: K, v: V) = this(immutable.ListMap(k -> v))
  def this(k1: K, v1: V, k2: K, v2: V) = this(immutable.ListMap(k1 -> v1, k2 -> v2))
  def inserted(k: K, v: V) = new LNode(listmap + ((k, v)))
  def removed(k: K, ct: TrieMap[K, V]): MainNode[K, V] = {
    val updmap = listmap - k
    if (updmap.size > 1) new LNode(updmap)
    else {
      val (k, v) = updmap.iterator.next()
      new TNode(k, v, ct.computeHash(k)) // create it tombed so that it gets compressed on subsequent accesses
    }
  }
  def get(k: K) = listmap.get(k)
  def cachedSize(ct: AnyRef): Int = listmap.size
  def string(lev: Int) = (" " * lev) + "LNode(%s)".format(listmap.mkString(", "))
}


private[collection] final class CNode[K, V](val bitmap: Int, val array: Array[BasicNode], val gen: Gen) extends CNodeBase[K, V] {
  // this should only be called from within read-only snapshots
  def cachedSize(ct: AnyRef) = {
    val currsz = READ_SIZE()
    if (currsz != -1) currsz
    else {
      val sz = computeSize(ct.asInstanceOf[TrieMap[K, V]])
      while (READ_SIZE() == -1) CAS_SIZE(-1, sz)
      READ_SIZE()
    }
  }

  // lends itself towards being parallelizable by choosing
  // a random starting offset in the array
  // => if there are concurrent size computations, they start
  //    at different positions, so they are more likely to
  //    to be independent
  private def computeSize(ct: TrieMap[K, V]): Int = {
    var i = 0
    var sz = 0
    val offset =
      if (array.length > 0)
        //util.Random.nextInt(array.length) /* <-- benchmarks show that this causes observable contention */
        java.util.concurrent.ThreadLocalRandom.current.nextInt(0, array.length)
      else 0
    while (i < array.length) {
      val pos = (i + offset) % array.length
      array(pos) match {
        case sn: SNode[_, _] => sz += 1
        case in: INode[K, V] => sz += in.cachedSize(ct)
      }
      i += 1
    }
    sz
  }

  def updatedAt(pos: Int, nn: BasicNode, gen: Gen) = {
    val len = array.length
    val narr = new Array[BasicNode](len)
    Array.copy(array, 0, narr, 0, len)
    narr(pos) = nn
    new CNode[K, V](bitmap, narr, gen)
  }

  def removedAt(pos: Int, flag: Int, gen: Gen) = {
    val arr = array
    val len = arr.length
    val narr = new Array[BasicNode](len - 1)
    Array.copy(arr, 0, narr, 0, pos)
    Array.copy(arr, pos + 1, narr, pos, len - pos - 1)
    new CNode[K, V](bitmap ^ flag, narr, gen)
  }

  def insertedAt(pos: Int, flag: Int, nn: BasicNode, gen: Gen) = {
    val len = array.length
    val bmp = bitmap
    val narr = new Array[BasicNode](len + 1)
    Array.copy(array, 0, narr, 0, pos)
    narr(pos) = nn
    Array.copy(array, pos, narr, pos + 1, len - pos)
    new CNode[K, V](bmp | flag, narr, gen)
  }

  /** Returns a copy of this cnode such that all the i-nodes below it are copied
   *  to the specified generation `ngen`.
   */
  def renewed(ngen: Gen, ct: TrieMap[K, V]) = {
    var i = 0
    val arr = array
    val len = arr.length
    val narr = new Array[BasicNode](len)
    while (i < len) {
      arr(i) match {
        case in: INode[K, V] => narr(i) = in.copyToGen(ngen, ct)
        case bn: BasicNode => narr(i) = bn
      }
      i += 1
    }
    new CNode[K, V](bitmap, narr, ngen)
  }

  private def resurrect(inode: INode[K, V], inodemain: AnyRef): BasicNode = inodemain match {
    case tn: TNode[_, _] => tn.copyUntombed
    case _ => inode
  }

  def toContracted(lev: Int): MainNode[K, V] = if (array.length == 1 && lev > 0) array(0) match {
    case sn: SNode[K, V] => sn.copyTombed
    case _ => this
  } else this

  // - if the branching factor is 1 for this CNode, and the child
  //   is a tombed SNode, returns its tombed version
  // - otherwise, if there is at least one non-null node below,
  //   returns the version of this node with at least some null-inodes
  //   removed (those existing when the op began)
  // - if there are only null-i-nodes below, returns null
  def toCompressed(ct: TrieMap[K, V], lev: Int, gen: Gen) = {
    val bmp = bitmap
    var i = 0
    val arr = array
    val tmparray = new Array[BasicNode](arr.length)
    while (i < arr.length) { // construct new bitmap
      val sub = arr(i)
      sub match {
        case in: INode[K, V] =>
          val inodemain = in.gcasRead(ct)
          assert(inodemain ne null)
          tmparray(i) = resurrect(in, inodemain)
        case sn: SNode[K, V] =>
          tmparray(i) = sn
      }
      i += 1
    }

    new CNode[K, V](bmp, tmparray, gen).toContracted(lev)
  }

  private[concurrent] def string(lev: Int): String = "CNode %x\n%s".format(bitmap, array.map(_.string(lev + 1)).mkString("\n"))

  /* quiescently consistent - don't call concurrently to anything involving a GCAS!! */
  private def collectElems: Seq[(K, V)] = array flatMap {
    case sn: SNode[K, V] => Some(sn.kvPair)
    case in: INode[K, V] => in.mainnode match {
      case tn: TNode[K, V] => Some(tn.kvPair)
      case ln: LNode[K, V] => ln.listmap.toList
      case cn: CNode[K, V] => cn.collectElems
    }
  }

  private def collectLocalElems: Seq[String] = array flatMap {
    case sn: SNode[K, V] => Some(sn.kvPair._2.toString)
    case in: INode[K, V] => Some(in.toString.drop(14) + "(" + in.gen + ")")
  }

  override def toString = {
    val elems = collectLocalElems
    "CNode(sz: %d; %s)".format(elems.size, elems.sorted.mkString(", "))
  }
}


private[concurrent] object CNode {

  def dual[K, V](x: SNode[K, V], xhc: Int, y: SNode[K, V], yhc: Int, lev: Int, gen: Gen): MainNode[K, V] = if (lev < 35) {
    val xidx = (xhc >>> lev) & 0x1f
    val yidx = (yhc >>> lev) & 0x1f
    val bmp = (1 << xidx) | (1 << yidx)
    if (xidx == yidx) {
      val subinode = new INode[K, V](gen)//(TrieMap.inodeupdater)
      subinode.mainnode = dual(x, xhc, y, yhc, lev + 5, gen)
      new CNode(bmp, Array(subinode), gen)
    } else {
      if (xidx < yidx) new CNode(bmp, Array(x, y), gen)
      else new CNode(bmp, Array(y, x), gen)
    }
  } else {
    new LNode(x.k, x.v, y.k, y.v)
  }

}


private[concurrent] case class RDCSS_Descriptor[K, V](old: INode[K, V], expectedmain: MainNode[K, V], nv: INode[K, V]) {
  @volatile var committed = false
}


/** A concurrent hash-trie or TrieMap is a concurrent thread-safe lock-free
 *  implementation of a hash array mapped trie. It is used to implement the
 *  concurrent map abstraction. It has particularly scalable concurrent insert
 *  and remove operations and is memory-efficient. It supports O(1), atomic,
 *  lock-free snapshots which are used to implement linearizable lock-free size,
 *  iterator and clear operations. The cost of evaluating the (lazy) snapshot is
 *  distributed across subsequent updates, thus making snapshot evaluation horizontally scalable.
 *
 *  For details, see: http://lampwww.epfl.ch/~prokopec/ctries-snapshot.pdf
 *
 *  @author Aleksandar Prokopec
 *  @since 2.10
 */
@SerialVersionUID(0L - 6402774413839597105L)
final class TrieMap[K, V] private (r: AnyRef, rtupd: AtomicReferenceFieldUpdater[TrieMap[K, V], AnyRef], hashf: Hashing[K], ef: Equiv[K])
extends scala.collection.concurrent.Map[K, V]
   with scala.collection.mutable.MapLike[K, V, TrieMap[K, V]]
   with CustomParallelizable[(K, V), ParTrieMap[K, V]]
   with Serializable
{
  private var hashingobj = if (hashf.isInstanceOf[Hashing.Default[_]]) new TrieMap.MangledHashing[K] else hashf
  private var equalityobj = ef
  private var rootupdater = rtupd
  def hashing = hashingobj
  def equality = equalityobj
  @deprecated("This field will be made private", "2.12.0")
  @volatile /*private*/ var root = r

  def this(hashf: Hashing[K], ef: Equiv[K]) = this(
    INode.newRootNode,
    AtomicReferenceFieldUpdater.newUpdater(classOf[TrieMap[K, V]], classOf[AnyRef], "root"),
    hashf,
    ef
  )

  def this() = this(Hashing.default, Equiv.universal)

  /* internal methods */

  private def writeObject(out: java.io.ObjectOutputStream) {
    out.writeObject(hashingobj)
    out.writeObject(equalityobj)

    val it = iterator
    while (it.hasNext) {
      val (k, v) = it.next()
      out.writeObject(k)
      out.writeObject(v)
    }
    out.writeObject(TrieMapSerializationEnd)
  }

  private def readObject(in: java.io.ObjectInputStream) {
    root = INode.newRootNode
    rootupdater = AtomicReferenceFieldUpdater.newUpdater(classOf[TrieMap[K, V]], classOf[AnyRef], "root")

    hashingobj = in.readObject().asInstanceOf[Hashing[K]]
    equalityobj = in.readObject().asInstanceOf[Equiv[K]]

    var obj: AnyRef = null
    do {
      obj = in.readObject()
      if (obj != TrieMapSerializationEnd) {
        val k = obj.asInstanceOf[K]
        val v = in.readObject().asInstanceOf[V]
        update(k, v)
      }
    } while (obj != TrieMapSerializationEnd)
  }

  @deprecated("This method will be made private", "2.12.0")
  /*private*/ def CAS_ROOT(ov: AnyRef, nv: AnyRef) = rootupdater.compareAndSet(this, ov, nv)

  @deprecated("This method will be made private", "2.12.0")
  /*private[collection]*/ def readRoot(abort: Boolean = false): INode[K, V] = RDCSS_READ_ROOT(abort)

  @deprecated("This method will be made private", "2.12.0")
  /*private[concurrent]*/ def RDCSS_READ_ROOT(abort: Boolean = false): INode[K, V] = {
    val r = /*READ*/root
    r match {
      case in: INode[K, V] => in
      case desc: RDCSS_Descriptor[K, V] => RDCSS_Complete(abort)
    }
  }

  @tailrec private def RDCSS_Complete(abort: Boolean): INode[K, V] = {
    val v = /*READ*/root
    v match {
      case in: INode[K, V] => in
      case desc: RDCSS_Descriptor[K, V] =>
        val RDCSS_Descriptor(ov, exp, nv) = desc
        if (abort) {
          if (CAS_ROOT(desc, ov)) ov
          else RDCSS_Complete(abort)
        } else {
          val oldmain = ov.gcasRead(this)
          if (oldmain eq exp) {
            if (CAS_ROOT(desc, nv)) {
              desc.committed = true
              nv
            } else RDCSS_Complete(abort)
          } else {
            if (CAS_ROOT(desc, ov)) ov
            else RDCSS_Complete(abort)
          }
        }
    }
  }

  private def RDCSS_ROOT(ov: INode[K, V], expectedmain: MainNode[K, V], nv: INode[K, V]): Boolean = {
    val desc = RDCSS_Descriptor(ov, expectedmain, nv)
    if (CAS_ROOT(ov, desc)) {
      RDCSS_Complete(abort = false)
      /*READ*/desc.committed
    } else false
  }

  @tailrec private def inserthc(k: K, hc: Int, v: V) {
    val r = RDCSS_READ_ROOT()
    if (!r.rec_insert(k, v, hc, 0, null, r.gen, this)) inserthc(k, hc, v)
  }

  @tailrec private def insertifhc(k: K, hc: Int, v: V, cond: AnyRef): Option[V] = {
    val r = RDCSS_READ_ROOT()

    val ret = r.rec_insertif(k, v, hc, cond, 0, null, r.gen, this)
    if (ret eq null) insertifhc(k, hc, v, cond)
    else ret
  }

  @tailrec private def lookuphc(k: K, hc: Int): AnyRef = {
    val r = RDCSS_READ_ROOT()
    val res = r.rec_lookup(k, hc, 0, null, r.gen, this)
    if (res eq INodeBase.RESTART) lookuphc(k, hc)
    else res
  }

  /* slower:
  //@tailrec
  private def lookuphc(k: K, hc: Int): AnyRef = {
    val r = RDCSS_READ_ROOT()
    try {
      r.rec_lookup(k, hc, 0, null, r.gen, this)
    } catch {
      case RestartException =>
        lookuphc(k, hc)
    }
  }
  */

  @tailrec private def removehc(k: K, v: V, hc: Int): Option[V] = {
    val r = RDCSS_READ_ROOT()
    val res = r.rec_remove(k, v, hc, 0, null, r.gen, this)
    if (res ne null) res
    else removehc(k, v, hc)
  }

  def string = RDCSS_READ_ROOT().string(0)

  /* public methods */

  override def seq = this

  override def par = new ParTrieMap(this)

  override def empty: TrieMap[K, V] = new TrieMap[K, V]

  def isReadOnly = rootupdater eq null

  def nonReadOnly = rootupdater ne null

  /** Returns a snapshot of this TrieMap.
   *  This operation is lock-free and linearizable.
   *
   *  The snapshot is lazily updated - the first time some branch
   *  in the snapshot or this TrieMap are accessed, they are rewritten.
   *  This means that the work of rebuilding both the snapshot and this
   *  TrieMap is distributed across all the threads doing updates or accesses
   *  subsequent to the snapshot creation.
   */
  @tailrec def snapshot(): TrieMap[K, V] = {
    val r = RDCSS_READ_ROOT()
    val expmain = r.gcasRead(this)
    if (RDCSS_ROOT(r, expmain, r.copyToGen(new Gen, this))) new TrieMap(r.copyToGen(new Gen, this), rootupdater, hashing, equality)
    else snapshot()
  }

  /** Returns a read-only snapshot of this TrieMap.
   *  This operation is lock-free and linearizable.
   *
   *  The snapshot is lazily updated - the first time some branch
   *  of this TrieMap are accessed, it is rewritten. The work of creating
   *  the snapshot is thus distributed across subsequent updates
   *  and accesses on this TrieMap by all threads.
   *  Note that the snapshot itself is never rewritten unlike when calling
   *  the `snapshot` method, but the obtained snapshot cannot be modified.
   *
   *  This method is used by other methods such as `size` and `iterator`.
   */
  @tailrec def readOnlySnapshot(): scala.collection.Map[K, V] = {
    val r = RDCSS_READ_ROOT()
    val expmain = r.gcasRead(this)
    if (RDCSS_ROOT(r, expmain, r.copyToGen(new Gen, this))) new TrieMap(r, null, hashing, equality)
    else readOnlySnapshot()
  }

  @tailrec override def clear() {
    val r = RDCSS_READ_ROOT()
    if (!RDCSS_ROOT(r, r.gcasRead(this), INode.newRootNode[K, V])) clear()
  }


  def computeHash(k: K) = hashingobj.hash(k)

  def lookup(k: K): V = {
    val hc = computeHash(k)
    lookuphc(k, hc).asInstanceOf[V]
  }

  override def apply(k: K): V = {
    val hc = computeHash(k)
    val res = lookuphc(k, hc)
    if (res eq null) throw new NoSuchElementException
    else res.asInstanceOf[V]
  }

  def get(k: K): Option[V] = {
    val hc = computeHash(k)
    Option(lookuphc(k, hc)).asInstanceOf[Option[V]]
  }

  override def put(key: K, value: V): Option[V] = {
    val hc = computeHash(key)
    insertifhc(key, hc, value, null)
  }

  override def update(k: K, v: V) {
    val hc = computeHash(k)
    inserthc(k, hc, v)
  }

  def +=(kv: (K, V)) = {
    update(kv._1, kv._2)
    this
  }

  override def remove(k: K): Option[V] = {
    val hc = computeHash(k)
    removehc(k, null.asInstanceOf[V], hc)
  }

  def -=(k: K) = {
    remove(k)
    this
  }

  def putIfAbsent(k: K, v: V): Option[V] = {
    val hc = computeHash(k)
    insertifhc(k, hc, v, INode.KEY_ABSENT)
  }

  // TODO once computeIfAbsent is added to concurrent.Map,
  // move the comment there and tweak the 'at most once' part
  /** If the specified key is not already in the map, computes its value using
   *  the given thunk `op` and enters it into the map.
   *
   *  Since concurrent maps cannot contain `null` for keys or values,
   *  a `NullPointerException` is thrown if the thunk `op`
   *  returns `null`.
   *
   *  If the specified mapping function throws an exception,
   *  that exception is rethrown.
   *
   *  Note: This method will invoke op at most once.
   *  However, `op` may be invoked without the result being added to the map if
   *  a concurrent process is also trying to add a value corresponding to the
   *  same key `k`.
   *
   *  @param k      the key to modify
   *  @param op     the expression that computes the value
   *  @return       the newly added value
   */
  override def getOrElseUpdate(k: K, op: =>V): V = {
    val oldv = lookup(k)
    if (oldv != null) oldv.asInstanceOf[V]
    else {
      val v = op
      if (v == null) {
        throw new NullPointerException("Concurrent TrieMap values cannot be null.")
      } else {
        val hc = computeHash(k)
        insertifhc(k, hc, v, INode.KEY_ABSENT) match {
          case Some(oldv) => oldv
          case None => v
        }
      }
    }
  }

  def remove(k: K, v: V): Boolean = {
    val hc = computeHash(k)
    removehc(k, v, hc).nonEmpty
  }

  def replace(k: K, oldvalue: V, newvalue: V): Boolean = {
    val hc = computeHash(k)
    insertifhc(k, hc, newvalue, oldvalue.asInstanceOf[AnyRef]).nonEmpty
  }

  def replace(k: K, v: V): Option[V] = {
    val hc = computeHash(k)
    insertifhc(k, hc, v, INode.KEY_PRESENT)
  }

  def iterator: Iterator[(K, V)] =
    if (nonReadOnly) readOnlySnapshot().iterator
    else new TrieMapIterator(0, this)

  private def cachedSize() = {
    val r = RDCSS_READ_ROOT()
    r.cachedSize(this)
  }

  override def size: Int =
    if (nonReadOnly) readOnlySnapshot().size
    else cachedSize()

  override def stringPrefix = "TrieMap"

}


object TrieMap extends MutableMapFactory[TrieMap] {
  val inodeupdater = AtomicReferenceFieldUpdater.newUpdater(classOf[INodeBase[_, _]], classOf[MainNode[_, _]], "mainnode")

  implicit def canBuildFrom[K, V]: CanBuildFrom[Coll, (K, V), TrieMap[K, V]] = new MapCanBuildFrom[K, V]

  def empty[K, V]: TrieMap[K, V] = new TrieMap[K, V]

  class MangledHashing[K] extends Hashing[K] {
    def hash(k: K)= scala.util.hashing.byteswap32(k.##)
  }

}


private[collection] class TrieMapIterator[K, V](var level: Int, private var ct: TrieMap[K, V], mustInit: Boolean = true) extends Iterator[(K, V)] {
  private val stack = new Array[Array[BasicNode]](7)
  private val stackpos = new Array[Int](7)
  private var depth = -1
  private var subiter: Iterator[(K, V)] = null
  private var current: KVNode[K, V] = null

  if (mustInit) initialize()

  def hasNext = (current ne null) || (subiter ne null)

  def next() = if (hasNext) {
    var r: (K, V) = null
    if (subiter ne null) {
      r = subiter.next()
      checkSubiter()
    } else {
      r = current.kvPair
      advance()
    }
    r
  } else Iterator.empty.next()

  private def readin(in: INode[K, V]) = in.gcasRead(ct) match {
    case cn: CNode[K, V] =>
      depth += 1
      stack(depth) = cn.array
      stackpos(depth) = -1
      advance()
    case tn: TNode[K, V] =>
      current = tn
    case ln: LNode[K, V] =>
      subiter = ln.listmap.iterator
      checkSubiter()
    case null =>
      current = null
  }

  private def checkSubiter() = if (!subiter.hasNext) {
    subiter = null
    advance()
  }

  private def initialize() {
    assert(ct.isReadOnly)

    val r = ct.RDCSS_READ_ROOT()
    readin(r)
  }

  def advance(): Unit = if (depth >= 0) {
    val npos = stackpos(depth) + 1
    if (npos < stack(depth).length) {
      stackpos(depth) = npos
      stack(depth)(npos) match {
        case sn: SNode[K, V] =>
          current = sn
        case in: INode[K, V] =>
          readin(in)
      }
    } else {
      depth -= 1
      advance()
    }
  } else current = null

  protected def newIterator(_lev: Int, _ct: TrieMap[K, V], _mustInit: Boolean) = new TrieMapIterator[K, V](_lev, _ct, _mustInit)

  protected def dupTo(it: TrieMapIterator[K, V]) = {
    it.level = this.level
    it.ct = this.ct
    it.depth = this.depth
    it.current = this.current

    // these need a deep copy
    Array.copy(this.stack, 0, it.stack, 0, 7)
    Array.copy(this.stackpos, 0, it.stackpos, 0, 7)

    // this one needs to be evaluated
    if (this.subiter == null) it.subiter = null
    else {
      val lst = this.subiter.toList
      this.subiter = lst.iterator
      it.subiter = lst.iterator
    }
  }

  /** Returns a sequence of iterators over subsets of this iterator.
   *  It's used to ease the implementation of splitters for a parallel version of the TrieMap.
   */
  protected def subdivide(): Seq[Iterator[(K, V)]] = if (subiter ne null) {
    // the case where an LNode is being iterated
    val it = newIterator(level + 1, ct, _mustInit = false)
    it.depth = -1
    it.subiter = this.subiter
    it.current = null
    this.subiter = null
    advance()
    this.level += 1
    Seq(it, this)
  } else if (depth == -1) {
    this.level += 1
    Seq(this)
  } else {
    var d = 0
    while (d <= depth) {
      val rem = stack(d).length - 1 - stackpos(d)
      if (rem > 0) {
        val (arr1, arr2) = stack(d).drop(stackpos(d) + 1).splitAt(rem / 2)
        stack(d) = arr1
        stackpos(d) = -1
        val it = newIterator(level + 1, ct, _mustInit = false)
        it.stack(0) = arr2
        it.stackpos(0) = -1
        it.depth = 0
        it.advance() // <-- fix it
        this.level += 1
        return Seq(this, it)
      }
      d += 1
    }
    this.level += 1
    Seq(this)
  }

  @deprecated("This method will be removed", "2.12.0")
  def printDebug() {
    println("ctrie iterator")
    println(stackpos.mkString(","))
    println("depth: " + depth)
    println("curr.: " + current)
    println(stack.mkString("\n"))
  }

}


private[concurrent] object RestartException extends ControlThrowable


/** Only used for ctrie serialization. */
@SerialVersionUID(0L - 7237891413820527142L)
private[concurrent] case object TrieMapSerializationEnd


private[concurrent] object Debug {
  import scala.collection._

  lazy val logbuffer = new java.util.concurrent.ConcurrentLinkedQueue[AnyRef]

  def log(s: AnyRef) = logbuffer.add(s)

  def flush() {
    for (s <- JavaConversions.asScalaIterator(logbuffer.iterator())) Console.out.println(s.toString)
    logbuffer.clear()
  }

  def clear() {
    logbuffer.clear()
  }

}