StrictOptimizedLinearSeqOps (original) (raw)

Selects all elements except the longest prefix that satisfies a predicate.

The matching prefix starts with the first element of this sequence, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire sequence.

Example:

scala> List(1, 2, 3, 100, 4).dropWhile(n => n < 10)
val res0: List[Int] = List(100, 4)

scala> List(1, 2, 3, 100, 4).dropWhile(n => n == 0)
val res1: List[Int] = List(1, 2, 3, 100, 4)

Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the predicate.

Value parameters

The predicate used to test elements.

Attributes

Returns

the longest suffix of this sequence whose first element does not satisfy the predicate p.

Definition Classes

Source

Alias for prependedAll.

Attributes

Definition Classes

Inherited from:

Source

Alias for prepended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Attributes

Inherited from:

Source

Alias for appended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Attributes

Inherited from:

Source

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

the string builder to which elements are appended.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:

Source

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

the string builder to which elements are appended.

sep

the separator string.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:

Source

Appends all elements of this collection to a string builder using start, end, and separator strings.

Appends all elements of this collection to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this collection are 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 , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)

Value parameters

the string builder to which elements are appended.

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:

Source

A copy of this sequence with an element appended.

Note: will not terminate for infinite-sized collections.

Example:

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

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

scala> println(a)
List(1)

Type parameters

the element type of the returned sequence.

Value parameters

elem

the appended element

Attributes

Returns

a new sequence consisting of all elements of this sequence followed by value.

Definition Classes

Inherited from:

Source

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

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

Type parameters

the element type of the returned collection.

Value parameters

suffix

the iterable to append.

Attributes

Returns

a new collection of type CC[B] which contains all elements of this sequence followed by all elements of suffix.

Definition Classes

Inherited from:

Source

Gets the element at the specified index.

Gets the element at the specified index. This operation is provided for convenience in Seq. It should not be assumed to be efficient unless you have an IndexedSeq.

Attributes

Definition Classes

Inherited from:

Source

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

Type parameters

the element type of the returned iterable collection.

Value parameters

the partial function which filters and maps the iterable collection.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

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

the partial function

Attributes

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:

Source

Iterates over combinations of elements.

A combination of length n is a sequence of n elements selected in order of their first index in this sequence.

For example, "xyx" has two combinations of length 2. The x is selected first: "xx", "xy". The sequence "yx" is not returned as a combination because it is subsumed by "xy".

If there is more than one way to generate the same combination, only one will be returned.

For example, the result "xy" arbitrarily selected one of the x elements.

As a further illustration, "xyxx" has three different ways to generate "xy" because there are three elements x to choose from. Moreover, there are three unordered pairs "xx" but only one is returned.

It is not specified which of these equal combinations is returned. It is an implementation detail that should not be relied on. For example, the combination "xx" does not necessarily contain the first x in this sequence. This behavior is observable if the elements compare equal but are not identical.

As a consequence, "xyx".combinations(3).next() is "xxy": the combination does not reflect the order of the original sequence, but the order in which elements were selected, by "first index"; the order of each x element is also arbitrary.

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

Attributes

Returns

An Iterator which traverses the n-element combinations of this sequence.

Example

Seq('a', 'b', 'b', 'b', 'c').combinations(2).foreach(println)
// List(a, b)
// List(a, c)
// List(b, b)
// List(b, c)
Seq('b', 'a', 'b').combinations(2).foreach(println)
// List(b, b)
// List(b, a)

Inherited from:

Source

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

Type parameters

the element type of the returned collection.

Value parameters

suffix

the iterable to append.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

Tests whether this sequence contains a given value as an element.

Note: may not terminate for infinite-sized collections.

Value parameters

elem

the element to test.

Attributes

Returns

true if this sequence has an element that is equal (as determined by ==) to elem, false otherwise.

Definition Classes

Inherited from:

Source

Tests whether this sequence contains a given sequence as a slice.

Note: may not terminate for infinite-sized collections.

Value parameters

that

the sequence to test

