A Buffer
implementation backed by a list. It provides constant time prepend and append. Most other operations are linear.
Type parameters
- A
-
the type of this list buffer's elements.
Attributes
- See also
-
"Scala's Collection Library overview" section on
List Buffers
for more information. - Companion
- object
- Source
- ListBuffer.scala
- Graph
-
- Supertypes
-
trait DefaultSerializabletrait Serializableclass AbstractBuffer[A]trait Buffer[A]trait Shrinkable[A]trait Growable[A]trait Clearableclass AbstractSeq[A]trait Seq[A]trait Cloneabletrait Iterable[A]class AbstractSeq[A]trait Seq[A]trait Equalsclass AbstractIterable[A]trait Iterable[A]trait IterableOnce[A]class Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Adds all elements produced by an IterableOnce to this list buffer.
Adds all elements produced by an IterableOnce to this list buffer.
Value parameters
- elems
-
the IterableOnce producing the elements to add.
Attributes
- Returns
-
the list buffer itself.
- Definition Classes
- Source
- ListBuffer.scala
Adds a single element to this list buffer.
Adds a single element to this list buffer.
Value parameters
- elem
-
the element to add.
Attributes
- Returns
-
the list buffer itself
- Source
- ListBuffer.scala
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
- Source
- ListBuffer.scala
Clears the contents of this builder.
Clears the contents of this builder. After execution of this method, the builder will contain no elements.
If executed immediately after a call to result()
, this allows a new instance of the same type of collection to be built.
Attributes
- Source
- ListBuffer.scala
Replace the contents of this list buffer with the filtered result.
Replace the contents of this list buffer with the filtered result.
Value parameters
- p
-
the filtering predicate
Attributes
- Returns
-
this list buffer
- Source
- ListBuffer.scala
Replace the contents of this list buffer with the flatmapped result.
Replace the contents of this list buffer with the flatmapped result.
Value parameters
- f
-
the mapping function
Attributes
- Returns
-
this list buffer
- Source
- ListBuffer.scala
Inserts a new element at a given index into this buffer.
Inserts a new element at a given index into this buffer.
Value parameters
- elem
-
the element to insert.
- idx
-
the index where the new elements is inserted.
Attributes
- Throws
-
IndexOutOfBoundsException if the index
idx
is not in the valid range0 <= idx <= length
. - Source
- ListBuffer.scala
Inserts new elements at the index idx
.
Inserts new elements at the index idx
. Opposed to method update
, this method will not replace an element with a new one. Instead, it will insert a new element at index idx
.
Value parameters
- elems
-
the iterable object providing all elements to insert.
- idx
-
the index where a new element will be inserted.
Attributes
- Throws
-
IndexOutOfBoundsException if
idx
is out of bounds. - Source
- ListBuffer.scala
Tests whether the list buffer is empty.
Tests whether the list buffer 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 list buffer contains no elements,false
otherwise. - Definition Classes
- Source
- ListBuffer.scala
The companion object of this list buffer, providing various factory methods.
The companion object of this list buffer, 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). - Definition Classes
- Source
- ListBuffer.scala
An scala.collection.Iterator over the elements of this list buffer.
An scala.collection.Iterator over the elements of this list buffer.
If an IterableOnce
object is in fact an scala.collection.Iterator, this method always returns itself, in its current state, but if it is an scala.collection.Iterable, this method always returns a new scala.collection.Iterator.
Attributes
- Source
- ListBuffer.scala
The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.
The number of elements in the collection under construction, if it can be cheaply computed, -1 otherwise.
Attributes
- Returns
-
The number of elements. The default implementation always returns -1.
- Definition Classes
- Source
- ListBuffer.scala
Selects the last element.
Selects the last element.
Runs in constant time.
Attributes
- Returns
-
The last element of this list buffer.
- Throws
-
NoSuchElementException If the list buffer is empty.
- Definition Classes
- Source
- ListBuffer.scala
Optionally selects the last element.
Optionally selects the last element.
Runs in constant time.
Attributes
- Returns
-
the last element of this list buffer$ if it is nonempty,
None
if it is empty. - Definition Classes
- Source
- ListBuffer.scala
The length (number of elements) of the list buffer.
The length (number of elements) of the list buffer. size
is an alias for length
in Seq
collections.
Attributes
- Source
- ListBuffer.scala
Replace the contents of this list buffer with the mapped result.
Replace the contents of this list buffer with the mapped result.
Value parameters
- f
-
the mapping function
Attributes
- Returns
-
this list buffer
- Source
- ListBuffer.scala
Replaces a slice of elements in this list buffer by another sequence of elements.
Replaces a slice of elements in this list buffer by another sequence of elements.
Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original list buffer appends the patch to the end. If the replaced
count would exceed the available elements, the difference in excess is ignored.
Value parameters
- from
-
the index of the first replaced element
- patch
-
the replacement sequence
- replaced
-
the number of elements to drop in the original list buffer
Attributes
- Returns
-
this list buffer
- Source
- ListBuffer.scala
Prepends a single element at the front of this list buffer.
Prepends a single element at the front of this list buffer.
Value parameters
- elem
-
the element to add.
Attributes
- Returns
-
the list buffer itself
- Source
- ListBuffer.scala
Prepends the elements of this buffer to a given list
Prepends the elements of this buffer to a given list
Value parameters
- xs
-
the list to which elements are prepended
Attributes
- Source
- ListBuffer.scala
Removes the element at a given index position.
Removes the element at a given index position.
Value parameters
- idx
-
the index which refers to the element to delete.
Attributes
- Returns
-
the element that was formerly at index
idx
. - Source
- ListBuffer.scala
Removes the element on a given index position.
Removes the element on a given index position. It takes time linear in the buffer size.
Value parameters
- count
-
the number of elements to remove.
- idx
-
the index which refers to the first element to remove.
Attributes
- Throws
-
IllegalArgumentException if
count < 0
.IndexOutOfBoundsException if the index
idx
is not in the valid range0 <= idx <= length - count
(withcount > 0
). - Source
- ListBuffer.scala
Produces a collection from the added elements.
Produces a collection from the added elements.
After a call to result
, the behavior of all other methods is undefined save for clear()
. If clear()
is called, then the builder is reset and may be used to build another instance.
Attributes
- Returns
-
a collection containing the elements added to this builder.
- Source
- ListBuffer.scala
Removes a single element from this buffer, at its first occurrence.
Removes a single element from this buffer, at its first occurrence. If the buffer does not contain that element, it is unchanged.
Value parameters
- x
-
the element to remove.
Attributes
- Returns
-
the buffer itself
- Definition Classes
-
Buffer -> Shrinkable
- Source
- ListBuffer.scala
Converts this list buffer to a List
.
Converts this list buffer to a List
.
Attributes
- Returns
-
This list buffer as a
List[A]
. - Definition Classes
- Source
- ListBuffer.scala
Replaces element at given index with a new value.
Replaces element at given index with a new value.
Value parameters
- elem
-
the new value.
- idx
-
the index of the element to replace.
Attributes
- Throws
-
IndexOutOfBoundsException if the index is not valid.
- Source
- ListBuffer.scala
Inherited methods
Alias for concat
Alias for prependedAll
.
Alias for prependedAll
.
Attributes
Alias for addAll
Alias for prependAll
Alias for addOne
Alias for prepend
Alias for subtractAll
Alias for subtractOne
Appends all elements of this collection to a string builder.
Appends all elements of this collection to a string builder. The written text consists of the string representations (w.r.t. the method toString
) of all elements of this collection without any separator string.
Example:
scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)
scala> val b = new StringBuilder()
b: StringBuilder =
scala> val h = a.addString(b)
h: StringBuilder = 1234
Value parameters
- b
-
the string builder to which elements are appended.
Attributes
- Returns
-
the string builder
b
to which elements were appended. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Appends all elements of this collection to a string builder using a separator string.
Appends all elements of this collection to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString
) of all elements of this collection, separated by the string sep
.
Example:
scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)
scala> val b = new StringBuilder()
b: StringBuilder =
scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
Value parameters
- b
-
the string builder to which elements are appended.
- sep
-
the separator string.
Attributes
- Returns
-
the string builder
b
to which elements were appended. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Appends all elements of this collection to a string builder using 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
- b
-
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:
- IterableOnceOps
- Source
- IterableOnce.scala
Composes this partial function with another partial function that gets applied to results of this partial function.
Composes this partial function with another partial function that gets applied to results of this partial function.
Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.
Type parameters
- C
-
the result type of the transformation function.
Value parameters
- k
-
the transformation function
Attributes
- Returns
-
a partial function with the domain of this partial function narrowed by other partial function, which maps arguments
x
tok(this(x))
. - Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
Composes this partial function with a transformation function that gets applied to results of this partial function.
Composes this partial function with a transformation function that gets applied to results of this partial function.
If the runtime type of the function is a PartialFunction
then the other andThen
method is used (note its cautions).
Type parameters
- C
-
the result type of the transformation function.
Value parameters
- k
-
the transformation function
Attributes
- Returns
-
a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments
x
tok(this(x))
. - Definition Classes
- Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
Appends the given elements to this buffer.
Appends the given elements to this buffer.
Value parameters
- elem
-
the element to append.
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
Appends the elements contained in a iterable object to this buffer.
Appends the elements contained in a iterable object to this buffer.
Value parameters
- elems
-
the iterable object containing the elements to append.
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
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 parameters
- B
-
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:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
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
- B
-
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 ofsuffix
. - Definition Classes
- Inherited from:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
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 parameters
- default
-
the fallback function
- x
-
the function argument
Attributes
- Returns
-
the result of this function or fallback function application.
- Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
Checks whether this instance can possibly equal that
.
Checks whether this instance can possibly equal that
.
A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.
Value parameters
- that
-
the value being probed for possible equality
Attributes
Create a copy of the receiver object.
Builds a new iterable collection by applying a partial function to all elements of this iterable collection on which the function is defined.
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
- B
-
the element type of the returned iterable collection.
Value parameters
- pf
-
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Finds the first element of the collection for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the collection for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- pf
-
the partial function
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:
- IterableOnceOps
- Source
- IterableOnce.scala
Iterates over combinations of elements.
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:
- SeqOps
- Source
- Seq.scala
Composes another partial function k
with this partial function so that this partial function gets applied to results of k
.
Composes another partial function k
with this partial function so that this partial function gets applied to results of k
.
Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. For efficiency, it is recommended to call applyOrElse instead of isDefinedAt or apply.
Type parameters
- R
-
the parameter type of the transformation function.
Value parameters
- k
-
the transformation function
Attributes
- Returns
-
a partial function with the domain of other partial function narrowed by this partial function, which maps arguments
x
tothis(k(x))
. - Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
Composes two instances of Function1
in a new Function1
, with this function applied last.
Composes two instances of Function1
in a new Function1
, with this function applied last.
Type parameters
- A
-
the type to which function
g
can be applied
Value parameters
- g
-
a function A => T1
Attributes
- Returns
-
a new function
f
such thatf(x) == apply(g(x))
- Inherited from:
- Function1
- Source
- Function1.scala
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
- B
-
the element type of the returned collection.
Value parameters
- suffix
-
the iterable to append.
Attributes
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 parameters
- elem
-
the element to test.
Attributes
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 parameters
- that
-
the sequence to test
Attributes
Copy elements to an array, returning the number of elements written.
Copy elements to an array, returning the number of elements written.
Fills the given array xs
starting at index start
with at most len
elements of this collection.
Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached, or len
elements have been copied.
Type parameters
- B
-
the type of the elements of the array.
Value parameters
- len
-
the maximal number of elements to copy.
- start
-
the starting index of xs.
- xs
-
the array to fill.
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:
- IterableOnceOps
- Source
- IterableOnce.scala
Copies elements to an array, returning the number of elements written.
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
- B
-
the type of the elements of the array.
Value parameters
- start
-
the starting index of xs.
- 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:
- IterableOnceOps
- Source
- IterableOnce.scala
Copies elements to an array, returning the number of elements written.
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
- B
-
the type of the elements of the array.
Value parameters
- 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:
- IterableOnceOps
- Source
- IterableOnce.scala
Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.
Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
the type of the elements of
that
Value parameters
- p
-
the test predicate, which relates elements from both collections
- that
-
the other collection
Attributes
- Returns
-
true
if both collections have the same length andp(x, y)
istrue
for all corresponding elementsx
of this iterator andy
ofthat
, otherwisefalse
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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 parameters
- B
-
the type of the elements of
that
Value parameters
- p
-
the test predicate, which relates elements from both sequences
- that
-
the other sequence
Attributes
Counts the number of elements in the collection which satisfy a predicate.
Counts the number of elements in the collection which satisfy a predicate.
Note: will not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
the number of elements satisfying the predicate
p
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Computes the multiset difference between this sequence and another sequence.
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 valuex
appears n times inthat
, then the first n occurrences ofx
will not form part of the result, but any following occurrences will. - Definition Classes
- Inherited from:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
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 parameters
- B
-
the type of the elements after being transformed by
f
Value parameters
- f
-
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:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
Selects all elements except the first n
ones.
Selects all elements except the first n
ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- n
-
the number of elements to drop from this iterable collection.
Attributes
- Returns
-
a iterable collection consisting of all elements of this iterable collection except the first
n
ones, or else the empty iterable collection, if this iterable collection has less thann
elements. Ifn
is negative, don't drop any elements. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Removes the first n
elements from this shrinkable collection.
Removes the first n
elements from this shrinkable collection.
Value parameters
- n
-
the number of elements to remove
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Removes the last n
elements from this shrinkable collection.
Removes the last n
elements from this shrinkable collection.
Value parameters
- n
-
the number of elements to remove
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
Selects all elements except the longest prefix that satisfies a predicate.
Selects all elements except the longest prefix that satisfies a predicate.
The matching prefix starts with the first element of this iterable collection, 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 iterable collection.
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.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- p
-
The predicate used to test elements.
Attributes
- Returns
-
the longest suffix of this iterable collection whose first element does not satisfy the predicate
p
. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Drops the longest prefix of elements that satisfy a predicate.
Drops the longest prefix of elements that satisfy a predicate.
Value parameters
- p
-
The predicate used to test elements.
Attributes
- Returns
-
this shrinkable collection
- See also
- Inherited from:
- Buffer
- Source
- Buffer.scala
Returns an extractor object with a unapplySeq
method, which extracts each element of a sequence data.
Returns an extractor object with a unapplySeq
method, which extracts each element of a sequence data.
Attributes
- Example
-
val firstChar: String => Option[Char] = _.headOption Seq("foo", "bar", "baz") match { case firstChar.unlift.elementWise(c0, c1, c2) => println(s"$c0, $c1, $c2") // Output: f, b, b }
- Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
The empty iterable of the same type as this iterable
The empty iterable of the same type as this iterable
Attributes
- Returns
-
an empty iterable of type
C
. - Definition Classes
- Inherited from:
- IterableFactoryDefaults
- Source
- Iterable.scala
Tests whether this sequence ends with the given sequence.
Tests whether a predicate holds for at least one element of this collection.
Tests whether a predicate holds for at least one element of this collection.
Note: may not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
true
if the given predicatep
is satisfied by at least one element of this collection, otherwisefalse
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Selects all elements of this iterable collection which satisfy a predicate.
Selects all elements of this iterable collection which satisfy a predicate.
Value parameters
- p
-
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Selects all elements of this iterable collection which do not satisfy a predicate.
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Finds the first element of the collection satisfying a predicate, if any.
Finds the first element of the collection satisfying a predicate, if any.
Note: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
an option value containing the first element in the collection that satisfies
p
, orNone
if none exists. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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 parameters
- p
-
the predicate used to test elements.
Attributes
Builds a new iterable collection by applying a function to all elements of this iterable collection and using the elements of the resulting collections.
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
- B
-
the element type of the returned collection.
Value parameters
- f
-
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Converts this iterable collection of iterable collections into a iterable collection formed by the elements of these iterable collections.
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
- B
-
the type of the elements of each iterable collection.
Value parameters
- asIterable
-
an implicit conversion which asserts that the element type of this iterable collection is an
Iterable
.
Attributes
- Returns
-
a new iterable collection resulting from concatenating all element iterable collections.
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Applies the given binary operator op
to the given initial value z
and all elements of this collection.
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
- A1
-
The type parameter for the binary operator, a supertype of
A
.
Value parameters
- op
-
A binary operator; must be associative for the result to always be the same across runs.
- z
-
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 andz
, orz
if this collection is empty. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op
to the given initial value z
and all elements of this collection, going left to right.
Applies the given binary operator op
to the given initial value z
and all elements of this collection, going left to right. Returns the initial value if this collection is empty.
"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(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 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
- B
-
The result type of the binary operator.
Value parameters
- op
-
A binary operator.
- z
-
An initial value.
Attributes
- Returns
-
The result of applying
op
toz
and all elements of this collection, going left to right. Returnsz
if this collection is empty. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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
- B
-
The result type of the binary operator.
Value parameters
- op
-
A binary operator.
- z
-
An initial value.
Attributes
- Returns
-
The result of applying
op
to all elements of this collection andz
, going right to left. Returnsz
if this collection is empty. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Tests whether a predicate holds for all elements of this collection.
Tests whether a predicate holds for all elements of this collection.
Note: may not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
true
if this collection is empty or the given predicatep
holds for all elements of this collection, otherwisefalse
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Defines how to turn a given Iterable[A]
into a collection of type C
.
Defines how to turn a given Iterable[A]
into a collection of type C
.
This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.
Attributes
- Note
-
When implementing a custom collection type and refining
C
to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case whereC =:= CC[A]
, this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.As witnessed by the
@uncheckedVariance
annotation, using this method might be unsound. However, as long as it is called with anIterable[A]
obtained fromthis
collection (as it is the case in the implementations of operations where we use aView[A]
), it is safe. - Inherited from:
- IterableFactoryDefaults
- Source
- Iterable.scala
Partitions this iterable collection into a map of iterable collections according to some discriminator function.
Partitions this iterable collection into a map of iterable collections according to some discriminator function.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- K
-
the type of keys returned by the discriminator function.
Value parameters
- f
-
the discriminator function.
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 elementsx
for whichf(x)
equalsk
. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Partitions this iterable collection into a map of iterable collections according to a discriminator function key
.
Partitions this iterable collection into a map of iterable collections according to a discriminator function key
. Each element in a group is transformed into a value of type B
using the value
function.
It is equivalent to groupBy(key).mapValues(_.map(f))
, but more efficient.
case class User(name: String, age: Int)
def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
users.groupMap(_.age)(_.name)
Note: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- B
-
the type of values returned by the transformation function
- K
-
the type of keys returned by the discriminator function
Value parameters
- f
-
the element transformation function
- key
-
the discriminator function
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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:
- IterableOps
- Source
- Iterable.scala
Partitions elements in fixed size iterable collections.
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 sizesize
if the elements don't divide evenly. - See also
-
scala.collection.Iterator, method
grouped
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Calculates a hash code value for the object.
Calculates a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)
) yet not be equal (o1.equals(o2)
returns false
). A degenerate implementation could always return 0
. However, it is required that if two objects are equal (o1.equals(o2)
returns true
) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)
). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals
method.
Attributes
Selects the first element of this iterable collection.
Selects the first element of this iterable collection.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Attributes
- Returns
-
the first element of this iterable collection.
- Throws
-
NoSuchElementException if the iterable collection is empty.
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Optionally selects the first element.
Optionally selects the first element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Attributes
- Returns
-
the first element of this iterable collection if it is nonempty,
None
if it is empty. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Finds index of first occurrence of some value in this sequence.
Finds index of first occurrence of some value in this sequence.
Type parameters
- B
-
the type of the element
elem
.
Value parameters
- elem
-
the element value to search for.
Attributes
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 parameters
- B
-
the type of the element
elem
.
Value parameters
- elem
-
the element value to search for.
- from
-
the start index
Attributes
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 parameters
- that
-
the sequence to test
Attributes
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 parameters
- from
-
the start index
- that
-
the sequence to test
Attributes
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 parameters
- p
-
the predicate used to test elements.
Attributes
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 parameters
- from
-
the start index
- p
-
the predicate used to test elements.
Attributes
Produces the range of all indices of this sequence.
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.
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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:
- IterableOps
- Source
- Iterable.scala
Computes the multiset intersection between this sequence and another sequence.
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 valuex
appears n times inthat
, then the first n occurrences ofx
will be retained in the result, but any following occurrences will be omitted. - Definition Classes
- Inherited from:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
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 parameters
- idx
-
the index to test
Attributes
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:
- IterableOps
- Source
- Iterable.scala
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 parameters
- B
-
the type of the element
elem
.
Value parameters
- elem
-
the element value to search for.
- end
-
the end index.
Attributes
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 parameters
- that
-
the sequence to test
Attributes
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 parameters
- end
-
the end index
- that
-
the sequence to test
Attributes
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 parameters
- p
-
the predicate used to test elements.
Attributes
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 parameters
- p
-
the predicate used to test elements.
Attributes
Analogous to zip
except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2
decorator.
Analogous to zip
except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2
decorator.
Calls to lazyZip
can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.
val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
Type parameters
- B
-
the type of the second element in each eventual pair
Value parameters
- that
-
the iterable providing the second element of each eventual pair
Attributes
- Returns
-
a decorator
LazyZip2
that allows strict operations to be performed on the lazily evaluated pairs or chained calls tolazyZip
. Implicit conversion toIterable[(A, B)]
is also supported. - Inherited from:
- Iterable
- Source
- Iterable.scala
Compares the length of this sequence to the size of another Iterable
.
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
wherex < 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
orsize
directly; its running time isO(this.length min that.size)
instead ofO(this.length + that.size)
. The method should be overridden if computingsize
is cheap andknownSize
returns-1
. - Inherited from:
- SeqOps
- Source
- Seq.scala
Compares the length of this sequence to a test value.
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
wherex < 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 isO(length min len)
instead ofO(length)
. The method should be overridden if computinglength
is cheap andknownSize
returns-1
. - See also
- Inherited from:
- SeqOps
- Source
- Seq.scala
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
Attributes
Turns this partial function into a plain function returning an Option
result.
Turns this partial function into a plain function returning an Option
result.
Attributes
- Returns
-
a function that takes an argument
x
toSome(this(x))
ifthis
is defined forx
, and toNone
otherwise. - See also
-
Function.unlift
- Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
Builds a new iterable collection by applying a function to all elements of this iterable collection.
Builds a new iterable collection by applying a function to all elements of this iterable collection.
Type parameters
- B
-
the element type of the returned iterable collection.
Value parameters
- f
-
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
A builder resulting from this builder by mapping the result using f
.
A builder resulting from this builder by mapping the result using f
.
Attributes
- Inherited from:
- Builder
- Source
- Builder.scala
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the largest element of this collection with respect to the ordering
ord
. - Throws
-
UnsupportedOperationException if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the largest value measured by function f
.
Finds the first element which yields the largest value measured by function f
.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f
.
Value parameters
- cmp
-
An ordering to be used for comparing elements.
- f
-
The measuring function.
Attributes
- Returns
-
the first element of this collection with the largest value measured by function
f
with respect to the orderingcmp
. - Throws
-
UnsupportedOperationException if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the largest value measured by function f
.
Finds the first element which yields the largest value measured by function f
.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f
.
Value parameters
- cmp
-
An ordering to be used for comparing elements.
- f
-
The measuring function.
Attributes
- Returns
-
an option value containing the first element of this collection with the largest value measured by function
f
with respect to the orderingcmp
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the largest element of this collection with respect to the ordering
ord
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the smallest element of this collection with respect to the ordering
ord
. - Throws
-
UnsupportedOperationException if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the smallest value measured by function f
.
Finds the first element which yields the smallest value measured by function f
.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f
.
Value parameters
- cmp
-
An ordering to be used for comparing elements.
- f
-
The measuring function.
Attributes
- Returns
-
the first element of this collection with the smallest value measured by function
f
with respect to the orderingcmp
. - Throws
-
UnsupportedOperationException if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the smallest value measured by function f
.
Finds the first element which yields the smallest value measured by function f
.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f
.
Value parameters
- cmp
-
An ordering to be used for comparing elements.
- f
-
The measuring function.
Attributes
- Returns
-
an option value containing the first element of this collection with the smallest value measured by function
f
with respect to the orderingcmp
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the smallest element of this collection with respect to the ordering
ord
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
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:
- IterableOnceOps
- Source
- IterableOnce.scala
Displays all elements of this collection in a string using a separator string.
Displays all elements of this collection in a string using a separator string.
Delegates to addString, which can be overridden.
Value parameters
- sep
-
the separator string.
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 stringsep
. - Example
-
List(1, 2, 3).mkString("|") = "1|2|3"
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Displays all elements of this collection in a string using start, end, and separator strings.
Displays all elements of this collection in a string using start, end, and separator strings.
Delegates to addString, which can be overridden.
Value parameters
- end
-
the ending string.
- sep
-
the separator string.
- start
-
the starting string.
Attributes
- Returns
-
a string representation of this collection. The resulting string begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this collection are separated by the stringsep
. - Example
-
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Returns
-
a strict builder for the same collection type. Note that in the case of lazy collections (e.g. scala.collection.View or scala.collection.immutable.LazyList), it is possible to implement this method but the resulting
Builder
will break laziness. As a consequence, operations should preferably be implemented withfromSpecific
instead of this method. - Note
-
When implementing a custom collection type and refining
C
to the new type, this method needs to be overridden (the compiler will issue an error otherwise). In the common case whereC =:= CC[A]
, this can be done by mixing in the scala.collection.IterableFactoryDefaults trait, which implements the method using iterableFactory.As witnessed by the
@uncheckedVariance
annotation, using this method might be unsound. However, as long as the returned builder is only fed withA
values taken fromthis
instance, it is safe. - Inherited from:
- IterableFactoryDefaults
- Source
- Iterable.scala
Tests whether the collection is not empty.
Tests whether the collection is not empty.
Attributes
- Returns
-
true
if the collection contains at least one element,false
otherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.
Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.
Type parameters
- A1
-
the argument type of the fallback function
- B1
-
the result type of the fallback function
Value parameters
- that
-
the fallback function
Attributes
- Returns
-
a partial function which has as domain the union of the domains of this partial function and
that
. The resulting partial function takesx
tothis(x)
wherethis
is defined, and tothat(x)
where it is not. - Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
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 parameters
- B
-
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 leastlen
. - Definition Classes
- Inherited from:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
Append the given element to this shrinkable collection until a target length is reached.
Append the given element to this shrinkable collection until a target length is reached.
Value parameters
- elem
-
the padding value
- len
-
the target length
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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 parameters
- A1
-
the element type of the first resulting collection
- A2
-
the element type of the second resulting collection
Value parameters
- f
-
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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 the replaced
count would exceed the available elements, the difference in excess is ignored.
Type parameters
- B
-
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
Iterates over distinct permutations of elements.
Iterates over distinct permutations of elements.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Attributes
Prepends the elements contained in a iterable object to this buffer.
Prepends the elements contained in a iterable object to this buffer.
Value parameters
- elems
-
the iterable object containing the elements to append.
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
A copy of the sequence with an element prepended.
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
- B
-
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:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
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 parameters
- B
-
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:
- StrictOptimizedSeqOps
- Source
- StrictOptimizedSeqOps.scala
Multiplies together the elements of this collection.
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
- B
-
the result type of the
*
operator.
Value parameters
- num
-
an implicit parameter defining a set of numeric operations which includes the
*
operator to be used in forming the product.
Attributes
- Returns
-
the product of all elements of this collection with respect to the
*
operator innum
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op
to all elements of this collection.
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: 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.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type parameter for the binary operator, a supertype of
A
.
Value parameters
- op
-
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
-
UnsupportedOperationException if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op
to all elements of this collection, going left to right.
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
- B
-
The result type of the binary operator, a supertype of
A
.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of applying
op
to all elements of this collection, going left to right. - Throws
-
UnsupportedOperationException if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
If this collection is nonempty, reduces it with the given binary operator op
, going left to right.
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
- B
-
The result type of the binary operator, a supertype of
A
.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of reducing this collection with
op
going left to right if the collection is nonempty, inside aSome
, andNone
otherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
If this collection is nonempty, reduces it with the given binary operator op
.
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: 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.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
A type parameter for the binary operator, a supertype of
A
.
Value parameters
- op
-
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 aSome
, andNone
otherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op
to all elements of this collection, going right to left.
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
- B
-
The result type of the binary operator, a supertype of
A
.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of applying
op
to all elements of this collection, going right to left. - Throws
-
UnsupportedOperationException if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
If this collection is nonempty, reduces it with the given binary operator op
, going right to left.
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
- B
-
The result type of the binary operator, a supertype of
A
.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of reducing this collection with
op
going right to left if the collection is nonempty, inside aSome
, andNone
otherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Returns a new sequence with the elements of this sequence in reverse order.
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
An iterator yielding the elements of this sequence in reverse order.
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
Attributes
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Composes this partial function with an action function which gets applied to results of this partial function.
Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.
Note that expression pf.runWith(action)(x)
is equivalent to
if(pf isDefinedAt x) { action(pf(x)); true } else false
except that runWith
is implemented via applyOrElse
and thus potentially more efficient. Using runWith
avoids double evaluation of pattern matchers and guards for partial function literals.
Value parameters
- action
-
the action function
Attributes
- Returns
-
a function which maps arguments
x
toisDefinedAt(x)
. The resulting function runsaction(this(x))
wherethis
is defined. - See also
-
applyOrElse
. - Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
Computes a prefix scan of the elements of the collection.
Computes a prefix scan of the elements of the collection.
Note: The neutral element z
may be applied more than once.
Type parameters
- B
-
element type of the resulting collection
Value parameters
- op
-
the associative operator for the scan
- z
-
neutral element for the operator
op
Attributes
- Returns
-
a new iterable collection containing the prefix scan of the elements in this iterable collection
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Produces a iterable collection containing cumulative results of applying the operator going left to right, including the initial value.
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
- B
-
the type of the elements in the resulting collection
Value parameters
- op
-
the binary operator applied to the intermediate result and the element
- z
-
the initial value
Attributes
- Returns
-
collection with intermediate results
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Produces a collection containing cumulative results of applying the operator going right to left.
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Example:
List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
Type parameters
- B
-
the type of the elements in the resulting collection
Value parameters
- op
-
the binary operator applied to the intermediate result and the element
- z
-
the initial value
Attributes
- Returns
-
collection with intermediate results
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
- to
-
the index following where the search ends.
Attributes
- Returns
-
a
Found
value containing the index corresponding to the element in the sequence, or theInsertionPoint
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 anInsertionPoint
atfrom
is returned - Inherited from:
- SeqOps
- Source
- Seq.scala
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
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 parameters
- from
-
the index where the search starts.
- p
-
the predicate used to test elements.
Attributes
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 parameters
- p
-
the predicate used to test elements.
Attributes
The size of this sequence.
The size of this sequence.
Note: will not terminate for infinite-sized collections.
Attributes
Compares the size of this sequence to the size of another Iterable
.
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
wherex < 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 isO(this.size min that.size)
instead ofO(this.size + that.size)
. The method should be overridden if computingsize
is cheap andknownSize
returns-1
. - Definition Classes
- Inherited from:
- SeqOps
- Source
- Seq.scala
Compares the size of this sequence to a test value.
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
wherex < 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 isO(size min otherSize)
instead ofO(size)
. The method should be overridden if computingsize
is cheap andknownSize
returns-1
. - See also
- Definition Classes
- Inherited from:
- SeqOps
- Source
- Seq.scala
Gives a hint that the result
of this builder is expected to have the same size as the given collection, plus some delta.
Gives a hint that the result
of this builder is expected to have the same size as the given collection, plus some delta.
This method provides a hint only if the collection has a known size, as specified by the following pseudocode:
if (coll.knownSize != -1)
if (coll.knownSize + delta <= 0) sizeHint(0)
else sizeHint(coll.knownSize + delta)
If the delta is negative and the result size is known to be negative, then the size hint is issued at zero.
Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, i.e., if a different number of elements is added.
Value parameters
- coll
-
the collection which serves as a hint for the result's size.
- delta
-
a correction to add to the
coll.size
to produce the size hint (zero if omitted).
Attributes
- Inherited from:
- Builder
- Source
- Builder.scala
Gives a hint how many elements are expected to be added in total by the time result
is called.
Gives a hint how many elements are expected to be added in total by the time result
is called.
Some builder classes will optimize their representation based on the hint. However, builder implementations are required to work correctly even if the hint is wrong, e.g., a different number of elements is added, or the hint is out of range.
The default implementation simply ignores the hint.
Value parameters
- size
-
the hint how many elements will be added.
Attributes
- Inherited from:
- Builder
- Source
- Builder.scala
Gives a hint how many elements are expected to be added when the next result
is called, together with an upper bound given by the size of some other collection.
Gives a hint how many elements are expected to be added when the next result
is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.
Value parameters
- boundingColl
-
the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.
- size
-
the hint how many elements will be added.
Attributes
- Inherited from:
- Builder
- Source
- Builder.scala
Returns a value class containing operations for comparing the size of this iterable collection to a test value.
Returns a value class containing operations for comparing the size of this iterable collection to a test value.
These operations are implemented in terms of sizeCompare(Int)
, and allow the following more readable usages:
this.sizeIs < size // this.sizeCompare(size) < 0
this.sizeIs <= size // this.sizeCompare(size) <= 0
this.sizeIs == size // this.sizeCompare(size) == 0
this.sizeIs != size // this.sizeCompare(size) != 0
this.sizeIs >= size // this.sizeCompare(size) >= 0
this.sizeIs > size // this.sizeCompare(size) > 0
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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) indexuntil
of this iterable collection. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Retains the specified slice from this shrinkable collection and removes the rest.
Retains the specified slice from this shrinkable collection and removes the rest.
Value parameters
- end
-
the lowest index to exclude
- start
-
the lowest index to include
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.
Value parameters
- size
-
the number of elements per group
- step
-
the distance between the first elements of successive groups
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 thansize
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
- Source
- Iterable.scala
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped
.)
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped
.)
An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.
Value parameters
- size
-
the number of elements per group
Attributes
- Returns
-
An iterator producing iterable collections of size
size
, except for a non-empty collection with less thansize
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
- Source
- Iterable.scala
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 parameters
- B
-
the target type of the transformation
f
, and the type where the orderingord
is defined.
Value parameters
- f
-
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
iford.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
- Source
- Seq.scala
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 (lt
returns false for both directions of comparison) appear in the same order in the sorted sequence as in the original.
Value parameters
- lt
-
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:
- SeqOps
- Source
- Seq.scala
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 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:
- SeqOps
- Source
- Seq.scala
Splits this iterable collection into a prefix/suffix pair according to a predicate.
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
- p
-
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Splits this iterable collection into a prefix/suffix pair at a given position.
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
- n
-
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:
- IterableOps
- Source
- Iterable.scala
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 parameters
- offset
-
the index where the sequence is searched.
- that
-
the sequence to test
Attributes
Returns a scala.collection.Stepper for the elements of this collection.
Returns a scala.collection.Stepper for the elements of this collection.
The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.
The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.
-
For collections of
Int
,Short
,Byte
orChar
, an scala.collection.IntStepper is returned -
For collections of
Double
orFloat
, 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
- IterableOnce.scala
Removes all elements produced by an iterator from this shrinkable collection.
Removes all elements produced by an iterator from this shrinkable collection.
Value parameters
- xs
-
the iterator producing the elements to remove.
Attributes
- Returns
-
the shrinkable collection itself
- Inherited from:
- Shrinkable
- Source
- Shrinkable.scala
Sums the elements of this collection.
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
- B
-
the result type of the
+
operator.
Value parameters
- num
-
an implicit parameter defining a set of numeric operations which includes the
+
operator to be used in forming the sum.
Attributes
- Returns
-
the sum of all elements of this collection with respect to the
+
operator innum
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
The rest of the collection without its first element.
The rest of the collection without its first element.
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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
.
Attributes
- Returns
-
an iterator over all the tails of this iterable collection
- Example
-
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Selects the first n
elements.
Selects the first n
elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- n
-
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 thann
elements. Ifn
is negative, returns an empty iterable collection. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Retains the first n
elements from this shrinkable collection and removes the rest.
Retains the first n
elements from this shrinkable collection and removes the rest.
Value parameters
- n
-
the number of elements to retain
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
A collection containing the last n
elements of this collection.
A collection containing the last n
elements of this collection.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Attributes
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Retains the last n
elements from this shrinkable collection and removes the rest.
Retains the last n
elements from this shrinkable collection and removes the rest.
Value parameters
- n
-
the number of elements to retain
Attributes
- Returns
-
this shrinkable collection
- Inherited from:
- Buffer
- Source
- Buffer.scala
Takes longest prefix of elements that satisfy a predicate.
Takes longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- p
-
The predicate used to test elements.
Attributes
- Returns
-
the longest prefix of this iterable collection whose elements all satisfy the predicate
p
. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Retains the longest prefix of elements that satisfy a predicate.
Retains the longest prefix of elements that satisfy a predicate.
Value parameters
- p
-
The predicate used to test elements.
Attributes
- Returns
-
this shrinkable collection
- See also
- Inherited from:
- Buffer
- Source
- Buffer.scala
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
- U
-
the return type of f
Value parameters
- f
-
a function to apply to each element in this iterable collection
Attributes
- Returns
-
The same logical collection as this
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this collection to an Array
.
Converts this collection to an Array
.
Implementation note: DO NOT call Array.from from this method.
Type parameters
- B
-
The type of elements of the result, a supertype of
A
.
Attributes
- Returns
-
This collection as an
Array[B]
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this collection to a Buffer
.
Converts this collection to a Buffer
.
Type parameters
- B
-
The type of elements of the result, a supertype of
A
.
Attributes
- Returns
-
This collection as a
Buffer[B]
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this collection to an IndexedSeq
.
Converts this collection to an IndexedSeq
.
Attributes
- Returns
-
This collection as an
IndexedSeq[A]
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this collection to a Map
, given an implicit coercion from the collection's type to a key-value tuple.
Converts this collection to a Map
, given an implicit coercion from the collection's type to a key-value tuple.
Type parameters
- K
-
The key type for the resulting map.
- V
-
The value type for the resulting map.
Value parameters
- ev
-
An implicit coercion from
A
to[K, V]
.
Attributes
- Returns
-
This collection as a
Map[K, V]
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Returns
-
This collection as a
Seq[A]
. This is equivalent toto(Seq)
but might be faster. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this collection to a Set
.
Converts this collection to a Set
.
Type parameters
- B
-
The type of elements of the result, a supertype of
A
.
Attributes
- Returns
-
This collection as a
Set[B]
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this collection to a Vector
.
Converts this collection to a Vector
.
Attributes
- Returns
-
This collection as a
Vector[A]
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.
Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.
The resulting collection's type will be guided by the static type of iterable collection. For example:
val xs = List(
Set(1, 2, 3),
Set(4, 5, 6)).transpose
// xs == List(
// List(1, 4),
// List(2, 5),
// List(3, 6))
val ys = Vector(
List(1, 2, 3),
List(4, 5, 6)).transpose
// ys == Vector(
// Vector(1, 4),
// Vector(2, 5),
// Vector(3, 6))
Note: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- B
-
the type of the elements of each iterable collection.
Value parameters
- asIterable
-
an implicit conversion which asserts that the element type of this iterable collection is an
Iterable
.
Attributes
- Returns
-
a two-dimensional iterable collection of iterable collections which has as nth row the nth column of this iterable collection.
- Throws
-
IllegalArgumentException if all collections in this iterable collection are not of the same size.
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
Attributes
- Inherited from:
- PartialFunction
- Source
- PartialFunction.scala
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 parameters
- A1
-
the type of the first half of the element pairs
- A2
-
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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 parameters
- 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 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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
A copy of this sequence with one single replaced element.
A copy of this sequence with one single replaced element.
Type parameters
- B
-
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 byelem
. - Throws
-
IndexOutOfBoundsException if
index
does not satisfy0 <= 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
- Source
- Seq.scala
A view over the elements of this collection.
A view over the elements of this collection.
Attributes
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.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
an object of class
WithFilter
, which supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this iterable collection which satisfy the predicatep
. - Inherited from:
- IterableOps
- Source
- Iterable.scala
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
- B
-
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 andthat
. - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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 andthat
. If this iterable collection is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this iterable collection,thatElem
values are used to pad the result. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Zips this iterable collection with its indices.
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:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Deprecated and Inherited methods
Adds two or more elements to this growable collection.
Adds two or more elements to this growable collection.
Value parameters
- elem1
-
the first element to add.
- elem2
-
the second element to add.
- elems
-
the remaining elements to add.
Attributes
- Returns
-
the growable collection itself
- Deprecated
- true
- Inherited from:
- Growable
- Source
- Growable.scala
Removes two or more elements from this shrinkable collection.
Removes two or more elements from this shrinkable collection.
Value parameters
- elem1
-
the first element to remove.
- elem2
-
the second element to remove.
- elems
-
the remaining elements to remove.
Attributes
- Returns
-
the shrinkable collection itself
- Deprecated
- true
- Inherited from:
- Shrinkable
- Source
- Shrinkable.scala
Attributes
- Deprecated
- true
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Deprecated
- true
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Aggregates the results of applying an operator to subsequent elements.
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
- B
-
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.
- z
-
the start value, a neutral element for
seqop
.
Attributes
- Deprecated
- true
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Deprecated
- true
- Inherited from:
- Buffer
- Source
- Buffer.scala
Attributes
- Deprecated
- true
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Attributes
- Deprecated
- true
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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
-
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
returnsfalse
. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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 parameters
- p
-
the predicate used to test elements.
Attributes
Attributes
- Deprecated
- true
- Inherited from:
- Buffer
- Source
- Buffer.scala
Attributes
- Deprecated
- true
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Attributes
- Deprecated
- true
- Inherited from:
- Iterable
- Source
- Iterable.scala