A builder for mutable sequence of characters. This class provides an API
mostly compatible with `java.lang.StringBuilder`

, except where there are
conflicts with the Scala collections API (such as the `reverse`

method.)

This Builder can be reused after calling `result()`

without an
intermediate call to `clear()`

in order to build multiple related results.

- Companion
- object

## Value members

### Constructors

Constructs a string builder with no characters in it and an
initial capacity specified by the `capacity`

argument.

Constructs a string builder with no characters in it and an
initial capacity specified by the `capacity`

argument.

- Value Params
- capacity
the initial capacity.

- Throws
- java.lang.NegativeArraySizeException
if capacity < 0.

### Concrete methods

Appends the string representation of the given argument,
which is converted to a String with `String.valueOf`

.

Appends the string representation of the given argument,
which is converted to a String with `String.valueOf`

.

- Value Params
- x
an

`Any`

object.

- Returns
this StringBuilder.

Appends the given String to this sequence.

Appends the given String to this sequence.

- Value Params
- s
a String.

- Returns
this StringBuilder.

Appends the given CharSequence to this sequence.

Appends the given CharSequence to this sequence.

- Value Params
- cs
a CharSequence.

- Returns
this StringBuilder.

Appends the specified string builder to this sequence.

Appends the specified string builder to this sequence.

- Returns

Append the String representation of the given primitive type to this sequence.

Append the String representation of the given primitive type to this sequence. The argument is converted to a String with String.valueOf.

- Value Params
- x
a primitive value

- Returns
This StringBuilder.

Appends all the Chars in the given IterableOnce[Char] to this sequence.

Appends all the Chars in the given IterableOnce[Char] to this sequence.

- Value Params
- xs
the characters to be appended.

- Returns
this StringBuilder.

Appends all the Chars in the given Array[Char] to this sequence.

Appends all the Chars in the given Array[Char] to this sequence.

- Value Params
- xs
the characters to be appended.

- Returns
a reference to this object.

Appends a portion of the given Array[Char] to this sequence.

Appends a portion of the given Array[Char] to this sequence.

- Value Params
- len
the numbers of Chars to append.

- offset
the index of the first Char to append.

- xs
the Array containing Chars to be appended.

- Returns
this StringBuilder.

Returns the current capacity, which is the size of the underlying array.

Returns the current capacity, which is the size of the underlying array. A new array will be allocated if the current capacity is exceeded.

- Returns
the capacity

Returns the Char at the specified index, counting from 0 as in Arrays.

Returns the Char at the specified index, counting from 0 as in Arrays.

- Value Params
- index
the index to look up

- Returns
the Char at the given index.

- Throws
- IndexOutOfBoundsException
if the index is out of bounds.

Remove a subsequence of Chars from this sequence, starting at the given start index (inclusive) and extending to the end index (exclusive) or to the end of the String, whichever comes first.

Remove a subsequence of Chars from this sequence, starting at the given start index (inclusive) and extending to the end index (exclusive) or to the end of the String, whichever comes first.

- Value Params
- end
The ending index, exclusive.

- start
The beginning index, inclusive.

- Returns
This StringBuilder.

- Throws
- StringIndexOutOfBoundsException
if start < 0 || start > end

Removes the Char at the specified index.

Removes the Char at the specified index. The sequence is shortened by one.

- Value Params
- index
The index to remove.

- Returns
This StringBuilder.

- Throws
- IndexOutOfBoundsException
if the index is out of bounds.

Ensure that the capacity is at least the given argument.

Ensure that the capacity is at least the given argument.
If the argument is greater than the current capacity, new
storage will be allocated with size equal to the given
argument or to `(2 * capacity + 2)`

, whichever is larger.

- Value Params
- newCapacity
the minimum desired capacity.

Finds the index of the first occurrence of the specified substring.

Finds the index of the first occurrence of the specified substring.

- Value Params
- str
the target string to search for

- Returns
the first applicable index where target occurs, or -1 if not found.

Finds the index of the first occurrence of the specified substring.

Finds the index of the first occurrence of the specified substring.

- Value Params
- fromIndex
the smallest index in the source string to consider

- str
the target string to search for

- Returns
the first applicable index where target occurs, or -1 if not found.

Inserts the String representation (via String.valueOf) of the given argument into this sequence at the given index.

Inserts the String representation (via String.valueOf) of the given argument into this sequence at the given index.

- Value Params
- index
the index at which to insert.

- x
a value.

- Returns
this StringBuilder.

- Throws
- StringIndexOutOfBoundsException
if the index is out of bounds.

Inserts the String into this character sequence.

Inserts the String into this character sequence.

- Value Params
- index
the index at which to insert.

- x
a String.

- Returns
this StringBuilder.

- Throws
- StringIndexOutOfBoundsException
if the index is out of bounds.

Calls String.valueOf on the given primitive value, and inserts the String at the given index.

Calls String.valueOf on the given primitive value, and inserts the String at the given index.

- Value Params
- index
the offset position.

- x
a primitive value.

- Returns
this StringBuilder.

Inserts a subarray of the given Array[Char] at the given index of this sequence.

Inserts a subarray of the given Array[Char] at the given index of this sequence.

- Value Params
- index
index at which to insert the subarray.

- len
the number of Chars from 'str' to insert.

- offset
the index of the first Char to insert.

- str
the Array from which Chars will be taken.

- Returns
This StringBuilder.

- Throws
- StringIndexOutOfBoundsException
if index < 0, index > length, offset < 0, len < 0, or (offset + len) > str.length.

