OpenHashMap

@deprecated("Use HashMap or one of the specialized versions (LongMap, AnyRefMap) instead of OpenHashMap", "2.13.0")
class OpenHashMap[Key, Value](initialSize: Int) extends AbstractMap[Key, Value] with MapOps[Key, Value, OpenHashMap, OpenHashMap[Key, Value]] with StrictOptimizedIterableOps[(Key, Value), Iterable, OpenHashMap[Key, Value]] with MapFactoryDefaults[Key, Value, OpenHashMap, Iterable] with DefaultSerializable

A mutable hash map based on an open addressing method. The precise scheme is undefined, but it should make a reasonable effort to ensure that an insert with consecutive hash codes is not unnecessarily penalised. In particular, mappings of consecutive integer keys should work without significant performance loss.

Type parameters:
Key

type of the keys in this map.

Value

type of the values in this map.

Value parameters:
initialSize

the initial size of the internal hash table.

Companion:
object
Deprecated
Source:
OpenHashMap.scala
trait StrictOptimizedIterableOps[(Key, Value), Iterable, OpenHashMap[Key, Value]]
class AbstractMap[Key, Value]
trait Map[Key, Value]
trait MapOps[Key, Value, OpenHashMap, OpenHashMap[Key, Value]]
trait Shrinkable[Key]
trait Builder[(Key, Value), OpenHashMap[Key, Value]]
trait Growable[(Key, Value)]
trait Clearable
trait Cloneable[OpenHashMap[Key, Value]]
trait Cloneable
trait Iterable[(Key, Value)]
class AbstractMap[Key, Value]
trait Map[Key, Value]
trait Equals
trait MapOps[Key, Value, OpenHashMap, OpenHashMap[Key, Value]]
trait PartialFunction[Key, Value]
trait Key => Value
class AbstractIterable[(Key, Value)]
trait Iterable[(Key, Value)]
trait IterableFactoryDefaults[(Key, Value), Iterable]
trait IterableOps[(Key, Value), Iterable, OpenHashMap[Key, Value]]
trait IterableOnceOps[(Key, Value), Iterable, OpenHashMap[Key, Value]]
trait IterableOnce[(Key, Value)]
class Object
trait Matchable
class Any

Value members

Constructors

def this()

A default constructor creates a hashmap with initial size 8.

A default constructor creates a hashmap with initial size 8.

Source:
OpenHashMap.scala

Concrete methods

@deprecatedOverriding("addOne should not be overridden in order to maintain consistency with put.", "2.11.0")
def addOne(kv: (Key, Value)): OpenHashMap[Key, Value]
override def clone(): OpenHashMap[Key, Value]
Definition Classes
Source:
OpenHashMap.scala
override def filterInPlace(f: (Key, Value) => Boolean): OpenHashMap[Key, Value]
Definition Classes
Source:
OpenHashMap.scala
override def foreach[U](f: ((Key, Value)) => U): Unit

Loop over the key, value mappings of this map.

Loop over the key, value mappings of this map.

The behaviour of modifying the map during an iteration is as follows: - Deleting a mapping is always permitted. - Changing the value of mapping which is already present is permitted. - Anything else is not permitted. It will usually, but not always, throw an exception.

Type parameters:
U

The return type of the specified function f, return result of which is ignored.

Value parameters:
f

The function to apply to each key, value mapping.

Definition Classes
Source:
OpenHashMap.scala
override def foreachEntry[U](f: (Key, Value) => U): Unit
Definition Classes
Source:
OpenHashMap.scala
def get(key: Key): Option[Value]
override def isEmpty: Boolean
Definition Classes
Source:
OpenHashMap.scala
def iterator: Iterator[(Key, Value)]

An iterator over the elements of this map.

An iterator over the elements of this map. Use of this iterator follows the same contract for concurrent modification as the foreach method.

Returns:

the iterator

Source:
OpenHashMap.scala
override def keysIterator: Iterator[Key]
Definition Classes
Source:
OpenHashMap.scala
override def knownSize: Int
Definition Classes
Source:
OpenHashMap.scala
Definition Classes
Map -> Map -> MapOps
Source:
OpenHashMap.scala
override def mapValuesInPlace(f: (Key, Value) => Value): OpenHashMap[Key, Value]
Definition Classes
Source:
OpenHashMap.scala
override def put(key: Key, value: Value): Option[Value]
Definition Classes
Source:
OpenHashMap.scala
override def remove(key: Key): Option[Value]
Definition Classes
Source:
OpenHashMap.scala
override def size: Int
Definition Classes
Source:
OpenHashMap.scala
@deprecatedOverriding("subtractOne should not be overridden in order to maintain consistency with remove.", "2.11.0")
def subtractOne(key: Key): OpenHashMap[Key, Value]
override def update(key: Key, value: Value): Unit
Definition Classes
Source:
OpenHashMap.scala
override def valuesIterator: Iterator[Value]
Definition Classes
Source:
OpenHashMap.scala

