Class scala.collection.mutable.TreeMap

Companion object TreeMap

sealed class TreeMap[K, V] extends AbstractMap[K, V] with SortedMap[K, V] with SortedMapOps[K, V, TreeMap, TreeMap[K, V]] with StrictOptimizedIterableOps[(K, V), Iterable, TreeMap[K, V]] with StrictOptimizedMapOps[K, V, Map, TreeMap[K, V]] with StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]] with SortedMapFactoryDefaults[K, V, TreeMap, Iterable, Map] with DefaultSerializable

A mutable sorted map implemented using a mutable red-black tree as underlying data structure.

K

the type of the keys contained in this tree map.

V

the type of the values associated with the keys.

Source
TreeMap.scala
Since

2.12

Linear Supertypes
DefaultSerializable, java.io.Serializable, StrictOptimizedSortedMapOps[K, V, TreeMap, TreeMap[K, V]], StrictOptimizedMapOps[K, V, [_, _]Map[_, _], TreeMap[K, V]], StrictOptimizedIterableOps[(K, V), [_]Iterable[_], TreeMap[K, V]], SortedMap[K, V], SortedMapOps[K, V, [X, Y]TreeMap[X, Y], TreeMap[K, V]], collection.SortedMap[K, V], SortedMapFactoryDefaults[K, V, [x, y]TreeMap[x, y], [x]Iterable[x], [x, y]Map[x, y]], collection.SortedMapOps[K, V, [X, Y]TreeMap[X, Y], TreeMap[K, V]], SortedOps[K, TreeMap[K, V]], AbstractMap[K, V], Map[K, V], MapOps[K, V, Map, TreeMap[K, V]], Shrinkable[K], Builder[(K, V), TreeMap[K, V]], Growable[(K, V)], Clearable, Cloneable[TreeMap[K, V]], java.lang.Cloneable, Iterable[(K, V)], collection.AbstractMap[K, V], collection.Map[K, V], Equals, MapFactoryDefaults[K, V, [x, y]Map[x, y], [x]Iterable[x]], collection.MapOps[K, V, [_, _]Map[_, _], TreeMap[K, V]], PartialFunction[K, V], (K) => V, collection.AbstractIterable[(K, V)], collection.Iterable[(K, V)], IterableFactoryDefaults[(K, V), [x]Iterable[x]], IterableOps[(K, V), [_]Iterable[_], TreeMap[K, V]], IterableOnceOps[(K, V), [_]Iterable[_], TreeMap[K, V]], IterableOnce[(K, V)], AnyRef, Any

Instance Constructors

new TreeMap()(implicit ord: Ordering[K])

Creates an empty TreeMap.

ord

the implicit ordering used to compare objects of type K.

returns

an empty TreeMap.

Type Members

trait GenKeySet extends AnyRef

A generic trait that is reused by keyset implementations

Attributes
protected
Definition Classes
MapOps

class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

The implementation class of the set returned by keySet.

Attributes
protected
Definition Classes
MapOps

trait GenKeySortedSet extends GenKeySet

A generic trait that is reused by sorted keyset implementations

Attributes
protected
Definition Classes
SortedMapOps

class KeySortedSet extends SortedSet[K] with GenKeySet with GenKeySortedSet

The implementation class of the set returned by keySet

Attributes
protected
Definition Classes
SortedMapOps

Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

a hash value consistent with ==

Definition Classes
AnyRef → Any

final def ++[V2 >: V](xs: IterableOnce[(K, V2)]): TreeMap[K, V2]

Alias for concat

Definition Classes
SortedMapOpsMapOps
Annotations
@inline()