Inserts the given Seq[Char] into this sequence at the given index.

Inserts the given Seq[Char] into this sequence at the given index.

- Value Params
- index
the index at which to insert.

- xs
the Seq[Char].

- Returns
this StringBuilder.

- Throws
- StringIndexOutOfBoundsException
if the index is out of bounds.

Inserts the given Array[Char] into this sequence at the given index.

Inserts the given Array[Char] into this sequence at the given index.

- Value Params
- index
the index at which to insert.

- xs
the Array[Char].

- Returns
this StringBuilder.

- Throws
- StringIndexOutOfBoundsException
if the index is out of bounds.

Tests whether this builder is empty.

Tests whether this builder is empty.

This method is required for JDK15+ compatibility

- Returns
`true`

if this builder contains nothing,`false`

otherwise.- Definition Classes

Finds the index of the last occurrence of the specified substring.

Finds the index of the last occurrence of the specified substring.

- Value Params
- str
the target string to search for

- Returns
the last applicable index where target occurs, or -1 if not found.

Finds the index of the last occurrence of the specified substring.

Finds the index of the last occurrence of the specified substring.

- Value Params
- fromIndex
the smallest index in the source string to consider

- str
the target string to search for

- Returns
the last applicable index where target occurs, or -1 if not found.

Replaces a subsequence of Chars with the given String.

Replaces a subsequence of Chars with the given String. The semantics are as in delete, with the String argument then inserted at index 'start'.

- Value Params
- end
The ending index, exclusive.

- start
The beginning index, inclusive.

- str
The String to be inserted at the start index.

- Returns
This StringBuilder.

- Throws
- StringIndexOutOfBoundsException
if start < 0, start > length, or start > end

Like reverse, but destructively updates the target StringBuilder.

Like reverse, but destructively updates the target StringBuilder.

- Returns
the reversed StringBuilder (same as the target StringBuilder)

Update the sequence at the given index to hold the specified Char.

Update the sequence at the given index to hold the specified Char.

- Value Params
- ch
the new Char.

- index
the index to modify.

- Throws
- IndexOutOfBoundsException
if the index is out of bounds.

Sets the length of the character sequence.

Sets the length of the character sequence. If the current sequence is shorter than the given length, it is padded with nulls; if it is longer, it is truncated.

- Value Params
- len
the new length

- Throws
- IndexOutOfBoundsException
if the argument is negative.

Returns a new String made up of a subsequence of this sequence, beginning at the given index and extending to the end of the sequence.

Returns a new String made up of a subsequence of this sequence, beginning at the given index and extending to the end of the sequence.

target.substring(start) is equivalent to target.drop(start)

- Value Params
- start
The starting index, inclusive.

- Returns
The new String.

- Throws
- IndexOutOfBoundsException
if the index is out of bounds.

Returns a new String made up of a subsequence of this sequence, beginning at the start index (inclusive) and extending to the end index (exclusive).

Returns a new String made up of a subsequence of this sequence, beginning at the start index (inclusive) and extending to the end index (exclusive).

target.substring(start, end) is equivalent to target.slice(start, end).mkString

- Value Params
- end
The ending index, exclusive.

- start
The beginning index, inclusive.

- Returns
The new String.

- Throws
- StringIndexOutOfBoundsException
If either index is out of bounds, or if start > end.

### Deprecated methods

Like reverse, but destructively updates the target StringBuilder.

Like reverse, but destructively updates the target StringBuilder.

- Returns
the reversed StringBuilder (same as the target StringBuilder)

- Deprecated

### Inherited methods

Alias for `concat`

Alias for `concat`

- Inherited from
- IterableOps

Alias for `prependedAll`

Alias for `prependedAll`

- Definition Classes
- Inherited from
- SeqOps

Alias for `addAll`

Alias for `addAll`

- Inherited from
- Growable

Alias for `prepended`

.

Alias for `prepended`

.

Note that :-ending operators are right associative (see example).
A mnemonic for `+:`

vs. `:+`

is: the COLon goes on the COLlection side.

- Inherited from
- SeqOps

Alias for `addOne`

Alias for `addOne`

- Inherited from
- Growable

Alias for `appended`

Alias for `appended`

Note that :-ending operators are right associative (see example).
A mnemonic for `+:`

vs. `:+`

is: the COLon goes on the COLlection side.

- Inherited from
- SeqOps

Alias for `appendedAll`

Alias for `appendedAll`

- Inherited from
- SeqOps

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

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

- Value Params
- xs
the IterableOnce producing the elements to add.

- Returns
the growable collection itself.

- Inherited from
- Growable

Appends all elements of this collection to a string builder.

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

) of all elements of this collection without any separator string.

Example:

```
scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)
scala> val b = new StringBuilder()
b: StringBuilder =
scala> val h = a.addString(b)
h: StringBuilder = 1234
```

- Value Params
- b
the string builder to which elements are appended.

- Returns
the string builder

`b`

to which elements were appended.- Inherited from
- IterableOnceOps

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

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

)
of all elements of this collection, separated by the string `sep`

.

Example:

```
scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)
scala> val b = new StringBuilder()
b: StringBuilder =
scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
```

- Value Params
- b
the string builder to which elements are appended.

- sep
the separator string.

- Returns
the string builder

`b`

to which elements were appended.- Inherited from
- IterableOnceOps

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 Params
- b
the string builder to which elements are appended.

- end
the ending string.

- sep
the separator string.

- start
the starting string.

- Returns
the string builder

`b`

