Scaladoc for scala.collection.SortedMap

Inherits

SortedMapLike
Sorted
Map
MapLike
Subtractable
PartialFunction
Function1
Iterable
IterableLike
Equals
Traversable
GenericTraversableTemplate
TraversableLike
HasNewBuilder
AnyRef
Any

Type Members

class WithFilter extends AnyRef

A class supporting filtered operations

Value Members

def +[B1 >: B](elem1: (A, B1), elem2: (A, B1), elems: (A, B1)*): SortedMap[A, B1]

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

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

B1
the type of the added values
elem1
the first element to add.
elem2
the second element to add.
elems
the remaining elements to add.
returns
a new map with the given bindings added to this map

definition classes: SortedMapLike ⇐ MapLike
def +[B1 >: B](kv: (A, B1)): SortedMap[A, B1]

Add a key/value pair to this map

Add a key/value pair to this map.

B1
the type of the value in the key/value pair.
kv
the key/value pair
returns
A new map with the new binding added to this map

attributes: abstract

definition classes: SortedMapLike ⇐ MapLike
def ++[B1 >: B](iter: Iterator[(A, B1)]): Map[A, B1]

Adds all key/value pairs produced by an iterator to this map, returning a new map

Adds all key/value pairs produced by an iterator to this map, returning a new map.

B1
the type of the added values
iter
the iterator producing key/value pairs
returns
a new map with the given bindings added to this map

definition classes: MapLike
def ++[B1 >: B](kvs: Traversable[(A, B1)]): Map[A, B1]

Adds all key/value pairs in a traversable collection to this map, returning a new map

Adds all key/value pairs in a traversable collection to this map, returning a new map.

B1
the type of the added values
kvs
the collection containing the added key/value pairs
returns
a new map with the given bindings added to this map