Attributes

Returns

true if this sequence contains a slice with the same elements as that, otherwise false.

Inherited from:

Source

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

the type of the elements of the array.

Value parameters

len

the maximal number of elements to copy.

start

the starting index of xs.

the array to fill.

Attributes

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:

Source

Copies 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

the type of the elements of the array.

Value parameters

start

the starting index of xs.

the array to fill.

Attributes

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:

Source

Copies 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

the type of the elements of the array.

Value parameters

the array to fill.

Attributes

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:

Source

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

the type of the elements of that

Value parameters

the test predicate, which relates elements from both collections

that

the other collection

Attributes

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:

Source

Tests whether every element of this sequence relates to the corresponding element of another sequence by satisfying a test predicate.

Type parameters

the type of the elements of that

Value parameters

the test predicate, which relates elements from both sequences

that

the other sequence

Attributes

Returns

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

Inherited from:

Source

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

Note: will not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

the number of elements satisfying the predicate p.

Inherited from:

Source

Computes the multiset difference between this sequence and another sequence.

Value parameters

that

the sequence of elements to remove

Attributes

Returns

a new sequence which contains all elements of this sequence except some of occurrences of elements that also appear in that. If an element value x appears n times in that, then the first n occurrences of x will not form part of the result, but any following occurrences will.

Definition Classes

Inherited from:

Source

Selects all the elements of this sequence ignoring the duplicates.

Attributes

Returns

a new sequence consisting of all the elements of this sequence without duplicates.

Inherited from:

Source

Selects all the elements of this sequence ignoring the duplicates as determined by == after applying the transforming function f.

Type parameters

the type of the elements after being transformed by f

Value parameters

The transforming function whose result is used to determine the uniqueness of each element

Attributes

Returns

a new sequence consisting of all the elements of this sequence without duplicates.

Definition Classes

Inherited from:

Source

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.

Attributes

Definition Classes

Inherited from:

Source

The empty iterable of the same type as this iterable

Attributes

Returns

an empty iterable of type C.

Inherited from:

Source

Tests whether this sequence ends with the given sequence.

Note: will not terminate for infinite-sized collections.

Value parameters

that

the sequence to test

Attributes

Returns

true if this sequence has that as a suffix, false otherwise.

Inherited from:

Source

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

Note: may not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

Selects all elements of this iterable collection which satisfy a predicate.

Value parameters

the predicate used to test elements.

Attributes

Returns

a new iterable collection consisting of all elements of this iterable collection that satisfy the given predicate p. The order of the elements is preserved.

Definition Classes

Inherited from:

Source

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

Value parameters

pred

the predicate used to test elements.

Attributes

Returns

a new iterable collection consisting of all elements of this iterable collection that do not satisfy the given predicate pred. Their order may not be preserved.

Definition Classes

Inherited from:

Source

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

Note: may not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

Finds the last element of the sequence satisfying a predicate, if any.

Note: will not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

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

For example:

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

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

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

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

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

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

Type parameters

the element type of the returned collection.

Value parameters

the function to apply to each element.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

Converts this iterable collection of iterable collections into a iterable collection formed by the elements of these iterable collections.

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

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

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

Type parameters

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.

Attributes

Returns

a new iterable collection resulting from concatenating all element iterable collections.

Definition Classes

Inherited from:

Source

Applies the given binary operator op to the given initial value z and all elements of this collection.

For each application of the operator, each operand is either an element of this collection, the initial value, or another such application of the operator.

The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation. The initial value may be used an arbitrary number of times, but at least once.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative. In either case, it is also necessary that the initial value be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.

The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

Note: will not terminate for infinite-sized collections.

Type parameters

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

Value parameters

A binary operator; must be associative for the result to always be the same across runs.

An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for op for the result to always be the same across runs.

Attributes

Returns

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

Inherited from:

Source

Applies the given binary operator op to the given initial value z and all elements of this sequence, going left to right.

Applies the given binary operator op to the given initial value z and all elements of this sequence, going left to right. Returns the initial value if this sequence is empty.

"Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this sequence, the result is op( op( ... op( op(z, x1), x2) ... ), xn).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this sequence and the initial value all appear exactly once in the computation.

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the binary operator.

Value parameters

A binary operator.

An initial value.

Attributes

Returns

The result of applying op to z and all elements of this sequence, going left to right. Returns z if this sequence is empty.

Definition Classes

Inherited from:

Source

Applies the given binary operator op to all elements of this collection and the given initial value z, going right to left.

Applies the given binary operator op to all elements of this collection and the given initial value z, going right to left. Returns the initial value if this collection is empty.

"Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this collection, the result is op(x1, op(x2, op( ... op(xn, z) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this collection and the initial value all appear exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the binary operator.

Value parameters

A binary operator.

An initial value.

Attributes

Returns

The result of applying op to all elements of this collection and z, going right to left. Returns z if this collection is empty.

Inherited from:

Source

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

Note: may not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

Applies f to each element for its side effects.

Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

Attributes

Definition Classes

Inherited from:

Source

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

the type of keys returned by the discriminator function.

Value parameters

the discriminator function.

Attributes

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:

Source

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

the type of values returned by the transformation function

the type of keys returned by the discriminator function

Value parameters

the element transformation function

key

the discriminator function

Attributes

Inherited from:

Source

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.

Attributes

Inherited from:

Source

Partitions elements in fixed size iterable collections.

Value parameters

size

the number of elements per group

Attributes

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:

Source

Selects the first element of this iterable collection.

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

Attributes

Returns

the first element of this iterable collection.

Throws

Inherited from:

Source

Optionally selects the first element.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

Finds index of first occurrence of some value in this sequence.

Type parameters

the type of the element elem.

Value parameters

elem

the element value to search for.

Attributes

Returns

the index >= 0 of the first element of this sequence that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:

Source

Finds index of first occurrence of some value in this sequence after or at some start index.

Type parameters

the type of the element elem.

Value parameters

elem

the element value to search for.

from

the start index

Attributes

Returns

the index >= from of the first element of this sequence that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:

Source

Finds first index where this sequence contains a given sequence as a slice.

Note: may not terminate for infinite-sized collections.

Value parameters

that

the sequence to test

Attributes

Returns

the first index >= 0 such that the elements of this sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.

Inherited from:

Source

Finds first index after or at a start index where this sequence contains a given sequence as a slice.

Note: may not terminate for infinite-sized collections.

Value parameters

from

the start index

that

the sequence to test

Attributes

Returns

the first index >= from such that the elements of this sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.

Inherited from:

Source

Finds index of the first element satisfying some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

the index >= 0 of the first element of this sequence that satisfies the predicate p, or -1, if none exists.

Inherited from:

Source

Finds index of the first element satisfying some predicate after or at some start index.

Note: may not terminate for infinite-sized collections.

Value parameters

from

the start index

the predicate used to test elements.

Attributes

Returns

the index >= from of the first element of this sequence that satisfies the predicate p, or -1, if none exists.

Definition Classes

Inherited from:

Source

Produces the range of all indices of this sequence.

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

Attributes

Returns

a Range value from 0 to one less than the length of this sequence.

Inherited from:

Source

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.

Attributes

Inherited from:

Source

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.

Attributes

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:

Source

Computes the multiset intersection between this sequence and another sequence.

Value parameters

that

the sequence of elements to intersect with.

Attributes

Returns

a new sequence which contains all elements of this sequence which also appear in that. If an element value x appears n times in that, then the first n occurrences of x will be retained in the result, but any following occurrences will be omitted.

Definition Classes

Inherited from:

Source

Tests whether this sequence contains given index.

The implementations of methods apply and isDefinedAt turn a Seq[A] into a PartialFunction[Int, A].

Value parameters

idx

the index to test

Attributes

Returns

true if this sequence contains an element at position idx, false otherwise.

Definition Classes

Inherited from:

Source

Tests whether the sequence is empty.

