This class implements immutable maps using a Compressed Hash-Array Mapped Prefix-tree.
This class implements immutable maps using a Compressed Hash-Array Mapped Prefix-tree. See paper https://michael.steindorfer.name/publications/oopsla15.pdf for more details.
- Type Params
- K
- the type of the keys contained in this hash set. 
- V
- the type of the values associated with the keys in this hash map. 
 
- Companion
- object
Type members
Inherited classlikes
The implementation class of the set returned by keySet
The implementation class of the set returned by keySet
- Inherited from
- MapOps
Value members
Constructors
Concrete methods
Merges this HashMap with an other HashMap by combining all key-value pairs of both maps, and delegating to a merge function to resolve any key collisions between the two HashMaps.
Merges this HashMap with an other HashMap by combining all key-value pairs of both maps, and delegating to a merge function to resolve any key collisions between the two HashMaps.
- Value Params
- mergef
- the merge function which resolves collisions between the two HashMaps. If - mergefis null, then keys from- thiswill overwrite keys from- that, making the behaviour equivalent to- that.concat(this)
- that
- the HashMap to merge this HashMap with 
 
- Note
- In cases where - mergefreturns keys which themselves collide with other keys returned by- merge, or found in- thisor- that, it is not defined which value will be chosen. For example: Colliding multiple results of merging:- // key `3` collides between a result of merging keys `1` and `2` val left = HashMap(1 -> 1, 2 -> 2) val right = HashMap(1 -> 1, 2 -> 2) val merged = left.merged(right){ case (_, (_, v1)) => 3 -> v1 } // HashMap(3 -> 2) is returned, but it could also have returned HashMap(3 -> 1)- Colliding results of merging with other keys: - // key `2` collides between a result of merging `1`, and existing key `2` val left = HashMap(1 -> 1, 2 -> 1) val right = HashMap(1 -> 2) val merged = left.merged(right)((_,_) => 2 -> 3) // HashMap(2 -> 1) is returned, but it could also have returned HashMap(2 -> 3)
- Example
- val left = HashMap(1 -> 1, 2 -> 1) val right = HashMap(2 -> 2, 3 -> 2) val merged = left.merged(right){ case ((k0, v0), (k1, v1)) => (k0 + k1) -> (v0 + v1) } // HashMap(1 -> 1, 3 -> 2, 4 -> 3)
- Definition Classes
Inherited methods
Alias for concat
Alias for concat
- Inherited from
- IterableOps
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 Params
- b
- the string builder to which elements are appended. 
 
- Returns
- the string builder - bto which elements were appended.
- Inherited from
- IterableOnceOps
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 Params
- b
- the string builder to which elements are appended. 
- sep
- the separator string. 
 
- Returns
- the string builder - bto which elements were appended.
- Inherited from
- IterableOnceOps
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. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.
- Type Params
- C
- the result type of the transformation function. 
 
- Value Params
- k
- the transformation function 
 
- Returns
- a partial function with the domain of this partial function narrowed by other partial function, which maps arguments - xto- k(this(x)).
- Inherited from
- PartialFunction
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 Params
- C
- the result type of the transformation function. 
 
- Value Params
- k
- the transformation function 
 
- Returns
- a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments - xto- k(this(x)).
- Definition Classes
- Inherited from
- PartialFunction
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 Params
- pf
- the partial function 
 
- Returns
- an option value containing pf applied to the first value for which it is defined, or - Noneif none exists.
- Example
- Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
- Inherited from
- IterableOnceOps
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. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.
- Type Params
- R
- the parameter type of the transformation function. 
 
- Value Params
- k
- the transformation function 
 
- Returns
- a partial function with the domain of other partial function narrowed by this partial function, which maps arguments - xto- this(k(x)).
- Inherited from
- PartialFunction
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 Params
- A
- the type to which function - gcan be applied
 
- Value Params
- g
- a function A => T1 
 