definition classes: MapLike
def ++[B >: (A, B), That](that: Iterator[B])(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

Concatenates this map with the elements of an iterator

Concatenates this map with the elements of an iterator.

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

definition classes: TraversableLike
def ++[B >: (A, B), That](that: Traversable[B])(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

Concatenates this map with the elements of a traversable collection

Concatenates this map with the elements of a traversable collection.

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

definition classes: TraversableLike
def -(elem1: A, elem2: A, elems: A*): SortedMap[A, B]

Creates a new map from this map with some elements removed

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

elem1
the first element to remove.
elem2
the second element to remove.
elems
the remaining elements to remove.
returns
a new map that contains all elements of the current map except one less occurrence of each of the given elements.

definition classes: Subtractable
def -(key: A): SortedMap[A, B]

Removes a key from this map, returning a new map

Removes a key from this map, returning a new map.

key
the key to be removed
returns
a new map without a binding for key

attributes: abstract

definition classes: MapLike ⇐ Subtractable
def --(iter: Iterator[A]): SortedMap[A, B]

Creates a new map from this map by removing all elements produced by an iterator

Creates a new map from this map by removing all elements produced by an iterator.

iter
the iterator producing the removed elements.
returns
a new map that contains all elements of the current map except one less occurrence of each of the elements produced by iter.

definition classes: Subtractable
def --(elems: Traversable[A]): SortedMap[A, B]

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

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

elems
the collection containing the removed elements.
returns
a new map that contains all elements of the current map except one less occurrence of each of the elements of elems.

definition classes: Subtractable
def /:[B](z: B)(op: (B, (A, B)) ⇒ B): B

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

Applies a binary operator to a start value and all elements of this map, going left to right.
Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this map$, going left to right with the start value z on the left: {{{ op(...op(op(z, x₁), x₂), ..., x_n) }}} where x,,1,,, ..., x,,n,, are the elements of this map.

definition classes: TraversableLike
def :\[B](z: B)(op: ((A, B), B) ⇒ B): B

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

Applies a binary operator to all elements of this map and a start value, going right to left.
Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

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 map$, going right to left with the start value z on the right: {{{ op(x₁, op(x₂, ... op(x_n, z)...)) }}} where x,,1,,, ..., x,,n,, are the elements of this map.

definition classes: TraversableLike
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

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

b
the builder to which strings are appended.
start
the starting string.
sep
the separator string.
end
the ending string.
returns
the string builder b to which elements were appended.

definition classes: MapLike ⇐ TraversableLike
def addString(b: StringBuilder): StringBuilder

Appends all elements of this map to a string builder

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

b
the string builder to which elements are appended.
returns
the string builder b to which elements were appended.

definition classes: TraversableLike
def addString(b: StringBuilder, sep: String): StringBuilder

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

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

b
the string builder to which elements are appended.
sep
the separator string.
returns
the string builder b to which elements were appended.

definition classes: TraversableLike
def andThen[C](k: (B) ⇒ C): PartialFunction[A, C]

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

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

C
the result type of the transformation function.
k
the transformation function
returns
a partial function with the same domain as this partial function, which maps arguments x to k(this(x)).

definition classes: PartialFunction ⇐ Function1
def apply(key: A): B

Retrieves the value which is associated with the given key

Retrieves the value which is associated with the given key. This method invokes the default method of the map if there is no mapping from the given key to a value. Unless overridden, the default method throws a NoSuchElementException.

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

definition classes: MapLike ⇐ Function1
def canEqual(that: Any): Boolean

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

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

that
The object with which this map should be compared
returns
true, if this map can possibly equal that, false otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.

definition classes: IterableLike ⇐ Equals
def companion: GenericCompanion[Iterable[A][A]]

The factory companion object that builds instances of class Map

The factory companion object that builds instances of class Map.

definition classes: Iterable ⇐ Traversable ⇐ GenericTraversableTemplate
def compare(k0: A, k1: A): Int

Comparison function that orders keys

Comparison function that orders keys.

definition classes: Sorted
def compose[A](g: (A) ⇒ A): (A) ⇒ B

(f compose g)(x) == f(g(x))

(f compose g)(x) == f(g(x))

definition classes: Function1
def contains(key: A): Boolean

Tests whether this map contains a binding for a key

Tests whether this map contains a binding for a key.

key
the key
returns
true if there is a binding for key in this map, false otherwise.

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

Copies elements of this map to an array

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

B
the type of the elements of the array.
xs
the array to fill.
start
the starting index.
len
the maximal number of elements to copy.

definition classes: IterableLike ⇐ TraversableLike
def copyToArray[B >: (A, B)](xs: Array[B]): Unit

Copies elements of this map to an array

Copies elements of this map to an array. Fills the given array xs with all elements of this map, starting at position 0. Copying will stop once either the end of the current map is reached, or the end of the array is reached.

B
the type of the elements of the array.
xs
the array to fill.

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

Copies elements of this map to an array

Copies elements of this map to an array. Fills the given array xs with all elements of this map, starting at position start. Copying will stop once either the end of the current map is reached, or the end of the array is reached.

B
the type of the elements of the array.
xs
the array to fill.
start
the starting index.

definition classes: TraversableLike
def copyToBuffer[B >: (A, B)](dest: Buffer[B]): Unit

Copies all elements of this map to a buffer

Copies all elements of this map to a buffer.

dest
The buffer to which elements are copied.

definition classes: TraversableLike
def count(p: ((A, B)) ⇒ Boolean): Int

Counts the number of elements in the map which satisfy a predicate

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

p
the predicate used to test elements.
returns
the number of elements satisfying the predicate p.

definition classes: TraversableLike
def default(key: A): B

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

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

key
the given key value for which a binding is missing.

definition classes: MapLike
def drop(n: Int): SortedMap[A, B]

Selects all elements except first n ones

Selects all elements except first n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.

n
the number of elements to drop from this map.
returns
a map consisting of all elements of this map except the first n ones, or else the empty map, if this map has less than n elements.

definition classes: TraversableLike
def dropRight(n: Int): SortedMap[A, B]

Selects all elements except first n ones

Selects all elements except first n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.

n
The number of elements to take
returns
a map consisting of all elements of this map except the first n ones, or else the empty map, if this map has less than n elements.

definition classes: IterableLike
def dropWhile(p: ((A, B)) ⇒ Boolean): SortedMap[A, B]

Drops longest prefix of elements that satisfy a predicate

Drops longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.

p
The predicate used to test elements.
returns
the longest suffix of this map whose first element does not satisfy the predicate p.

definition classes: TraversableLike
def elements: Iterator[(A, B)]
def empty: SortedMap[A, B]

Needs to be overridden in subclasses

Needs to be overridden in subclasses.
def equals(that: Any): Boolean

Compares two maps structurally; i

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

that
the other map
returns
true if both maps contain exactly the same mappings, false otherwise.

definition classes: MapLike ⇐ Equals ⇐ AnyRef ⇐ Any
def exists(p: ((A, B)) ⇒ Boolean): Boolean

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

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

p
the predicate used to test elements.
returns
true if the given predicate p holds for some of the elements of this map, otherwise false.

definition classes: IterableLike ⇐ TraversableLike
def filter(p: ((A, B)) ⇒ Boolean): SortedMap[A, B]

Selects all elements of this map which satisfy a predicate

Selects all elements of this map which satisfy a predicate.

p
the predicate used to test elements.
returns
a new map consisting of all elements of this map that satisfy the given predicate p. The order of the elements is preserved.

definition classes: TraversableLike
def filterKeys(p: (A) ⇒ Boolean): DefaultMap[A, B]

Filters this map by retaining only keys satisfying a predicate

Filters this map by retaining only keys satisfying a predicate.

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

definition classes: MapLike
def filterNot(p: ((A, B)) ⇒ Boolean): SortedMap[A, B]

Selects all elements of this map which do not satisfy a predicate

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

p
the predicate used to test elements.
returns
a new map consisting of all elements of this map that do not satisfy the given predicate p. The order of the elements is preserved.

definition classes: TraversableLike
def find(p: ((A, B)) ⇒ Boolean): Option[(A, B)]

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

Finds the first element of the map satisfying a predicate, if any.
Note: might return different results for different runs, unless the underlying collection type is ordered.

p
the predicate used to test elements.
returns
an option value containing the first element in the map that satisfies p, or None if none exists.

definition classes: IterableLike ⇐ TraversableLike
def first: (A, B)
def firstKey: A

Returns the first key of the collection

Returns the first key of the collection.

definition classes: SortedMapLike ⇐ Sorted
def firstOption: Option[(A, B)]

None if iterable is empty

None if iterable is empty.

definition classes: IterableLike
def flatMap[B, That](f: ((A, B)) ⇒ Traversable[B])(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

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

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

B
the element type of the returned collection.
That
the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.
f
the function to apply to each element.
bf
an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.
returns
a new collection of type That resulting from applying the given collection-valued function f to each element of this map and concatenating the results.

definition classes: TraversableLike
def flatten[B](asTraversable: ((A, B)) ⇒ Traversable[B]): Iterable[B]

Converts this map of traversable collections into a map in which all element collections are concatenated

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

B
the type of the elements of each traversable collection.
asTraversable
an implicit conversion which asserts that the element type of this map is a Traversable.
returns
a new map resulting from concatenating all element maps.

definition classes: GenericTraversableTemplate
def foldLeft[B](z: B)(op: (B, (A, B)) ⇒ B): B

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

Applies a binary operator to a start value and all elements of this map, going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this map$, going left to right with the start value z on the left: {{{ op(...op(z, x₁), x₂, ..., x_n) }}} where x,,1,,, ..., x,,n,, are the elements of this map.

definition classes: TraversableLike
def foldRight[B](z: B)(op: ((A, B), B) ⇒ B): B

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

Applies a binary operator to all elements of this map and a start value, going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this map$, going right to left with the start value z on the right: {{{ op(x₁, op(x₂, ... op(x_n, z)...)) }}} where x,,1,,, ..., x,,n,, are the elements of this map.

definition classes: IterableLike ⇐ TraversableLike
def forall(p: ((A, B)) ⇒ Boolean): Boolean

Tests whether a predicate holds for all elements of this map

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

p
the predicate used to test elements.
returns
true if the given predicate p holds for all elements of this map, otherwise false.

definition classes: IterableLike ⇐ TraversableLike
def foreach[U](f: ((A, B)) ⇒ U): Unit

Applies a function f to all elements of this map

Applies a function f to all elements of this map.
Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.

U
the type parameter describing the result of function f. This result will always be ignored. Typically U is Unit, but this is not necessary.
f
the function that is applied for its side-effect to every element. The result of function f is discarded.

definition classes: IterableLike ⇐ TraversableLike
def from(from: A): SortedMap[A, B]

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

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

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

definition classes: Sorted
def genericBuilder[B]: Builder[B, Iterable[B]]

The generic builder that builds instances of Map at arbitrary element types

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

definition classes: GenericTraversableTemplate
def get(key: A): Option[B]

Optionally returns the value associated with a key

Optionally returns the value associated with a key.

attributes: abstract

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

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

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

B1
the result type of the default computation.
key
the key.
default
a computation that yields a default value in case no binding for key is found in the map.
returns
the value assocuated with key if it exists, otherwise the result of the default computation.

definition classes: MapLike
def groupBy[K](f: ((A, B)) ⇒ K): Map[K, SortedMap[A, B]]

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

Partitions this map into a map of maps according to some discriminator function.
Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new map.

K
the type of keys returned by the discriminator function.
f
the discriminator function.
returns
A map from keys to maps such that the following invariant holds: {{{ (xs partition f)(k) = xs filter (x => f(x) == k) }}} That is, every key k is bound to a map of those elements x for which f(x) equals k.

definition classes: TraversableLike
def hasDefiniteSize: Boolean

Tests whether this map is known to have a finite size

Tests whether this map is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end.
Note: many collection methods will not work on collections of infinite sizes.

definition classes: TraversableLike
def hashCode(): Int

Returns a hash code value for the object

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

definition classes: MapLike ⇐ AnyRef ⇐ Any
def head: (A, B)

Selects the first element of this map

Selects the first element of this map.
Note: might return different results for different runs, unless the underlying collection type is ordered.

definition classes: IterableLike ⇐ TraversableLike
def headOption: Option[(A, B)]

Optionally selects the first element

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

definition classes: TraversableLike
def init: SortedMap[A, B]

Selects all elements except the last

Selects all elements except the last.
Note: might return different results for different runs, unless the underlying collection type is ordered.

definition classes: TraversableLike
def isDefinedAt(key: A): Boolean

Tests whether this map contains a binding for a key

Tests whether this map contains a binding for a key. This method, which implements an abstract method of trait PartialFunction, is equivalent to contains.

key
the key
returns
true if there is a binding for key in this map, false otherwise.

definition classes: MapLike ⇐ PartialFunction
def isEmpty: Boolean

Tests whether the map is empty

Tests whether the map is empty.

definition classes: MapLike ⇐ IterableLike ⇐ TraversableLike
def iterator: Iterator[(A, B)]

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

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

attributes: abstract

definition classes: MapLike ⇐ IterableLike
def keySet: SortedSet[A]

Collects all keys of this map in a set

Collects all keys of this map in a set.

definition classes: SortedMapLike ⇐ MapLike ⇐ Sorted
def keys: Iterator[A]

Creates an iterator for all keys

Creates an iterator for all keys.

definition classes: MapLike
def keysIterator: Iterator[A]

Creates an iterator for all keys

Creates an iterator for all keys.

definition classes: MapLike
def last: (A, B)

Selects the last element

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

definition classes: TraversableLike
def lastKey: A

Returns the last key of the collection

Returns the last key of the collection.

definition classes: SortedMapLike ⇐ Sorted
def lastOption: Option[(A, B)]

Optionally selects the last element

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

definition classes: TraversableLike
def lift: (A) ⇒ Option[B]

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

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

definition classes: PartialFunction
def map[B, That](f: ((A, B)) ⇒ B)(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

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

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

B
the element type of the returned collection.
That
the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.
f
the function to apply to each element.
bf
an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.
returns
a new collection of type That resulting from applying the given function f to each element of this map and collecting the results.

definition classes: TraversableLike
def mapElements[C](f: (B) ⇒ C): DefaultMap[A, C]
def mapValues[C](f: (B) ⇒ C): DefaultMap[A, C]

A map view resulting from applying a given function f to each value associated with a key in this map

A map view resulting from applying a given function f to each value associated with a key in this map.

definition classes: MapLike
def max[B >: (A, B)](cmp: Ordering[B]): (A, B)

Finds the largest element

Finds the largest element.

B
The type over which the ordering is defined.
cmp
An ordering to be used for comparing elements.
returns
the largest element of this map with respect to the ordering cmp.

definition classes: TraversableLike
def min[B >: (A, B)](cmp: Ordering[B]): (A, B)

Finds the smallest element

Finds the smallest element.

B
The type over which the ordering is defined.
cmp
An ordering to be used for comparing elements.
returns
the smallest element of this map with respect to the ordering cmp.

definition classes: TraversableLike
def mkString: String

Displays all elements of this map in a string

Displays all elements of this map in a string.

definition classes: TraversableLike
def mkString(sep: String): String

Displays all elements of this map in a string using a separator string

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

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

definition classes: TraversableLike
def mkString(start: String, sep: String, end: String): String

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

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

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

definition classes: TraversableLike
def nonEmpty: Boolean

Tests whether the map is not empty

Tests whether the map is not empty.

definition classes: TraversableLike
def orElse[A1 <: A, B1 >: B](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

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

A1
the argument type of the fallback function
B1
the result type of the fallback function
that
the fallback function
returns
a partial function which has as domain the union of the domains of this partial function and that. The resulting partial function takes x to this(x) where this is defined, and to that(x) where it is not.

definition classes: PartialFunction
def ordering: Ordering[A]
def partialMap[B, That](pf: PartialFunction[(A, B), B])(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

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

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

B
the element type of the returned collection.
That
the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.
pf
the partial function which filters and maps the map.
bf
an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.
returns
a new collection of type That resulting from applying the partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

definition classes: TraversableLike
def partition(p: ((A, B)) ⇒ Boolean): (SortedMap[A, B], SortedMap[A, B])

Partitions this map in two maps according to a predicate

Partitions this map in two maps according to a predicate.

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

definition classes: TraversableLike
def product[B >: (A, B)](num: Numeric[B]): B

Multiplies up the elements of this collection

Multiplies up the elements of this collection.

B
the result type of the * operator.
num
an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.
returns
the product of all elements of this map with respect to the * operator in num.

definition classes: TraversableLike
def projection: IterableView[(A, B), SortedMap[A, B]]

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

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

definition classes: IterableLike
def range(from: A, until: A): SortedMap[A, B]

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

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

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

definition classes: Sorted
def rangeImpl(from: Option[A], until: Option[A]): SortedMap[A, B]

Creates a ranged projection of this collection

Creates a ranged projection of this collection. Any mutations in the ranged projection will update this collection and vice versa. Note: keys are not garuanteed to be consistent between this collection and the projection. This is the case for buffers where indexing is relative to the projection.

from
The lower-bound (inclusive) of the ranged projection. None if there is no lower bound.
until
The upper-bound (exclusive) of the ranged projection. None if there is no upper bound.

attributes: abstract

definition classes: SortedMapLike ⇐ Sorted
def reduceLeft[B >: (A, B)](op: (B, (A, B)) ⇒ B): B

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

Applies a binary operator to all elements of this map, going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this map$, going left to right: {{{ op(...(op(x₁, x₂), ... ) , x_n) }}} where x,,1,,, ..., x,,n,, are the elements of this map.

definition classes: TraversableLike
def reduceLeftOption[B >: (A, B)](op: (B, (A, B)) ⇒ B): Option[B]

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

Optionally applies a binary operator to all elements of this map, going left to right.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceLeft(op) is this map is nonempty, None otherwise.

definition classes: TraversableLike
def reduceRight[B >: (A, B)](op: ((A, B), B) ⇒ B): B

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

Applies a binary operator to all elements of this map, going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

B
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this map$, going right to left: {{{ op(x₁, op(x₂, ..., op(x_n-1, x_n)...)) }}} where x,,1,,, ..., x,,n,, are the elements of this map.

definition classes: IterableLike ⇐ TraversableLike
def reduceRightOption[B >: (A, B)](op: ((A, B), B) ⇒ B): Option[B]

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

Optionally applies a binary operator to all elements of this map, going right to left.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.

B
the result type of the binary operator.
op
the binary operator.
returns
an option value containing the result of reduceRight(op) is this map is nonempty, None otherwise.

definition classes: TraversableLike
def repr: SortedMap[A, B]

The collection of type map underlying this TraversableLike object

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

definition classes: TraversableLike
def sameElements[B >: (A, B)](that: Iterable[B]): Boolean

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

Checks if the other iterable collection contains the same elements in the same order as this map.
Note: might return different results for different runs, unless the underlying collection type is ordered.

B
the type of the elements of collection that.
that
the collection to compare with.
returns
true, if both collections contain the same elements in the same order, false otherwise.

definition classes: IterableLike
def size: Int

The size of this map

The size of this map.

definition classes: TraversableLike
def slice(from: Int, until: Int): SortedMap[A, B]

Selects an interval of elements

Selects an interval of elements.
Note: c.slice(from, to) is equivalent to (but possibly more efficient than) c.drop(from).take(to - from)
Note: might return different results for different runs, unless the underlying collection type is ordered.

from
the index of the first returned element in this map.
until
the index one past the last returned element in this map.
returns
a map containing the elements starting at index from and extending up to (but not including) index until of this map.

definition classes: IterableLike ⇐ TraversableLike
def span(p: ((A, B)) ⇒ Boolean): (SortedMap[A, B], SortedMap[A, B])

Spits this map into a prefix/suffix pair according to a predicate

Spits this map into a prefix/suffix pair according to a predicate.
Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side-effects.
Note: might return different results for different runs, unless the underlying collection type is ordered.

p
the test predicate
returns
a pair consisting of the longest prefix of this map whose elements all satisfy p, and the rest of this map.

definition classes: TraversableLike
def splitAt(n: Int): (SortedMap[A, B], SortedMap[A, B])

Splits this map into two at a given position

Splits this map into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).
Note: might return different results for different runs, unless the underlying collection type is ordered.

n
the position at which to split.
returns
a pair of maps consisting of the first n elements of this map, and the other elements.

definition classes: TraversableLike
def stringPrefix: String

Defines the prefix of this object's toString representation

Defines the prefix of this object's toString representation.

definition classes: MapLike ⇐ TraversableLike
def sum[B >: (A, B)](num: Numeric[B]): B

Sums up the elements of this collection

Sums up the elements of this collection.

B
the result type of the + operator.
num
an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.
returns
the sum of all elements of this map with respect to the + operator in num.

definition classes: TraversableLike
def tail: SortedMap[A, B]

Selects all elements except the first

Selects all elements except the first.
Note: might return different results for different runs, unless the underlying collection type is ordered.

definition classes: TraversableLike
def take(n: Int): SortedMap[A, B]

Selects first n elements

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

n
Tt number of elements to take from this map.
returns
a map consisting only of the first n elements of this map, or else the whole map, if it has less than n elements.

definition classes: IterableLike ⇐ TraversableLike
def takeRight(n: Int): SortedMap[A, B]

Selects last n elements

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

n
the number of elements to take
returns
a map consisting only of the last n elements of this map, or else the whole map, if it has less than n elements.

definition classes: IterableLike
def takeWhile(p: ((A, B)) ⇒ Boolean): SortedMap[A, B]

Takes longest prefix of elements that satisfy a predicate

Takes longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.

p
The predicate used to test elements.
returns
the longest prefix of this map whose elements all satisfy the predicate p.

definition classes: IterableLike ⇐ TraversableLike
def to(to: A): SortedMap[A, B]

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

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

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

definition classes: Sorted
def toArray[B >: (A, B)](arg0: ClassManifest[B]): Array[B]

Converts this map to an array

Converts this map to an array.

B
the type of the elements of the array. A ClassManifest for this type must be available.
returns
an array containing all elements of this map.

definition classes: TraversableLike
def toIndexedSeq[B >: (A, B)]: IndexedSeq[B]

Converts this map to an indexed sequence

Converts this map to an indexed sequence.

definition classes: TraversableLike
def toIterable: Iterable[(A, B)]

Converts this map to an iterable collection

Converts this map to an iterable collection.
Note: Will not terminate for infinite-sized collections.

definition classes: IterableLike ⇐ TraversableLike
def toList: List[(A, B)]

Converts this map to a list

Converts this map to a list.

definition classes: TraversableLike
def toSeq: Seq[(A, B)]

Converts this map to a sequence

Converts this map to a sequence.

definition classes: TraversableLike
def toSet[B >: (A, B)]: Set[B]

Converts this map to a set

Converts this map to a set.

definition classes: TraversableLike
def toStream: Stream[(A, B)]

Converts this map to a stream

Converts this map to a stream.

definition classes: IterableLike ⇐ TraversableLike
def toString(): String

Converts this map to a string

Converts this map to a string

definition classes: MapLike ⇐ TraversableLike ⇐ Function1 ⇐ AnyRef ⇐ Any
def transpose[B](asTraversable: ((A, B)) ⇒ Traversable[B]): Iterable[Iterable[B]]

Transposes this map of traversable collections into

Transposes this map of traversable collections into

definition classes: GenericTraversableTemplate
def until(until: A): SortedMap[A, B]

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

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

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

definition classes: Sorted
def unzip[A1, A2](asPair: ((A, B)) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])

Converts this map of pairs into two collections of the first and second halfs of each pair

Converts this map of pairs into two collections of the first and second halfs of each pair.

asPair
an implicit conversion which asserts that the element type of this map is a pair.
returns
a pair maps, containing the first, respectively second half of each element pair of this map.

definition classes: GenericTraversableTemplate
def updated[B1 >: B](key: A, value: B1): SortedMap[A, B1]

Add a key/value pair to this map

Add a key/value pair to this map.

B1
the type of the added value
key
the key
value
the value
returns
A new map with the new binding added to this map

definition classes: SortedMapLike ⇐ MapLike
def values: Iterator[B]

Creates an iterator for all contained values

Creates an iterator for all contained values.

definition classes: MapLike
def valuesIterable: Iterable[B]

Collects all values of this map in an iterable collection

Collects all values of this map in an iterable collection.

definition classes: MapLike
def valuesIterator: Iterator[B]

Creates an iterator for all values in this map

Creates an iterator for all values in this map.

definition classes: MapLike
def view(from: Int, until: Int): IterableView[(A, B), SortedMap[A, B]]

Creates a non-strict view of a slice of this map

Creates a non-strict view of a slice of this map.
Note: the difference between view and slice is that view produces a view of the current map, whereas slice produces a new map.
Note: view(from, to) is equivalent to view.slice(from, to)
Note: might return different results for different runs, unless the underlying collection type is ordered.

from
the index of the first element of the view
until
the index of the element following the view
returns
a non-strict view of a slice of this map, starting at index from and extending up to (but not including) index until.

definition classes: IterableLike ⇐ TraversableLike
def view: IterableView[(A, B), SortedMap[A, B]]

Creates a non-strict view of this map

Creates a non-strict view of this map.

definition classes: IterableLike ⇐ TraversableLike
def withFilter(p: ((A, B)) ⇒ Boolean): WithFilter

Creates a non-strict filter of this map

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 satify the predicate p.

definition classes: TraversableLike
def zip[A1 >: (A, B), B, That](that: Iterable[B])(bf: CanBuildFrom[SortedMap[A, B], (A1, B), That]): That

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

Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.
Note: might return different results for different runs, unless the underlying collection type is ordered.

A1
the type of the first half of the returned pairs (this is always a supertype of the collection's element type A).
B
the type of the second half of the returned pairs
That
the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, B) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, B), That]. is found.
that
The iterable providing the second half of each result pair
bf
an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type (A1, B).
returns
a new collection of type That containing pairs consisting of corresponding elements of this map and that. The length of the returned collection is the minimum of the lengths of this map$ and that.

definition classes: IterableLike
def zipAll[B, A1 >: (A, B), That](that: Iterable[B], thisElem: A1, thatElem: B)(bf: CanBuildFrom[SortedMap[A, B], (A1, B), That]): That

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

Returns a map formed from this map and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.
Note: might return different results for different runs, unless the underlying collection type is ordered.

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

definition classes: IterableLike
def zipWithIndex[A1 >: (A, B), That](bf: CanBuildFrom[SortedMap[A, B], (A1, Int), That]): That

Zips this map with its indices

Zips this map with its indices.
Note: might return different results for different runs, unless the underlying collection type is ordered.

A1
the type of the first half of the returned pairs (this is always a supertype of the collection's element type A).
That
the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, Int) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, Int), That]. is found.
returns
A new collection of type That containing pairs consisting of all elements of this map paired with their index. Indices start at 0.