to which elements were appended.- Inherited from
- IterableOnceOps

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

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

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.

- Type Params
- C
the result type of the transformation function.

- Value Params
- k
the transformation function

- Returns
a partial function with the domain of this partial function narrowed by other partial function, which maps arguments

`x`

to`k(this(x))`

.- Inherited from
- PartialFunction

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

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

If the runtime type of the function is a `PartialFunction`

then the
other `andThen`

method is used (note its cautions).

- Type Params
- C
the result type of the transformation function.

- Value Params
- k
the transformation function

- Returns
a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments

`x`

to`k(this(x))`

.- Definition Classes
- Inherited from
- PartialFunction

A copy of this sequence with an element appended.

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 Params
- B
the element type of the returned sequence.

- Value Params
- elem
the appended element

- Returns
a new sequence consisting of all elements of this sequence followed by

`value`

.- Inherited from
- SeqOps

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 Params
- B
the element type of the returned collection.

- Value Params
- suffix
the iterable to append.

- Returns
a new collection of type

`CC[B]`

which contains all elements of this sequence followed by all elements of`suffix`

.- Inherited from
- SeqOps

Applies this partial function to the given argument when it is contained in the function domain.

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

Note that expression `pf.applyOrElse(x, default)`

is equivalent to

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

except that `applyOrElse`

method can be implemented more efficiently.
For all partial function literals the compiler generates an `applyOrElse`

implementation which
avoids double evaluation of pattern matchers and guards.
This makes `applyOrElse`

the basis for the efficient implementation for many operations and scenarios, such as:

- combining partial functions into `orElse`

/`andThen`

chains does not lead to
excessive `apply`

/`isDefinedAt`

evaluation
- `lift`

and `unlift`

do not evaluate source functions twice on each invocation
- `runWith`

allows efficient imperative-style combining of partial functions
with conditionally applied actions

For non-literal partial function classes with nontrivial `isDefinedAt`

method
it is recommended to override `applyOrElse`

with custom implementation that avoids
double `isDefinedAt`

evaluation. This may result in better performance
and more predictable behavior w.r.t. side effects.

- Value Params
- default
the fallback function

- x
the function argument

- Returns
the result of this function or fallback function application.

- Inherited from
- PartialFunction

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

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

Note: may not terminate for infinite-sized collections.

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

- Value Params
- pf
the partial function

- Returns
an option value containing pf applied to the first value for which it is defined, or

`None`

if none exists.- Example
`Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)`

- Inherited from
- IterableOnceOps

Iterates over combinations.

Iterates over combinations. A _combination_ of length `n`

is a subsequence of
the original sequence, with the elements taken in order. Thus, `"xy"`

and `"yy"`

are both length-2 combinations of `"xyy"`

, but `"yx"`

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

For example, `"xyyy"`

has three different ways to generate `"xy"`

depending on
whether the first, second, or third `"y"`

is selected. However, since all are
identical, only one will be chosen. Which of the three will be taken is an
implementation detail that is not defined.

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

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

- Example
`"abbbc".combinations(2) = Iterator(ab, ac, bb, bc)`

- Inherited from
- SeqOps

Composes another partial function `k`

with this partial function so that this
partial function gets applied to results of `k`

.

Composes another partial function `k`

with this partial function so that this
partial function gets applied to results of `k`

.

Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.

- Type Params
- R
the parameter type of the transformation function.

- Value Params
- k
the transformation function

- Returns
a partial function with the domain of other partial function narrowed by this partial function, which maps arguments

`x`

to`this(k(x))`

.- Inherited from
- PartialFunction

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

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

- Type Params
- A
the type to which function

`g`

can be applied

- Value Params
- g
a function A => T1

- Returns
a new function

`f`

such that`f(x) == apply(g(x))`

- Inherited from
- Function1

- Definition Classes
- Inherited from
- SeqOps

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

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

Note: may not terminate for infinite-sized collections.

- Value Params
- elem
the element to test.

- Returns
`true`

if this sequence has an element that is equal (as determined by`==`

) to`elem`

,`false`

otherwise.- Inherited from
- SeqOps

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

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

Note: may not terminate for infinite-sized collections.

- Value Params
- that
the sequence to test

- Returns
`true`

if this sequence contains a slice with the same elements as`that`

, otherwise`false`

.- Inherited from
- SeqOps

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

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

Fills the given array `xs`

starting at index `start`

with at most `len`

elements of this collection.

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

elements have been copied.

- Type Params
- B
the type of the elements of the array.

- Value Params
- len
the maximal number of elements to copy.

- start
the starting index of xs.

- xs
the array to fill.

- Returns
the number of elements written to the array

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

- Inherited from
- IterableOnceOps

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

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

Fills the given array `xs`

starting at index `start`

with values of this collection.

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

- Type Params
- B
the type of the elements of the array.

- Value Params
- start
the starting index of xs.

- xs
the array to fill.

- Returns
the number of elements written to the array

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

- Inherited from
- IterableOnceOps

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

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

Fills the given array `xs`

starting at index `start`

with values of this collection.

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

- Type Params
- B
the type of the elements of the array.

- Value Params
- xs
the array to fill.

- Returns
the number of elements written to the array

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

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Type Params
- B
the type of the elements of

`that`

- Value Params
- p
the test predicate, which relates elements from both collections

- that
the other collection

- Returns
`true`

if both collections have the same length and`p(x, y)`

is`true`

for all corresponding elements`x`

of this iterator and`y`

of`that`

, otherwise`false`

- Inherited from
- IterableOnceOps

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

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