Note: The default implementation creates and discards an iterator.

Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when isEmpty is called.

Attributes

Returns

true if the sequence contains no elements, false otherwise.

Definition Classes

Inherited from:

Source

Tests whether this iterable collection can be repeatedly traversed.

Tests whether this iterable collection can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Attributes

Returns

true if it is repeatedly traversable, false otherwise.

Definition Classes

Inherited from:

Source

The number of elements in this collection, if it can be cheaply computed, -1 otherwise.

The number of elements in this collection, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

Attributes

Inherited from:

IterableOnce

Source

Selects the last element.

Attributes

Returns

The last element of this sequence.

Throws

Definition Classes

Inherited from:

Source

Finds index of last occurrence of some value in this sequence before or at a given end index.

Note: will not terminate for infinite-sized collections.

Type parameters

the type of the element elem.

Value parameters

elem

the element value to search for.

end

the end index.

Attributes

Returns

the index <= end of the last element of this sequence that is equal (as determined by ==) to elem, or -1, if none exists.

Inherited from:

Source

Finds last index where this sequence contains a given sequence as a slice.

Note: will not terminate for infinite-sized collections.

Value parameters

that

the sequence to test

Attributes

Returns

the last index such that the elements of this sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.

Inherited from:

Source

Finds last index before or at a given end index where this sequence contains a given sequence as a slice.

Note: will not terminate for infinite-sized collections.

Value parameters

end

the end index

that

the sequence to test

Attributes

Returns

the last index <= end such that the elements of this sequence starting at this index match the elements of sequence that, or -1 if no such subsequence exists.

Inherited from:

Source

Finds index of last element satisfying some predicate.

Note: will not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

the index of the last element of this sequence that satisfies the predicate p, or -1, if none exists.

Inherited from:

Source

Finds index of last element satisfying some predicate before or at given end index.

Note: will not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

the index <= end of the last element of this sequence that satisfies the predicate p, or -1, if none exists.

Definition Classes

Inherited from:

Source

Optionally selects the last element.

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

Attributes

Returns

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

Inherited from:

Source

The length (number of elements) of the sequence.

The length (number of elements) of the sequence. size is an alias for length in Seq collections.

Attributes

Inherited from:

Source

Compares the length of this sequence to the size of another Iterable.

Value parameters

that

the Iterable whose size is compared with this sequence's length.

Attributes

Returns

A value x where

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

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

Definition Classes

Inherited from:

Source

Compares the length of this sequence to a test value.

Value parameters

len

the test value that gets compared with the length.

Attributes

Returns

A value x where

x <  0       if this.length <  len
x == 0       if this.length == len
x >  0       if this.length >  len

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

See also

Definition Classes

Inherited from:

Source

Returns a value class containing operations for comparing the length of this sequence to a test value.

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

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0

Attributes

Inherited from:

Source

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

Type parameters

the element type of the returned iterable collection.

Value parameters

the function to apply to each element.

Attributes

Returns

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

Definition Classes

Inherited from:

Source

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Throws

Inherited from:

Source

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

The measuring function.

Attributes

Returns

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

Throws

Inherited from:

Source

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

The measuring function.

Attributes

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:

Source

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Inherited from:

Source

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Throws

Inherited from:

Source

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

The measuring function.

Attributes

Returns

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

Throws

Inherited from:

Source

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

The measuring function.

Attributes

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:

Source

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Inherited from:

Source

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

Attributes

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:

Source

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.

Attributes

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:

Source

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.

Attributes

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:

Source

Tests whether the collection is not empty.

Attributes

Returns

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

Inherited from:

Source

A copy of this sequence with an element value appended until a given target length is reached.

Type parameters

the element type of the returned sequence.

Value parameters

elem

the padding value

len

the target length

Attributes

Returns

a new sequence consisting of all elements of this sequence followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.

Definition Classes

Inherited from:

Source

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not. Interesting because it splits a collection in two.

The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.

Attributes

Definition Classes

Inherited from:

Source

Applies a function f to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Example:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))

Type parameters