Inherited methods

final def ++[B >: (Key, Value)](suffix: IterableOnce[B]): Iterable[B]

Alias for concat

Alias for concat

Inherited from:
IterableOps
Source:
Iterable.scala
def ++[V2 >: Value](xs: IterableOnce[(Key, V2)]): OpenHashMap[Key, V2]

Alias for concat

Alias for concat

Inherited from:
MapOps
Source:
Map.scala
final def ++=(xs: IterableOnce[(Key, Value)]): OpenHashMap[Key, Value]

Alias for addAll

Alias for addAll

Inherited from:
Growable
Source:
Growable.scala
final def +=(elem: (Key, Value)): OpenHashMap[Key, Value]

Alias for addOne

Alias for addOne

Inherited from:
Growable
Source:
Growable.scala
final def --=(xs: IterableOnce[Key]): OpenHashMap[Key, Value]

Alias for subtractAll

Alias for subtractAll

Inherited from:
Shrinkable
Source:
Shrinkable.scala
final def -=(elem: Key): OpenHashMap[Key, Value]

Alias for subtractOne

Alias for subtractOne

Inherited from:
Shrinkable
Source:
Shrinkable.scala
def addAll(xs: IterableOnce[(Key, Value)]): OpenHashMap[Key, Value]

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

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

Value parameters:
xs

the IterableOnce producing the elements to add.

Returns:

the growable collection itself.

Inherited from:
Growable
Source:
Growable.scala

Appends all elements of this collection to a string builder.

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

Example:

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

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

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

the string builder to which elements are appended.

Returns:

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala

Appends all elements of this collection to a string builder using a separator string.

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

Example:

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

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

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

the string builder to which elements are appended.

sep

the separator string.

Returns:

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder
Definition Classes
Inherited from:
MapOps
Source:
Map.scala
def andThen[C](k: PartialFunction[Value, C]): PartialFunction[Key, C]

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

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

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters:
C

the result type of the transformation function.

Value parameters:
k

the transformation function

Returns:

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

Inherited from:
PartialFunction
Source:
PartialFunction.scala
override def andThen[C](k: Value => C): PartialFunction[Key, C]

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

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

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

Type parameters:
C

the result type of the transformation function.

Value parameters:
k

the transformation function

Returns:

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

Definition Classes
Inherited from:
PartialFunction
Source:
PartialFunction.scala
@throws(scala.throws.$lessinit$greater$default$1[scala.NoSuchElementException])
def apply(key: Key): Value

Retrieves the value which is associated with the given key.

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

Value parameters:
key

the key

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
override def applyOrElse[K1 <: Key, V1 >: Value](x: K1, default: K1 => V1): V1
Definition Classes
Inherited from:
MapOps
Source:
Map.scala
def canEqual(that: Any): Boolean
Inherited from:
Map
Source:
Map.scala
def clear(): Unit
Inherited from:
MapOps
Source:
Map.scala
def collect[K2, V2](pf: PartialFunction[(Key, Value), (K2, V2)]): OpenHashMap[K2, V2]

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

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

Type parameters:
K2

the key type of the returned map.

V2

the value type of the returned map.

Value parameters:
pf

the partial function which filters and maps the map.

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
def collectFirst[B](pf: PartialFunction[(Key, Value), B]): Option[B]

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

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

Note: may not terminate for infinite-sized collections.

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

Value parameters:
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.

Example:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def compose[R](k: PartialFunction[R, Key]): PartialFunction[R, Value]

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

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

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.

Type parameters:
R

the parameter type of the transformation function.

Value parameters:
k

the transformation function

Returns:

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

Inherited from:
PartialFunction
Source:
PartialFunction.scala
def compose[A](g: A => Key): A => Value

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

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

Type parameters:
A

the type to which function g can be applied

Value parameters:
g

a function A => T1

Returns:

a new function f such that f(x) == apply(g(x))

Inherited from:
Function1
Source:
Function1.scala
def concat[B >: (Key, Value)](suffix: IterableOnce[B]): Iterable[B]

Returns a new iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand.

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

Type parameters:
B

the element type of the returned collection.

Value parameters:
suffix

the traversable to append.

Returns:

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

Inherited from:
IterableOps
Source:
Iterable.scala
def concat[V2 >: Value](suffix: IterableOnce[(Key, V2)]): OpenHashMap[Key, V2]

Returns a new map containing the elements from the left hand operand followed by the elements from the right hand operand.

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

Value parameters:
suffix

the traversable to append.

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
def contains(key: Key): Boolean

Tests whether this map contains a binding for a key.

Tests whether this map contains a binding for a key.

Value parameters:
key

the key

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
def copyToArray[B >: (Key, Value)](xs: Array[B], start: Int, len: Int): Int

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

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

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

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

Type parameters:
B

the type of the elements of the array.

Value parameters:
len

the maximal number of elements to copy.

start

the starting index of xs.

xs

the array to fill.

Returns:

the number of elements written to the array