- Type Params
- B
the type of the elements of

`that`

- Value Params
- p
the test predicate, which relates elements from both sequences

- that
the other sequence

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

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

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

Note: will not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
the number of elements satisfying the predicate

`p`

.- Inherited from
- IterableOnceOps

Computes the multiset difference between this sequence and another sequence.

Computes the multiset difference between this sequence and another sequence.

- Value Params
- that
the sequence of elements to remove

- 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.- Inherited from
- SeqOps

Selects all the elements of this sequence ignoring the duplicates.

Selects all the elements of this sequence ignoring the duplicates.

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

- Inherited from
- SeqOps

Selects all the elements of this sequence ignoring the duplicates as determined by `==`

after applying
the transforming function `f`

.

Selects all the elements of this sequence ignoring the duplicates as determined by `==`

after applying
the transforming function `f`

.

- Type Params
- B
the type of the elements after being transformed by

`f`

- Value Params
- f
The transforming function whose result is used to determine the uniqueness of each element

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

- Inherited from
- SeqOps

Returns an extractor object with a `unapplySeq`

method, which extracts each element of a sequence data.

Returns an extractor object with a `unapplySeq`

method, which extracts each element of a sequence data.

- Example
`val firstChar: String => Option[Char] = _.headOption Seq("foo", "bar", "baz") match { case firstChar.unlift.elementWise(c0, c1, c2) => println(s"$c0, $c1, $c2") // Output: f, b, b }`

- Inherited from
- PartialFunction

Tests whether this sequence ends with the given sequence.

Tests whether this sequence ends with the given sequence.

Note: will not terminate for infinite-sized collections.

- Value Params
- that
the sequence to test

- Returns
`true`

if this sequence has`that`

as a suffix,`false`

otherwise.- Inherited from
- SeqOps

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

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

Note: may not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
`true`

if the given predicate`p`

is satisfied by at least one element of this collection, otherwise`false`

- Inherited from
- IterableOnceOps

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

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

Note: may not terminate for infinite-sized collections.

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

- Value Params
- p
the predicate used to test elements.

- Returns
an option value containing the first element in the collection that satisfies

`p`

, or`None`

if none exists.- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
an option value containing the last element in the sequence that satisfies

`p`

, or`None`

if none exists.- Inherited from
- SeqOps

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

Folds the elements of this collection using the specified associative binary operator.
The default implementation in `IterableOnce`

is equivalent to `foldLeft`

but may be
overridden for more efficient traversal orders.

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

Note: will not terminate for infinite-sized collections.

- Type Params
- A1
a type parameter for the binary operator, a supertype of

`A`

.

- Value Params
- op
a binary operator that must be associative.

- z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g.,

`Nil`

for list concatenation, 0 for addition, or 1 for multiplication).

- Returns
the result of applying the fold operator

`op`

between all the elements and`z`

, or`z`

if this collection is empty.- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

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

- Type Params
- B
the result type of the binary operator.

- Value Params
- op
the binary operator.

- z
the start value.

- Returns
the result of inserting

`op`

between consecutive elements of this collection, going left to right with the start value`z`

on the left:`op(...op(z, x1), x2, ..., xn)`

where`x1, ..., xn`

are the elements of this collection. Returns`z`

if this collection is empty.- Inherited from
- IterableOnceOps

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

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

Note: may not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
`true`

if this collection is empty or the given predicate`p`

holds for all elements of this collection, otherwise`false`

.- Inherited from
- IterableOnceOps

Apply `f`

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

Apply `f`

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

- Inherited from
- IterableOnceOps

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

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

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

- Type Params
- K
the type of keys returned by the discriminator function.

- Value Params
- f
the discriminator function.

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

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

That is, every key

`k`

is bound to a iterable collection of those elements`x`

for which`f(x)`

equals`k`

.- Inherited from
- IterableOps

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

.

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

.
Each element in a group is transformed into a value of type `B`

using the `value`

function.

It is equivalent to `groupBy(key).mapValues(_.map(f))`

, but more efficient.

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

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

- Type Params
- B
the type of values returned by the transformation function

- K
the type of keys returned by the discriminator function

- Value Params
- f
the element transformation function

- key
the discriminator function

- Inherited from
- IterableOps

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

.

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

. All the values that
have the same discriminator are then transformed by the `f`

function and then reduced into a
single value with the `reduce`

function.

It is equivalent to `groupBy(key).mapValues(_.map(f).reduce(reduce))`

, but more efficient.

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

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

- Inherited from
- IterableOps

Partitions elements in fixed size iterable collections.

Partitions elements in fixed size iterable collections.

- Value Params
- size
the number of elements per group

- Returns
An iterator producing iterable collections of size

`size`

, except the last will be less than size`size`

if the elements don't divide evenly.- See also
scala.collection.Iterator, method

`grouped`

- Inherited from
- IterableOps

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

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

- Type Params
- B
the type of the element

`elem`

.

- Value Params
- elem
the element value to search for.

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

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

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

- Type Params
- B
the type of the element

`elem`

.

- Value Params
- elem
the element value to search for.

- from
the start index

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

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

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

Note: may not terminate for infinite-sized collections.

- Value Params
- that
the sequence to test

- Returns
the first index

`>= 0`

such that the elements of this sequence starting at this index match the elements of sequence`that`

, or`-1`

of no such subsequence exists.- Inherited from
- SeqOps

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

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 Params
- from
the start index

- that
the sequence to test

- Returns
the first index

`>= from`

