IndexedSeqOps
- Source:
- IndexedSeq.scala
Value members
Concrete methods
Modifies this mutable sequence by applying a function to all elements of this mutable sequence.
Modifies this mutable sequence by applying a function to all elements of this mutable sequence.
- Value parameters:
- f
the function to apply to each element.
- Returns:
this mutable sequence modified by replacing all elements with the result of applying the given function
f
to each element of this mutable sequence.- Source:
- IndexedSeq.scala
Sorts this mutable sequence in place according to an Ordering.
Sorts this mutable sequence in place according to an Ordering.
- Value parameters:
- ord
the ordering to be used to compare elements.
- Returns:
modified input mutable sequence sorted according to the ordering
ord
.- See also:
- Source:
- IndexedSeq.scala
Sorts this mutable sequence in place according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
Sorts this mutable sequence in place according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
- See also:
- Source:
- IndexedSeq.scala
Sorts this mutable sequence in place according to a comparison function.
Sorts this mutable sequence in place according to a comparison function.
- See also:
- Source:
- IndexedSeq.scala
Inherited methods
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.
- 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.
- 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.
- Returns:
the string builder
b
to which elements were appended.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.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)
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.
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.
- 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.- Inherited from:
- IterableOps
- Source:
- Iterable.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
- 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.
Iterates over combinations. A _combination_ of length n
is a subsequence of
the original sequence, with the elements taken in order. Thus, "xy"
and "yy"
are both length-2 combinations of "xyy"
, but "yx"
is not. If there is
more than one way to generate the same subsequence, only one will be returned.
For example, "xyyy"
has three different ways to generate "xy"
depending on
whether the first, second, or third "y"
is selected. However, since all are
identical, only one will be chosen. Which of the three will be taken is an
implementation detail that is not defined.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Returns 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.
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.
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.
- 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
Copy elements to an array, returning the number of elements written.
Copy elements to an array, returning the number of elements written.
Fills the given array xs
starting at index start
with values of this collection.
Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.
- Type parameters:
- B
the type of the elements of the array.
- Value parameters:
- start
the starting index of xs.
- xs
the array to fill.
- Returns:
the number of elements written to the array
- Note:
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Copy elements to an array, returning the number of elements written.
Copy elements to an array, returning the number of elements written.
Fills the given array xs
starting at index start
with values of this collection.
Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.
- Type parameters:
- B
the type of the elements of the array.
- Value parameters:
- xs
the array to fill.
- Returns:
the number of elements written to the array
- Note:
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
- 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
- Returns:
true
if both sequences have the same length andp(x, y)
istrue
for all corresponding elementsx
of this sequence andy
ofthat
, otherwisefalse
.- Inherited from:
- SeqOps
- Source:
- Seq.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
- 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
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.
- 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
- 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.- Inherited from:
- SeqOps
- Source:
- Seq.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
- Returns:
a new sequence consisting of all the elements of this sequence without duplicates.
- Inherited from:
- SeqOps
- Source:
- Seq.scala
Selects all elements except first n ones.
Selects all elements except first n ones.
- Value parameters:
- n
the number of elements to drop from this sequence.
- Returns:
a sequence consisting of all elements of this sequence except the first
n
ones, or else the empty sequence, if this sequence has less thann
elements. Ifn
is negative, don't drop any elements.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Selects all elements except last n ones.
Selects all elements except last n ones.
- Value parameters:
- n
the number of elements to drop from this sequence.
- Returns:
a sequence consisting of all elements of this sequence except the last
n
ones, or else the empty sequence, if this sequence has less thann
elements. Ifn
is negative, don't drop any elements.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Drops longest prefix of elements that satisfy a predicate.
Drops 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.
- Returns:
the longest suffix of this iterable collection whose first element does not satisfy the predicate
p
.- Inherited from:
- IterableOps
- Source:
- Iterable.scala
The empty iterable of the same type as this iterable
The empty iterable of the same type as this iterable
- Returns:
an empty iterable of type
C
.- Inherited from:
- IterableOps
- Source:
- Iterable.scala
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.
- 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.
- 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.- Inherited from:
- IterableOps
- Source:
- Iterable.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.
- 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.- Inherited from:
- IterableOps
- Source:
- Iterable.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.
- 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.
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.
- 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.- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Converts this iterable collection of traversable collections into a iterable collection formed by the elements of these traversable collections.
Converts this iterable collection of traversable collections into a iterable collection formed by the elements of these traversable 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 traversable collection.
- Value parameters:
- asIterable
an implicit conversion which asserts that the element type of this iterable collection is a
GenTraversable
.
- Returns:
a new iterable collection resulting from concatenating all element iterable collections.
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Folds the elements of this collection using the specified associative binary operator.
Folds the elements of this collection using the specified associative binary operator.
The default implementation in IterableOnce
is equivalent to foldLeft
but may be
overridden for more efficient traversal orders.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
Note: will not terminate for infinite-sized collections.
- Type parameters:
- A1
a type parameter for the binary operator, a supertype of
A
.
- Value parameters:
- op
a binary operator that must be associative.
- z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g.,
Nil
for list concatenation, 0 for addition, or 1 for multiplication).
- Returns:
the result of applying the fold operator
op
between all the elements andz
, orz
if this collection is empty.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Applies a binary operator to a start value and all elements of this collection, going left to right.
Applies a binary operator to a start value and all elements of this collection, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- Type parameters:
- B
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- z
the start value.
- Returns:
the result of inserting
op
between consecutive elements of this collection, going left to right with the start valuez
on the left:op(...op(z, x1), x2, ..., xn)
wherex1, ..., xn
are the elements of this collection. Returnsz
if this collection is empty.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Applies a binary operator to all elements of this sequence and a start value, going right to left.
Applies a binary operator to all elements of this sequence and a start value, going right to left.
Note: will not terminate for infinite-sized collections.
- Type parameters:
- B
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- z
the start value.
- Returns:
the result of inserting
op
between consecutive elements of this sequence, going right to left with the start valuez
on the right:op(x1, op(x2, ... op(xn, z)...))
wherex1, ..., xn
are the elements of this sequence. Returnsz
if this sequence is empty.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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.
- 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
Apply f
to each element for its side effects
Note: [U] parameter needed to help scalac's type inference.
Apply f
to each element for its side effects
Note: [U] parameter needed to help scalac's type inference.
- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.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.
- 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
- 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.
- 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
- 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
Selects the first element of this sequence.
Selects the first element of this sequence.
- Returns:
the first element of this sequence.
- Throws:
- NoSuchElementException
if the sequence is empty.
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Optionally selects the first element.
Optionally selects the first element.
- Returns:
the first element of this sequence if it is nonempty,
None
if it is empty.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Finds index of first occurrence of some value in this sequence.
Finds index of first occurrence of some value in this sequence.
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.
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.
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.
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.
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.
The initial part of the collection without its last element.
The initial part of the collection without its last element.
Note: Even when applied to a view or a lazy collection it will always force the elements.
- Inherited from:
- IterableOps
- 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.
- 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.
- 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.- Inherited from:
- SeqOps
- Source:
- Seq.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]
.
Tests whether the sequence is empty.
Tests whether the sequence is empty.
Note: Implementations in subclasses that are not repeatedly traversable must take
care not to consume any elements when isEmpty
is called.
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.
- Returns:
true
if it is repeatedly traversable,false
otherwise.- Definition Classes
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
The companion object of this iterable collection, providing various factory methods.
The companion object of this iterable collection, providing various factory methods.
- Note:
When implementing a custom collection type and refining
CC
to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Iterator can be used only once
Iterator can be used only once
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
- Returns:
The number of elements in this sequence, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Selects the last element.
Selects the last element.
- Returns:
The last element of this sequence.
- Throws:
- NoSuchElementException
If the sequence is empty.
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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.
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.
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.
Finds index of last element satisfying some predicate.
Finds index of last element satisfying some predicate.
Note: will not terminate for infinite-sized collections.
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.
Optionally selects the last element.
Optionally selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- Returns:
the last element of this iterable collection$ if it is nonempty,
None
if it is empty.- Inherited from:
- IterableOps
- 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.
- 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
.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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.
- 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:
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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
Builds a new sequence by applying a function to all elements of this sequence.
Builds a new sequence by applying a function to all elements of this sequence.
- Type parameters:
- B
the element type of the returned sequence.
- Value parameters:
- f
the function to apply to each element.
- Returns:
a new sequence resulting from applying the given function
f
to each element of this sequence and collecting the results.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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.
- 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.
- Returns:
the first element of this collection with the largest value measured by function f with respect to the ordering
cmp
.- Throws:
- UnsupportedOperationException
if this collection is empty.
- Inherited from:
- IterableOnceOps
- 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.
- Returns:
an option value containing the first element of this collection with the largest value measured by function f with respect to the ordering
cmp
.- Inherited from:
- IterableOnceOps
- 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.
- 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.
- 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.
- Returns:
the first element of this collection with the smallest value measured by function f with respect to the ordering
cmp
.- Throws:
- UnsupportedOperationException
if this collection is empty.
- Inherited from:
- IterableOnceOps
- 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.
- Returns:
an option value containing the first element of this collection with the smallest value measured by function f with respect to the ordering
cmp
.- Inherited from:
- IterableOnceOps
- 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.
- 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.
- 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.
- 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.
- 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
Tests whether the collection is not empty.
Tests whether the collection is not empty.
- Returns:
true
if the collection contains at least one element,false
otherwise.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.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
- 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
.- Inherited from:
- SeqOps
- Source:
- Seq.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.
- Inherited from:
- IterableOps
- Source:
- Iterable.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
- Returns:
a pair of iterable collections: the first one made of those values returned by
f
that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.- Inherited from:
- IterableOps
- Source:
- Iterable.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 more values are replaced than actually exist, the 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
- Returns:
a new sequence consisting of all elements of this sequence except that
replaced
elements starting fromfrom
are replaced by all the elements ofother
.- Inherited from:
- SeqOps
- Source:
- Seq.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
- Returns:
a new sequence consisting of
value
followed by all elements of this sequence.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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.
Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
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.
- Returns:
the product of all elements of this collection with respect to the
*
operator innum
.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Reduces the elements of this collection using the specified associative binary operator.
Reduces the elements of this collection using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- Type parameters:
- B
A type parameter for the binary operator, a supertype of
A
.
- Value parameters:
- op
A binary operator that must be associative.
- Returns:
The result of applying reduce operator
op
between all the elements if the collection is nonempty.- Throws:
- UnsupportedOperationException
if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Applies a binary operator to all elements of this collection, going left to right.
Applies a binary operator to all elements of this collection, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- Type parameters:
- B
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- Returns:
the result of inserting
op
between consecutive elements of this collection, going left to right:op( op( ... op(x1, x2) ..., xn-1), xn)
wherex1, ..., xn
are the elements of this collection.- Throws:
- UnsupportedOperationException
if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Optionally applies a binary operator to all elements of this collection, going left to right.
Optionally applies a binary operator to all elements of this collection, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- Type parameters:
- B
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- Returns:
an option value containing the result of
reduceLeft(op)
if this collection is nonempty,None
otherwise.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Reduces the elements of this collection, if any, using the specified associative binary operator.
Reduces the elements of this collection, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- Type parameters:
- B
A type parameter for the binary operator, a supertype of
A
.
- Value parameters:
- op
A binary operator that must be associative.
- Returns:
An option value containing result of applying reduce operator
op
between all the elements if the collection is nonempty, andNone
otherwise.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Applies a binary operator to all elements of this collection, going right to left.
Applies a binary operator to all elements of this collection, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- Type parameters:
- B
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- Returns:
the result of inserting
op
between consecutive elements of this collection, going right to left:op(x1, op(x2, ..., op(xn-1, xn)...))
wherex1, ..., xn
are the elements of this collection.- Throws:
- UnsupportedOperationException
if this collection is empty.
- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Optionally applies a binary operator to all elements of this collection, going right to left.
Optionally applies a binary operator to all elements of this collection, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- Type parameters:
- B
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- Returns:
an option value containing the result of
reduceRight(op)
if this collection is nonempty,None
otherwise.- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Returns new sequence with elements in reversed order.
Returns new sequence with elements in reversed 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.
- Returns:
A new sequence with all elements of this sequence in reversed order.
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
An iterator yielding elements in reversed order.
An iterator yielding elements in reversed order.
Note: will not terminate for infinite-sized collections.
Note: xs.reverseIterator
is the same as xs.reverse.iterator
but might be more efficient.
- Returns:
an iterator yielding the elements of this sequence in reversed order
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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
- 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
- Returns:
collection with intermediate results
- Inherited from:
- IterableOps
- Source:
- Iterable.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
- Returns:
collection with intermediate results
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Search within an interval in this sorted sequence for a specific element.
Search 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.
- 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- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Search this sorted sequence for a specific element.
Search 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.
- 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:
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
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.
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.
The size of this sequence.
The size of this sequence.
Note: will not terminate for infinite-sized collections.
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.
- 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.
- 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
Returns a value class containing operations for comparing the size of this iterable collection to a test value.
Returns a value class containing operations for comparing the size of this iterable collection to a test value.
These operations are implemented in terms of sizeCompare(Int)
, and
allow the following more readable usages:
this.sizeIs < size // this.sizeCompare(size) < 0
this.sizeIs <= size // this.sizeCompare(size) <= 0
this.sizeIs == size // this.sizeCompare(size) == 0
this.sizeIs != size // this.sizeCompare(size) != 0
this.sizeIs >= size // this.sizeCompare(size) >= 0
this.sizeIs > size // this.sizeCompare(size) > 0
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Selects an interval of elements.
Selects an interval of elements. The returned sequence is made up
of all elements x
which satisfy the invariant:
from <= indexOf(x) < until
- Value parameters:
- from
the lowest index to include from this sequence.
- until
the lowest index to EXCLUDE from this sequence.
- Returns:
a sequence containing the elements greater than or equal to index
from
extending up to (but not including) indexuntil
of this sequence.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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
- 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
- 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
.
- 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 (as determined by
lt
) appear in the same order in the sorted sequence as in the original.
- Value parameters:
- lt
the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
- Returns:
a sequence consisting of the elements of this sequence sorted according to the comparison function
lt
.- Example:
List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) = List("Bob", "John", "Steve", "Tom")
- Inherited from:
- SeqOps
- 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.
- 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
- Returns:
a pair consisting of the longest prefix of this iterable collection whose elements all satisfy
p
, and the rest of this iterable collection.- Inherited from:
- IterableOps
- Source:
- Iterable.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.
- 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.
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 returnedFor collections of
Double
orFloat
, a scala.collection.DoubleStepper is returnedFor collections of
Long
a scala.collection.LongStepper is returnedFor 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.
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Sums up the elements of this collection.
Sums up the elements of this collection.
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.
- 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.
- 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
.
- 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.
- Value parameters:
- n
the number of elements to take from this sequence.
- Returns:
a sequence consisting only of the first
n
elements of this sequence, or else the whole sequence, if it has less thann
elements. Ifn
is negative, returns an empty sequence.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
Selects the last n elements.
Selects the last n elements.
- Value parameters:
- n
the number of elements to take from this sequence.
- Returns:
a sequence consisting only of the last
n
elements of this sequence, or else the whole sequence, if it has less thann
elements. Ifn
is negative, returns an empty sequence.- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.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.
- Returns:
the longest prefix of this iterable collection whose elements all satisfy the predicate
p
.- Inherited from:
- IterableOps
- Source:
- Iterable.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
- Returns:
The same logical collection as this
- Definition Classes
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Given a collection factory factory
, convert this collection to the appropriate
representation for the current element type A
.
Given a collection factory factory
, convert this collection to the appropriate
representation for the current element type A
. Example uses:
xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // for xs: Iterable[Int]
- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
Convert collection to array.
Convert collection to array.
Implementation note: DO NOT call Array.from from this method.
- Inherited from:
- IterableOnceOps
- Source:
- IterableOnce.scala
- Returns:
This collection as a
Seq[A]
. This is equivalent toto(Seq)
but might be faster.- 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
.
- 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
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.
- Returns:
a pair of iterable collections, containing the first, respectively second half of each element pair of this iterable collection.
- Inherited from:
- IterableOps
- Source:
- Iterable.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.
- Returns:
a triple of iterable collections, containing the first, second, respectively third member of each element triple of this iterable collection.
- Inherited from:
- IterableOps
- Source:
- Iterable.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
- 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.
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala
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.
- 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
- 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
.- 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 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
.
- Returns:
a new collection of type
That
containing pairs consisting of corresponding elements of this iterable collection andthat
. 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.
- 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))
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Deprecated and Inherited methods
Tests whether this collection is known to have a finite size.
Tests whether this collection is known to have a finite size.
All strict collections are known to have finite size. For a non-strict
collection such as Stream
, the predicate returns true
if all
elements have been computed. It returns false
if the stream is
not yet evaluated to the end. Non-empty Iterators usually return
false
even if they were created from a collection with a known
finite size.
Note: many collection methods will not work on collections of infinite sizes.
The typical failure mode is an infinite loop. These methods always attempt a
traversal without checking first that hasDefiniteSize
returns true
.
However, checking hasDefiniteSize
can provide an assurance that size is
well-defined and non-termination is not a concern.
- Returns:
true
if this collection is known to have finite size,false
otherwise.- See also:
method
knownSize
for a more useful alternative- Deprecated
This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though
hasDefiniteSize
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.
- Returns:
This collection as an
Iterable[A]
. No new collection will be built ifthis
is already anIterable[A]
.- Deprecated
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Converts this iterable collection to an unspecified Iterable.
Converts this iterable collection to an unspecified Iterable. Will return the same collection if this instance is already Iterable.
- Returns:
An Iterable containing all elements of this iterable collection.
- Deprecated
- Inherited from:
- IterableOps
- Source:
- Iterable.scala
Produces a new sequence which contains all elements of this sequence and also all elements of a given sequence.
Produces a new sequence which contains all elements of this sequence and also all elements of
a given sequence. xs union ys
is equivalent to xs ++ ys
.
A view over a slice of the elements of this collection.
A view over a slice of the elements of this collection.
- Deprecated
- Definition Classes
- Inherited from:
- IndexedSeqOps
- Source:
- IndexedSeq.scala