Note:

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: (Key, Value)](xs: Array[B], start: Int): Int

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

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

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

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

Type parameters:
B

the type of the elements of the array.

Value parameters:
start

the starting index of xs.

xs

the array to fill.

Returns:

the number of elements written to the array

Note:

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: (Key, Value)](xs: Array[B]): Int

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

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

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

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

Type parameters:
B

the type of the elements of the array.

Value parameters:
xs

the array to fill.

Returns:

the number of elements written to the array

Note:

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def corresponds[B](that: IterableOnce[B])(p: ((Key, Value), B) => Boolean): Boolean

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

the type of the elements of that

Value parameters:
p

the test predicate, which relates elements from both collections

that

the other collection

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def count(p: ((Key, Value)) => Boolean): Int

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

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

Note: will not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

the number of elements satisfying the predicate p.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@throws(scala.throws.$lessinit$greater$default$1[scala.NoSuchElementException])
def default(key: Key): Value

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

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

Value parameters:
key

the given key value for which a binding is missing.

Inherited from:
MapOps
Source:
Map.scala
def drop(n: Int): OpenHashMap[Key, Value]
Inherited from:
IterableOps
Source:
Iterable.scala
override def dropRight(n: Int): OpenHashMap[Key, Value]

The rest of the collection without its n last elements.

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

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

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source:
StrictOptimizedIterableOps.scala
def dropWhile(p: ((Key, Value)) => Boolean): OpenHashMap[Key, Value]
Inherited from:
IterableOps
Source:
Iterable.scala

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

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

Example:

val firstChar: String => Option[Char] = _.headOption
Seq("foo", "bar", "baz") match {
  case firstChar.unlift.elementWise(c0, c1, c2) =>
    println(s"$c0, $c1, $c2") // Output: f, b, b
}
Inherited from:
PartialFunction
Source:
PartialFunction.scala
override def empty: OpenHashMap[Key, Value]
Definition Classes
Inherited from:
MapFactoryDefaults
Source:
Iterable.scala
override def equals(o: Any): Boolean

Equality of maps is implemented using the lookup method get.

Equality of maps is implemented using the lookup method get. This method returns true if

  • the argument o is a Map,

  • the two maps have the same size, and

  • for every (key, value) pair in this map, other.get(key) == Some(value).

The implementation of equals checks the canEqual method, so subclasses of Map can narrow down the equality to specific map types. The Map implementations in the standard library can all be compared, their canEqual methods return true.

Note: The equals method only respects the equality laws (symmetry, transitivity) if the two maps use the same key equivalence function in their lookup operation. For example, the key equivalence operation in a scala.collection.immutable.TreeMap is defined by its ordering. Comparing a TreeMap with a HashMap leads to unexpected results if ordering.equiv(k1, k2) (used for lookup in TreeMap) is different from k1 == k2 (used for lookup in HashMap).

scala> import scala.collection.immutable._
scala> val ord: Ordering[String] = _ compareToIgnoreCase _

scala> TreeMap("A" -> 1)(ord) == HashMap("a" -> 1)
val res0: Boolean = false

scala> HashMap("a" -> 1) == TreeMap("A" -> 1)(ord)
val res1: Boolean = true
Value parameters:
o

The map to which this map is compared

Returns:

true if the two maps are equal according to the description