such that the elements of this sequence starting at this index match the elements of sequence`that`

, or`-1`

of no such subsequence exists.- Inherited from
- SeqOps

Finds index of the first element satisfying some predicate.

Finds index of the first element satisfying some predicate.

Note: may not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
the index

`>= 0`

of the first element of this sequence that satisfies the predicate`p`

, or`-1`

, if none exists.- Inherited from
- SeqOps

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

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

Note: may not terminate for infinite-sized collections.

- Value Params
- from
the start index

- p
the predicate used to test elements.

- Returns
the index

`>= from`

of the first element of this sequence that satisfies the predicate`p`

, or`-1`

, if none exists.- Inherited from
- SeqOps

Produces the range of all indices of this sequence.

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.

- Returns
a

`Range`

value from`0`

to one less than the length of this sequence.- Inherited from
- SeqOps

The initial part of the collection without its last element.

The initial part of the collection without its last element.

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

- Inherited from
- IterableOps

Iterates over the inits of this iterable collection.

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

.

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

- Returns
an iterator over all the inits of this iterable collection

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

- Inherited from
- IterableOps

Computes the multiset intersection between this sequence and another sequence.

Computes the multiset intersection between this sequence and another sequence.

- Value Params
- that
the sequence of elements to intersect with.

- 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.- Inherited from
- SeqOps

Tests whether this sequence contains given index.

Tests whether this sequence contains given index.

The implementations of methods `apply`

and `isDefinedAt`

turn a `Seq[A]`

into
a `PartialFunction[Int, A]`

.

- Value Params
- idx
the index to test

- Returns
`true`

if this sequence contains an element at position`idx`

,`false`

otherwise.- Inherited from
- SeqOps

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

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 Params
- B
the type of the element

`elem`

.

- Value Params
- elem
the element value to search for.

- end
the end index.

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

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

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

Note: will not terminate for infinite-sized collections.

- Value Params
- that
the sequence to test

- Returns
the last index such that the elements of this sequence starting at this index match the elements of sequence

`that`

, or`-1`

of no such subsequence exists.- Inherited from
- SeqOps

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

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 Params
- end
the end index

- that
the sequence to test

- Returns
the last index

`<= end`

such that the elements of this sequence starting at this index match the elements of sequence`that`

, or`-1`

of no such subsequence exists.- Inherited from
- SeqOps

Finds index of last element satisfying some predicate.

Finds index of last element satisfying some predicate.

Note: will not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
the index of the last element of this sequence that satisfies the predicate

`p`

, or`-1`

, if none exists.- Inherited from
- SeqOps

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

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

Note: will not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
the index

`<= end`

of the last element of this sequence that satisfies the predicate`p`

, or`-1`

, if none exists.- Inherited from
- SeqOps

Optionally selects the last element.

Optionally selects the last element.

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

- Returns
the last element of this iterable collection$ if it is nonempty,

`None`

if it is empty.- Inherited from
- IterableOps

Analogous to `zip`

except that the elements in each collection are not consumed until a strict operation is
invoked on the returned `LazyZip2`

decorator.

Analogous to `zip`

except that the elements in each collection are not consumed until a strict operation is
invoked on the returned `LazyZip2`

decorator.

Calls to `lazyZip`

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

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

- Type Params
- B
the type of the second element in each eventual pair

- Value Params
- that
the iterable providing the second element of each eventual pair

- Returns
a decorator

`LazyZip2`

that allows strict operations to be performed on the lazily evaluated pairs or chained calls to`lazyZip`

. Implicit conversion to`Iterable[(A, B)]`

is also supported.- Inherited from
- Iterable

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

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

- Inherited from
- SeqOps

Turns this partial function into a plain function returning an `Option`

result.

Turns this partial function into a plain function returning an `Option`

result.

- Returns
a function that takes an argument

`x`

to`Some(this(x))`

if`this`

is defined for`x`

, and to`None`

otherwise.- See also
Function.unlift

- Inherited from
- PartialFunction

Modifies this mutable sequence by applying a function to all elements of this mutable sequence.

Modifies this mutable sequence by applying a function to all elements of this mutable sequence.

- Value Params
- f
the function to apply to each element.

- Returns
this mutable sequence modified by replacing all elements with the result of applying the given function

`f`

to each element of this mutable sequence.- Inherited from
- IndexedSeqOps

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

.

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

.

- Inherited from
- Builder

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The type over which the ordering is defined.

- Value Params
- ord
An ordering to be used for comparing elements.

- Returns
the largest element of this collection with respect to the ordering

`ord`

.- Throws
- UnsupportedOperationException
if this collection is empty.

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The result type of the function f.

- Value Params
- cmp
An ordering to be used for comparing elements.

- f
The measuring function.

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

`cmp`

.- Throws
- UnsupportedOperationException
if this collection is empty.

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The result type of the function f.

- Value Params
- cmp
An ordering to be used for comparing elements.

- f
The measuring function.

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

`cmp`

.- Inherited from
- IterableOnceOps

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The type over which the ordering is defined.

- Value Params
- ord
An ordering to be used for comparing elements.

- Returns
an option value containing the largest element of this collection with respect to the ordering

`ord`

.- Inherited from
- IterableOnceOps

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The type over which the ordering is defined.

- Value Params
- ord
An ordering to be used for comparing elements.

- Returns
the smallest element of this collection with respect to the ordering

`ord`

.- Throws
- UnsupportedOperationException
if this collection is empty.

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The result type of the function f.

- Value Params
- cmp
An ordering to be used for comparing elements.