the element type of the first resulting collection

the element type of the second resulting collection

Value parameters

the 'split function' mapping the elements of this iterable collection to an scala.util.Either

Attributes

Returns

a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Definition Classes

Inherited from:

Source

Produces a new sequence where a slice of elements in this sequence is replaced by another sequence.

Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original sequence appends the patch to the end. If the replaced count would exceed the available elements, the difference in excess is ignored.

Type parameters

the element type of the returned sequence.

Value parameters

from

the index of the first replaced element

other

the replacement sequence

replaced

the number of elements to drop in the original sequence

Attributes

Returns

a new sequence consisting of all elements of this sequence except that replaced elements starting from from are replaced by all the elements of other.

Inherited from:

Source

Iterates over distinct permutations of elements.

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

Attributes

Returns

An Iterator which traverses the distinct permutations of this sequence.

Example

Seq('a', 'b', 'b').permutations.foreach(println)
// List(a, b, b)
// List(b, a, b)
// List(b, b, a)

Inherited from:

Source

A copy of the sequence with an element prepended.

Also, the original sequence is not modified, so you will want to capture the result.

Example:

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

scala> val y = 2 +: x
y: List[Int] = List(2, 1)

scala> println(x)
List(1)

Type parameters

the element type of the returned sequence.

Value parameters

elem

the prepended element

Attributes

Returns

a new sequence consisting of value followed by all elements of this sequence.

Definition Classes

Inherited from:

Source

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

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

Type parameters

the element type of the returned collection.

Value parameters

prefix

the iterable to prepend.

Attributes

Returns

a new sequence which contains all elements of prefix followed by all the elements of this sequence.

Definition Classes

Inherited from:

Source

Multiplies together the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

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.

Attributes

Returns

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

Inherited from:

Source

Applies the given binary operator op to all elements of this collection.

For each application of the operator, each operand is either an element of this collection or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

Note: will not terminate for infinite-sized collections.

Type parameters

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

Value parameters

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

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

Throws

Inherited from:

Source

Applies the given binary operator op to all elements of this collection, going left to right.

"Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this collection, the result is op( op( op( ... op(x1, x2) ... ), xn-1), xn).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this collection and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the binary operator, a supertype of A.

Value parameters

A binary operator.

Attributes

Returns

The result of applying op to all elements of this collection, going left to right.

Throws

Inherited from:

Source

If this collection is nonempty, reduces it with the given binary operator op, going left to right.

The behavior is the same as reduceLeft except that the value is None if the collection is empty. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the binary operator, a supertype of A.

Value parameters

A binary operator.

Attributes

Returns

The result of reducing this collection with op going left to right if the collection is nonempty, inside a Some, and None otherwise.

Inherited from:

Source

If this collection is nonempty, reduces it with the given binary operator op.

The behavior is the same as reduce except that the value is None if the collection is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

Note: will not terminate for infinite-sized collections.

Type parameters

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

Value parameters

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

The result of reducing this collection with op if the collection is nonempty, inside a Some, and None otherwise.

Inherited from:

Source

Applies the given binary operator op to all elements of this collection, going right to left.

"Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this collection, the result is op(x1, op(x2, op( ... op(xn-1, xn) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this collection and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the binary operator, a supertype of A.

Value parameters

A binary operator.

Attributes

Returns

The result of applying op to all elements of this collection, going right to left.

Throws

Inherited from:

Source

If this collection is nonempty, reduces it with the given binary operator op, going right to left.

The behavior is the same as reduceRight except that the value is None if the collection is empty. Each element appears exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

The result type of the binary operator, a supertype of A.

Value parameters

A binary operator.

Attributes

Returns

The result of reducing this collection with op going right to left if the collection is nonempty, inside a Some, and None otherwise.

Inherited from:

Source

Returns a new sequence with the elements of this sequence in reverse order.

Note: will not terminate for infinite-sized collections.

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

Attributes

Returns

a new sequence with all elements of this sequence in reverse order.

Inherited from:

Source

