scala.collection.immutable.IntMap

sealed abstract class IntMap[+T] extends AbstractMap[immutable.IntMapUtils.Int, T] with Map[immutable.IntMapUtils.Int, T] with MapLike[immutable.IntMapUtils.Int, T, IntMap[T]]

Specialised immutable map structure for integer keys, based on Fast Mergeable Integer Maps by Okasaki and Gill. Essentially a trie based on binary digits of the integers.

Note: This class is as of 2.8 largely superseded by HashMap.

• T
  • type of the values associated with integer keys.
• Source
  • IntMap.scala - Blame
  • IntMap.scala - History
• Since
  • 2.7

Type Members

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

The implementation class of the set returned by keySet .

• Attributes
  • protected
• Definition Classes
  • MapLike

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

The implementation class of the iterable returned by values .

• Attributes
  • protected
• Definition Classes
  • MapLike

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

• Attributes
  • protected
• Definition Classes
  • MapLike

class ImmutableDefaultKeySet extends DefaultKeySet with Set[A]

• Attributes
  • protected
• Definition Classes
  • MapLike

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

• Attributes
  • protected
• Definition Classes
  • MapLike

type Self = IntMap[T]

The type implementing this traversable

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

class WithFilter extends FilterMonadic[A, Repr]

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

• Definition Classes
  • TraversableLike

Value Members From scala.Function1

def compose[A](g: (A) ⇒ IntMapUtils.Int): (A) ⇒ T

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

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

(defined at scala.Function1)

Value Members From scala.PartialFunction

def andThen[C](k: (T) ⇒ C): PartialFunction[IntMapUtils.Int, C]

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

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

(defined at scala.PartialFunction)

def applyOrElse[A1 <: IntMapUtils.Int, B1 >: T](x: A1, default: (A1) ⇒ B1): B1

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

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

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

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

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

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

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

(defined at scala.PartialFunction)

def lift: (IntMapUtils.Int) ⇒ Option[T]

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

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

(defined at scala.PartialFunction)

def orElse[A1 <: IntMapUtils.Int, B1 >: T](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

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

(defined at scala.PartialFunction)

def runWith[U](action: (T) ⇒ U): (IntMapUtils.Int) ⇒ Boolean

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

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

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

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

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

(defined at scala.PartialFunction)

Value Members From scala.collection.GenMapLike

def equals(that: Any): Boolean

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

• that
  • the other map
• returns
  • true if both maps contain exactly the same mappings, false otherwise.
• Definition Classes
  • GenMapLike → Equals → AnyRef → Any

(defined at scala.collection.GenMapLike)

Value Members From scala.collection.IterableLike

def canEqual(that: Any): Boolean

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

• that
  • The object with which this iterable collection should be compared
• returns
  • true , if this iterable collection can possibly equal that , false otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
• Definition Classes
  • IterableLike → Equals

(defined at scala.collection.IterableLike)

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

[use case]

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

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

(defined at scala.collection.IterableLike)

def drop(n: Int): IntMap[T]

Selects all elements except first n ones.

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

• n
  • the number of elements to drop from this iterable collection.
• returns
  • a iterable collection consisting of all elements of this iterable collection except the first n ones, or else the empty iterable collection, if this iterable collection has less than n elements.
• Definition Classes
  • IterableLike → TraversableLike → GenTraversableLike

(defined at scala.collection.IterableLike)

def dropRight(n: Int): IntMap[T]

Selects all elements except last n ones.

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

• n
  • The number of elements to take
• returns
  • a iterable collection consisting of all elements of this iterable collection except the last n ones, or else the empty iterable collection, if this iterable collection has less than n elements.
• Definition Classes
  • IterableLike

(defined at scala.collection.IterableLike)

def exists(p: ((IntMapUtils.Int, T)) ⇒ Boolean): Boolean

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

Note: may not terminate for infinite-sized collections.

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

(defined at scala.collection.IterableLike)

def find(p: ((IntMapUtils.Int, T)) ⇒ Boolean): Option[(IntMapUtils.Int, T)]

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

Note: may not terminate for infinite-sized collections.

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

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

(defined at scala.collection.IterableLike)

def foldRight[B](z: B)(op: ((IntMapUtils.Int, T), B) ⇒ B): B

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

Note: will not terminate for infinite-sized collections.

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

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

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

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

• Definition Classes
  • IterableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.IterableLike)

def forall(p: ((IntMapUtils.Int, T)) ⇒ Boolean): Boolean

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

Note: may not terminate for infinite-sized collections.

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

(defined at scala.collection.IterableLike)

def grouped(size: Int): Iterator[IntMap[T]]

Partitions elements in fixed size iterable collections.

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

(defined at scala.collection.IterableLike)

def head: (IntMapUtils.Int, T)

Selects the first element of this iterable collection.

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

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

(defined at scala.collection.IterableLike)

def reduceRight[B >: (IntMapUtils.Int, T)](op: ((IntMapUtils.Int, T), B) ⇒ B): B

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

Note: will not terminate for infinite-sized collections.

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

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • the result of inserting op between consecutive elements of this iterable collection, going right to left:

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

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

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

(defined at scala.collection.IterableLike)

def sameElements[B >: (IntMapUtils.Int, T)](that: GenIterable[B]): Boolean

[use case]

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

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

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

(defined at scala.collection.IterableLike)

def slice(from: Int, until: Int): IntMap[T]

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

from <= indexOf(x) < until

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

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

(defined at scala.collection.IterableLike)

def sliding(size: Int): Iterator[IntMap[T]]

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

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

(defined at scala.collection.IterableLike)

def sliding(size: Int, step: Int): Iterator[IntMap[T]]

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

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

(defined at scala.collection.IterableLike)

def take(n: Int): IntMap[T]

Selects first n elements.

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

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

(defined at scala.collection.IterableLike)

def takeRight(n: Int): IntMap[T]

Selects last n elements.

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

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

(defined at scala.collection.IterableLike)

def takeWhile(p: ((IntMapUtils.Int, T)) ⇒ Boolean): IntMap[T]

Takes longest prefix of elements that satisfy a predicate.

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

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

(defined at scala.collection.IterableLike)

def thisCollection: collection.Iterable[(IntMapUtils.Int, T)]

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

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

(defined at scala.collection.IterableLike)

def toCollection(repr: IntMap[T]): collection.Iterable[(IntMapUtils.Int, T)]

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

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

(defined at scala.collection.IterableLike)

def toIterable: collection.Iterable[(IntMapUtils.Int, T)]