- f
The measuring function.

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

`cmp`

.- Throws
- UnsupportedOperationException
if this collection is empty.

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The result type of the function f.

- Value Params
- cmp
An ordering to be used for comparing elements.

- f
The measuring function.

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

`cmp`

.- Inherited from
- IterableOnceOps

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

- Type Params
- B
The type over which the ordering is defined.

- Value Params
- ord
An ordering to be used for comparing elements.

- Returns
an option value containing the smallest element of this collection with respect to the ordering

`ord`

.- Inherited from
- IterableOnceOps

Displays all elements of this collection in a string.

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

- Returns
a string representation of this collection. In the resulting string the string representations (w.r.t. the method

`toString`

) of all elements of this collection follow each other without any separator string.- Inherited from
- IterableOnceOps

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

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

Delegates to addString, which can be overridden.

- Value Params
- sep
the separator string.

- Returns
a string representation of this collection. In the resulting string the string representations (w.r.t. the method

`toString`

) of all elements of this collection are separated by the string`sep`

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

- Inherited from
- IterableOnceOps

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

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

Delegates to addString, which can be overridden.

- Value Params
- end
the ending string.

- sep
the separator string.

- start
the starting string.

- Returns
a string representation of this collection. The resulting string begins with the string

`start`

and ends with the string`end`

. Inside, the string representations (w.r.t. the method`toString`

) of all elements of this collection are separated by the string`sep`

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

- Inherited from
- IterableOnceOps

Tests whether the collection is not empty.

Tests whether the collection is not empty.

- Returns
`true`

if the collection contains at least one element,`false`

otherwise.- Inherited from
- IterableOnceOps

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

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

- Type Params
- A1
the argument type of the fallback function

- B1
the result type of the fallback function

- Value Params
- that
the fallback function

- Returns
a partial function which has as domain the union of the domains of this partial function and

`that`

. The resulting partial function takes`x`

to`this(x)`

where`this`

is defined, and to`that(x)`

where it is not.- Inherited from
- PartialFunction

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

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

- Type Params
- B
the element type of the returned sequence.

- Value Params
- elem
the padding value

- len
the target length

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

.- Inherited from
- SeqOps

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.

- Inherited from
- IterableOps

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.

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 Params
- A1
the element type of the first resulting collection

- A2
the element type of the second resulting collection

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

- 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.- Inherited from
- IterableOps

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

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 more values are replaced than actually exist, the excess is ignored.

- Type Params
- B
the element type of the returned sequence.

- Value Params
- from
the index of the first replaced element

- other
the replacement sequence

- replaced
the number of elements to drop in the original sequence

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

Iterates over distinct permutations.

Iterates over distinct permutations.

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

- Returns
An Iterator which traverses the distinct permutations of this sequence.

- Example
`"abb".permutations = Iterator(abb, bab, bba)`

- Inherited from
- SeqOps

As with `:++`

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

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 Params
- B
the element type of the returned collection.

- Value Params
- prefix
the iterable to prepend.

- Returns
a new sequence which contains all elements of

`prefix`

followed by all the elements of this sequence.- Inherited from
- SeqOps

Multiplies up the elements of this collection.

Multiplies up the elements of this collection.

Note: will not terminate for infinite-sized collections.

- Type Params
- B
the result type of the

`*`

operator.

- Value Params
- num
an implicit parameter defining a set of numeric operations which includes the

`*`

operator to be used in forming the product.

- Returns
the product of all elements of this collection with respect to the

`*`

operator in`num`

.- Inherited from
- IterableOnceOps

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

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

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

- Type Params
- B
A type parameter for the binary operator, a supertype of

`A`

.

- Value Params
- op
A binary operator that must be associative.

- Returns
The result of applying reduce operator

`op`

between all the elements if the collection is nonempty.- Throws
- UnsupportedOperationException
if this collection is empty.

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

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

- Type Params
- B
the result type of the binary operator.

- Value Params
- op
the binary operator.

- Returns
the result of inserting

`op`

between consecutive elements of this collection, going left to right:`op( op( ... op(x1, x2) ..., xn-1), xn)`

where`x1, ..., xn`

are the elements of this collection.- Throws
- UnsupportedOperationException
if this collection is empty.

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

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

- Type Params
- B
the result type of the binary operator.

- Value Params
- op
the binary operator.

- Returns
an option value containing the result of

`reduceLeft(op)`

if this collection is nonempty,`None`

otherwise.- Inherited from
- IterableOnceOps

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

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

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

- Type Params
- B
A type parameter for the binary operator, a supertype of

`A`

.

- Value Params
- op
A binary operator that must be associative.

- Returns
An option value containing result of applying reduce operator

`op`

between all the elements if the collection is nonempty, and`None`

otherwise.- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Type Params
- B
the result type of the binary operator.

- Value Params
- op
the binary operator.

- Returns
the result of inserting

`op`

between consecutive elements of this collection, going right to left:`op(x1, op(x2, ..., op(xn-1, xn)...))`

where`x1, ..., xn`

are the elements of this collection.- Throws
- UnsupportedOperationException
if this collection is empty.

- Inherited from
- IterableOnceOps

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

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

Note: will not terminate for infinite-sized collections.

- Type Params
- B
the result type of the binary operator.

- Value Params
- op
the binary operator.

- Returns
an option value containing the result of

`reduceRight(op)`

if this collection is nonempty,`None`

otherwise.- Inherited from
- IterableOnceOps

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

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

Note that expression `pf.runWith(action)(x)`

is equivalent to

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