- Returns
- a new function - fsuch that- f(x) == apply(g(x))
- Inherited from
- Function1
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 Params
- B
- the element type of the returned collection. 
 
- Value Params
- 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
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 Params
- B
- the type of the elements of the array. 
 
- Value Params
- 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
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 Params
- B
- the type of the elements of the array. 
 
- Value Params
- 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
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 Params
- B
- the type of the elements of the array. 
 
- Value Params
- 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
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 Params
- B
- the type of the elements of - that
 
- Value Params
- p
- the test predicate, which relates elements from both collections 
- that
- the other collection 
 
- Returns
- trueif both collections have the same length and- p(x, y)is- truefor all corresponding elements- xof this iterator and- yof- that, otherwise- false
- Inherited from
- IterableOnceOps
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 Params
- p
- the predicate used to test elements. 
 
- Returns
- the number of elements satisfying the predicate - p.
- Inherited from
- IterableOnceOps
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 Params
- key
- the given key value for which a binding is missing. 
 
- Inherited from
- MapOps
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
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 Params
- p
- the predicate used to test elements. 
 
- Returns
- trueif the given predicate- pis satisfied by at least one element of this collection, otherwise- false
- Inherited from
- IterableOnceOps
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 Params
- p
- the predicate used to test elements. 
 
- Returns
- an option value containing the first element in the collection that satisfies - p, or- Noneif none exists.
- Inherited from
- IterableOnceOps
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 Params
- A1
- a type parameter for the binary operator, a supertype of - A.
 
- Value Params
- 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., - Nilfor list concatenation, 0 for addition, or 1 for multiplication).
 
- Returns
- the result of applying the fold operator - opbetween all the elements and- z, or- zif this collection is empty.
- Inherited from
- IterableOnceOps
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 Params
- B
- the result type of the binary operator. 
 
- Value Params
- op
- the binary operator. 
- z
- the start value. 
 
- Returns
- the result of inserting - opbetween consecutive elements of this collection, going left to right with the start value- zon the left:- op(...op(z, x1), x2, ..., xn)where- x1, ..., xnare the elements of this collection. Returns- zif this collection is empty.
- Inherited from
- IterableOnceOps
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 Params
- B
- the result type of the binary operator. 
 
- Value Params
- op
- the binary operator. 
- z
- the start value. 
 
- Returns
- the result of inserting - opbetween consecutive elements of this collection, going right to left with the start value- zon the right:- op(x1, op(x2, ... op(xn, z)...))where- x1, ..., xnare the elements of this collection. Returns- zif this collection is empty.
- Inherited from
- IterableOnceOps
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 Params
- p
- the predicate used to test elements. 
 
- Returns
- trueif this collection is empty or the given predicate- pholds for all elements of this collection, otherwise- false.
- Inherited from
- IterableOnceOps
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 Params
- K
- the type of keys returned by the discriminator function. 
 
- Value Params
- 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 - kis bound to a iterable collection of those elements- xfor which- f(x)equals- k.
- Inherited from
- IterableOps
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 Params
- B
- the type of values returned by the transformation function 
- K
- the type of keys returned by the discriminator function 
 
- Value Params
- f
- the element transformation function 
- key
- the discriminator function 
 
- Inherited from
- IterableOps
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
Partitions elements in fixed size iterable collections.
Partitions elements in fixed size iterable collections.
- Value Params
- size
- the number of elements per group 
 
- Returns
- An iterator producing iterable collections of size - size, except the last will be less than size- sizeif the elements don't divide evenly.
- See also
- scala.collection.Iterator, method - grouped
- Inherited from
- IterableOps
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, - Noneif it is empty.
- Inherited from
- IterableOps
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
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 Params
- key
- the key 
 
- Returns
- trueif there is a binding for- keyin this map,- falseotherwise.
- Inherited from
- MapOps
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
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, - Noneif it is empty.
- Inherited from
- IterableOps
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 Params
- B
- the type of the second element in each eventual pair 
 