definition classes: IterableLike

SortedMap

trait SortedMap[A, +B] extends Map[A, B] with SortedMapLike[A, B, SortedMap[A, B]]

Inherits

Type Members

class WithFilter extends AnyRef

Value Members

def +[B1 >: B](elem1: (A, B1), elem2: (A, B1), elems: (A, B1)*): SortedMap[A, B1]

def +[B1 >: B](kv: (A, B1)): SortedMap[A, B1]

def ++[B1 >: B](iter: Iterator[(A, B1)]): Map[A, B1]

def ++[B1 >: B](kvs: Traversable[(A, B1)]): Map[A, B1]

def ++[B >: (A, B), That](that: Iterator[B])(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

def ++[B >: (A, B), That](that: Traversable[B])(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

def -(elem1: A, elem2: A, elems: A*): SortedMap[A, B]

def -(key: A): SortedMap[A, B]

def --(iter: Iterator[A]): SortedMap[A, B]

def --(elems: Traversable[A]): SortedMap[A, B]

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

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

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

def addString(b: StringBuilder): StringBuilder

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

def andThen[C](k: (B) ⇒ C): PartialFunction[A, C]

def apply(key: A): B

def canEqual(that: Any): Boolean

def companion: GenericCompanion[Iterable[A][A]]

def compare(k0: A, k1: A): Int

def compose[A](g: (A) ⇒ A): (A) ⇒ B

def contains(key: A): Boolean

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

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

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

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

def count(p: ((A, B)) ⇒ Boolean): Int

def default(key: A): B

def drop(n: Int): SortedMap[A, B]

def dropRight(n: Int): SortedMap[A, B]

def dropWhile(p: ((A, B)) ⇒ Boolean): SortedMap[A, B]

def elements: Iterator[(A, B)]

def empty: SortedMap[A, B]

def equals(that: Any): Boolean

def exists(p: ((A, B)) ⇒ Boolean): Boolean

def filter(p: ((A, B)) ⇒ Boolean): SortedMap[A, B]

def filterKeys(p: (A) ⇒ Boolean): DefaultMap[A, B]

def filterNot(p: ((A, B)) ⇒ Boolean): SortedMap[A, B]

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

def first: (A, B)

def firstKey: A

def firstOption: Option[(A, B)]

def flatMap[B, That](f: ((A, B)) ⇒ Traversable[B])(bf: CanBuildFrom[SortedMap[A, B], B, That]): That

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

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

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

def forall(p: ((A, B)) ⇒ Boolean): Boolean

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

def from(from: A): SortedMap[A, B]

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

def get(key: A): Option[B]

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

def groupBy[K](f: ((A, B)) ⇒ K): Map[K, SortedMap[A, B]]

def hasDefiniteSize: Boolean

def hashCode(): Int

def head: (A, B)

def headOption: Option[(A, B)]

def init: SortedMap[A, B]

def isDefinedAt(key: A): Boolean

def isEmpty: Boolean

def iterator: Iterator[(A, B)]

def keySet: SortedSet[A]

def keys: Iterator[A]

def keysIterator: Iterator[A]

def last: (A, B)

def lastKey: A

def lastOption: Option[(A, B)]

def lift: (A) ⇒ Option[B]

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

def mapElements[C](f: (B) ⇒ C): DefaultMap[A, C]

def mapValues[C](f: (B) ⇒ C): DefaultMap[A, C]

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

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

def mkString: String