except that `runWith`

is implemented via `applyOrElse`

and thus potentially more efficient.
Using `runWith`

avoids double evaluation of pattern matchers and guards for partial function literals.

- Value Params
- action
the action function

- Returns
a function which maps arguments

`x`

to`isDefinedAt(x)`

. The resulting function runs`action(this(x))`

where`this`

is defined.- See also
`applyOrElse`

.- Inherited from
- PartialFunction

Are the elements of this collection the same (and in the same order)
as those of `that`

?

Are the elements of this collection the same (and in the same order)
as those of `that`

?

- Inherited from
- SeqOps

Computes a prefix scan of the elements of the collection.

Computes a prefix scan of the elements of the collection.

Note: The neutral element `z`

may be applied more than once.

- Type Params
- B
element type of the resulting collection

- Value Params
- op
the associative operator for the scan

- z
neutral element for the operator

`op`

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

- Inherited from
- IterableOps

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

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

Note: will not terminate for infinite-sized collections.

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

Example:

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

- Type Params
- B
the type of the elements in the resulting collection

- Value Params
- op
the binary operator applied to the intermediate result and the element

- z
the initial value

- Returns
collection with intermediate results

- Inherited from
- IterableOps

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

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 Params
- from
the index where the search starts.

- p
the predicate used to test elements.

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

.- Inherited from
- SeqOps

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

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 Params
- p
the predicate used to test elements.

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

Gives a hint that one expects the `result`

of this builder
to have the same size as the given collection, plus some delta.

Gives a hint that one expects the `result`

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

- Value Params
- coll
the collection which serves as a hint for the result's size.

- delta
a correction to add to the

`coll.size`

to produce the size hint.

- Inherited from
- Builder

Gives a hint how many elements are expected to be added
when the next `result`

is called.

Gives a hint how many elements are expected to be added
when the next `result`

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

- Value Params
- size
the hint how many elements will be added.

- Inherited from
- Builder

Gives a hint how many elements are expected to be added
when the next `result`

is called, together with an upper bound
given by the size of some other collection.

Gives a hint how many elements are expected to be added
when the next `result`

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

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

- size
the hint how many elements will be added.

- Inherited from
- Builder

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

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

These operations are implemented in terms of `sizeCompare(Int)`

, and
allow the following more readable usages:

```
this.sizeIs < size // this.sizeCompare(size) < 0
this.sizeIs <= size // this.sizeCompare(size) <= 0
this.sizeIs == size // this.sizeCompare(size) == 0
this.sizeIs != size // this.sizeCompare(size) != 0
this.sizeIs >= size // this.sizeCompare(size) >= 0
this.sizeIs > size // this.sizeCompare(size) > 0
```

- Inherited from
- IterableOps

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

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

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

- Value Params
- size
the number of elements per group

- step
the distance between the first elements of successive groups

- Returns
An iterator producing iterable collections of size

`size`

, except the last element (which may be the only element) will be smaller if there are fewer than`size`

elements remaining to be grouped.- See also
scala.collection.Iterator, method

`sliding`

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

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

- Inherited from
- IterableOps

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

.)

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

.)

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

- Value Params
- size
the number of elements per group

- Returns
An iterator producing iterable collections of size

`size`

, except for a non-empty collection with less than`size`

elements, which returns an iterator that produces the source collection itself as its only element.- See also
scala.collection.Iterator, method

`sliding`

- Example
`List().sliding(2) = empty iterator`

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

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

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

- Inherited from
- IterableOps

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

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 Params
- B
the target type of the transformation

`f`

, and the type where the ordering`ord`

is defined.

- Value Params
- f
the transformation function mapping elements to some other domain

`B`

.- ord
the ordering assumed on domain

`B`

.

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

Sorts this mutable sequence in place according to an Ordering.

Sorts this mutable sequence in place according to an Ordering.

- Value Params
- ord
the ordering to be used to compare elements.

- Returns
modified input mutable sequence sorted according to the ordering

`ord`

.- See also
- Inherited from
- IndexedSeqOps

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

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

- See also
- Inherited from
- IndexedSeqOps

Sorts this mutable sequence in place according to a comparison function.

Sorts this mutable sequence in place according to a comparison function.

- See also
- Inherited from
- IndexedSeqOps

Sorts this sequence according to a comparison function.

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 (as determined by
`lt`

) appear in the same order in the sorted sequence as in the original.

- Value Params
- lt
the comparison function which tests whether its first argument precedes its second argument in the desired ordering.

- Returns
a sequence consisting of the elements of this sequence sorted according to the comparison function

`lt`

.- Example
`List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) = List("Bob", "John", "Steve", "Tom")`

- Inherited from
- SeqOps

Sorts this sequence according to an Ordering.

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 Params
- ord
the ordering to be used to compare elements.

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

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

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 Params
- offset
the index where the sequence is searched.

- that
the sequence to test

- Returns
`true`

if the sequence`that`

is contained in this sequence at index`offset`

, otherwise`false`

.- Inherited from
- SeqOps

Sums up the elements of this collection.

Sums up the elements of this collection.

Note: will not terminate for infinite-sized collections.

- Type Params
- B
the result type of the

`+`

operator.

- Value Params
- num
an implicit parameter defining a set of numeric operations which includes the

`+`

operator to be used in forming the sum.

- Returns
the sum of all elements of this collection with respect to the

`+`

operator in`num`

.- Inherited from
- IterableOnceOps

The rest of the collection without its first element.

The rest of the collection without its first element.

- Inherited from
- IterableOps