Returns this iterable collection as an iterable collection.

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

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.IterableLike)

def toIterator: Iterator[(IntMapUtils.Int, T)]

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

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.IterableLike)

def toStream: Stream[(IntMapUtils.Int, T)]

Converts this iterable collection to a stream.

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

(defined at scala.collection.IterableLike)

def view(from: Int, until: Int): IterableView[(IntMapUtils.Int, T), IntMap[T]]

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

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

Note: view(from, to) is equivalent to view.slice(from, to)

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

• from
  • the index of the first element of the view
• until
  • the index of the element following the view
• returns
  • a non-strict view of a slice of this iterable collection, starting at index from and extending up to (but not including) index until .
• Definition Classes
  • IterableLike → TraversableLike

(defined at scala.collection.IterableLike)

def view: IterableView[(IntMapUtils.Int, T), IntMap[T]]

Creates a non-strict view of this iterable collection.

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

(defined at scala.collection.IterableLike)

def zipAll[B, A1 >: (IntMapUtils.Int, T), That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[IntMap[T], (A1, B), That]): That

[use case]

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

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

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

(defined at scala.collection.IterableLike)

def zipWithIndex[A1 >: (IntMapUtils.Int, T), That](implicit bf: CanBuildFrom[IntMap[T], (A1, Int), That]): That

[use case]

Zips this immutable integer map with its indices.

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

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

Example:

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

(defined at scala.collection.IterableLike)

def zip[A1 >: (IntMapUtils.Int, T), B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[IntMap[T], (A1, B), That]): That

[use case]

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

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

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

(defined at scala.collection.IterableLike)

Value Members From scala.collection.MapLike

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

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

• b
  • the builder to which strings are appended.
• start
  • the starting string.
• sep
  • the separator string.
• end
  • the ending string.
• returns
  • the string builder b to which elements were appended.
• Definition Classes
  • MapLike → TraversableOnce

(defined at scala.collection.MapLike)

def contains(key: IntMapUtils.Int): Boolean

Tests whether this map contains a binding for a key.

• key
  • the key
• returns
  • true if there is a binding for key in this map, false otherwise.
• Definition Classes
  • MapLike → GenMapLike

(defined at scala.collection.MapLike)

def default(key: IntMapUtils.Int): T

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

• key
  • the given key value for which a binding is missing.
• Definition Classes
  • MapLike → GenMapLike
• Exceptions thrown *

(defined at scala.collection.MapLike)

def filterNot(p: ((IntMapUtils.Int, T)) ⇒ Boolean): IntMap[T]

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

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

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

(defined at scala.collection.MapLike)

def isDefinedAt(key: IntMapUtils.Int): Boolean

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

• key
  • the key
• returns
  • true if there is a binding for key in this map, false otherwise.
• Definition Classes
  • MapLike → GenMapLike → PartialFunction

(defined at scala.collection.MapLike)

def keys: collection.Iterable[IntMapUtils.Int]

Collects all keys of this map in an iterable collection.

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

(defined at scala.collection.MapLike)

def newBuilder: Builder[(IntMapUtils.Int, T), IntMap[T]]

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

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

(defined at scala.collection.MapLike)

def toBuffer[C >: (IntMapUtils.Int, T)]: Buffer[C]

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

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

(defined at scala.collection.MapLike)

def toSeq: collection.Seq[(IntMapUtils.Int, T)]

Converts this map to a sequence. As with toIterable , it’s lazy in this default implementation, as this TraversableOnce may be lazy and unevaluated.

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

(defined at scala.collection.MapLike)

def values: collection.Iterable[T]

Collects all values of this map in an iterable collection.

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

(defined at scala.collection.MapLike)

Value Members From scala.collection.Parallelizable

def par: ParMap[IntMapUtils.Int, T]

Returns a parallel implementation of this collection.

For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

Specific collections (e.g. ParArray or mutable.ParHashMap ) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

All parallel collections return a reference to themselves.

• returns
  • a parallel implementation of this collection
• Definition Classes
  • Parallelizable

(defined at scala.collection.Parallelizable)

Value Members From scala.collection.TraversableLike