- Value Params
- that
- the iterable providing the second element of each eventual pair 
 
- Returns
- a decorator - LazyZip2that 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
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 - xto- Some(this(x))if- thisis defined for- x, and to- Noneotherwise.
- See also
- Function.unlift 
- Inherited from
- PartialFunction
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
- Type Params
- B
- The type over which the ordering is defined. 
 
- Value Params
- 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
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 Params
- B
- The result type of the function f. 
 
- Value Params
- 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
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 Params
- B
- The result type of the function f. 
 
- Value Params
- 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
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
- Type Params
- B
- The type over which the ordering is defined. 
 
- Value Params
- 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
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
- Type Params
- B
- The type over which the ordering is defined. 
 
- Value Params
- 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
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 Params
- B
- The result type of the function f. 
 
- Value Params
- 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
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 Params
- B
- The result type of the function f. 
 
- Value Params
- 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
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
- Type Params
- B
- The type over which the ordering is defined. 
 
- Value Params
- 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
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
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 Params
- 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
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 Params
- 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 - startand 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
Tests whether the collection is not empty.
Tests whether the collection is not empty.
- Returns
- trueif the collection contains at least one element,- falseotherwise.
- Inherited from
- IterableOnceOps
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 Params
- A1
- the argument type of the fallback function 
- B1
- the result type of the fallback function 
 
- Value Params
- 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- xto- this(x)where- thisis defined, and to- that(x)where it is not.
- Inherited from
- PartialFunction
Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
Note: will not terminate for infinite-sized collections.
- Type Params
- B
- the result type of the - *operator.
 
- Value Params
- 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
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 Params
- B
- A type parameter for the binary operator, a supertype of - A.
 
- Value Params
- op
- A binary operator that must be associative. 
 
- Returns
- The result of applying reduce operator - opbetween all the elements if the collection is nonempty.
- Throws
- UnsupportedOperationException
- if this collection is empty. 
 
- Inherited from
- IterableOnceOps
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 Params
- B
- the result type of the binary operator. 
 
- Value Params
- op
- the binary operator. 
 
- Returns
- the result of inserting - opbetween consecutive elements of this collection, going left to right:- op( op( ... op(x1, x2) ..., xn-1), xn)where- x1, ..., xnare the elements of this collection.
- Throws
- UnsupportedOperationException
- if this collection is empty. 
 
- Inherited from
- IterableOnceOps
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 Params
- B
- the result type of the binary operator. 
 
- Value Params
- op
- the binary operator. 
 
- Returns
- an option value containing the result of - reduceLeft(op)if this collection is nonempty,- Noneotherwise.
- Inherited from
- IterableOnceOps
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 Params
- B
- A type parameter for the binary operator, a supertype of - A.
 
- Value Params
- op
- A binary operator that must be associative. 
 
- Returns
- An option value containing result of applying reduce operator - opbetween all the elements if the collection is nonempty, and- Noneotherwise.
- Inherited from
- IterableOnceOps
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 Params
- B
- the result type of the binary operator. 
 
- Value Params
- op
- the binary operator. 
 
- Returns
- the result of inserting - opbetween consecutive elements of this collection, going right to left:- op(x1, op(x2, ..., op(xn-1, xn)...))where- x1, ..., xnare the elements of this collection.
- Throws
- UnsupportedOperationException
- if this collection is empty. 
 
- Inherited from
- IterableOnceOps
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 Params
- B
- the result type of the binary operator. 
 
- Value Params
- op
- the binary operator. 
 
- Returns
- an option value containing the result of - reduceRight(op)if this collection is nonempty,- Noneotherwise.
- Inherited from
- IterableOnceOps
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 falseexcept 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 Params
- action
- the action function 
 