Iterates over the tails of this iterable collection.

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

.

- Returns
an iterator over all the tails of this iterable collection

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

- Inherited from
- IterableOps

Takes longest prefix of elements that satisfy a predicate.

Takes longest prefix of elements that satisfy a predicate.

- Value Params
- p
The predicate used to test elements.

- Returns
the longest prefix of this iterable collection whose elements all satisfy the predicate

`p`

.- Inherited from
- IterableOps

Given a collection factory `factory`

, convert this collection to the appropriate
representation for the current element type `A`

.

Given a collection factory `factory`

, convert this collection to the appropriate
representation for the current element type `A`

. Example uses:

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

- Inherited from
- IterableOnceOps

- Returns
This collection as a

`Seq[A]`

. This is equivalent to`to(Seq)`

but might be faster.- Inherited from
- IterableOnceOps

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

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

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

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

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

- Type Params
- B
the type of the elements of each iterable collection.

- Value Params
- asIterable
an implicit conversion which asserts that the element type of this iterable collection is an

`Iterable`

.

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

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

- Inherited from
- IterableOps

Tries to extract a `B`

from an `A`

in a pattern matching expression.

Tries to extract a `B`

from an `A`

in a pattern matching expression.

- Inherited from
- PartialFunction

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

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 Params
- A1
the type of the first half of the element pairs

- A2
the type of the second half of the element pairs

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

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

- Inherited from
- IterableOps

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

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 Params
- A1
the type of the first member of the element triples

- A2
the type of the second member of the element triples

- A3
the type of the third member of the element triples

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

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

- Inherited from
- IterableOps

A copy of this sequence with one single replaced element.

A copy of this sequence with one single replaced element.

- Type Params
- B
the element type of the returned sequence.

- Value Params
- elem
the replacing element

- index
the position of the replacement

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

Creates a non-strict filter of this iterable collection.

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.

- Value Params
- p
the predicate used to test elements.

- Returns
an object of class

`WithFilter`

, which supports`map`

,`flatMap`

,`foreach`

, and`withFilter`

operations. All these operations apply to those elements of this iterable collection which satisfy the predicate`p`

.- Inherited from
- IterableOps

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 Params
- B
the type of the second half of the returned pairs

- Value Params
- that
The iterable providing the second half of each result pair

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

.- Inherited from
- IterableOps

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

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

- Value Params
- that
the iterable providing the second half of each result pair

- thatElem
the element to be used to fill up the result if

`that`

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

`that`

.

- Returns
a new collection of type

`That`

containing pairs consisting of corresponding elements of this iterable collection and`that`

. The length of the returned collection is the maximum of the lengths of this iterable collection and`that`

. If this iterable collection is shorter than`that`

,`thisElem`

values are used to pad the result. If`that`

is shorter than this iterable collection,`thatElem`

values are used to pad the result.- Inherited from
- IterableOps

### Deprecated and Inherited methods

Adds two or more elements to this growable collection.

Adds two or more elements to this growable collection.

- Value Params
- elem1
the first element to add.

- elem2
the second element to add.

- elems
the remaining elements to add.

- Returns
the growable collection itself

- Deprecated
- Inherited from
- Growable

- Deprecated
- Inherited from
- IterableOnceOps

- Deprecated
- Inherited from
- IterableOnceOps

- Deprecated
- Inherited from
- IterableOps

- Deprecated
- Inherited from
- IterableOnceOps

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

Tests whether this collection is known to have a finite size.
All strict collections are known to have finite size. For a non-strict
collection such as `Stream`

, the predicate returns `true`

if all
elements have been computed. It returns `false`

if the stream is
not yet evaluated to the end. Non-empty Iterators usually return
`false`

even if they were created from a collection with a known
finite size.

Note: many collection methods will not work on collections of infinite sizes.
The typical failure mode is an infinite loop. These methods always attempt a
traversal without checking first that `hasDefiniteSize`

returns `true`

.
However, checking `hasDefiniteSize`

can provide an assurance that size is
well-defined and non-termination is not a concern.

- Returns
`true`

if this collection is known to have finite size,`false`

otherwise.- See also
method

`knownSize`

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

`hasDefiniteSize`

returns`false`

.- Inherited from
- IterableOnceOps

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

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

Note: may not terminate for infinite-sized collections.

- Value Params
- p
the predicate used to test elements.

- Returns
the length of the longest prefix of this sequence such that every element of the segment satisfies the predicate

`p`

.- Deprecated
- Inherited from
- SeqOps

- Deprecated
- Inherited from
- IterableOps

- Deprecated
- Inherited from
- SeqOps

- Deprecated
- Inherited from
- Iterable

- Deprecated
- Inherited from
- IterableOnceOps

- Deprecated
- Inherited from
- IterableOnceOps

Converts this iterable collection to an unspecified Iterable.

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

- Returns
An Iterable containing all elements of this iterable collection.

- Deprecated
- Inherited from
- IterableOps

- Deprecated
- Inherited from
- SeqOps

Produces a new sequence which contains all elements of this sequence and also all elements of a given sequence.

Produces a new sequence which contains all elements of this sequence and also all elements of
a given sequence. `xs union ys`

is equivalent to `xs ++ ys`

.

- Type Params
- B
the element type of the returned sequence.

- Value Params
- that
the sequence to add.

- Returns
a new collection which contains all elements of this sequence followed by all elements of

`that`

.- Deprecated
- Inherited from
- SeqOps

- Deprecated
- Definition Classes
- Inherited from
- IndexedSeqOps