An iterator yielding the elements of this sequence in reverse order.

Note: will not terminate for infinite-sized collections.

Note: xs.reverseIterator is the same as xs.reverse.iterator but might be more efficient.

Attributes

Returns

an iterator yielding the elements of this sequence in reverse order.

Inherited from:

Source

Tests whether the elements of this collection are the same (and in the same order) as those of that.

Attributes

Definition Classes

Inherited from:

Source

Computes a prefix scan of the elements of the collection.

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

Type parameters

element type of the resulting collection

Value parameters

the associative operator for the scan

neutral element for the operator op

Attributes

Returns

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

Inherited from:

Source

Produces a iterable collection containing cumulative results of applying the operator going left to right, including the initial value.

Note: will not terminate for infinite-sized collections.

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

Type parameters

the type of the elements in the resulting collection

Value parameters

the binary operator applied to the intermediate result and the element

the initial value

Attributes

Returns

collection with intermediate results

Definition Classes

Inherited from:

Source

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

the type of the elements in the resulting collection

Value parameters

the binary operator applied to the intermediate result and the element

the initial value

Attributes

Returns

collection with intermediate results

Inherited from:

Source

Searches within an interval in this sorted sequence for a specific element.

Searches within an interval in this sorted sequence for a specific element. If this sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.

Value parameters

elem

the element to find.

from

the index where the search starts.

ord

the ordering to be used to compare elements.

the index following where the search ends.

Attributes

Returns

a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.

See also

Note

if to <= from, the search space is empty, and an InsertionPoint at from is returned

Inherited from:

Source

Searches this sorted sequence for a specific element.

Searches this sorted sequence for a specific element. If the sequence is an IndexedSeq, a binary search is used. Otherwise, a linear search is used.

The sequence should be sorted with the same Ordering before calling; otherwise, the results are undefined.

Value parameters

elem

the element to find.

ord

the ordering to be used to compare elements.

Attributes

Returns

a Found value containing the index corresponding to the element in the sequence, or the InsertionPoint where the element would be inserted if the element is not in the sequence.

See also

Inherited from:

Source

Computes the length of the longest segment that starts from some index and whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters

from

the index where the search starts.

the predicate used to test elements.

Attributes

Returns

the length of the longest segment of this sequence starting from index from such that every element of the segment satisfies the predicate p.

Definition Classes

Inherited from:

Source

Computes the length of the longest segment that starts from the first element and whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

the length of the longest segment of this sequence that starts from the first element such that every element of the segment satisfies the predicate p.

Inherited from:

Source

The size of this sequence.

Note: will not terminate for infinite-sized collections.

Attributes

Returns

the number of elements in this sequence.

Definition Classes

Inherited from:

Source

Compares the size of this sequence to the size of another Iterable.

Value parameters

that

the Iterable whose size is compared with this sequence's size.

Attributes

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.

Definition Classes

Inherited from:

Source

Compares the size of this sequence to a test value.

Value parameters

otherSize

the test value that gets compared with the size.

Attributes

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

Definition Classes

Inherited from:

Source

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

Attributes

Inherited from:

Source

Selects an interval of elements.

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

from <= indexOf(x) < until

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

Value parameters

from

the lowest index to include from this iterable collection.

until

the lowest index to EXCLUDE from this iterable collection.

Attributes

Returns

a iterable collection containing the elements greater than or equal to index from extending up to (but not including) index until of this iterable collection.

Inherited from:

Source

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

Attributes

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:

Source

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

Attributes

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:

Source

Sorts this sequence according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

Note: will not terminate for infinite-sized collections.

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

The sort is stable. That is, elements that are equal (as determined by ord.compare) appear in the same order in the sorted sequence as in the original.

Type parameters

the target type of the transformation f, and the type where the ordering ord is defined.

Value parameters

the transformation function mapping elements to some other domain B.

ord

the ordering assumed on domain B.

Attributes

Returns

a sequence consisting of the elements of this sequence sorted according to the ordering where x < y if ord.lt(f(x), f(y)).