def ++:[B >: (IntMapUtils.Int, T), That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

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

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

Example:

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

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

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

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

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

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

(defined at scala.collection.TraversableLike)

def ++:[B >: (IntMapUtils.Int, T), That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

[use case]

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

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

Example:

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

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

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

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

(defined at scala.collection.TraversableLike)

def ++[B >: (IntMapUtils.Int, T), That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

[use case]

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

Example:

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

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

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

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

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

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

(defined at scala.collection.TraversableLike)

def collect[B, That](pf: PartialFunction[(IntMapUtils.Int, T), B])(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

[use case]

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

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

(defined at scala.collection.TraversableLike)

def dropWhile(p: ((IntMapUtils.Int, T)) ⇒ Boolean): IntMap[T]

Drops longest prefix of elements that satisfy a predicate.

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

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

(defined at scala.collection.TraversableLike)

def flatMap[B, That](f: ((IntMapUtils.Int, T)) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

[use case]

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

For example:

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

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

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

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

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

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

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

(defined at scala.collection.TraversableLike)

def groupBy[K](f: ((IntMapUtils.Int, T)) ⇒ K): Map[K, IntMap[T]]

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

Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.

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

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

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

• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def headOption: Option[(IntMapUtils.Int, T)]

Optionally selects the first element.

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

• returns
  • the first element of this traversable collection if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def init: IntMap[T]

Selects all elements except the last.

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

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

(defined at scala.collection.TraversableLike)

def inits: Iterator[IntMap[T]]

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

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

Example:

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

(defined at scala.collection.TraversableLike)

def last: (IntMapUtils.Int, T)

Selects the last element.

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

• returns
  • The last element of this traversable collection.
• Definition Classes
  • TraversableLike → GenTraversableLike
• Exceptions thrown
  • NoSuchElementException If the traversable collection is empty.

(defined at scala.collection.TraversableLike)

def lastOption: Option[(IntMapUtils.Int, T)]

Optionally selects the last element.

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

• returns
  • the last element of this traversable collection$ if it is nonempty, None if it is empty.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def map[B, That](f: ((IntMapUtils.Int, T)) ⇒ B)(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

[use case]

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

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

(defined at scala.collection.TraversableLike)

def partition(p: ((IntMapUtils.Int, T)) ⇒ Boolean): (IntMap[T], IntMap[T])

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

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

(defined at scala.collection.TraversableLike)

def repr: IntMap[T]

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

• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def scanLeft[B, That](z: B)(op: (B, (IntMapUtils.Int, T)) ⇒ B)(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

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

Note: will not terminate for infinite-sized collections.

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

• B
  • the type of the elements in the resulting collection
• That
  • the actual type of the resulting collection
• z
  • the initial value
• op
  • the binary operator applied to the intermediate result and the element
• bf
  • an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B .
• returns
  • collection with intermediate results
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def scanRight[B, That](z: B)(op: ((IntMapUtils.Int, T), B) ⇒ B)(implicit bf: CanBuildFrom[IntMap[T], B, That]): That

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

Note: will not terminate for infinite-sized collections.

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

Example:

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

• B
  • the type of the elements in the resulting collection
• That
  • the actual type of the resulting collection
• z
  • the initial value
• op
  • the binary operator applied to the intermediate result and the element
• bf
  • an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B .
• returns
  • collection with intermediate results
• Definition Classes
  • TraversableLike → GenTraversableLike
• Annotations
  • @migration
• Migration
  • (Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.

(defined at scala.collection.TraversableLike)

def scan[B >: (IntMapUtils.Int, T), That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[IntMap[T], B, That]): That

Computes a prefix scan of the elements of the collection.

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

• B
  • element type of the resulting collection
• That
  • type of the resulting collection
• z
  • neutral element for the operator op
• op
  • the associative operator for the scan
• cbf
  • combiner factory which provides a combiner
• returns
  • a new traversable collection containing the prefix scan of the elements in this traversable collection
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def span(p: ((IntMapUtils.Int, T)) ⇒ Boolean): (IntMap[T], IntMap[T])

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

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

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

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

(defined at scala.collection.TraversableLike)

def splitAt(n: Int): (IntMap[T], IntMap[T])

Splits this traversable collection into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n) .

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

• n
  • the position at which to split.
• returns
  • a pair of traversable collections consisting of the first n elements of this traversable collection, and the other elements.
• Definition Classes
  • TraversableLike → GenTraversableLike

(defined at scala.collection.TraversableLike)

def tail: IntMap[T]

Selects all elements except the first.

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

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

(defined at scala.collection.TraversableLike)

def tails: Iterator[IntMap[T]]

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

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

Example:

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

(defined at scala.collection.TraversableLike)

def toTraversable: collection.Traversable[(IntMapUtils.Int, T)]

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

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.TraversableLike)

def withFilter(p: ((IntMapUtils.Int, T)) ⇒ Boolean): FilterMonadic[(IntMapUtils.Int, T), IntMap[T]]

Creates a non-strict filter of this traversable collection.

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

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

• p
  • the predicate used to test elements.
• returns
  • an object of class WithFilter , which supports map , flatMap , foreach , and withFilter operations. All these operations apply to those elements of this traversable collection which satisfy the predicate p .
• Definition Classes
  • TraversableLike → FilterMonadic

(defined at scala.collection.TraversableLike)

Value Members From scala.collection.TraversableOnce

def /:[B](z: B)(op: (B, (IntMapUtils.Int, T)) ⇒ B): B

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

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

Examples:

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

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

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

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

Note: will not terminate for infinite-sized collections.

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

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

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

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

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def :\[B](z: B)(op: ((IntMapUtils.Int, T), B) ⇒ B): B

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

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

Note: will not terminate for infinite-sized collections.

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

Examples:

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

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

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

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

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

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

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

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def addString(b: StringBuilder): StringBuilder

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

Example:

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

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

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

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

(defined at scala.collection.TraversableOnce)

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

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

Example:

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

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

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

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

(defined at scala.collection.TraversableOnce)

def aggregate[B](z: ⇒ B)(seqop: (B, (IntMapUtils.Int, T)) ⇒ B, combop: (B, B) ⇒ B): B

Aggregates the results of applying an operator to subsequent elements.

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

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

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

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

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

(defined at scala.collection.TraversableOnce)

def collectFirst[B](pf: PartialFunction[(IntMapUtils.Int, T), B]): Option[B]

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

Note: may not terminate for infinite-sized collections.

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

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

Example:

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

(defined at scala.collection.TraversableOnce)

def copyToArray[B >: (IntMapUtils.Int, T)](xs: Array[B]): Unit

[use case]

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

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

(defined at scala.collection.TraversableOnce)

def copyToArray[B >: (IntMapUtils.Int, T)](xs: Array[B], start: Int): Unit

[use case]

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

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

(defined at scala.collection.TraversableOnce)

def copyToBuffer[B >: (IntMapUtils.Int, T)](dest: Buffer[B]): Unit

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

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.TraversableOnce)

def count(p: ((IntMapUtils.Int, T)) ⇒ Boolean): Int

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

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

(defined at scala.collection.TraversableOnce)

def foldLeft[B](z: B)(op: (B, (IntMapUtils.Int, T)) ⇒ B): B

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

Note: will not terminate for infinite-sized collections.

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

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

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

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

• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def fold[A1 >: (IntMapUtils.Int, T)](z: A1)(op: (A1, A1) ⇒ A1): A1

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

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

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.TraversableOnce)

def maxBy[B](f: ((IntMapUtils.Int, T)) ⇒ B)(implicit cmp: Ordering[B]): (IntMapUtils.Int, T)

[use case]

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

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

(defined at scala.collection.TraversableOnce)

def minBy[B](f: ((IntMapUtils.Int, T)) ⇒ B)(implicit cmp: Ordering[B]): (IntMapUtils.Int, T)

[use case]

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

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

(defined at scala.collection.TraversableOnce)

def mkString(sep: String): String

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

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

Example:

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

(defined at scala.collection.TraversableOnce)

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

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

• start
  • the starting string.
• sep
  • the separator string.
• end
  • the ending string.
• returns
  • a string representation of this traversable or iterator. The resulting string begins with the string start and ends with the string end . Inside, the string representations (w.r.t. the method toString ) of all elements of this traversable or iterator are separated by the string sep .
• Definition Classes
  • TraversableOnce → GenTraversableOnce

Example:

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

(defined at scala.collection.TraversableOnce)

def reduceLeftOption[B >: (IntMapUtils.Int, T)](op: (B, (IntMapUtils.Int, T)) ⇒ B): Option[B]

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

Note: will not terminate for infinite-sized collections.

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

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • an option value containing the result of reduceLeft(op) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduceLeft[B >: (IntMapUtils.Int, T)](op: (B, (IntMapUtils.Int, T)) ⇒ B): B

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

Note: will not terminate for infinite-sized collections.

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

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

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

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

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

(defined at scala.collection.TraversableOnce)

def reduceOption[A1 >: (IntMapUtils.Int, T)](op: (A1, A1) ⇒ A1): Option[A1]

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

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

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

(defined at scala.collection.TraversableOnce)

def reduceRightOption[B >: (IntMapUtils.Int, T)](op: ((IntMapUtils.Int, T), B) ⇒ B): Option[B]

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

Note: will not terminate for infinite-sized collections.

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

• B
  • the result type of the binary operator.
• op
  • the binary operator.
• returns
  • an option value containing the result of reduceRight(op) if this traversable or iterator is nonempty, None otherwise.
• Definition Classes
  • TraversableOnce → GenTraversableOnce

(defined at scala.collection.TraversableOnce)

def reduce[A1 >: (IntMapUtils.Int, T)](op: (A1, A1) ⇒ A1): A1

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

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

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

(defined at scala.collection.TraversableOnce)

def reversed: scala.List[(IntMapUtils.Int, T)]

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

(defined at scala.collection.TraversableOnce)

def toIndexedSeq: IndexedSeq[(IntMapUtils.Int, T)]

Converts this traversable or iterator to an indexed sequence.

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.TraversableOnce)

def toSet[B >: (IntMapUtils.Int, T)]: Set[B]

Converts this traversable or iterator to a set.

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.TraversableOnce)

def toVector: scala.Vector[(IntMapUtils.Int, T)]

Converts this traversable or iterator to a Vector.

Note: will not terminate for infinite-sized collections.

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

(defined at scala.collection.TraversableOnce)

Value Members From scala.collection.generic.GenericTraversableTemplate

def flatten[B](implicit asTraversable: ((IntMapUtils.Int, T)) ⇒ GenTraversableOnce[B]): Iterable[B]

[use case]

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

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

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

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

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

(defined at scala.collection.generic.GenericTraversableTemplate)

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

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

• Definition Classes
  • GenericTraversableTemplate

(defined at scala.collection.generic.GenericTraversableTemplate)

def transpose[B](implicit asTraversable: ((IntMapUtils.Int, T)) ⇒ GenTraversableOnce[B]): Iterable[Iterable[B]]

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

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

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

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

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

(defined at scala.collection.generic.GenericTraversableTemplate)

def unzip3[A1, A2, A3](implicit asTriple: ((IntMapUtils.Int, T)) ⇒ (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

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

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

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

(defined at scala.collection.generic.GenericTraversableTemplate)

def unzip[A1, A2](implicit asPair: ((IntMapUtils.Int, T)) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])

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

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

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

(defined at scala.collection.generic.GenericTraversableTemplate)

Value Members From scala.collection.generic.Subtractable

def -(elem1: IntMapUtils.Int, elem2: IntMapUtils.Int, elems: IntMapUtils.Int*): IntMap[T]

Creates a new collection from this collection 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 collection that contains all elements of the current collection except one less occurrence of each of the given elements.
• Definition Classes
  • Subtractable

(defined at scala.collection.generic.Subtractable)

def --(xs: GenTraversableOnce[IntMapUtils.Int]): IntMap[T]

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

• xs
  • the collection containing the removed elements.
• returns
  • a new collection that contains all elements of the current collection except one less occurrence of each of the elements of elems .
• Definition Classes
  • Subtractable

(defined at scala.collection.generic.Subtractable)

Value Members From scala.collection.immutable.IntMap

def ++[S >: T](that: IntMap[S]): IntMap[S]

(defined at scala.collection.immutable.IntMap)

def +[S >: T](kv: (IntMapUtils.Int, S)): IntMap[S]

Add a key/value pair to this map, returning a new map.

• kv
  • the key/value pair.
• returns
  • A new map with the new binding added to this map.
• Definition Classes
  • IntMap → Map → MapLike → MapLike → GenMapLike

(defined at scala.collection.immutable.IntMap)

def -(key: IntMapUtils.Int): IntMap[T]

[use case]

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
• Definition Classes
  • IntMap → MapLike → Subtractable → GenMapLike

(defined at scala.collection.immutable.IntMap)

final def apply(key: IntMapUtils.Int): T

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

(defined at scala.collection.immutable.IntMap)

def empty: IntMap[T]

The empty map of the same type as this map

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

(defined at scala.collection.immutable.IntMap)

def filter(f: ((IntMapUtils.Int, T)) ⇒ Boolean): IntMap[T]

Selects all elements of this immutable integer map which satisfy a predicate.

• returns
  • a new immutable integer map consisting of all elements of this immutable integer map that satisfy the given predicate p . The order of the elements is preserved.
• Definition Classes
  • IntMap → TraversableLike → GenTraversableLike

(defined at scala.collection.immutable.IntMap)

final def firstKey: IntMapUtils.Int

The entry with the lowest key value considered in unsigned order.

• Annotations
  • @ tailrec ()

(defined at scala.collection.immutable.IntMap)

final def foreachKey(f: (IntMapUtils.Int) ⇒ Unit): Unit

Loop over the keys of the map. The same as keys.foreach(f) , but may be more efficient.

• f
  • The loop body

(defined at scala.collection.immutable.IntMap)

final def foreachValue(f: (T) ⇒ Unit): Unit

Loop over the values of the map. The same as values.foreach(f) , but may be more efficient.

• f
  • The loop body

(defined at scala.collection.immutable.IntMap)

final def foreach[U](f: ((IntMapUtils.Int, T)) ⇒ U): Unit

Loops over the key, value pairs of the map in unsigned order of the keys.

• 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
  • IntMap → IterableLike → GenericTraversableTemplate → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic

(defined at scala.collection.immutable.IntMap)

final def get(key: IntMapUtils.Int): Option[T]

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

(defined at scala.collection.immutable.IntMap)

final def getOrElse[S >: T](key: IntMapUtils.Int, default: ⇒ S): S

[use case]

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

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

(defined at scala.collection.immutable.IntMap)

def intersectionWith[S, R](that: IntMap[S], f: (IntMapUtils.Int, T, S) ⇒ R): IntMap[R]

Forms the intersection of these two maps with a combining function. The resulting map is a map that has only keys present in both maps and has values produced from the original mappings by combining them with f .

• S
  • The type of values in that .
• R
  • The type of values in the resulting LongMap .
• that
  • The map to intersect with.
• f
  • The combining function.
• returns
  • Intersection of this and that , with values for identical keys produced by function f .

(defined at scala.collection.immutable.IntMap)

def intersection[R](that: IntMap[R]): IntMap[T]

Left biased intersection. Returns the map that has all the same mappings as this but only for keys which are present in the other map.

• R
  • The type of values in that .
• that
  • The map to intersect with.
• returns
  • A map with all the keys both in this and that , mapped to corresponding values from this .

(defined at scala.collection.immutable.IntMap)

def iterator: Iterator[(IntMapUtils.Int, T)]

Iterator over key, value pairs of the map in unsigned order of the keys.

• returns
  • an iterator over pairs of integer keys and corresponding values.
• Definition Classes
  • IntMap → MapLike → IterableLike → GenIterableLike

(defined at scala.collection.immutable.IntMap)

def keysIterator: Iterator[IntMapUtils.Int]

Creates an iterator for all keys.

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

(defined at scala.collection.immutable.IntMap)

final def lastKey: IntMapUtils.Int

The entry with the highest key value considered in unsigned order.

• Annotations
  • @ tailrec ()

(defined at scala.collection.immutable.IntMap)

def modifyOrRemove[S](f: (IntMapUtils.Int, T) ⇒ Option[S]): IntMap[S]

A combined transform and filter function. Returns an IntMap such that for each (key, value) mapping in this map, if f(key, value) == None the map contains no mapping for key, and if f(key, value) .

• S
  • The type of the values in the resulting LongMap .
• f
  • The transforming function.
• returns
  • The modified map.

(defined at scala.collection.immutable.IntMap)

final def size: IntMapUtils.Int

The size of this immutable integer map.

• returns
  • the number of elements in this immutable integer map.
• Definition Classes
  • IntMap → GenTraversableLike → TraversableOnce → GenTraversableOnce

(defined at scala.collection.immutable.IntMap)

def toList: List[(IntMapUtils.Int, T)]

Converts this immutable integer map to a list.

• returns
  • a list containing all elements of this immutable integer map.
• Definition Classes
  • IntMap → TraversableOnce → GenTraversableOnce

(defined at scala.collection.immutable.IntMap)

def transform[S](f: (IntMapUtils.Int, T) ⇒ S): IntMap[S]

(defined at scala.collection.immutable.IntMap)

def unionWith[S >: T](that: IntMap[S], f: (IntMapUtils.Int, S, S) ⇒ S): IntMap[S]

Forms a union map with that map, using the combining function to resolve conflicts.

• S
  • The type of values in that , a supertype of values in this .
• that
  • The map to form a union with.
• f
  • The function used to resolve conflicts between two mappings.
• returns
  • Union of this and that , with identical key conflicts resolved using the function f .

(defined at scala.collection.immutable.IntMap)

def updateWith[S >: T](key: IntMapUtils.Int, value: S, f: (T, S) ⇒ S): IntMap[S]

Updates the map, using the provided function to resolve conflicts if the key is already present.

Equivalent to:

this.get(key) match {
  case None => this.update(key, value)
  case Some(oldvalue) => this.update(key, f(oldvalue, value)
}

• S
  • The supertype of values in this LongMap .
• key
  • The key to update
• value
  • The value to use if there is no conflict
• f
  • The function used to resolve conflicts.
• returns
  • The updated map.

(defined at scala.collection.immutable.IntMap)

def updated[S >: T](key: IntMapUtils.Int, value: S): IntMap[S]

Add a key/value pair to this map.

• key
  • the key
• value
  • the value
• returns
  • A new map with the new binding added to this map
• Definition Classes
  • IntMap → Map → MapLike → MapLike → GenMap

(defined at scala.collection.immutable.IntMap)

Value Members From scala.collection.immutable.Iterable

def companion: GenericCompanion[Iterable]

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

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

(defined at scala.collection.immutable.Iterable)

Value Members From scala.collection.immutable.Map

def seq: Map[IntMapUtils.Int, T]

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

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

• returns
  • a sequential view of the collection.
• Definition Classes
  • Map → Map → GenMap → GenMapLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

(defined at scala.collection.immutable.Map)

def toMap[T, U](implicit ev: <:<[(IntMapUtils.Int, T), (T, U)]): Map[T, U]

Returns this immutable map as an immutable map.

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

• returns
  • a map containing all elements of this immutable map.
• Definition Classes
  • Map → TraversableOnce → GenTraversableOnce
• Annotations
  • @ deprecatedOverriding (message =…, since = “2.11.0”)

(defined at scala.collection.immutable.Map)

def withDefaultValue[B1 >: T](d: B1): Map[IntMapUtils.Int, B1]

The same map with a given default value. Note: 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
  • Map

(defined at scala.collection.immutable.Map)

def withDefault[B1 >: T](d: (IntMapUtils.Int) ⇒ B1): Map[IntMapUtils.Int, B1]

The same map with a given default function. Note: 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
  • Map

(defined at scala.collection.immutable.Map)

Value Members From scala.collection.immutable.MapLike

def ++[B1 >: T](xs: GenTraversableOnce[(IntMapUtils.Int, B1)]): Map[IntMapUtils.Int, B1]

Adds a number of elements provided by a traversable object and returns a new collection with the added elements.

• B1
  • the type of the added values
• xs
  • the traversable object consisting of key-value pairs.
• returns
  • a new immutable map with the bindings of this map and those from xs .
• Definition Classes
  • MapLike → MapLike

(defined at scala.collection.immutable.MapLike)

def +[B1 >: T](elem1: (IntMapUtils.Int, B1), elem2: (IntMapUtils.Int, B1), elems: (IntMapUtils.Int, B1)*): Map[IntMapUtils.Int, B1]

Adds two or more elements to this collection and returns a new collection.

• 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 new bindings added to this map.
• Definition Classes
  • MapLike → MapLike

(defined at scala.collection.immutable.MapLike)

def filterKeys(p: (IntMapUtils.Int) ⇒ Boolean): Map[IntMapUtils.Int, T]

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

(defined at scala.collection.immutable.MapLike)

def keySet: Set[IntMapUtils.Int]

Collects all keys of this map in a set.

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

(defined at scala.collection.immutable.MapLike)

def mapValues[C](f: (T) ⇒ C): Map[IntMapUtils.Int, C]

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

• f
  • the function used to transform values of this map.
• returns
  • a map view which maps every key of this map to f(this(key)) . The resulting map wraps the original map without copying any elements.
• Definition Classes
  • MapLike → MapLike → GenMapLike

(defined at scala.collection.immutable.MapLike)

def parCombiner: Combiner[(IntMapUtils.Int, T), ParMap[IntMapUtils.Int, T]]

The default par implementation uses the combiner provided by this method to create a new parallel collection.

• returns
  • a combiner for the parallel collection of type ParRepr
• Attributes
  • protected[this]
• Definition Classes
  • MapLike → MapLike → TraversableLike → Parallelizable

(defined at scala.collection.immutable.MapLike)

def transform[C, That](f: (IntMapUtils.Int, T) ⇒ C)(implicit bf: CanBuildFrom[IntMap[T], (IntMapUtils.Int, C), That]): That

This function transforms all the values of mappings contained in this map with function f .

• f
  • A function over keys and values
• returns
  • the updated map
• Definition Classes
  • MapLike

(defined at scala.collection.immutable.MapLike)

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

def toParArray: ParArray[T]

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

Full Source:

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

package scala
package collection
package immutable

import scala.collection.generic.{ CanBuildFrom, BitOperations }
import scala.collection.mutable.{ Builder, MapBuilder }
import scala.annotation.tailrec

/** Utility class for integer maps.
 *  @author David MacIver
 */
private[immutable] object IntMapUtils extends BitOperations.Int {
  def branchMask(i: Int, j: Int) = highestOneBit(i ^ j)

  def join[T](p1: Int, t1: IntMap[T], p2: Int, t2: IntMap[T]): IntMap[T] = {
    val m = branchMask(p1, p2)
    val p = mask(p1, m)
    if (zero(p1, m)) IntMap.Bin(p, m, t1, t2)
    else IntMap.Bin(p, m, t2, t1)
  }

  def bin[T](prefix: Int, mask: Int, left: IntMap[T], right: IntMap[T]): IntMap[T] = (left, right) match {
    case (left, IntMap.Nil) => left
    case (IntMap.Nil, right) => right
    case (left, right) => IntMap.Bin(prefix, mask, left, right)
  }
}

import IntMapUtils._

/** A companion object for integer maps.
 *
 *  @define Coll  `IntMap`
 *  @define mapCanBuildFromInfo
 *    The standard `CanBuildFrom` instance for `$Coll` objects.
 *    The created value is an instance of class `MapCanBuildFrom`.
 *  @since 2.7
 */
object IntMap {
  /** $mapCanBuildFromInfo */
  implicit def canBuildFrom[A, B] = new CanBuildFrom[IntMap[A], (Int, B), IntMap[B]] {
    def apply(from: IntMap[A]): Builder[(Int, B), IntMap[B]] = apply()
    def apply(): Builder[(Int, B), IntMap[B]] = new MapBuilder[Int, B, IntMap[B]](empty[B])
  }

  def empty[T] : IntMap[T]  = IntMap.Nil

  def singleton[T](key: Int, value: T): IntMap[T] = IntMap.Tip(key, value)

  def apply[T](elems: (Int, T)*): IntMap[T] =
    elems.foldLeft(empty[T])((x, y) => x.updated(y._1, y._2))

  private[immutable] case object Nil extends IntMap[Nothing] {
    // Important! Without this equals method in place, an infinite
    // loop from Map.equals => size => pattern-match-on-Nil => equals
    // develops.  Case objects and custom equality don't mix without
    // careful handling.
    override def equals(that : Any) = that match {
      case _: this.type => true
      case _: IntMap[_] => false // The only empty IntMaps are eq Nil
      case _            => super.equals(that)
    }
  }

  private[immutable] case class Tip[+T](key: Int, value: T) extends IntMap[T]{
    def withValue[S](s: S) =
      if (s.asInstanceOf[AnyRef] eq value.asInstanceOf[AnyRef]) this.asInstanceOf[IntMap.Tip[S]]
      else IntMap.Tip(key, s)
  }
  private[immutable] case class Bin[+T](prefix: Int, mask: Int, left: IntMap[T], right: IntMap[T]) extends IntMap[T] {
    def bin[S](left: IntMap[S], right: IntMap[S]): IntMap[S] = {
      if ((this.left eq left) && (this.right eq right)) this.asInstanceOf[IntMap.Bin[S]]
      else IntMap.Bin[S](prefix, mask, left, right)
    }
  }

}

import IntMap._

// Iterator over a non-empty IntMap.
private[immutable] abstract class IntMapIterator[V, T](it: IntMap[V]) extends AbstractIterator[T] {

  // Basically this uses a simple stack to emulate conversion over the tree. However
  // because we know that Ints are at least 32 bits we can have at most 32 IntMap.Bins and
  // one IntMap.Tip sitting on the tree at any point. Therefore we know the maximum stack
  // depth is 33 and
  var index = 0
  var buffer = new Array[AnyRef](33)

  def pop = {
    index -= 1
    buffer(index).asInstanceOf[IntMap[V]]
  }

  def push(x: IntMap[V]) {
    buffer(index) = x.asInstanceOf[AnyRef]
    index += 1
  }
  push(it)

  /**
   * What value do we assign to a tip?
   */
  def valueOf(tip: IntMap.Tip[V]): T

  def hasNext = index != 0
  final def next: T =
    pop match {
      case IntMap.Bin(_,_, t@IntMap.Tip(_, _), right) => {
        push(right)
        valueOf(t)
      }
      case IntMap.Bin(_, _, left, right) => {
        push(right)
        push(left)
        next
      }
      case t@IntMap.Tip(_, _) => valueOf(t)
      // This should never happen. We don't allow IntMap.Nil in subtrees of the IntMap
      // and don't return an IntMapIterator for IntMap.Nil.
      case IntMap.Nil => sys.error("Empty maps not allowed as subtrees")
    }
}

private[immutable] class IntMapEntryIterator[V](it: IntMap[V]) extends IntMapIterator[V, (Int, V)](it) {
  def valueOf(tip: IntMap.Tip[V]) = (tip.key, tip.value)
}

private[immutable] class IntMapValueIterator[V](it: IntMap[V]) extends IntMapIterator[V, V](it) {
  def valueOf(tip: IntMap.Tip[V]) = tip.value
}

private[immutable] class IntMapKeyIterator[V](it: IntMap[V]) extends IntMapIterator[V, Int](it) {
  def valueOf(tip: IntMap.Tip[V]) = tip.key
}

import IntMap._

/** Specialised immutable map structure for integer keys, based on
 *  [[http://ittc.ku.edu/~andygill/papers/IntMap98.pdf Fast Mergeable Integer Maps]]
 *  by Okasaki and Gill. Essentially a trie based on binary digits of the integers.
 *
 *  '''Note:''' This class is as of 2.8 largely superseded by HashMap.
 *
 *  @tparam T    type of the values associated with integer keys.
 *
 *  @since 2.7
 *  @define Coll `immutable.IntMap`
 *  @define coll immutable integer map
 *  @define mayNotTerminateInf
 *  @define willNotTerminateInf
 */
sealed abstract class IntMap[+T] extends AbstractMap[Int, T]
   with Map[Int, T]
   with MapLike[Int, T, IntMap[T]] {

  override def empty: IntMap[T] = IntMap.Nil

  override def toList = {
    val buffer = new scala.collection.mutable.ListBuffer[(Int, T)]
    foreach(buffer += _)
    buffer.toList
  }

  /**
   * Iterator over key, value pairs of the map in unsigned order of the keys.
   *
   * @return an iterator over pairs of integer keys and corresponding values.
   */
  def iterator: Iterator[(Int, T)] = this match {
    case IntMap.Nil => Iterator.empty
    case _ => new IntMapEntryIterator(this)
  }

  /**
   * Loops over the key, value pairs of the map in unsigned order of the keys.
   */
  override final def foreach[U](f: ((Int, T)) => U): Unit = this match {
    case IntMap.Bin(_, _, left, right) => { left.foreach(f); right.foreach(f) }
    case IntMap.Tip(key, value) => f((key, value))
    case IntMap.Nil =>
  }

  override def keysIterator: Iterator[Int] = this match {
    case IntMap.Nil => Iterator.empty
    case _ => new IntMapKeyIterator(this)
  }

  /**
   * Loop over the keys of the map. The same as `keys.foreach(f)`, but may
   * be more efficient.
   *
   * @param f The loop body
   */
  final def foreachKey(f: Int => Unit): Unit = this match {
    case IntMap.Bin(_, _, left, right) => { left.foreachKey(f); right.foreachKey(f) }
    case IntMap.Tip(key, _) => f(key)
    case IntMap.Nil =>
  }

  override def valuesIterator: Iterator[T] = this match {
    case IntMap.Nil => Iterator.empty
    case _ => new IntMapValueIterator(this)
  }

  /**
   * Loop over the values of the map. The same as `values.foreach(f)`, but may
   * be more efficient.
   *
   * @param f The loop body
   */
  final def foreachValue(f: T => Unit): Unit = this match {
    case IntMap.Bin(_, _, left, right) => { left.foreachValue(f); right.foreachValue(f) }
    case IntMap.Tip(_, value) => f(value)
    case IntMap.Nil =>
  }

  override def stringPrefix = "IntMap"

  override def isEmpty = this == IntMap.Nil

  override def filter(f: ((Int, T)) => Boolean): IntMap[T] = this match {
    case IntMap.Bin(prefix, mask, left, right) => {
      val (newleft, newright) = (left.filter(f), right.filter(f))
      if ((left eq newleft) && (right eq newright)) this
      else bin(prefix, mask, newleft, newright)
    }
    case IntMap.Tip(key, value) =>
      if (f((key, value))) this
      else IntMap.Nil
    case IntMap.Nil => IntMap.Nil
  }

  def transform[S](f: (Int, T) => S): IntMap[S] = this match {
    case b@IntMap.Bin(prefix, mask, left, right) => b.bin(left.transform(f), right.transform(f))
    case t@IntMap.Tip(key, value) => t.withValue(f(key, value))
    case IntMap.Nil => IntMap.Nil
  }

  final override def size: Int = this match {
    case IntMap.Nil => 0
    case IntMap.Tip(_, _) => 1
    case IntMap.Bin(_, _, left, right) => left.size + right.size
  }

  final def get(key: Int): Option[T] = this match {
    case IntMap.Bin(prefix, mask, left, right) => if (zero(key, mask)) left.get(key) else right.get(key)
    case IntMap.Tip(key2, value) => if (key == key2) Some(value) else None
    case IntMap.Nil => None
  }

  final override def getOrElse[S >: T](key: Int, default: => S): S = this match {
    case IntMap.Nil => default
    case IntMap.Tip(key2, value) => if (key == key2) value else default
    case IntMap.Bin(prefix, mask, left, right) =>
      if (zero(key, mask)) left.getOrElse(key, default) else right.getOrElse(key, default)
  }

  final override def apply(key: Int): T = this match {
    case IntMap.Bin(prefix, mask, left, right) => if (zero(key, mask)) left(key) else right(key)
    case IntMap.Tip(key2, value) => if (key == key2) value else sys.error("Key not found")
    case IntMap.Nil => sys.error("key not found")
  }

  def + [S >: T] (kv: (Int, S)): IntMap[S] = updated(kv._1, kv._2)

  override def updated[S >: T](key: Int, value: S): IntMap[S] = this match {
    case IntMap.Bin(prefix, mask, left, right) =>
      if (!hasMatch(key, prefix, mask)) join(key, IntMap.Tip(key, value), prefix, this)
      else if (zero(key, mask)) IntMap.Bin(prefix, mask, left.updated(key, value), right)
      else IntMap.Bin(prefix, mask, left, right.updated(key, value))
    case IntMap.Tip(key2, value2) =>
      if (key == key2) IntMap.Tip(key, value)
      else join(key, IntMap.Tip(key, value), key2, this)
    case IntMap.Nil => IntMap.Tip(key, value)
  }

  /**
   * Updates the map, using the provided function to resolve conflicts if the key is already present.
   *
   * Equivalent to:
   * {{{
   *   this.get(key) match {
   *     case None => this.update(key, value)
   *     case Some(oldvalue) => this.update(key, f(oldvalue, value)
   *   }
   * }}}
   *
   * @tparam S     The supertype of values in this `LongMap`.
   * @param key    The key to update
   * @param value  The value to use if there is no conflict
   * @param f      The function used to resolve conflicts.
   * @return       The updated map.
   */
  def updateWith[S >: T](key: Int, value: S, f: (T, S) => S): IntMap[S] = this match {
    case IntMap.Bin(prefix, mask, left, right) =>
      if (!hasMatch(key, prefix, mask)) join(key, IntMap.Tip(key, value), prefix, this)
      else if (zero(key, mask)) IntMap.Bin(prefix, mask, left.updateWith(key, value, f), right)
      else IntMap.Bin(prefix, mask, left, right.updateWith(key, value, f))
    case IntMap.Tip(key2, value2) =>
      if (key == key2) IntMap.Tip(key, f(value2, value))
      else join(key, IntMap.Tip(key, value), key2, this)
    case IntMap.Nil => IntMap.Tip(key, value)
  }

  def - (key: Int): IntMap[T] = this match {
    case IntMap.Bin(prefix, mask, left, right) =>
      if (!hasMatch(key, prefix, mask)) this
      else if (zero(key, mask)) bin(prefix, mask, left - key, right)
      else bin(prefix, mask, left, right - key)
    case IntMap.Tip(key2, _) =>
      if (key == key2) IntMap.Nil
      else this
    case IntMap.Nil => IntMap.Nil
  }

  /**
   * A combined transform and filter function. Returns an `IntMap` such that
   * for each `(key, value)` mapping in this map, if `f(key, value) == None`
   * the map contains no mapping for key, and if `f(key, value)`.
   *
   * @tparam S  The type of the values in the resulting `LongMap`.
   * @param f   The transforming function.
   * @return    The modified map.
   */
  def modifyOrRemove[S](f: (Int, T) => Option[S]): IntMap[S] = this match {
    case IntMap.Bin(prefix, mask, left, right) =>
      val newleft = left.modifyOrRemove(f)
      val newright = right.modifyOrRemove(f)
      if ((left eq newleft) && (right eq newright)) this.asInstanceOf[IntMap[S]]
      else bin(prefix, mask, newleft, newright)
    case IntMap.Tip(key, value) => f(key, value) match {
      case None =>
        IntMap.Nil
      case Some(value2) =>
        //hack to preserve sharing
        if (value.asInstanceOf[AnyRef] eq value2.asInstanceOf[AnyRef]) this.asInstanceOf[IntMap[S]]
        else IntMap.Tip(key, value2)
      }
    case IntMap.Nil =>
      IntMap.Nil
  }

  /**
   * Forms a union map with that map, using the combining function to resolve conflicts.
   *
   * @tparam S      The type of values in `that`, a supertype of values in `this`.
   * @param that    The map to form a union with.
   * @param f       The function used to resolve conflicts between two mappings.
   * @return        Union of `this` and `that`, with identical key conflicts resolved using the function `f`.
   */
  def unionWith[S >: T](that: IntMap[S], f: (Int, S, S) => S): IntMap[S] = (this, that) match{
    case (IntMap.Bin(p1, m1, l1, r1), that@(IntMap.Bin(p2, m2, l2, r2))) =>
      if (shorter(m1, m2)) {
        if (!hasMatch(p2, p1, m1)) join[S](p1, this, p2, that) // TODO: remove [S] when SI-5548 is fixed
        else if (zero(p2, m1)) IntMap.Bin(p1, m1, l1.unionWith(that, f), r1)
        else IntMap.Bin(p1, m1, l1, r1.unionWith(that, f))
      } else if (shorter(m2, m1)){
        if (!hasMatch(p1, p2, m2)) join[S](p1, this, p2, that) // TODO: remove [S] when SI-5548 is fixed
        else if (zero(p1, m2)) IntMap.Bin(p2, m2, this.unionWith(l2, f), r2)
        else IntMap.Bin(p2, m2, l2, this.unionWith(r2, f))
      }
      else {
        if (p1 == p2) IntMap.Bin(p1, m1, l1.unionWith(l2,f), r1.unionWith(r2, f))
        else join[S](p1, this, p2, that) // TODO: remove [S] when SI-5548 is fixed
      }
    case (IntMap.Tip(key, value), x) => x.updateWith[S](key, value, (x, y) => f(key, y, x))
    case (x, IntMap.Tip(key, value)) => x.updateWith[S](key, value, (x, y) => f(key, x, y))
    case (IntMap.Nil, x) => x
    case (x, IntMap.Nil) => x
  }

  /**
   * Forms the intersection of these two maps with a combining function. The
   * resulting map is a map that has only keys present in both maps and has
   * values produced from the original mappings by combining them with `f`.
   *
   * @tparam S      The type of values in `that`.
   * @tparam R      The type of values in the resulting `LongMap`.
   * @param that    The map to intersect with.
   * @param f       The combining function.
   * @return        Intersection of `this` and `that`, with values for identical keys produced by function `f`.
   */
  def intersectionWith[S, R](that: IntMap[S], f: (Int, T, S) => R): IntMap[R] = (this, that) match {
    case (IntMap.Bin(p1, m1, l1, r1), that@IntMap.Bin(p2, m2, l2, r2)) =>
      if (shorter(m1, m2)) {
        if (!hasMatch(p2, p1, m1)) IntMap.Nil
        else if (zero(p2, m1)) l1.intersectionWith(that, f)
        else r1.intersectionWith(that, f)
      } else if (m1 == m2) bin(p1, m1, l1.intersectionWith(l2, f), r1.intersectionWith(r2, f))
        else {
        if (!hasMatch(p1, p2, m2)) IntMap.Nil
        else if (zero(p1, m2)) this.intersectionWith(l2, f)
        else this.intersectionWith(r2, f)
      }
    case (IntMap.Tip(key, value), that) => that.get(key) match {
      case None => IntMap.Nil
      case Some(value2) => IntMap.Tip(key, f(key, value, value2))
    }
    case (_, IntMap.Tip(key, value)) => this.get(key) match {
      case None => IntMap.Nil
      case Some(value2) => IntMap.Tip(key, f(key, value2, value))
    }
    case (_, _) => IntMap.Nil
  }

  /**
   * Left biased intersection. Returns the map that has all the same mappings
   * as this but only for keys which are present in the other map.
   *
   * @tparam R      The type of values in `that`.
   * @param that    The map to intersect with.
   * @return        A map with all the keys both in `this` and `that`, mapped to corresponding values from `this`.
   */
  def intersection[R](that: IntMap[R]): IntMap[T] =
    this.intersectionWith(that, (key: Int, value: T, value2: R) => value)

  def ++[S >: T](that: IntMap[S]) =
    this.unionWith[S](that, (key, x, y) => y)

  /**
   * The entry with the lowest key value considered in unsigned order.
   */
  @tailrec
  final def firstKey: Int = this match {
    case Bin(_, _, l, r) => l.firstKey
    case Tip(k, v) => k
    case IntMap.Nil => sys.error("Empty set")
  }

  /**
   * The entry with the highest key value considered in unsigned order.
   */
  @tailrec
  final def lastKey: Int = this match {
    case Bin(_, _, l, r) => r.lastKey
    case Tip(k, v) => k
    case IntMap.Nil => sys.error("Empty set")
  }
}