final def ++[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

Alias for concat

Definition Classes
IterableOps
Annotations
@inline()

final def ++=(xs: IterableOnce[(K, V)]): TreeMap.this.type

Alias for addAll

Definition Classes
Growable
Annotations
@inline()

final def +=(elem: (K, V)): TreeMap.this.type

Alias for addOne

Definition Classes
Growable
Annotations
@inline()

final def --=(xs: IterableOnce[K]): TreeMap.this.type

Alias for subtractAll

Definition Classes
Shrinkable
Annotations
@inline()

def -=(elem1: K, elem2: K, elems: K*): TreeMap.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

final def -=(elem: K): TreeMap.this.type

Alias for subtractOne

Definition Classes
Shrinkable
Annotations
@inline()

def ->[B](y: B): (TreeMap[K, V], B)

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

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

def addAll(xs: IterableOnce[(K, V)]): TreeMap.this.type

Adds all elements produced by an IterableOnce to this growable collection.

xs

the IterableOnce producing the elements to add.

returns

the growable collection itself.

Definition Classes
Growable

def addOne(elem: (K, V)): TreeMap.this.type

Adds a single element to this mutable tree map.

elem

the element to add.

returns

the mutable tree map itself

Definition Classes
TreeMapGrowable

def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

Example:

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

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

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

the starting string.

sep

the separator string.

end

the ending string.

returns

the string builder b to which elements were appended.

Definition Classes
MapOpsIterableOnceOps

final def addString(b: StringBuilder): StringBuilder

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

Example:

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

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

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

the string builder to which elements are appended.

returns

the string builder b to which elements were appended.

Definition Classes
IterableOnceOps
Annotations
@inline()

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

Appends all elements of this collection to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this collection, separated by the string sep.

Example:

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

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

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

the string builder to which elements are appended.

sep

the separator string.

returns

the string builder b to which elements were appended.

Definition Classes
IterableOnceOps
Annotations
@inline()

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

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

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.

C

the result type of the transformation function.

k

the transformation function

returns

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

Definition Classes
PartialFunction

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.

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

C

the result type of the transformation function.

k

the transformation function

returns

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

Definition Classes
PartialFunctionFunction1

def apply(key: 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.

key

the key

returns

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

Definition Classes
MapOpsFunction1
Annotations
@throws(scala.this.throws.<init>$default$1[NoSuchElementException])

def applyOrElse[K1 <: K, V1 >: V](x: K1, default: (K1) => V1): V1

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

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

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

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

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

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

x

the function argument

default

the fallback function

returns

the result of this function or fallback function application.

Definition Classes
MapOpsPartialFunction
Since

2.10

final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.

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

returns

the receiver object.

Definition Classes
Any
Exceptions thrown

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

def canEqual(that: Any): Boolean

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

that

the value being probed for possible equality

returns

true if this instance can possibly equal that, otherwise false

Definition Classes
MapEquals

def className: String

Defines the prefix of this object's toString representation.

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

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

returns

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

Attributes
protected[this]
Definition Classes
TreeMapIterable

def clear(): Unit

Clears the contents of this builder. After execution of this method the builder will contain no elements.

Definition Classes
TreeMapMapOpsBuilderClearable

def clone(): TreeMap[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
MapOpsCloneable → AnyRef
Note

not specified by SLS as a member of AnyRef

final def coll: TreeMap.this.type

returns

This collection as a C.

Attributes
protected
Definition Classes
IterableIterableOps

def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)])(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

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

pf

the partial function which filters and maps the map.

returns

a new 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
StrictOptimizedSortedMapOpsSortedMapOps

def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)]): Map[K2, V2]

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

K2

the key type of the returned map.

V2

the value type of the returned map.

pf

the partial function which filters and maps the map.

returns

a new 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
StrictOptimizedMapOpsMapOps

def collect[B](pf: PartialFunction[(K, V), B]): Iterable[B]

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

B

the element type of the returned iterable collection.

pf

the partial function which filters and maps the iterable collection.

returns

a new iterable collection resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

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

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

Note: may not terminate for infinite-sized collections.

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

pf

the partial function

returns

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

Definition Classes
IterableOnceOps
Example:

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

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

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

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.

R

the parameter type of the transformation function.

k

the transformation function

returns

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

Definition Classes
PartialFunction

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

def concat[V2 >: V](xs: IterableOnce[(K, V2)]): TreeMap[K, V2]

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

returns

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

Definition Classes
StrictOptimizedSortedMapOpsStrictOptimizedMapOpsSortedMapOpsMapOps