See also

Example

val words = "The quick brown fox jumped over the lazy dog".split(' ')
// this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
words.sortBy(x => (x.length, x.head))
res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)

Inherited from:

Source

Sorts this sequence according to a comparison function.

Note: will not terminate for infinite-sized collections.

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

The sort is stable. That is, elements that are equal (lt returns false for both directions of comparison) appear in the same order in the sorted sequence as in the original.

Value parameters

a predicate that is true if its first argument strictly precedes its second argument in the desired ordering.

Attributes

Returns

a sequence consisting of the elements of this sequence sorted according to the comparison function lt.

Example

List("Steve", "Bobby", "Tom", "John", "Bob").sortWith((x, y) => x.take(3).compareTo(y.take(3)) < 0) =
List("Bobby", "Bob", "John", "Steve", "Tom")

Inherited from:

Source

Sorts this sequence according to an Ordering.

The sort is stable. That is, elements that are equal (as determined by ord.compare) appear in the same order in the sorted sequence as in the original.

Value parameters

ord

the ordering to be used to compare elements.

Attributes

Returns

a sequence consisting of the elements of this sequence sorted according to the ordering ord.

See also

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

Inherited from:

Source

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

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

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

Value parameters

the test predicate

Attributes

Returns

a pair consisting of the longest prefix of this iterable collection whose elements all satisfy p, and the rest of this iterable collection.

Definition Classes

Inherited from:

Source

Splits this iterable collection into a prefix/suffix pair at a given position.

Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

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

Value parameters

the position at which to split.

Attributes

Returns

a pair of iterable collections consisting of the first n elements of this iterable collection, and the other elements.

Definition Classes

Inherited from:

Source

Tests whether this sequence contains the given sequence at a given index.

Note: If the both the receiver object this and the argument that are infinite sequences this method may not terminate.

Value parameters

offset

the index where the sequence is searched.

that

the sequence to test

Attributes

Returns

true if the sequence that is contained in this sequence at index offset, otherwise false.

Inherited from:

Source

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.

For collections of Int, Short, Byte or Char, an scala.collection.IntStepper is returned
For collections of Double or Float, a scala.collection.DoubleStepper is returned
For collections of Long a scala.collection.LongStepper is returned
For any other element type, an scala.collection.AnyStepper is returned

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.

Attributes

Inherited from:

IterableOnce

Source

Sums the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

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.

Attributes

Returns

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

Inherited from:

Source

The rest of the collection without its first element.

Iterates over the tails of this sequence.

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

Attributes

Returns

an iterator over all the tails of this sequence

Example

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

Definition Classes

Inherited from:

Source

Selects the first n elements.

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

Value parameters

the number of elements to take from this iterable collection.

Attributes

Returns

a iterable collection consisting only of the first n elements of this iterable collection, or else the whole iterable collection, if it has less than n elements. If n is negative, returns an empty iterable collection.

Inherited from:

Source

A collection containing the last n elements of this collection.

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

The predicate used to test elements.

Attributes

Returns

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

Inherited from:

Source

Applies a side-effecting function to each element in this collection.

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Type parameters

the return type of f

Value parameters

a function to apply to each element in this iterable collection

Attributes

Returns

The same logical collection as this

Definition Classes

Inherited from:

Source

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

Given a collection factory factory, converts 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]

Attributes

Inherited from:

Source

Converts this collection to an Array.

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

Type parameters

The type of elements of the result, a supertype of A.

Attributes

Returns

This collection as an Array[B].

Inherited from:

Source

Converts this collection to a Buffer.

Type parameters

The type of elements of the result, a supertype of A.

Attributes

Returns

This collection as a Buffer[B].

Inherited from:

Source

Converts this collection to an IndexedSeq.

Converts this collection to a List.

Converts this collection to a Map, given an implicit coercion from the collection's type to a key-value tuple.

Type parameters

The key type for the resulting map.

The value type for the resulting map.

Value parameters

An implicit coercion from A to [K, V].

Attributes