Definition Classes
Map -> Equals -> Any
Inherited from:
Map
Source:
Map.scala
def exists(p: ((Key, Value)) => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override def filter(pred: ((Key, Value)) => Boolean): OpenHashMap[Key, Value]
override def filterNot(pred: ((Key, Value)) => Boolean): OpenHashMap[Key, Value]
def find(p: ((Key, Value)) => Boolean): Option[(Key, Value)]

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

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

Note: may not terminate for infinite-sized collections.

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

Value parameters:
p

the predicate used to test elements.

Returns:

an option value containing the first element in the collection that satisfies p, or None if none exists.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override def flatMap[B](f: ((Key, Value)) => IterableOnce[B]): Iterable[B]
def flatMap[K2, V2](f: ((Key, Value)) => IterableOnce[(K2, V2)]): OpenHashMap[K2, V2]

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

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

Value parameters:
f

the function to apply to each element.

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
override def flatten[B](implicit toIterableOnce: ((Key, Value)) => IterableOnce[B]): Iterable[B]
def fold[A1 >: (Key, Value)](z: A1)(op: (A1, A1) => A1): A1

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

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
A1

a type parameter for the binary operator, a supertype of A.

Value parameters:
op

a binary operator that must be associative.

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

Returns:

the result of applying the fold operator op between all the elements and z, or z if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def foldLeft[B](z: B)(op: (B, (Key, Value)) => B): B

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

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

Note: will not terminate for infinite-sized collections.

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

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

z

the start value.

Returns:

the result of inserting op between consecutive elements of this collection, going left to right with the start value z on the left: op(...op(z, x1), x2, ..., xn) where x1, ..., xn are the elements of this collection. Returns z if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def foldRight[B](z: B)(op: ((Key, Value), B) => B): B

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

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

Note: will not terminate for infinite-sized collections.

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

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

z

the start value.

Returns:

the result of inserting op between consecutive elements of this collection, going right to left with the start value z on the right: op(x1, op(x2, ... op(xn, z)...)) where x1, ..., xn are the elements of this collection. Returns z if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def forall(p: ((Key, Value)) => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters:
p

the predicate used to test elements.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override protected def fromSpecific(coll: IterableOnce[(Key, Value)]): OpenHashMap[Key, Value]
Definition Classes
Inherited from:
MapFactoryDefaults
Source:
Iterable.scala
def getOrElse[V1 >: Value](key: Key, default: => V1): V1

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

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

Type parameters:
V1

the result type of the default computation.

Value parameters:
default

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

key

the key.

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
def getOrElseUpdate(key: Key, op: => Value): Value

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

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

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

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

Value parameters:
key

the key to test

op

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

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
def groupBy[K](f: ((Key, Value)) => K): Map[K, OpenHashMap[Key, Value]]

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

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

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

Type parameters:
K

the type of keys returned by the discriminator function.

Value parameters:
f

the discriminator function.

Returns:

A map from keys to iterable collections such that the following invariant holds:

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

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

Inherited from:
IterableOps
Source:
Iterable.scala
def groupMap[K, B](key: ((Key, Value)) => K)(f: ((Key, Value)) => B): Map[K, Iterable[B]]

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

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

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

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

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

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

Type parameters:
B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function

Value parameters:
f

the element transformation function

key

the discriminator function

Inherited from:
IterableOps
Source:
Iterable.scala
def groupMapReduce[K, B](key: ((Key, Value)) => K)(f: ((Key, Value)) => B)(reduce: (B, B) => B): Map[K, B]

Partitions this iterable collection into a map according to a discriminator function key.

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

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

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

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

Inherited from:
IterableOps
Source:
Iterable.scala
def grouped(size: Int): Iterator[OpenHashMap[Key, Value]]

Partitions elements in fixed size iterable collections.

Partitions elements in fixed size iterable collections.

Value parameters:
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.

See also:
Inherited from:
IterableOps
Source:
Iterable.scala
override def hashCode(): Int
Definition Classes
Map -> Any
Inherited from:
Map
Source:
Map.scala
def head: (Key, Value)

Selects the first element of this iterable collection.

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.

Throws:
NoSuchElementException

if the iterable collection is empty.

Inherited from:
IterableOps
Source:
Iterable.scala
def headOption: Option[(Key, Value)]

Optionally selects the first element.

Optionally selects the first element.

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

Returns:

the first element of this iterable collection if it is nonempty, None if it is empty.

Inherited from:
IterableOps
Source:
Iterable.scala
def init: OpenHashMap[Key, Value]

The initial part of the collection without its last element.

The initial part of the collection without its last element.

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

Inherited from:
IterableOps
Source:
Iterable.scala
def inits: Iterator[OpenHashMap[Key, Value]]

Iterates over the inits of this iterable collection.

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

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

Returns:

an iterator over all the inits of this iterable collection

Example:

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

Inherited from:
IterableOps
Source:
Iterable.scala
def isDefinedAt(key: Key): Boolean

Tests whether this map contains a binding for a key.

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

Value parameters:
key

the key

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
Definition Classes
Inherited from:
IterableOps
Source:
Iterable.scala
Definition Classes
Inherited from:
Iterable
Source:
Iterable.scala
def keySet: Set[Key]

Collects all keys of this map in a set.

Collects all keys of this map in a set.

Returns:

a set containing all keys of this map.

Inherited from:
MapOps
Source:
Map.scala
def keyStepper[S <: Stepper[_]](implicit shape: StepperShape[Key, S]): S

Returns a Stepper for the keys of this map.

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

Inherited from:
MapOps
Source:
Map.scala
def keys: Iterable[Key]

Collects all keys of this map in an iterable collection.

Collects all keys of this map in an iterable collection.

Returns:

the keys of this map as an iterable.

Inherited from:
MapOps
Source:
Map.scala
def last: (Key, Value)

Selects the last element.

Selects the last element.

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

Returns:

The last element of this iterable collection.

Throws:
NoSuchElementException

If the iterable collection is empty.

Inherited from:
IterableOps
Source:
Iterable.scala
def lastOption: Option[(Key, Value)]

Optionally selects the last element.

Optionally selects the last element.

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

Returns:

the last element of this iterable collection$ if it is nonempty, None if it is empty.

Inherited from:
IterableOps
Source:
Iterable.scala
def lazyZip[B](that: Iterable[B]): LazyZip2[(Key, Value), B, OpenHashMap[Key, Value]]

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

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

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

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

the type of the second element in each eventual pair

Value parameters:
that

the iterable providing the second element of each eventual pair

Returns:

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

Inherited from:
Iterable
Source:
Iterable.scala
def lift: Key => Option[Value]

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

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.

See also:

Function.unlift

Inherited from:
PartialFunction
Source:
PartialFunction.scala
override def map[B](f: ((Key, Value)) => B): Iterable[B]
def map[K2, V2](f: ((Key, Value)) => (K2, V2)): OpenHashMap[K2, V2]

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

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

Value parameters:
f

the function to apply to each element.

Returns:

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

Inherited from:
MapOps
Source:
Map.scala
def mapResult[NewTo](f: OpenHashMap[Key, Value] => NewTo): Builder[(Key, Value), NewTo]

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

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

Inherited from:
Builder
Source:
Builder.scala
def max[B >: (Key, Value)](implicit ord: Ordering[B]): (Key, Value)

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

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

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def maxBy[B](f: ((Key, Value)) => B)(implicit cmp: Ordering[B]): (Key, Value)

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

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

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def maxByOption[B](f: ((Key, Value)) => B)(implicit cmp: Ordering[B]): Option[(Key, Value)]

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def maxOption[B >: (Key, Value)](implicit ord: Ordering[B]): Option[(Key, Value)]

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def min[B >: (Key, Value)](implicit ord: Ordering[B]): (Key, Value)

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

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

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def minBy[B](f: ((Key, Value)) => B)(implicit cmp: Ordering[B]): (Key, Value)

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

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

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def minByOption[B](f: ((Key, Value)) => B)(implicit cmp: Ordering[B]): Option[(Key, Value)]

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

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

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The result type of the function f.

Value parameters:
cmp

An ordering to be used for comparing elements.

f

The measuring function.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def minOption[B >: (Key, Value)](implicit ord: Ordering[B]): Option[(Key, Value)]

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

The type over which the ordering is defined.

Value parameters:
ord

An ordering to be used for comparing elements.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def mkString: String

Displays all elements of this collection in a string.

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def mkString(sep: String): String

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

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

Delegates to addString, which can be overridden.

Value parameters:
sep

the separator string.

Returns:

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

Example:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def mkString(start: String, sep: String, end: String): String

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

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

Delegates to addString, which can be overridden.

Value parameters:
end

the ending string.

sep

the separator string.

start

the starting string.

Returns:

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

Example:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override protected def newSpecificBuilder: Builder[(Key, Value), OpenHashMap[Key, Value]]
Definition Classes
Inherited from:
MapFactoryDefaults
Source:
Iterable.scala
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

Tests whether the collection is not empty.

Tests whether the collection is not empty.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def orElse[A1 <: Key, B1 >: Value](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

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

Type parameters:
A1

the argument type of the fallback function

B1

the result type of the fallback function

Value parameters:
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.

Inherited from:
PartialFunction
Source:
PartialFunction.scala
override def partition(p: ((Key, Value)) => Boolean): (OpenHashMap[Key, Value], OpenHashMap[Key, Value])
override def partitionMap[A1, A2](f: ((Key, Value)) => Either[A1, A2]): (Iterable[A1], Iterable[A2])
def product[B >: (Key, Value)](implicit num: Numeric[B]): B

Multiplies up the elements of this collection.

Multiplies up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

the result type of the * operator.

Value parameters:
num

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

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduce[B >: (Key, Value)](op: (B, B) => B): B

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

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

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

Type parameters:
B

A type parameter for the binary operator, a supertype of A.

Value parameters:
op

A binary operator that must be associative.

Returns:

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

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceLeft[B >: (Key, Value)](op: (B, (Key, Value)) => B): B

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

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

Note: will not terminate for infinite-sized collections.

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

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

the result of inserting op between consecutive elements of this collection, going left to right: op( op( ... op(x1, x2) ..., xn-1), xn) where x1, ..., xn are the elements of this collection.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceLeftOption[B >: (Key, Value)](op: (B, (Key, Value)) => B): Option[B]

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

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

Note: will not terminate for infinite-sized collections.

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

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceOption[B >: (Key, Value)](op: (B, B) => B): Option[B]

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

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

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

Type parameters:
B

A type parameter for the binary operator, a supertype of A.

Value parameters:
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.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceRight[B >: (Key, Value)](op: ((Key, Value), B) => B): B

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

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

Note: will not terminate for infinite-sized collections.

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

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

the result of inserting op between consecutive elements of this collection, going right to left: op(x1, op(x2, ..., op(xn-1, xn)...)) where x1, ..., xn are the elements of this collection.

Throws:
UnsupportedOperationException

if this collection is empty.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def reduceRightOption[B >: (Key, Value)](op: ((Key, Value), B) => B): Option[B]

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

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

Note: will not terminate for infinite-sized collections.

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

Type parameters:
B

the result type of the binary operator.

Value parameters:
op

the binary operator.

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def result(): OpenHashMap[Key, Value]
Inherited from:
MapOps
Source:
Map.scala
protected def reversed: Iterable[(Key, Value)]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def runWith[U](action: Value => U): Key => Boolean

Composes this partial function with an action function which gets applied to results of this partial function.

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.

Value parameters:
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.

See also:

applyOrElse.

Inherited from:
PartialFunction
Source:
PartialFunction.scala
def scan[B >: (Key, Value)](z: B)(op: (B, B) => B): Iterable[B]

Computes a prefix scan of the elements of the collection.

Computes a prefix scan of the elements of the collection.

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

Type parameters:
B

element type of the resulting collection

Value parameters:
op

the associative operator for the scan

z

neutral element for the operator op

Returns:

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

Inherited from:
IterableOps
Source:
Iterable.scala
override def scanLeft[B](z: B)(op: (B, (Key, Value)) => B): Iterable[B]
def scanRight[B](z: B)(op: ((Key, Value), B) => B): Iterable[B]

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

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

Note: will not terminate for infinite-sized collections.

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

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

Example:

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

the type of the elements in the resulting collection

Value parameters:
op

the binary operator applied to the intermediate result and the element

z

the initial value

Returns:

collection with intermediate results

Inherited from:
IterableOps
Source:
Iterable.scala
def sizeCompare(that: Iterable[_]): Int

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

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

Value parameters:
that

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

Returns:

A value x where

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

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

Inherited from:
IterableOps
Source:
Iterable.scala
def sizeCompare(otherSize: Int): Int

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

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

Value parameters:
otherSize

the test value that gets compared with the size.

Returns:

A value x where

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

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

See also:
Inherited from:
IterableOps
Source:
Iterable.scala
final def sizeHint(coll: IterableOnce[_], delta: Int): Unit

Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

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

Value parameters:
coll

the collection which serves as a hint for the result's size.

delta

a correction to add to the coll.size to produce the size hint.

Inherited from:
Builder
Source:
Builder.scala
def sizeHint(size: Int): Unit

Gives a hint how many elements are expected to be added when the next result is called.

Gives a hint how many elements are expected to be added when the next result is called. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value parameters:
size

the hint how many elements will be added.

Inherited from:
Builder
Source:
Builder.scala
final def sizeHintBounded(size: Int, boundingColl: Iterable[_]): Unit

Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection.

Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value parameters:
boundingColl

the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.

size

the hint how many elements will be added.

Inherited from:
Builder
Source:
Builder.scala

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

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

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

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Inherited from:
IterableOps
Source:
Iterable.scala
def slice(from: Int, until: Int): OpenHashMap[Key, Value]
Inherited from:
IterableOps
Source:
Iterable.scala
def sliding(size: Int, step: Int): Iterator[OpenHashMap[Key, Value]]

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

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

The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

Value parameters:
size

the number of elements per group

step

the distance between the first elements of successive groups

Returns:

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

See also:
Example:

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

Inherited from:
IterableOps
Source:
Iterable.scala
def sliding(size: Int): Iterator[OpenHashMap[Key, Value]]

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

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

An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

Value parameters:
size

the number of elements per group

Returns:

An iterator producing iterable collections of size size, except for a non-empty collection with less than size elements, which returns an iterator that produces the source collection itself as its only element.

See also:
Example:

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

Inherited from:
IterableOps
Source:
Iterable.scala
override def span(p: ((Key, Value)) => Boolean): (OpenHashMap[Key, Value], OpenHashMap[Key, Value])
override def splitAt(n: Int): (OpenHashMap[Key, Value], OpenHashMap[Key, Value])
Definition Classes
Inherited from:
IterableOps
Source:
Iterable.scala
def stepper[S <: Stepper[_]](implicit shape: StepperShape[(Key, Value), S]): S

Returns a scala.collection.Stepper for the elements of this collection.

Returns a scala.collection.Stepper for the elements of this collection.

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

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

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

Inherited from:
IterableOnce
Source:
IterableOnce.scala
def subtractAll(xs: IterableOnce[Key]): OpenHashMap[Key, Value]

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

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

Value parameters:
xs

the iterator producing the elements to remove.

Returns:

the shrinkable collection itself

Inherited from:
Shrinkable
Source:
Shrinkable.scala
def sum[B >: (Key, Value)](implicit num: Numeric[B]): B

Sums up the elements of this collection.

Sums up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type parameters:
B

the result type of the + operator.

Value parameters:
num

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

Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def tail: OpenHashMap[Key, Value]

The rest of the collection without its first element.

The rest of the collection without its first element.

Inherited from:
IterableOps
Source:
Iterable.scala
def tails: Iterator[OpenHashMap[Key, Value]]

Iterates over the tails of this iterable collection.

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

Returns:

an iterator over all the tails of this iterable collection

Example:

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

Inherited from:
IterableOps
Source:
Iterable.scala
def take(n: Int): OpenHashMap[Key, Value]
Inherited from:
IterableOps
Source:
Iterable.scala
override def takeRight(n: Int): OpenHashMap[Key, Value]

A collection containing the last n elements of this collection.

A collection containing the last n elements of this collection.

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

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source:
StrictOptimizedIterableOps.scala
def takeWhile(p: ((Key, Value)) => Boolean): OpenHashMap[Key, Value]

Takes longest prefix of elements that satisfy a predicate.

Takes longest prefix of elements that satisfy a predicate.

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

Value parameters:
p

The predicate used to test elements.

Returns:

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

Inherited from:
IterableOps
Source:
Iterable.scala
override def tapEach[U](f: ((Key, Value)) => U): OpenHashMap[Key, Value]
def to[C1](factory: Factory[(Key, Value), C1]): C1

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

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

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toArray[B >: (Key, Value) : ClassTag]: Array[B]

Convert collection to array.

Convert collection to array.

Implementation note: DO NOT call Array.from from this method.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
final def toBuffer[B >: (Key, Value)]: Buffer[B]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toIndexedSeq: IndexedSeq[(Key, Value)]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toList: List[(Key, Value)]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toMap[K, V](implicit ev: (Key, Value) <:< (K, V)): Map[K, V]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toSeq: Seq[(Key, Value)]
Returns:

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

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def toSet[B >: (Key, Value)]: Set[B]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
override def toString(): String
Definition Classes
Inherited from:
Map
Source:
Map.scala
def toVector: Vector[(Key, Value)]
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
def transpose[B](implicit asIterable: ((Key, Value)) => Iterable[B]): Iterable[Iterable[B]]

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

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

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

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

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

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

Type parameters:
B

the type of the elements of each iterable collection.

Value parameters:
asIterable

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

Returns:

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

Throws:
IllegalArgumentException

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

Inherited from:
IterableOps
Source:
Iterable.scala
def unapply(a: Key): Option[Value]

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

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

Inherited from:
PartialFunction
Source:
PartialFunction.scala
override def unzip[A1, A2](implicit asPair: ((Key, Value)) => (A1, A2)): (Iterable[A1], Iterable[A2])
override def unzip3[A1, A2, A3](implicit asTriple: ((Key, Value)) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
def updateWith(key: Key)(remappingFunction: Option[Value] => Option[Value]): Option[Value]

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

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

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

Value parameters:
key

the key value

remappingFunction

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

Returns:

the new value associated with the specified key

Inherited from:
MapOps
Source:
Map.scala
def valueStepper[S <: Stepper[_]](implicit shape: StepperShape[Value, S]): S

Returns a Stepper for the values of this map.

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

Inherited from:
MapOps
Source:
Map.scala
def values: Iterable[Value]

Collects all values of this map in an iterable collection.

Collects all values of this map in an iterable collection.

Returns:

the values of this map as an iterable.

Inherited from:
MapOps
Source:
Map.scala
override def view: MapView[Key, Value]
Definition Classes
Inherited from:
MapOps
Source:
Map.scala
def withDefault(d: Key => Value): Map[Key, Value]

The same map with a given default function.

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

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

Value parameters:
d

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

Returns:

a wrapper of the map with a default value

Inherited from:
Map
Source:
Map.scala
def withDefaultValue(d: Value): Map[Key, Value]

The same map with a given default value.

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

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

Value parameters:
d

default value used for non-present keys

Returns:

a wrapper of the map with a default value

Inherited from:
Map
Source:
Map.scala
override def withFilter(p: ((Key, Value)) => Boolean): WithFilter[Key, Value, Iterable, OpenHashMap]
Definition Classes
Inherited from:
MapFactoryDefaults
Source:
Iterable.scala
override def zip[B](that: IterableOnce[B]): Iterable[((Key, Value), B)]
def zipAll[A1 >: (Key, Value), B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

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

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

Value parameters:
that

the iterable providing the second half of each result pair

thatElem

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

thisElem

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

Returns:

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

Inherited from:
IterableOps
Source:
Iterable.scala

Deprecated and Inherited methods

@deprecated("Use ++ with an explicit collection argument instead of + with varargs", "2.13.0")
def +[V1 >: Value](elem1: (Key, V1), elem2: (Key, V1), elems: (Key, V1)*): OpenHashMap[Key, V1]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Consider requiring an immutable Map or fall back to Map.concat.", "2.13.0")
def +[V1 >: Value](kv: (Key, V1)): OpenHashMap[Key, V1]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Use ++ instead of ++: for collections of type Iterable", "2.13.0")
def ++:[B >: (Key, Value)](that: IterableOnce[B]): Iterable[B]
Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala
@deprecated("Use ++ instead of ++: for collections of type Iterable", "2.13.0")
def ++:[V1 >: Value](that: IterableOnce[(Key, V1)]): OpenHashMap[Key, V1]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Use `++=` aka `addAll` instead of varargs `+=`; infix operations with an operand of multiple args will be deprecated", "2.13.0") @inline
final def +=(elem1: (Key, Value), elem2: (Key, Value), elems: (Key, Value)*): OpenHashMap[Key, Value]

Adds two or more elements to this growable collection.

Adds two or more elements to this growable collection.

Value parameters:
elem1

the first element to add.

elem2

the second element to add.

elems

the remaining elements to add.

Returns:

the growable collection itself

Deprecated
Inherited from:
Growable
Source:
Growable.scala
@deprecated("Use -- or removeAll on an immutable Map", "2.13.0")
final def -(key1: Key, key2: Key, keys: Key*): OpenHashMap[Key, Value]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Use - or remove on an immutable Map", "2.13.0")
final def -(key: Key): OpenHashMap[Key, Value]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Consider requiring an immutable Map.", "2.13.0") @inline
def --(keys: IterableOnce[Key]): OpenHashMap[Key, Value]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Use `--=` aka `subtractAll` instead of varargs `-=`; infix operations with an operand of multiple args will be deprecated", "2.13.3")
def -=(elem1: Key, elem2: Key, elems: Key*): OpenHashMap[Key, Value]

Removes two or more elements from this shrinkable collection.

Removes two or more elements from this shrinkable collection.

Value parameters:
elem1

the first element to remove.

elem2

the second element to remove.

elems

the remaining elements to remove.

Returns:

the shrinkable collection itself

Deprecated
Inherited from:
Shrinkable
Source:
Shrinkable.scala
@deprecated("Use foldLeft instead of /:", "2.13.0") @inline
final def /:[B](z: B)(op: (B, (Key, Value)) => B): B
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use foldRight instead of :\\", "2.13.0") @inline
final def :\[B](z: B)(op: ((Key, Value), B) => B): B
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("`aggregate` is not relevant for sequential collections. Use `foldLeft(z)(seqop)` instead.", "2.13.0")
def aggregate[B](z: => B)(seqop: (B, (Key, Value)) => B, combop: (B, B) => B): B
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use iterableFactory instead", "2.13.0") @deprecatedOverriding("Use iterableFactory instead", "2.13.0") @inline
Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala
@deprecated("Use `dest ++= coll` instead", "2.13.0") @inline
final def copyToBuffer[B >: (Key, Value)](dest: Buffer[B]): Unit
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use .view.filterKeys(f). A future version will include a strict version of this method (for now, .view.filterKeys(p).toMap).", "2.13.0")
def filterKeys(p: Key => Boolean): MapView[Key, Value]

Filters this map by retaining only keys satisfying a predicate.

Filters this map by retaining only keys satisfying a predicate.

Value parameters:
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.

Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)", "2.13.0")

Tests whether this collection is known to have a finite size.

Tests whether this collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end. Non-empty Iterators usually return false even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns true. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

Returns:

true if this collection is known to have finite size, false otherwise.

See also:

method knownSize for a more useful alternative

Deprecated

This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though hasDefiniteSize returns false.

Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use .view.mapValues(f). A future version will include a strict version of this method (for now, .view.mapValues(f).toMap).", "2.13.0")
def mapValues[W](f: Value => W): MapView[Key, W]

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

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

Value parameters:
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.

Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Use coll instead of repr in a collection implementation, use the collection value itself from the outside", "2.13.0")
final def repr: OpenHashMap[Key, Value]
Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala
@deprecated("Use filterInPlace instead", "2.13.0") @inline
final def retain(p: (Key, Value) => Boolean): OpenHashMap[Key, Value]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Iterable.seq always returns the iterable itself", "2.13.0")
def seq: OpenHashMap[Key, Value]
Deprecated
Inherited from:
Iterable
Source:
Iterable.scala
@deprecated("toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections", "2.13.7")
final def toIterable: OpenHashMap[Key, Value]
Deprecated
Inherited from:
Iterable
Source:
Iterable.scala
@deprecated("Use .iterator instead of .toIterator", "2.13.0") @inline
final def toIterator: Iterator[(Key, Value)]
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("Use .to(LazyList) instead of .toStream", "2.13.0") @inline
final def toStream: Stream[(Key, Value)]
Deprecated
Inherited from:
IterableOnceOps
Source:
IterableOnce.scala
@deprecated("toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections", "2.13.0")
final def toTraversable: Iterable[(Key, Value)]

Converts this iterable collection to an unspecified Iterable.

Converts this iterable collection to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

Returns:

An Iterable containing all elements of this iterable collection.

Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala
@deprecated("Use mapValuesInPlace instead", "2.13.0") @inline
final def transform(f: (Key, Value) => Value): OpenHashMap[Key, Value]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Use m.clone().addOne((k,v)) instead of m.updated(k, v)", "2.13.0")
def updated[V1 >: Value](key: Key, value: V1): OpenHashMap[Key, V1]
Deprecated
Inherited from:
MapOps
Source:
Map.scala
@deprecated("Use .view.slice(from, until) instead of .view(from, until)", "2.13.0")
def view(from: Int, until: Int): View[(Key, Value)]

A view over a slice of the elements of this collection.

A view over a slice of the elements of this collection.

Deprecated
Inherited from:
IterableOps
Source:
Iterable.scala