def concat[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

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

B

the element type of the returned collection.

suffix

the traversable to append.

returns

a new iterable collection which contains all elements of this iterable collection followed by all elements of suffix.

Definition Classes
IterableOps

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
TreeMapMapOps

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

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

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

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

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index of xs.

len

the maximal number of elements to copy.

returns

the number of elements written to the array

Definition Classes
IterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change. Note: will not terminate for infinite-sized collections.

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

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

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

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

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index of xs.

returns

the number of elements written to the array Note: will not terminate for infinite-sized collections.

Definition Classes
IterableOnceOps

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

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

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

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

B

the type of the elements of the array.

xs

the array to fill.

returns

the number of elements written to the array Note: will not terminate for infinite-sized collections.

Definition Classes
IterableOnceOps

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

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

B

the type of the elements of that

that

the other collection

p

the test predicate, which relates elements from both collections

returns

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

Definition Classes
IterableOnceOps

def count(p: ((K, V)) => Boolean): Int

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

p

the predicate used to test elements.

returns

the number of elements satisfying the predicate p.

Definition Classes
IterableOnceOps

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
MapOps
Annotations
@throws(scala.this.throws.<init>$default$1[NoSuchElementException])
Exceptions thrown

def drop(n: Int): TreeMap[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. If n is negative, don't drop any elements.

Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

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

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

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

n

the number of elements to drop from this iterable collection.

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. If n is negative, don't drop any elements.

Definition Classes
StrictOptimizedIterableOpsIterableOps

def dropWhile(p: ((K, V)) => Boolean): TreeMap[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.

p

The predicate used to test elements.

returns

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

Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def elementWise: ElementWiseExtractor[K, V]

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

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

def empty: TreeMap[K, V]

The empty iterable of the same type as this iterable

returns

an empty iterable of type C.

Definition Classes
SortedMapFactoryDefaultsIterableOps

def ensuring(cond: (TreeMap[K, V]) => Boolean, msg: => Any): TreeMap[K, V]

Implicit
This member is added by an implicit conversion from TreeMap[K, V] toEnsuring[TreeMap[K, V]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (TreeMap[K, V]) => Boolean): TreeMap[K, V]

Implicit
This member is added by an implicit conversion from TreeMap[K, V] toEnsuring[TreeMap[K, V]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: => Any): TreeMap[K, V]

Implicit
This member is added by an implicit conversion from TreeMap[K, V] toEnsuring[TreeMap[K, V]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): TreeMap[K, V]

Implicit
This member is added by an implicit conversion from TreeMap[K, V] toEnsuring[TreeMap[K, V]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

final def eq(arg0: AnyRef): Boolean

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

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

    It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. null.eq(null) returns true.

When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

returns

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

Definition Classes
AnyRef

def equals(o: Any): Boolean

The universal equality method defined in AnyRef.

Definition Classes
MapEquals → AnyRef → Any

def exists(p: ((K, V)) => Boolean): Boolean

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

Note: may not terminate for infinite-sized collections.

p

the predicate used to test elements.

returns

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

Definition Classes
IterableOnceOps

def filter(pred: ((K, V)) => Boolean): TreeMap[K, V]

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

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps

def filterImpl(pred: ((K, V)) => Boolean, isFlipped: Boolean): TreeMap[K, V]

Attributes
protected[scala.collection]
Definition Classes
StrictOptimizedIterableOps

def filterInPlace(p: (K, V) => Boolean): TreeMap.this.type

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

p

The test predicate

Definition Classes
MapOps

def filterNot(pred: ((K, V)) => Boolean): TreeMap[K, V]

Selects all elements of this iterable collection which do not satisfy a predicate.

pred

the predicate used to test elements.

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps

def finalize(): Unit

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

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

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

not specified by SLS as a member of AnyRef

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

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

Definition Classes
IterableOnceOps

def firstKey: K

Returns the first key of the collection.

Definition Classes
SortedMapOpsSortedOps

def flatMap[K2, V2](f: ((K, V)) => IterableOnce[(K2, V2)])(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

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

f

the function to apply to each element.

returns

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

Definition Classes
StrictOptimizedSortedMapOpsSortedMapOps

def flatMap[K2, V2](f: ((K, V)) => IterableOnce[(K2, V2)]): Map[K2, V2]

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

f

the function to apply to each element.

returns

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

Definition Classes
StrictOptimizedMapOpsMapOps

def flatMap[B](f: ((K, V)) => IterableOnce[B]): Iterable[B]

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

For example:

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

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

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

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

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

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

the element type of the returned collection.

f

the function to apply to each element.

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def flatten[B](implicit toIterableOnce: ((K, V)) => IterableOnce[B]): Iterable[B]

Converts this iterable collection of traversable collections into a iterable collection formed by the elements of these traversable collections.

The resulting collection's type will be guided by the type of iterable collection. 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 iterable collection resulting from concatenating all element iterable collections.

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

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

Folds the elements of this collection using the specified associative binary operator. The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

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 collection is empty.

Definition Classes
IterableOnceOps

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

Applies a binary operator to a start value and all elements of this collection, 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 collection, going left to right with the start value z on the left:

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

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

Definition Classes
IterableOnceOps

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

Applies a binary operator to all elements of this 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 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 collection. Returns z if this collection is empty.

Definition Classes
IterableOnceOps

def forall(p: ((K, V)) => Boolean): Boolean

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

Note: may not terminate for infinite-sized collections.

p

the predicate used to test elements.

returns

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

Definition Classes
IterableOnceOps

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

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

Definition Classes
TreeMapIterableOnceOps

def foreachEntry[U](f: (K, V) => U): Unit

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

Definition Classes
TreeMapMapOps

def formatted(fmtstr: String): String

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

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

def fromSpecific(coll: IterableOnce[(K, V)]): TreeMap[K, V]

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

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

Attributes
protected
Definition Classes
SortedMapFactoryDefaultsIterableOps
Note

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

,

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

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

Optionally returns the value associated with a key.

key

the key value

returns

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

Definition Classes
TreeMapMapOps

final def getClass(): Class[_ <: AnyRef]

Returns the runtime class representation of the object.

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def getOrElse[V1 >: V](key: K, default: => V1): V1

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

V1

the result type of the default computation.

key

the key.

default

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

returns

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

Definition Classes
MapOps

def getOrElseUpdate(key: K, op: => V): V

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

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

Concurrent map implementations may evaluate the expression op multiple times, or may evaluate op without inserting the result.

key

the key to test

op

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

returns

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

Definition Classes
MapOps

def groupBy[K](f: ((K, V)) => K): immutable.Map[K, TreeMap[K, V]]

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

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

K

the type of keys returned by the discriminator function.

f

the discriminator function.

returns

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

Definition Classes
IterableOps

def groupMap[K, B](key: ((K, V)) => K)(f: ((K, V)) => B): immutable.Map[K, Iterable[B]]

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

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

case class User(name: String, age: Int)

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

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

K

the type of keys returned by the discriminator function

B

the type of values returned by the transformation function

key

the discriminator function

f

the element transformation function

Definition Classes
IterableOps

def groupMapReduce[K, B](key: ((K, V)) => K)(f: ((K, V)) => B)(reduce: (B, B) => B): immutable.Map[K, B]

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

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

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

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

Definition Classes
IterableOps

def grouped(size: Int): Iterator[TreeMap[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
IterableOps
See also

scala.collection.Iterator, method grouped

def hashCode(): Int

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

returns

the hash code value for this object.

Definition Classes
Map → AnyRef → Any

Selects the first element of this mutable tree map.

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

returns

the first element of this mutable tree map.

Definition Classes
TreeMapIterableOps
Exceptions thrown

NoSuchElementException if the mutable tree map is empty.

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

Definition Classes
IterableOps

def init: TreeMap[K, V]

The initial part of the collection without its last element.

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

Definition Classes
IterableOps

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

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

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

returns

an iterator over all the inits of this iterable collection

Definition Classes
IterableOps
Example:

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

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
MapOpsPartialFunction

def isEmpty: Boolean

Tests whether the mutable tree map is empty.

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

returns

true if the mutable tree map contains no elements, false otherwise.

Definition Classes
TreeMapIterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

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

returns

true if it is repeatedly traversable, false otherwise.

Definition Classes
IterableOpsIterableOnceOps

def iterableFactory: IterableFactory[Iterable]

The companion object of this iterable collection, providing various factory methods.

Definition Classes
IterableIterableIterableOps
Note

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

def iterator: Iterator[(K, V)]

Iterator can be used only once

Definition Classes
TreeMapIterableOnce

def iteratorFrom(start: K): Iterator[(K, V)]

Creates an iterator over all the key/value pairs contained in this map having a key greater than or equal to start according to the ordering of this map. x.iteratorFrom(y) is equivalent to but often more efficient than x.from(y).iterator.

start

The lower bound (inclusive) on the keys to be returned

Definition Classes
TreeMapSortedMapOps

def keySet: collection.SortedSet[K]

Collects all keys of this map in a set.

returns

a set containing all keys of this map.

Definition Classes
SortedMapOpsMapOps

def keyStepper[S <: Stepper[_]](implicit shape: StepperShape[K, S]): S with EfficientSplit

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

Definition Classes
TreeMapMapOps

def keys: collection.Iterable[K]

Collects all keys of this map in an iterable collection.

returns

the keys of this map as an iterable.

Definition Classes
MapOps

def keysIterator: Iterator[K]

Creates an iterator for all keys.

returns

an iterator over all keys.

Definition Classes
TreeMapMapOps

def keysIteratorFrom(start: K): Iterator[K]

Creates an iterator over all the keys(or elements) contained in this collection greater than or equal to start according to the ordering of this collection. x.keysIteratorFrom(y) is equivalent to but often more efficient than x.from(y).keysIterator.

start

The lower bound (inclusive) on the keys to be returned

Definition Classes
TreeMapSortedMapOps

def knownSize: Int

returns

The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise. The default implementation always returns -1.

Definition Classes
TreeMapMapOpsGrowableIterableOnce

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 mutable tree map.

Definition Classes
TreeMapIterableOps
Exceptions thrown

NoSuchElementException If the mutable tree map is empty.

def lastKey: K

Returns the last key of the collection.

Definition Classes
SortedMapOpsSortedOps

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

Definition Classes
IterableOps

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[(K, V), B, TreeMap.this.type]

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

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

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

the type of the second element in each eventual pair

that

the iterable providing the second element of each eventual pair

returns

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

Definition Classes
Iterable

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

def map[K2, V2](f: ((K, V)) => (K2, V2))(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

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

f

the function to apply to each element.

returns

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

Definition Classes
StrictOptimizedSortedMapOpsSortedMapOps

def map[K2, V2](f: ((K, V)) => (K2, V2)): Map[K2, V2]

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

f

the function to apply to each element.

returns

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

Definition Classes
StrictOptimizedMapOpsMapOps

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

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

B

the element type of the returned iterable collection.

f

the function to apply to each element.

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def mapFactory: MapFactory[Map]

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

Definition Classes
MapMapMapOps
Note

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

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

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

Attributes
protected
Definition Classes
MapOps
Annotations
@inline()

def mapResult[NewTo](f: (TreeMap[K, V]) => NewTo): Builder[(K, V), NewTo]

A builder resulting from this builder my mapping the result using f.

Definition Classes
Builder

def mapValuesInPlace(f: (K, V) => V): TreeMap.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
MapOps

def max[B >: (K, V)](implicit ord: math.Ordering[B]): (K, V)

Finds the largest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

the largest element of this collection with respect to the ordering ord.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this collection is empty.

def maxBefore(key: K): Option[(K, V)]

Find the element with largest key less than a given key.

key

The given key.

returns

None if there is no such node.

Definition Classes
TreeMapSortedMapOps

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

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.

cmp

An ordering to be used for comparing elements.

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this collection is empty.

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

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.

cmp

An ordering to be used for comparing elements.

returns

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

Definition Classes
IterableOnceOps

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

Finds the largest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

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

Definition Classes
IterableOnceOps

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

Finds the smallest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

the smallest element of this collection with respect to the ordering ord.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this collection is empty.

def minAfter(key: K): Option[(K, V)]

Find the element with smallest key larger than or equal to a given key.

key

The given key.

returns

None if there is no such node.

Definition Classes
TreeMapSortedMapOps

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

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.

cmp

An ordering to be used for comparing elements.

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this collection is empty.

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

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.

cmp

An ordering to be used for comparing elements.

returns

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

Definition Classes
IterableOnceOps

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

Finds the smallest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

Delegates to addString, which can be overridden.

sep

the separator string.

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()
Example:

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

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

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

Delegates to addString, which can be overridden.

start

the starting string.

sep

the separator string.

end

the ending string.

returns

a string representation of this collection. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this collection are separated by the string sep.

Definition Classes
IterableOnceOps
Example:

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

final def ne(arg0: AnyRef): Boolean

Equivalent to !(this eq that).

returns

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

Definition Classes
AnyRef

def newSpecificBuilder: Builder[(K, V), TreeMap[K, V]]

returns

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

Attributes
protected
Definition Classes
SortedMapFactoryDefaultsIterableOps
Note

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

,

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

def nonEmpty: Boolean

Tests whether the collection is not empty.

returns

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

Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

final def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

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

implicit val ordering: Ordering[K]

Definition Classes
TreeMapSortedOps

def partition(p: ((K, V)) => Boolean): (TreeMap[K, V], TreeMap[K, V])

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not. Interesting because it splits a collection in two.

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

Definition Classes
StrictOptimizedIterableOpsIterableOps

def partitionMap[A1, A2](f: ((K, V)) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

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

Example:

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

the element type of the first resulting collection

A2

the element type of the second resulting collection

f

the 'split function' mapping the elements of this iterable collection to an scala.util.Either

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOps

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

Multiplies up the elements of this collection.

B

the result type of the * operator.

num

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

returns

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

Definition Classes
IterableOnceOps

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
MapOps

def range(from: K, until: K): TreeMap[K, V]

Creates a ranged projection of this collection with both a lower-bound and an upper-bound.

from

The lower-bound (inclusive) of the ranged projection.

until

The upper-bound (exclusive) of the ranged projection.

Definition Classes
SortedOps

def rangeFrom(from: K): TreeMap[K, V]

Creates a ranged projection of this collection with no upper-bound.

from

The lower-bound (inclusive) of the ranged projection.

Definition Classes
SortedOps

def rangeImpl(from: Option[K], until: Option[K]): TreeMap[K, V]

Creates a ranged projection of this map. Any mutations in the ranged projection will update the original map and vice versa.

Only entries with keys between this projection's key range will ever appear as elements of this map, independently of whether the entries are added through the original map or through this view. That means that if one inserts a key-value in a view whose key is outside the view's bounds, calls to get or contains will _not_ consider the newly added entry. Mutations are always reflected in the original map, though.

from

the lower bound (inclusive) of this projection wrapped in a Some, or None if there is no lower bound.

until

the upper bound (exclusive) of this projection wrapped in a Some, or None if there is no upper bound.

Definition Classes
TreeMapSortedOps

def rangeTo(to: K): TreeMap[K, V]

Create a range projection of this collection with no lower-bound.

to

The upper-bound (inclusive) of the ranged projection.

Definition Classes
SortedMapOpsSortedOps

def rangeUntil(until: K): TreeMap[K, V]

Creates a ranged projection of this collection with no lower-bound.

until

The upper-bound (exclusive) of the ranged projection.

Definition Classes
SortedOps

def reduce[B >: (K, V)](op: (B, B) => B): B

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

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

B

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 collection is nonempty.

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this collection is empty.

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

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

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this collection is empty.

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

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

Definition Classes
IterableOnceOps

def reduceOption[B >: (K, V)](op: (B, B) => B): Option[B]

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

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

B

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
IterableOnceOps

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

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

Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this collection is empty.

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

Optionally applies a binary operator to all elements of this 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

an option value containing the result of reduceRight(op) if this collection is nonempty, None otherwise.

Definition Classes
IterableOnceOps

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

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

key

the key to be removed

returns

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

Definition Classes
MapOps

def result(): TreeMap[K, V]

Result collection consisting of all elements appended so far.

Definition Classes
MapOpsBuilder

def reversed: collection.Iterable[(K, V)]

Attributes
protected
Definition Classes
IterableOnceOps

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.

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

Computes a prefix scan of the elements of the collection.

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

B

element type of the resulting collection

z

neutral element for the operator op

op

the associative operator for the scan

returns

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

Definition Classes
IterableOps

def scanLeft[B](z: B)(op: (B, (K, V)) => B): Iterable[B]

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

Note: will not terminate for infinite-sized collections.

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

B

the type of the elements in the resulting collection

z

the initial value

op

the binary operator applied to the intermediate result and the element

returns

collection with intermediate results

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def scanRight[B](z: B)(op: ((K, V), B) => B): Iterable[B]

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

Note: will not terminate for infinite-sized collections.

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

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

Example:

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

the type of the elements in the resulting collection

z

the initial value

op

the binary operator applied to the intermediate result and the element

returns

collection with intermediate results

Definition Classes
IterableOps

def size: Int

The size of this mutable tree map.

Note: will not terminate for infinite-sized collections.

returns

the number of elements in this mutable tree map.

Definition Classes
TreeMapIterableOnceOps

def sizeCompare(that: collection.Iterable[_]): Int

Compares the size of this iterable collection to the size of another Iterable.

that

the Iterable whose size is compared with this iterable collection's size.

returns

A value x where

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

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

Definition Classes
IterableOps

def sizeCompare(otherSize: Int): Int

Compares the size of this iterable collection to a test value.

otherSize

the test value that gets compared with the size.

returns

A value x where

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

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

Definition Classes
IterableOps
See also

sizeIs

final def sizeHint(coll: IterableOnce[_], delta: Int = 0): Unit

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

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

final def sizeHintBounded(size: Int, boundingColl: collection.Iterable[_]): 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

final def sizeIs: SizeCompareOps

Returns a value class containing operations for comparing the size of this iterable collection to a test value.

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

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Definition Classes
IterableOps
Annotations
@inline()

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

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

from <= indexOf(x) < until

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

from

the lowest index to include from this iterable collection.

until

the lowest index to EXCLUDE from this iterable collection.

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
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def sliding(size: Int, step: Int): Iterator[TreeMap[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 element (which may be the only element) will be truncated if there are fewer than size elements remaining to be grouped.

Definition Classes
IterableOps
See also

scala.collection.Iterator, method sliding

def sliding(size: Int): Iterator[TreeMap[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.) The "sliding window" step is set to one.

size

the number of elements per group

returns

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

Definition Classes
IterableOps
See also

scala.collection.Iterator, method sliding

def sortedMapFactory: TreeMap

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

Definition Classes
TreeMapSortedMapSortedMapSortedMapOps
Note

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

final def sortedMapFromIterable[K2, V2](it: collection.Iterable[(K2, V2)])(implicit ordering: Ordering[K2]): TreeMap[K2, V2]

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

Attributes
protected
Definition Classes
SortedMapOps
Annotations
@inline()

def span(p: ((K, V)) => Boolean): (TreeMap[K, V], TreeMap[K, V])

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

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

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

p

the test predicate

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.

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

Splits this iterable collection into a prefix/suffix pair at a given position.

Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

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

n

the position at which to split.

returns

a pair of iterable collections consisting of the first n elements of this iterable collection, and the other elements.

Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.

def stepper[S <: Stepper[_]](implicit shape: StepperShape[(K, V), S]): S with EfficientSplit

Returns a Stepper for the elements of this collection.

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

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

    For collections of Int, Short, Byte or Char, an IntStepper is returnedFor collections of Double or Float, a DoubleStepper is returnedFor collections of Long a LongStepper is returnedFor any other element type, an AnyStepper is returned

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

Definition Classes
TreeMapIterableOnce

final def strictOptimizedCollect[B, C2](b: Builder[B, C2], pf: PartialFunction[(K, V), B]): C2

B

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

C2

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

b

Builder to use to build the resulting collection

pf

Element transformation partial function

returns

The resulting collection

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedConcat[B >: (K, V), C2](that: IterableOnce[B], b: Builder[B, C2]): C2

B

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

C2

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

that

Elements to concatenate to this collection

b

Builder to use to build the resulting collection

returns

The resulting collection

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedFlatMap[B, C2](b: Builder[B, C2], f: ((K, V)) => IterableOnce[B]): C2

B

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

C2

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

b

Builder to use to build the resulting collection

f

Element transformation function

returns

The resulting collection

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedFlatten[B, C2](b: Builder[B, C2])(implicit toIterableOnce: ((K, V)) => IterableOnce[B]): C2

B

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

C2

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

b

Builder to use to build the resulting collection

toIterableOnce

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

returns

The resulting collection

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedMap[B, C2](b: Builder[B, C2], f: ((K, V)) => B): C2

B

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

C2

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

b

Builder to use to build the resulting collection

f

Element transformation function

returns

The resulting collection

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

final def strictOptimizedZip[B, C2](that: IterableOnce[B], b: Builder[((K, V), B), C2]): C2

B

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

C2

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

that

Collection to zip with this collection

b

Builder to use to build the resulting collection

returns

The resulting collection

Attributes
protected[this]
Definition Classes
StrictOptimizedIterableOps
Annotations
@inline()

def stringPrefix: String

Attributes
protected[this]
Definition Classes
SortedMapMapIterable
Annotations
@deprecatedOverriding("Compatibility override", "2.13.0")

def subtractAll(xs: IterableOnce[K]): TreeMap.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

def subtractOne(elem: K): TreeMap.this.type

Removes a single element from this mutable tree map.

elem

the element to remove.

returns

the mutable tree map itself

Definition Classes
TreeMapShrinkable

def sum[B >: (K, V)](implicit num: math.Numeric[B]): B

Sums up the elements of this collection.

B

the result type of the + operator.

num

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

returns

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

Definition Classes
IterableOnceOps

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def tail: TreeMap[K, V]

The rest of the collection without its first element.

Definition Classes
IterableOps

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

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

returns

an iterator over all the tails of this iterable collection

Definition Classes
IterableOps
Example:

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

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

Selects the first n elements.

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

n

the number of elements to take from this 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. If n is negative, returns an empty iterable collection.

Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

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

A collection containing the last n elements of this collection.

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

n

the number of elements to take from this iterable collection.

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. If n is negative, returns an empty iterable collection.

Definition Classes
StrictOptimizedIterableOpsIterableOps

def takeWhile(p: ((K, V)) => Boolean): TreeMap[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.

p

The predicate used to test elements.

returns

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

Definition Classes
IterableOpsIterableOnceOps

def tapEach[U](f: ((K, V)) => U): TreeMap[K, V]

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

U

the return type of f

f

a function to apply to each element in this iterable collection

returns

The same logical collection as this

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps

def to[C1](factory: Factory[(K, V), C1]): C1

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

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // for xs: Iterable[Int]

Definition Classes
IterableOnceOps

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

Convert collection to array.

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

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

Definition Classes
IterableOnceOps

final def toIterable: TreeMap.this.type

returns

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

Definition Classes
IterableIterableOps

def toList: immutable.List[(K, V)]

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toSeq: immutable.Seq[(K, V)]

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toString(): String

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

returns

a String representation of the object.

Definition Classes
MapFunction1Iterable → AnyRef → Any

def toVector: immutable.Vector[(K, V)]

Definition Classes
IterableOnceOps

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

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

The resulting collection's type will be guided by the static type of iterable 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))

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

B

the type of the elements of each iterable collection.

asIterable

an implicit conversion which asserts that the element type of this iterable collection is an Iterable.

returns

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

Definition Classes
IterableOps
Exceptions thrown

IllegalArgumentException if all collections in this iterable collection are not of the same size.

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

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

Definition Classes
PartialFunction

def unlift: PartialFunction[K, B]

Converts an optional function to a partial function.

Implicit
This member is added by an implicit conversion from TreeMap[K, V] toUnliftOps[K, B] performed by method UnliftOps in scala.Function1.This conversion will take place only if V is a subclass of Option[B] (V <: Option[B]).
Definition Classes
UnliftOps
Example:

    Unlike Function.unlift, this UnliftOps.unlift method can be used in extractors.

    val of: Int => Option[String] = { i =>
      if (i == 2) {
        Some("matched by an optional function")
      } else {
        None
      }
    }
    
    util.Random.nextInt(4) match {
      case of.unlift(m) => // Convert an optional function to a pattern
        println(m)
      case _ =>
        println("Not matched")
    }

def unsorted: Map[K, V]

Definition Classes
SortedMapSortedMapOpsSortedMapSortedMapOps

def unzip[A1, A2](implicit asPair: ((K, V)) => (A1, A2)): (Iterable[A1], Iterable[A2])

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

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(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 iterable collection is a pair.

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOps

def unzip3[A1, A2, A3](implicit asTriple: ((K, V)) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

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

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(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 iterable collection is a triple.

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOps

def update(key: K, value: 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.

key

The key to update

value

The new value

Definition Classes
MapOps

def updateWith(key: K)(remappingFunction: (Option[V]) => Option[V]): Option[V]

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

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

key

the key value

remappingFunction

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

returns

the new value associated with the specified key

Definition Classes
MapOps
Since

2.13.0

def valueStepper[S <: Stepper[_]](implicit shape: StepperShape[V, S]): S with EfficientSplit

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

Definition Classes
TreeMapMapOps

def values: collection.Iterable[V]

Collects all values of this map in an iterable collection.

returns

the values of this map as an iterable.

Definition Classes
MapOps

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
TreeMapMapOps

def valuesIteratorFrom(start: K): Iterator[V]

Creates an iterator over all the values contained in this map that are associated with a key greater than or equal to start according to the ordering of this map. x.valuesIteratorFrom(y) is equivalent to but often more efficient than x.from(y).valuesIterator.

start

The lower bound (inclusive) on the keys to be returned

Definition Classes
TreeMapSortedMapOps

def view: MapView[K, V]

A view over the elements of this collection.

Definition Classes
MapOpsIterableOps

final def wait(): Unit

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

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

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

final def wait(arg0: Long): Unit

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

def withDefault(d: (K) => V): SortedMap[K, V]

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

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

d

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

returns

a wrapper of the map with a default value

Definition Classes
SortedMapMap

def withDefaultValue(d: V): SortedMap[K, V]

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

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

d

default value used for non-present keys

returns

a wrapper of the map with a default value

Definition Classes
SortedMapMap

def withFilter(p: ((K, V)) => Boolean): SortedMapOps.WithFilter[K, V, [x]Iterable[x], [x, y]Map[x, y], [x, y]TreeMap[x, y]]

Creates a non-strict filter of this map.

Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

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

p

the predicate used to test elements.

returns

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

Definition Classes
SortedMapFactoryDefaultsIterableOps

def writeReplace(): AnyRef

Attributes
protected[this]
Definition Classes
DefaultSerializable

def zip[B](that: IterableOnce[B]): Iterable[((K, V), B)]

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

B

the type of the second half of the returned pairs

that

The iterable providing the second half of each result pair

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOps

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

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

that

the iterable providing the second half of each result pair

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableOps

def zipWithIndex: Iterable[((K, V), Int)]

Zips this iterable collection with its indices.

returns

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

Definition Classes
StrictOptimizedIterableOpsIterableOpsIterableOnceOps
Example:

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

Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

Shadowed Implicit Value Members

def +(other: String): String

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

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/mutable/TreeMap.html