Returns

This collection as a Map[K, V].

Inherited from:

Source

Converts this collection to a Set.

Type parameters

The type of elements of the result, a supertype of A.

Attributes

Returns

This collection as a Set[B].

Inherited from:

Source

Converts this collection to a Vector.

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

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.

Attributes

Returns

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

Throws

Inherited from:

Source

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

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

Type parameters

the type of the first half of the element pairs

the type of the second half of the element pairs

Value parameters

asPair

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

Attributes

Returns

a pair of iterable collections, containing the first, respectively second half of each element pair of this iterable collection.

Definition Classes

Inherited from:

Source

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

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

Type parameters

the type of the first member of the element triples

the type of the second member of the element triples

the type of the third member of the element triples

Value parameters

asTriple

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

Attributes

Returns

a triple of iterable collections, containing the first, second, respectively third member of each element triple of this iterable collection.

Definition Classes

Inherited from:

Source

A copy of this sequence with one single replaced element.

Type parameters

the element type of the returned sequence.

Value parameters

elem

the replacing element

index

the position of the replacement

Attributes

Returns

a new sequence which is a copy of this sequence with the element at position index replaced by elem.

Throws

IndexOutOfBoundsException if index does not satisfy 0 <= index < length. In case of a lazy collection this exception may be thrown at a later time or not at all (if the end of the collection is never evaluated).

Inherited from:

Source

A view over the elements of this collection.

Attributes

Definition Classes

Inherited from:

Source

Creates a non-strict filter of this iterable collection.

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

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

Value parameters

the predicate used to test elements.

Attributes

Returns

an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this iterable collection which satisfy the predicate p.

Inherited from:

Source

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 longer than the other, its remaining elements are ignored.

Type parameters

the type of the second half of the returned pairs

Value parameters

that

The iterable providing the second half of each result pair

Attributes

Returns

a new iterable collection containing pairs consisting of corresponding elements of this iterable collection and that. The length of the returned collection is the minimum of the lengths of this iterable collection and that.

Definition Classes

Inherited from:

Source

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.

Attributes

Returns

a new collection of the type of this iterable collection 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:

Source

Zips this iterable collection with its indices.

Attributes

Returns

A new iterable collection containing pairs consisting of all elements of this iterable collection paired with their index. Indices start at 0.

Example

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

Definition Classes

Inherited from:

Source

The companion object of this iterable collection, providing various factory methods.

Attributes

Note

When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).

Inherited from:

Source

Aggregates the results of applying an operator to subsequent elements.

Since this method degenerates to foldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to prefer foldLeft for that case.

For parallel collections, use the aggregate method specified by scala.collection.parallel.ParIterableLike.

Type parameters

the result type, produced by seqop, combop, and by this function as a final result.

Value parameters

combop

an associative operator for combining sequential results, unused for sequential collections.

seqop

the binary operator used to accumulate the result.

the start value, a neutral element for seqop.

Attributes

Deprecated

[Since version 2.13.0] For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`.

Inherited from:

Source

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.

Attributes

Returns

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

See also

method knownSize for a more useful alternative

Deprecated

[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)

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:

Source

Returns the length of the longest prefix whose elements all satisfy some predicate.

Note: may not terminate for infinite-sized collections.

Value parameters

the predicate used to test elements.

Attributes

Returns

the length of the longest prefix of this sequence such that every element of the segment satisfies the predicate p.

Deprecated

[Since version 2.13.0] Use segmentLength instead of prefixLength

Inherited from:

Source

Attributes

Deprecated

[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside

Inherited from:

Source

Attributes

Deprecated

[Since version 2.13.0] Use .reverseIterator.map(f).to(...) instead of .reverseMap(f)

Inherited from:

Source

Attributes

Returns

This collection as an Iterable[A]. No new collection will be built if this is already an Iterable[A].

Deprecated

[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections

Inherited from:

Source

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.

Attributes

Returns

An Iterable containing all elements of this iterable collection.

Deprecated

[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections

Inherited from:

Source