- Returns
- a function which maps arguments - xto- isDefinedAt(x). The resulting function runs- action(this(x))where- thisis defined.
- See also
- applyOrElse.
- Inherited from
- PartialFunction
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 Params
- B
- element type of the resulting collection 
 
- Value Params
- 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
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 Params
- B
- the type of the elements in the resulting collection 
 
- Value Params
- op
- the binary operator applied to the intermediate result and the element 
- z
- the initial value 
 
- Returns
- collection with intermediate results 
- Inherited from
- IterableOps
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 Params
- that
- the - Iterablewhose size is compared with this iterable collection's size.
 
- Returns
- A value - xwhere- 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 - sizedirectly; its running time is- O(this.size min that.size)instead of- O(this.size + that.size). The method should be overridden if computing- sizeis cheap and- knownSizereturns- -1.
- Inherited from
- IterableOps
Compares the size of this iterable collection to a test value.
Compares the size of this iterable collection to a test value.
- Value Params
- otherSize
- the test value that gets compared with the size. 
 
- Returns
- A value - xwhere- 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 - sizedirectly; its running time is- O(size min otherSize)instead of- O(size). The method should be overridden if computing- sizeis cheap and- knownSizereturns- -1.
- See also
- Inherited from
- IterableOps
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
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 Params
- 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- sizeelements remaining to be grouped.
- See also
- scala.collection.Iterator, method - sliding
- 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
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 Params
- 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- sizeelements, which returns an iterator that produces the source collection itself as its only element.
- See also
- scala.collection.Iterator, method - sliding
- 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
Sums up the elements of this collection.
Sums up the elements of this collection.
Note: will not terminate for infinite-sized collections.
- Type Params
- B
- the result type of the - +operator.
 
- Value Params
- 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
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
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
Convert collection to array.
Convert collection to array.
Implementation note: DO NOT call Array.from from this method.
- Inherited from
- IterableOnceOps
- Returns
- This collection as a - Seq[A]. This is equivalent to- to(Seq)but might be faster.
- Inherited from
- IterableOnceOps
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 Params
- B
- the type of the elements of each iterable collection. 
 
- Value Params
- 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
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
- Definition Classes
- Inherited from
- StrictOptimizedIterableOps
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
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 withDefault.
Invoking transformer methods (e.g. map) will not preserve the default value.
- Value Params
- 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
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 Params
- d
- default value used for non-present keys 
 
- Returns
- a wrapper of the map with a default value 
- Inherited from
- Map
- Definition Classes
- Inherited from
- MapFactoryDefaults
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 Params
- that
- the iterable providing the second half of each result pair 
- thatElem
- the element to be used to fill up the result if - thatis 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 - Thatcontaining 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,- thisElemvalues are used to pad the result. If- thatis shorter than this iterable collection,- thatElemvalues are used to pad the result.
- Inherited from
- IterableOps
Deprecated and Inherited methods
- Deprecated
- Definition Classes
- Inherited from
- StrictOptimizedMapOps
- Deprecated
- Inherited from
- IterableOps
- Deprecated
- Inherited from
- MapOps
- Deprecated
- Inherited from
- IterableOnceOps
- Deprecated
- Inherited from
- IterableOnceOps
- Deprecated
- Inherited from
- IterableOps
- Deprecated
- Inherited from
- IterableOnceOps
Filters this map by retaining only keys satisfying a predicate.
Filters this map by retaining only keys satisfying a predicate.
- Value Params
- 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
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
- trueif this collection is known to have finite size,- falseotherwise.
- See also
- method - knownSizefor 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 - hasDefiniteSizereturns- false.
- Inherited from
- IterableOnceOps
Transforms this map by applying a function to every retrieved value.
Transforms this map by applying a function to every retrieved value.
- Value Params
- 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
- Deprecated
- Inherited from
- IterableOps
- Deprecated
- Inherited from
- Iterable
- Deprecated
- Inherited from
- IterableOnceOps
- Deprecated
- Inherited from
- IterableOnceOps
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
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