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.

mergef

the merge function which resolves collisions between the two HashMaps. If mergef is null, then keys from this will overwrite keys from that, making the behaviour equivalent to that.concat(this)

that

the HashMap to merge this HashMap with

In cases where mergef returns keys which themselves collide with other keys returned by merge, or found in this or 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)

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)

V1

the type of the value in the key/value pair.

kv

the key/value pair.

A new map with the new binding added to this map.

b

the string builder to which elements are appended.

the string builder b to which elements were appended.

b

the string builder to which elements are appended.

sep

the separator string.

the string builder b to which elements were appended.

C

the result type of the transformation function.

k

the transformation function

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

C

the result type of the transformation function.

k

the transformation function

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

pf

the partial function

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

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

R

the parameter type of the transformation function.

k

the transformation function

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

A

the type to which function g can be applied

g

a function A => T1

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

B

the element type of the returned collection.

suffix

the traversable to append.

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

B

the type of the elements of the array.

len

the maximal number of elements to copy.

start

the starting index of xs.

xs

the array to fill.

the number of elements written to the array

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

B

the type of the elements of the array.

start

the starting index of xs.

xs

the array to fill.

the number of elements written to the array

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

B

the type of the elements of the array.

xs

the array to fill.

the number of elements written to the array

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

B

the type of the elements of that

p

the test predicate, which relates elements from both collections

that

the other collection

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

p

the predicate used to test elements.

the number of elements satisfying the predicate p.

key

the given key value for which a binding is missing.

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
}

p

the predicate used to test elements.

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

p

the predicate used to test elements.

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

A1

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

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

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

B

the result type of the binary operator.

op

the binary operator.

z

the start value.

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.

B

the result type of the binary operator.

op

the binary operator.

z

the start value.

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.

p

the predicate used to test elements.

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

K

the type of keys returned by the discriminator function.

f

the discriminator function.

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.

B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function

f

the element transformation function

key

the discriminator function

size

the number of elements per group

An iterator producing iterable collections of size size, except the last will be less than size size if the elements don't divide evenly.

scala.collection.Iterator, method grouped

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

an iterator over all the inits of this iterable collection

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

key

the key

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

the keys of this map as an iterable.

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

B

the type of the second element in each eventual pair

that

the iterable providing the second element of each eventual pair

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.

a function that takes an argument x to Some(this(x)) if this is defined for x, and to None otherwise.

Function.unlift

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

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

UnsupportedOperationException

if this collection is empty.

B

The result type of the function f.

cmp

An ordering to be used for comparing elements.

f

The measuring function.

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

UnsupportedOperationException

if this collection is empty.

B

The result type of the function f.

cmp

An ordering to be used for comparing elements.

f

The measuring function.

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

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

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

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

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

UnsupportedOperationException

if this collection is empty.

B

The result type of the function f.

cmp

An ordering to be used for comparing elements.

f

The measuring function.

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

UnsupportedOperationException

if this collection is empty.

B

The result type of the function f.

cmp

An ordering to be used for comparing elements.

f

The measuring function.

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

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

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

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.

sep

the separator string.

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.

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

end

the ending string.

sep

the separator string.

start

the starting string.

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.

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

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

A1

the argument type of the fallback function

B1

the result type of the fallback function

that

the fallback function

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.

B

the result type of the * operator.

num

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

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

B

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

op

A binary operator that must be associative.

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

UnsupportedOperationException

if this collection is empty.

B

the result type of the binary operator.

op

the binary operator.

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.

UnsupportedOperationException

if this collection is empty.

B

the result type of the binary operator.

op

the binary operator.

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

B

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

op

A binary operator that must be associative.

An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.

B

the result type of the binary operator.

op

the binary operator.

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.

UnsupportedOperationException

if this collection is empty.

B

the result type of the binary operator.

op

the binary operator.

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

action

the action function

a function which maps arguments x to isDefinedAt(x). The resulting function runs action(this(x)) where this is defined.

applyOrElse.

B

element type of the resulting collection

op

the associative operator for the scan

z

neutral element for the operator op

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

B

the type of the elements in the resulting collection

op

the binary operator applied to the intermediate result and the element

z

the initial value

collection with intermediate results

that

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

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.

otherSize

the test value that gets compared with the size.

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.

sizeIs

size

the number of elements per group

step

the distance between the first elements of successive groups

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.

scala.collection.Iterator, method sliding

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

size

the number of elements per group

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.

scala.collection.Iterator, method sliding

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

B

the result type of the + operator.

num

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

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

an iterator over all the tails of this iterable collection

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

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

B

the type of the elements of each iterable collection.

asIterable

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

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

IllegalArgumentException

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

the values of this map as an iterable.

d

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

a wrapper of the map with a default value

d

default value used for non-present keys

a wrapper of the map with a default value

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.

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.