Test two objects for inequality.
true
if !(this == that), false otherwise.
Equivalent to x.hashCode
except for boxed numeric types and null
. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null
returns a hashcode where null.hashCode
throws a NullPointerException
.
a hash value consistent with ==
Alias for concat
Alias for prependedAll
Alias for prepended
.
Note that :-ending operators are right associative (see example). A mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
Alias for appended
Note that :-ending operators are right associative (see example). A mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
Alias for appendedAll
The expression x == that
is equivalent to if (x eq null) that eq null else x.equals(that)
.
true
if the receiver object is equivalent to the argument; false
otherwise.
Appends all elements of this immutable sequence to a string builder. The written text consists of the string representations (w.r.t. the method toString
) of all elements of this immutable sequence 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
the string builder to which elements are appended.
the string builder b
to which elements were appended.
Appends all elements of this immutable sequence 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 immutable sequence, 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
the string builder to which elements are appended.
the separator string.
the string builder b
to which elements were appended.
Appends all elements of this immutable sequence 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 immutable sequence 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)
the string builder to which elements are appended.
the starting string.
the separator string.
the ending string.
the string builder b
to which elements were appended.
Composes this partial function with another partial function that gets applied to results of this partial function.
Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.
the result type of the transformation function.
the transformation function
a partial function with the domain of this partial function narrowed by other partial function, which maps arguments x
to k(this(x))
.
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).
the result type of the transformation function.
the transformation function
a partial function with the domain of this partial function, possibly narrowed by the specified function, which maps arguments x
to k(this(x))
.
A copy of this array with an element appended.
A copy of this immutable 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)
the element type of the returned immutable sequence.
the appended element
a new immutable sequence consisting of all elements of this immutable sequence followed by value
.
A copy of this array with all elements of an array appended.
A copy of this array with all elements of a collection appended.
Returns a new immutable sequence containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable sequence is the most specific superclass encompassing the element types of the two operands.
the element type of the returned collection.
the iterable to append.
a new collection of type CC[B]
which contains all elements of this immutable sequence followed by all elements of suffix
.
The element at given index.
Indices start at 0
; xs.apply(0)
is the first element of array xs
. Note the indexing syntax xs(i)
is a shorthand for xs.apply(i)
.
the index
the element at the given index
ArrayIndexOutOfBoundsException
if i < 0
or length <= i
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:
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.
the function argument
the fallback function
the result of this function or fallback function application.
2.10
Cast the receiver object to be of type T0
.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String]
will throw a ClassCastException
at runtime, while the expression List(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
the receiver object.
ClassCastException
if the receiver object is not an instance of the erasure of type T0
.
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
The object with which this immutable sequence should be compared
true
, if this immutable sequence can possibly equal that
, false
otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
Builds a new array by applying a partial function to all elements of this array on which the function is defined.
the element type of the returned array.
the partial function which filters and maps the array.
a new array 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.
Builds a new immutable sequence by applying a partial function to all elements of this immutable sequence on which the function is defined.
the element type of the returned immutable sequence.
the partial function which filters and maps the immutable sequence.
a new immutable sequence 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.
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
Finds the first element of the array for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the immutable sequence for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite-sized collections.
the partial function
an option value containing pf applied to the first value for which it is defined, or None
if none exists.
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Composes another partial function k
with this partial function so that this partial function gets applied to results of k
.
Note that calling isDefinedAt on the resulting partial function may apply the first partial function and execute its side effect. It is highly recommended to call applyOrElse instead of isDefinedAt / apply for efficiency.
the parameter type of the transformation function.
the transformation function
a partial function with the domain of other partial function narrowed by this partial function, which maps arguments x
to this(k(x))
.
Composes two instances of Function1 in a new Function1, with this function applied last.
the type to which function g
can be applied
a function A => T1
a new function f
such that f(x) == apply(g(x))
Returns a new immutable sequence containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable sequence is the most specific superclass encompassing the element types of the two operands.
the element type of the returned collection.
the traversable to append.
a new immutable sequence which contains all elements of this immutable sequence followed by all elements of suffix
.
Tests whether this immutable sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
the sequence to test
true
if this immutable sequence contains a slice with the same elements as that
, otherwise false
.
Copy elements of this array to another array. Fills the given array xs
starting at index start
with at most len
values. Copying will stop once either all the elements of this array have been copied, or the end of the array is reached, or len
elements have been copied.
the type of the elements of the array.
the array to fill.
the starting index within the destination array.
the maximal number of elements to copy.
Copy elements of this array to another array. Fills the given array xs
starting at index start
. Copying will stop once either all the elements of this array have been copied, or the end of the array is reached.
the type of the elements of the array.
the array to fill.
the starting index within the destination array.
Copy elements of this array to another array. Fills the given array xs
starting at index 0. Copying will stop once either all the elements of this array have been copied, or the end of the array is reached.
the type of the elements of the array.
the array to fill.
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 immutable sequence.
Copying will stop once either all the elements of this immutable sequence have been copied, or the end of the array is reached, or len
elements have been copied.
the type of the elements of the array.
the array to fill.
the starting index of xs.
the maximal number of elements to copy.
the number of elements written to the array
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change. Note: will not terminate for infinite-sized collections.
Copy elements to an array, returning the number of elements written.
Fills the given array xs
starting at index start
with values of this immutable sequence.
Copying will stop once either all the elements of this immutable sequence have been copied, or the end of the array is reached.
the type of the elements of the array.
the array to fill.
the starting index of xs.
the number of elements written to the array Note: will not terminate for infinite-sized collections.
Copy elements to an array, returning the number of elements written.
Fills the given array xs
starting at index start
with values of this immutable sequence.
Copying will stop once either all the elements of this immutable sequence have been copied, or the end of the array is reached.
the type of the elements of the array.
the array to fill.
the number of elements written to the array Note: will not terminate for infinite-sized collections.
Tests whether every element of this immutable sequence relates to the corresponding element of another sequence by satisfying a test predicate.
the type of the elements of that
the other sequence
the test predicate, which relates elements from both sequences
true
if both sequences have the same length and p(x, y)
is true
for all corresponding elements x
of this immutable sequence and y
of that
, otherwise false
.
Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.
the type of the elements of that
the other collection
the test predicate, which relates elements from both collections
true
if both collections have the same length and p(x, y)
is true
for all corresponding elements x
of this iterator and y
of that
, otherwise false
Computes the multiset difference between this array and another sequence.
the sequence of elements to remove
a new array which contains all elements of this array except some of occurrences of elements that also appear in that
. If an element value x
appears n times in that
, then the first n occurrences of x
will not form part of the result, but any following occurrences will.
Computes the multiset difference between this immutable sequence and another sequence.
the sequence of elements to remove
a new immutable sequence which contains all elements of this immutable sequence except some of occurrences of elements that also appear in that
. If an element value x
appears n times in that
, then the first n occurrences of x
will not form part of the result, but any following occurrences will.
Selects all the elements of this array ignoring the duplicates as determined by ==
after applying the transforming function f
.
the type of the elements after being transformed by f
The transforming function whose result is used to determine the uniqueness of each element
a new array consisting of all the elements of this array without duplicates.
Selects all the elements of this immutable sequence ignoring the duplicates as determined by ==
after applying the transforming function f
.
the type of the elements after being transformed by f
The transforming function whose result is used to determine the uniqueness of each element
a new immutable sequence consisting of all the elements of this immutable sequence without duplicates.
Returns an extractor object with a unapplySeq
method, which extracts each element of a sequence data.
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 }
The empty iterable of the same type as this iterable
an empty iterable of type C
.
Tests whether this array ends with the given sequence.
the sequence to test
true
if this array has that
as a suffix, false
otherwise.
Tests whether this array ends with the given array.
the array to test
true
if this array has that
as a suffix, false
otherwise.
Tests whether this immutable sequence ends with the given sequence.
Note: will not terminate for infinite-sized collections.
the sequence to test
true
if this immutable sequence has that
as a suffix, false
otherwise.
Tests whether the argument (that
) is a reference to the receiver object (this
).
The eq
method implements an equivalence relation on non-null instances of AnyRef
, and has three additional properties:
x
and y
of type AnyRef
, multiple invocations of x.eq(y)
consistently returns true
or consistently returns false
.For any non-null instance x
of type AnyRef
, x.eq(null)
and null.eq(x)
returns false
.
null.eq(null)
returns true
. When overriding the equals
or hashCode
methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2
), they should be equal to each other (o1 == o2
) and they should hash to the same value (o1.hashCode == o2.hashCode
).
true
if the argument is a reference to the receiver object; false
otherwise.
The equality method for reference types. Default implementation delegates to eq
.
See also equals
in scala.Any.
true
if the receiver object is equivalent to the argument; false
otherwise.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize
method is invoked, as well as the interaction between finalize
and non-local returns and exceptions, are all platform dependent.
Finds the last element of the immutable sequence satisfying a predicate, if any.
Note: will not terminate for infinite-sized collections.
the predicate used to test elements.
an option value containing the last element in the immutable sequence that satisfies p
, or None
if none exists.
Builds a new array by applying a function to all elements of this array and using the elements of the resulting collections.
the element type of the returned array.
the function to apply to each element.
a new array resulting from applying the given collection-valued function f
to each element of this array and concatenating the results.
Builds a new immutable sequence by applying a function to all elements of this immutable sequence 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 immutable sequence. 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)
the element type of the returned collection.
the function to apply to each element.
a new immutable sequence resulting from applying the given collection-valued function f
to each element of this immutable sequence and concatenating the results.
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
Flattens a two-dimensional array by concatenating all its rows into a single array.
Type of row elements.
A function that converts elements of this array to rows - Iterables of type B
.
An array obtained by concatenating rows of this array.
Converts this immutable sequence of traversable collections into a immutable sequence formed by the elements of these traversable collections.
The resulting collection's type will be guided by the type of immutable sequence. 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)
the type of the elements of each traversable collection.
an implicit conversion which asserts that the element type of this immutable sequence is a GenTraversable
.
a new immutable sequence resulting from concatenating all element immutable sequences.
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
Folds the elements of this array using the specified associative binary operator.
a type parameter for the binary operator, a supertype of A
.
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).
a binary operator that must be associative.
the result of applying the fold operator op
between all the elements, or z
if this array is empty.
Folds the elements of this immutable sequence 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.
a type parameter for the binary operator, a supertype of A
.
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).
a binary operator that must be associative.
the result of applying the fold operator op
between all the elements and z
, or z
if this immutable sequence is empty.
Applies a binary operator to a start value and all elements of this array, going left to right.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this array, going left to right with the start value z
on the left:
op(...op(z, x_1), x_2, ..., x_n)
where x_{1}, ..., x_{n}
are the elements of this array. Returns z
if this array is empty.
Applies a binary operator to a start value and all elements of this immutable sequence, going left to right.
Note: will not terminate for infinite-sized collections.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable sequence, going left to right with the start value z
on the left:
op(...op(z, x_1), x_2, ..., x_n)
where x_{1}, ..., x_{n}
are the elements of this immutable sequence. Returns z
if this immutable sequence is empty.
Applies a binary operator to all elements of this array and a start value, going right to left.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this array, going right to left with the start value z
on the right:
op(x_1, op(x_2, ... op(x_n, z)...))
where x_{1}, ..., x_{n}
are the elements of this array. Returns z
if this array is empty.
Applies a binary operator to all elements of this immutable sequence and a start value, going right to left.
Note: will not terminate for infinite-sized collections.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this immutable sequence, going right to left with the start value z
on the right:
op(x_1, op(x_2, ... op(x_n, z)...))
where x_{1}, ..., x_{n}
are the elements of this immutable sequence. Returns z
if this immutable sequence is empty.
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.
Returns string formatted according to given format
string. Format strings are as for String.format
(@see java.lang.String.format).
Returns the runtime class representation of the object.
a class object corresponding to the runtime type of the receiver.
Partitions this array into a map of arrays according to some discriminator function.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to arrays such that the following invariant holds:
(xs groupBy f)(k) = xs filter (x => f(x) == k)
That is, every key k
is bound to an array of those elements x
for which f(x)
equals k
.
Partitions this immutable sequence into a map of immutable sequences according to some discriminator function.
Note: Even when applied to a view or a lazy collection it will always force the elements.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to immutable sequences 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 immutable sequence of those elements x
for which f(x)
equals k
.
Partitions this array into a map of arrays 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: Array[User]): Map[Int, Array[String]] = users.groupMap(_.age)(_.name)
the type of keys returned by the discriminator function
the type of values returned by the transformation function
the discriminator function
the element transformation function
Partitions this immutable sequence into a map of immutable sequences 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.
the type of keys returned by the discriminator function
the type of values returned by the transformation function
the discriminator function
the element transformation function
Partitions this immutable sequence into a map according to a discriminator function key
. All the values that have the same discriminator are then transformed by the value
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.
The hashCode method for reference types. See hashCode in scala.Any.
the hash code value for this object.
Finds index of first occurrence of some value in this immutable sequence.
the type of the element elem
.
the element value to search for.
the index >= 0
of the first element of this immutable sequence that is equal (as determined by ==
) to elem
, or -1
, if none exists.
Finds first index where this immutable sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
the sequence to test
the first index >= 0
such that the elements of this immutable sequence starting at this index match the elements of sequence that
, or -1
of no such subsequence exists.
Finds first index after or at a start index where this immutable sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
the sequence to test
the start index
the first index >= from
such that the elements of this immutable sequence starting at this index match the elements of sequence that
, or -1
of no such subsequence exists.
Finds index of the first element satisfying some predicate.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
the index >= 0
of the first element of this immutable sequence that satisfies the predicate p
, or -1
, if none exists.
Computes the multiset intersection between this array and another sequence.
the sequence of elements to intersect with.
a new array which contains all elements of this array which also appear in that
. If an element value x
appears n times in that
, then the first n occurrences of x
will be retained in the result, but any following occurrences will be omitted.
Computes the multiset intersection between this immutable sequence and another sequence.
the sequence of elements to intersect with.
a new immutable sequence which contains all elements of this immutable sequence which also appear in that
. If an element value x
appears n times in that
, then the first n occurrences of x
will be retained in the result, but any following occurrences will be omitted.
Tests whether this immutable sequence contains given index.
The implementations of methods apply
and isDefinedAt
turn a Seq[A]
into a PartialFunction[Int, A]
.
the index to test
true
if this immutable sequence contains an element at position idx
, false
otherwise.
Test whether the dynamic type of the receiver object is T0
.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String]
will return false
, while the expression List(1).isInstanceOf[List[String]]
will return true
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
true
if the receiver object is an instance of erasure of type T0
; false
otherwise.
Tests whether this immutable sequence can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.
true
if it is repeatedly traversable, false
otherwise.
The companion object of this immutable sequence, providing various factory methods.
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).
Finds last index where this immutable sequence contains a given sequence as a slice.
Note: will not terminate for infinite-sized collections.
the sequence to test
the last index such that the elements of this immutable sequence starting at this index match the elements of sequence that
, or -1
of no such subsequence exists.
Finds last index before or at a given end index where this immutable sequence contains a given sequence as a slice.
Note: will not terminate for infinite-sized collections.
the sequence to test
the end index
the last index <= end
such that the elements of this immutable sequence starting at this index match the elements of sequence that
, or -1
of no such subsequence exists.
Finds index of last element satisfying some predicate.
Note: will not terminate for infinite-sized collections.
the predicate used to test elements.
the index of the last element of this immutable sequence that satisfies the predicate p
, or -1
, if none exists.
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)
the type of the second element in each eventual pair
the iterable providing the second element of each eventual pair
a decorator LazyZip2
that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip
. Implicit conversion to Iterable[(A, B)]
is also supported.
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)
the type of the second element in each eventual pair
a decorator LazyZip2
that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip
. Implicit conversion to Iterable[(A, B)]
is also supported.
Compares the length of this immutable sequence to the size of another Iterable
.
the Iterable
whose size is compared with this immutable sequence's length.
A value x
where
x < 0 if this.length < that.size x == 0 if this.length == that.size x > 0 if this.length > that.size
The method as implemented here does not call length
or size
directly; its running time is O(this.length min that.size)
instead of O(this.length + that.size)
. The method should be overridden if computing size
is cheap and knownSize
returns -1
.
Turns this partial function into a plain function returning an Option
result.
a function that takes an argument x
to Some(this(x))
if this
is defined for x
, and to None
otherwise.
Function.unlift
Builds a new array by applying a function to all elements of this array.
the element type of the returned array.
the function to apply to each element.
a new aray resulting from applying the given function f
to each element of this array and collecting the results.
Builds a new immutable sequence by applying a function to all elements of this immutable sequence.
the element type of the returned immutable sequence.
the function to apply to each element.
a new immutable sequence resulting from applying the given function f
to each element of this immutable sequence and collecting the results.
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
Finds the largest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the largest element of this immutable sequence with respect to the ordering ord
.
UnsupportedOperationException
if this immutable sequence is empty.
Finds the first element which yields the largest value measured by function f.
The result type of the function f.
The measuring function.
An ordering to be used for comparing elements.
the first element of this immutable sequence with the largest value measured by function f with respect to the ordering cmp
.
UnsupportedOperationException
if this immutable sequence is empty.
Finds the first element which yields the largest value measured by function f.
The result type of the function f.
The measuring function.
An ordering to be used for comparing elements.
an option value containing the first element of this immutable sequence with the largest value measured by function f with respect to the ordering cmp
.
Finds the largest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
an option value containing the largest element of this immutable sequence with respect to the ordering ord
.
Finds the smallest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
the smallest element of this immutable sequence with respect to the ordering ord
.
UnsupportedOperationException
if this immutable sequence is empty.
Finds the first element which yields the smallest value measured by function f.
The result type of the function f.
The measuring function.
An ordering to be used for comparing elements.
the first element of this immutable sequence with the smallest value measured by function f with respect to the ordering cmp
.
UnsupportedOperationException
if this immutable sequence is empty.
Finds the first element which yields the smallest value measured by function f.
The result type of the function f.
The measuring function.
An ordering to be used for comparing elements.
an option value containing the first element of this immutable sequence with the smallest value measured by function f with respect to the ordering cmp
.
Finds the smallest element.
The type over which the ordering is defined.
An ordering to be used for comparing elements.
an option value containing the smallest element of this immutable sequence with respect to the ordering ord
.
Displays all elements of this immutable sequence in a string.
Delegates to addString, which can be overridden.
a string representation of this immutable sequence. In the resulting string the string representations (w.r.t. the method toString
) of all elements of this immutable sequence follow each other without any separator string.
Displays all elements of this immutable sequence in a string using a separator string.
Delegates to addString, which can be overridden.
the separator string.
a string representation of this immutable sequence. In the resulting string the string representations (w.r.t. the method toString
) of all elements of this immutable sequence are separated by the string sep
.
List(1, 2, 3).mkString("|") = "1|2|3"
Displays all elements of this immutable sequence in a string using start, end, and separator strings.
Delegates to addString, which can be overridden.
the starting string.
the separator string.
the ending string.
a string representation of this immutable sequence. The resulting string begins with the string start
and ends with the string end
. Inside, the string representations (w.r.t. the method toString
) of all elements of this immutable sequence are separated by the string sep
.
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Equivalent to !(this eq that)
.
true
if the argument is not a reference to the receiver object; false
otherwise.
Wakes up a single thread that is waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
Wakes up all threads that are waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.
the argument type of the fallback function
the result type of the fallback function
the fallback function
a partial function which has as domain the union of the domains of this partial function and that
. The resulting partial function takes x
to this(x)
where this
is defined, and to that(x)
where it is not.
A copy of this array with an element value appended until a given target length is reached.
the element type of the returned array.
the target length
the padding value
a new array consisting of all elements of this array followed by the minimal number of occurrences of elem
so that the resulting collection has a length of at least len
.
A copy of this immutable sequence with an element value appended until a given target length is reached.
the element type of the returned immutable sequence.
the target length
the padding value
a new immutable sequence consisting of all elements of this immutable sequence followed by the minimal number of occurrences of elem
so that the resulting collection has a length of at least len
.
Applies a function f
to each element of the array and returns a pair of arrays: 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 = Array(1, "one", 2, "two", 3, "three") partitionMap { case i: Int => Left(i) case s: String => Right(s) } // xs == (Array(1, 2, 3), // Array(one, two, three))
the element type of the first resulting collection
the element type of the second resulting collection
the 'split function' mapping the elements of this array to an scala.util.Either
a pair of arrays: 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 immutable sequence and returns a pair of immutable sequences: 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 = `immutable.Seq`(1, "one", 2, "two", 3, "three") partitionMap { case i: Int => Left(i) case s: String => Right(s) } // xs == (`immutable.Seq`(1, 2, 3), // `immutable.Seq`(one, two, three))
the element type of the first resulting collection
the element type of the second resulting collection
the 'split function' mapping the elements of this immutable sequence to an scala.util.Either
a pair of immutable sequences: 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.
Returns a copy of this array with patched values. Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original array appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
The start index from which to patch
The patch values
The number of values in the original array that are replaced by the patch.
Produces a new immutable sequence where a slice of elements in this immutable 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 immutable sequence appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
the element type of the returned immutable sequence.
the index of the first replaced element
the replacement sequence
the number of elements to drop in the original immutable sequence
a new immutable sequence consisting of all elements of this immutable sequence except that replaced
elements starting from from
are replaced by all the elements of other
.
A copy of this array with an element prepended.
A copy of the immutable sequence with an element prepended.
Also, the original immutable 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)
the element type of the returned immutable sequence.
the prepended element
a new immutable sequence consisting of value
followed by all elements of this immutable sequence.
A copy of this array with all elements of an array prepended.
A copy of this array with all elements of a collection prepended.
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.
the element type of the returned collection.
the iterable to prepend.
a new immutable sequence which contains all elements of prefix
followed by all the elements of this immutable sequence.
Multiplies up the elements of this collection.
the result type of the *
operator.
an implicit parameter defining a set of numeric operations which includes the *
operator to be used in forming the product.
the product of all elements of this immutable sequence with respect to the *
operator in num
.
Reduces the elements of this immutable sequence using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
A type parameter for the binary operator, a supertype of A
.
A binary operator that must be associative.
The result of applying reduce operator op
between all the elements if the immutable sequence is nonempty.
UnsupportedOperationException
if this immutable sequence is empty.
Applies a binary operator to all elements of this immutable sequence, going left to right.
Note: will not terminate for infinite-sized collections.
the result type of the binary operator.
the binary operator.
the result of inserting op
between consecutive elements of this immutable sequence, going left to right:
op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
where x_{1}, ..., x_{n}
are the elements of this immutable sequence.
UnsupportedOperationException
if this immutable sequence is empty.
Optionally applies a binary operator to all elements of this immutable sequence, going left to right.
Note: will not terminate for infinite-sized collections.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceLeft(op)
if this immutable sequence is nonempty, None
otherwise.
Reduces the elements of this immutable sequence, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
A type parameter for the binary operator, a supertype of A
.
A binary operator that must be associative.
An option value containing result of applying reduce operator op
between all the elements if the collection is nonempty, and None
otherwise.
Applies a binary operator to all elements of this immutable sequence, going right to left.
Note: will not terminate for infinite-sized collections.
the result type of the binary operator.
the binary operator.
the result of inserting op
between consecutive elements of this immutable sequence, going right to left:
op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
where x_{1}, ..., x_{n}
are the elements of this immutable sequence.
UnsupportedOperationException
if this immutable sequence is empty.
Optionally applies a binary operator to all elements of this immutable sequence, going right to left.
Note: will not terminate for infinite-sized collections.
the result type of the binary operator.
the binary operator.
an option value containing the result of reduceRight(op)
if this immutable sequence is nonempty, None
otherwise.
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.
the action function
a function which maps arguments x
to isDefinedAt(x)
. The resulting function runs action(this(x))
where this
is defined.
2.10
applyOrElse
.
Are the elements of this collection the same (and in the same order) as those of that
?
Computes a prefix scan of the elements of the array.
Note: The neutral element z
may be applied more than once.
element type of the resulting array
neutral element for the operator op
the associative operator for the scan
a new array containing the prefix scan of the elements in this array
Computes a prefix scan of the elements of the collection.
Note: The neutral element z
may be applied more than once.
element type of the resulting collection
neutral element for the operator op
the associative operator for the scan
a new immutable sequence containing the prefix scan of the elements in this immutable sequence
Produces an array containing cumulative results of applying the binary operator going left to right.
the result type of the binary operator.
the start value.
the binary operator.
array with intermediate values. Example:
Array(1, 2, 3, 4).scanLeft(0)(_ + _) == Array(0, 1, 3, 6, 10)
Produces a immutable sequence containing cumulative results of applying the operator going left to right, including the initial value.
Note: will not terminate for infinite-sized collections.
the type of the elements in the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
collection with intermediate results
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
Produces an array containing cumulative results of applying the binary operator going right to left.
the result type of the binary operator.
the start value.
the binary operator.
array with intermediate values. Example:
Array(4, 3, 2, 1).scanRight(0)(_ + _) == Array(10, 6, 3, 1, 0)
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
Note: will not terminate for infinite-sized collections.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Example:
List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
the type of the elements in the resulting collection
the initial value
the binary operator applied to the intermediate result and the element
collection with intermediate results
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.
the element to find.
the index where the search starts.
the index following where the search ends.
the ordering to be used to compare elements.
a Found
value containing the index corresponding to the element in the sequence, or the InsertionPoint
where the element would be inserted if the element is not in the sequence.
if to <= from
, the search space is empty, and an InsertionPoint
at from
is returned
scala.collection.SeqOps, method sorted
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.
the element to find.
the ordering to be used to compare elements.
a Found
value containing the index corresponding to the element in the sequence, or the InsertionPoint
where the element would be inserted if the element is not in the sequence.
scala.collection.SeqOps, method sorted
Computes length of longest segment whose elements all satisfy some predicate.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
the index where the search starts.
the length of the longest segment of this immutable sequence starting from index from
such that every element of the segment satisfies the predicate p
.
Computes length of longest segment whose elements all satisfy some predicate.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
the length of the longest segment of this immutable sequence such that every element of the segment satisfies the predicate p
.
Compares the size of this immutable sequence to the size of another Iterable
.
the Iterable
whose size is compared with this immutable sequence's size.
A value x
where
x < 0 if this.size < that.size x == 0 if this.size == that.size x > 0 if this.size > that.size
The method as implemented here does not call size
directly; its running time is O(this.size min that.size)
instead of O(this.size + that.size)
. The method should be overridden if computing size
is cheap and knownSize
returns -1
.
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped
.) The "sliding window" step is set to one.
the number of elements per group
An iterator producing immutable sequences of size size
, except the last element (which may be the only element) will be truncated if there are fewer than size
elements remaining to be grouped.
scala.collection.Iterator, method sliding
Sorts this array according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.
the target type of the transformation f
, and the type where the ordering ord
is defined.
the transformation function mapping elements to some other domain B
.
the ordering assumed on domain B
.
an array consisting of the elements of this array sorted according to the ordering where x < y
if ord.lt(f(x), f(y))
.
Sorts this immutable 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.
the target type of the transformation f
, and the type where the ordering ord
is defined.
the transformation function mapping elements to some other domain B
.
the ordering assumed on domain B
.
a immutable sequence consisting of the elements of this immutable sequence sorted according to the ordering where x < y
if ord.lt(f(x), f(y))
.
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)
Sorts this array according to an Ordering.
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.
the ordering to be used to compare elements.
an array consisting of the elements of this array sorted according to the ordering ord
.
Sorts this immutable 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.
the ordering to be used to compare elements.
a immutable sequence consisting of the elements of this immutable sequence sorted according to the ordering ord
.
scala.math.Ordering Note: Even when applied to a view or a lazy collection it will always force the elements.
Tests whether this array contains the given sequence at a given index.
the sequence to test
the index where the sequence is searched.
true
if the sequence that
is contained in this array at index offset
, otherwise false
.
Tests whether this array contains the given array at a given index.
the array to test
the index where the array is searched.
true
if the array that
is contained in this array at index offset
, otherwise false
.
Tests whether this array starts with the given array.
Tests whether this immutable 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.
the sequence to test
the index where the sequence is searched.
true
if the sequence that
is contained in this immutable sequence at index offset
, otherwise false
.
Returns a 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 StepperShape parameter defines the resulting Stepper type according to the element type of this collection.
Int
, Short
, Byte
or Char
, an IntStepper is returnedFor collections of Double
or Float
, a DoubleStepper is returnedFor collections of Long
a LongStepper is returnedFor any other element type, an AnyStepper is returnedNote that this method is overridden in subclasses and the return type is refined to S with EfficientSplit
, for example 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.
Sums up the elements of this collection.
the result type of the +
operator.
an implicit parameter defining a set of numeric operations which includes the +
operator to be used in forming the sum.
the sum of all elements of this immutable sequence with respect to the +
operator in num
.
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.
the return type of f
a function to apply to each element in this immutable sequence
The same logical collection as this
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]
Create a copy of this array with the specified element type.
Convert collection to array.
This collection as an Iterable[A]
. No new collection will be built if this
is already an Iterable[A]
.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
a String representation of the object.
Transposes a two dimensional array.
Type of row elements.
A function that converts elements of this array to rows - arrays of type B
.
An array obtained by replacing elements of this arrays with rows the represent.
Transposes this immutable sequence of iterable collections into a immutable sequence of immutable sequences.
The resulting collection's type will be guided by the static type of immutable sequence. 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.
the type of the elements of each iterable collection.
an implicit conversion which asserts that the element type of this immutable sequence is an Iterable
.
a two-dimensional immutable sequence of immutable sequences which has as nth row the nth column of this immutable sequence.
IllegalArgumentException
if all collections in this immutable sequence are not of the same size.
Tries to extract a B
from an A
in a pattern matching expression.
Converts an array of pairs into an array of first elements and an array of second elements.
the type of the first half of the element pairs
the type of the second half of the element pairs
an implicit conversion which asserts that the element type of this Array is a pair.
a class tag for A1
type parameter that is required to create an instance of Array[A1]
a class tag for A2
type parameter that is required to create an instance of Array[A2]
a pair of Arrays, containing, respectively, the first and second half of each element pair of this Array.
Converts this immutable sequence of pairs into two collections of the first and second half of each pair.
val xs = `immutable.Seq`( (1, "one"), (2, "two"), (3, "three")).unzip // xs == (`immutable.Seq`(1, 2, 3), // `immutable.Seq`(one, two, three))
the type of the first half of the element pairs
the type of the second half of the element pairs
an implicit conversion which asserts that the element type of this immutable sequence is a pair.
a pair of immutable sequences, containing the first, respectively second half of each element pair of this immutable sequence.
Converts an array of triples into three arrays, one containing the elements from each position of the triple.
the type of the first of three elements in the triple
the type of the second of three elements in the triple
the type of the third of three elements in the triple
an implicit conversion which asserts that the element type of this Array is a triple.
a class tag for T1 type parameter that is required to create an instance of Array[T1]
a class tag for T2 type parameter that is required to create an instance of Array[T2]
a class tag for T3 type parameter that is required to create an instance of Array[T3]
a triple of Arrays, containing, respectively, the first, second, and third elements from each element triple of this Array.
Converts this immutable sequence of triples into three collections of the first, second, and third element of each triple.
val xs = `immutable.Seq`( (1, "one", '1'), (2, "two", '2'), (3, "three", '3')).unzip3 // xs == (`immutable.Seq`(1, 2, 3), // `immutable.Seq`(one, two, three), // `immutable.Seq`(1, 2, 3))
the type of the first member of the element triples
the type of the second member of the element triples
the type of the third member of the element triples
an implicit conversion which asserts that the element type of this immutable sequence is a triple.
a triple of immutable sequences, containing the first, second, respectively third member of each element triple of this immutable sequence.
Update the element at given index.
Indices start at 0
; xs.update(i, x)
replaces the i^{th} element in the array. Note the syntax xs(i) = x
is a shorthand for xs.update(i, x)
.
the index
the value to be written at index i
ArrayIndexOutOfBoundsException
if i < 0
or length <= i
A copy of this array with one single replaced element.
the position of the replacement
the replacing element
a new array which is a copy of this array with the element at position index
replaced by elem
.
IndexOutOfBoundsException
if index
does not satisfy 0 <= index < length
.
A copy of this immutable sequence with one single replaced element.
the element type of the returned immutable sequence.
the position of the replacement
the replacing element
a new immutable sequence which is a copy of this immutable sequence with the element at position index
replaced by elem
.
IndexOutOfBoundsException
if index
does not satisfy 0 <= index < length
. In case of a lazy collection this exception may be thrown at a later time or not at all (if the end of the collection is never evaluated).
Returns an array formed from this array 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.
the type of the second half of the returned pairs
The iterable providing the second half of each result pair
a new array containing pairs consisting of corresponding elements of this array and that
. The length of the returned array is the minimum of the lengths of this array and that
.
Returns a immutable sequence formed from this immutable sequence 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.
the type of the second half of the returned pairs
The iterable providing the second half of each result pair
a new immutable sequence containing pairs consisting of corresponding elements of this immutable sequence and that
. The length of the returned collection is the minimum of the lengths of this immutable sequence and that
.
Returns an array formed from this array 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.
the iterable providing the second half of each result pair
the element to be used to fill up the result if this array is shorter than that
.
the element to be used to fill up the result if that
is shorter than this array.
a new array containing pairs consisting of corresponding elements of this array and that
. The length of the returned array is the maximum of the lengths of this array and that
. If this array is shorter than that
, thisElem
values are used to pad the result. If that
is shorter than this array, thatElem
values are used to pad the result.
Returns a immutable sequence formed from this immutable sequence 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.
the iterable providing the second half of each result pair
the element to be used to fill up the result if this immutable sequence is shorter than that
.
the element to be used to fill up the result if that
is shorter than this immutable sequence.
a new collection of type That
containing pairs consisting of corresponding elements of this immutable sequence and that
. The length of the returned collection is the maximum of the lengths of this immutable sequence and that
. If this immutable sequence is shorter than that
, thisElem
values are used to pad the result. If that
is shorter than this immutable sequence, thatElem
values are used to pad the result.
Get 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
.
(array: IndexedSeq[T]).apply(i)
Iterates over combinations. A _combination_ of length n
is a subsequence of the original array, with the elements taken in order. Thus, Array("x", "y")
and Array("y", "y")
are both length-2 combinations of Array("x", "y", "y")
, but Array("y", "x")
is not. If there is more than one way to generate the same subsequence, only one will be returned.
For example, Array("x", "y", "y", "y")
has three different ways to generate Array("x", "y")
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.
An Iterator which traverses the possible n-element combinations of this array.
(array: ArrayOps[T]).combinations(n)
Array("a", "b", "b", "b", "c").combinations(2) == Iterator(Array(a, b), Array(a, c), Array(b, b), Array(b, c))
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.
An Iterator which traverses the possible n-element combinations of this immutable sequence.
(array: IndexedSeq[T]).combinations(n)
"abbbc".combinations(2) = Iterator(ab, ac, bb, bc)
Tests whether this array contains a given value as an element.
the element to test.
true
if this array has an element that is equal (as determined by ==
) to elem
, false
otherwise.
(array: ArrayOps[T]).contains(elem)
Tests whether this immutable sequence contains a given value as an element.
Note: may not terminate for infinite-sized collections.
the element to test.
true
if this immutable sequence has an element that is equal (as determined by ==
) to elem
, false
otherwise.
(array: IndexedSeq[T]).contains(elem)
Counts the number of elements in this array which satisfy a predicate
(array: ArrayOps[T]).count(p)
Counts the number of elements in the immutable sequence which satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p
.
(array: IndexedSeq[T]).count(p)
Selects all the elements of this array ignoring the duplicates.
a new array consisting of all the elements of this array without duplicates.
(array: ArrayOps[T]).distinct
Selects all the elements of this immutable sequence ignoring the duplicates.
a new immutable sequence consisting of all the elements of this immutable sequence without duplicates.
(array: IndexedSeq[T]).distinct
The rest of the array without its n
first elements.
(array: ArrayOps[T]).drop(n)
Selects all elements except first n ones.
the number of elements to drop from this immutable sequence.
a immutable sequence consisting of all elements of this immutable sequence except the first n
ones, or else the empty immutable sequence, if this immutable sequence has less than n
elements. If n
is negative, don't drop any elements.
(array: IndexedSeq[T]).drop(n)
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
The rest of the array without its n
last elements.
(array: ArrayOps[T]).dropRight(n)
Selects all elements except last n ones.
the number of elements to drop from this immutable sequence.
a immutable sequence consisting of all elements of this immutable sequence except the last n
ones, or else the empty immutable sequence, if this immutable sequence has less than n
elements. If n
is negative, don't drop any elements.
(array: IndexedSeq[T]).dropRight(n)
Drops longest prefix of elements that satisfy a predicate.
The predicate used to test elements.
the longest suffix of this array whose first element does not satisfy the predicate p
.
(array: ArrayOps[T]).dropWhile(p)
Drops longest prefix of elements that satisfy a predicate.
The predicate used to test elements.
the longest suffix of this immutable sequence whose first element does not satisfy the predicate p
.
(array: IndexedSeq[T]).dropWhile(p)
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
The universal equality method defined in AnyRef
.
(array: IndexedSeq[T]).equals(o)
Tests whether a predicate holds for at least one element of this array.
true
if the given predicate p
is satisfied by at least one element of this array, otherwise false
(array: ArrayOps[T]).exists(f)
Tests whether a predicate holds for at least one element of this immutable sequence.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
true
if the given predicate p
is satisfied by at least one element of this immutable sequence, otherwise false
(array: IndexedSeq[T]).exists(p)
Selects all elements of this array which satisfy a predicate.
the predicate used to test elements.
a new array consisting of all elements of this array that satisfy the given predicate p
.
(array: ArrayOps[T]).filter(p)
Selects all elements of this immutable sequence which satisfy a predicate.
a new iterator consisting of all elements of this immutable sequence that satisfy the given predicate p
. The order of the elements is preserved.
(array: IndexedSeq[T]).filter(pred)
Selects all elements of this array which do not satisfy a predicate.
a new array consisting of all elements of this array that do not satisfy the given predicate pred
.
(array: ArrayOps[T]).filterNot(p)
Selects all elements of this immutable sequence which do not satisfy a predicate.
the predicate used to test elements.
a new immutable sequence consisting of all elements of this immutable sequence that do not satisfy the given predicate pred
. Their order may not be preserved.
(array: IndexedSeq[T]).filterNot(pred)
Finds the first element of the array satisfying a predicate, if any.
an option value containing the first element in the array that satisfies p
, or None
if none exists.
(array: ArrayOps[T]).find(f)
Finds the first element of the immutable sequence satisfying a predicate, if any.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
an option value containing the first element in the immutable sequence that satisfies p
, or None
if none exists.
(array: IndexedSeq[T]).find(p)
Tests whether a predicate holds for all elements of this array.
true
if this array is empty or the given predicate p
holds for all elements of this array, otherwise false
.
(array: ArrayOps[T]).forall(f)
Tests whether a predicate holds for all elements of this immutable sequence.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
true
if this immutable sequence is empty or the given predicate p
holds for all elements of this immutable sequence, otherwise false
.
(array: IndexedSeq[T]).forall(p)
Partitions elements in fixed size arrays.
the number of elements per group
An iterator producing arrays of size size
, except the last will be less than size size
if the elements don't divide evenly.
(array: ArrayOps[T]).grouped(size)
scala.collection.Iterator, method grouped
Partitions elements in fixed size immutable sequences.
the number of elements per group
An iterator producing immutable sequences of size size
, except the last will be less than size size
if the elements don't divide evenly.
(array: IndexedSeq[T]).grouped(size)
scala.collection.Iterator, method grouped
The hashCode method for reference types. See hashCode in scala.Any.
the hash code value for this object.
(array: IndexedSeq[T]).hashCode()
Selects the first element of this array.
the first element of this array.
(array: ArrayOps[T]).head
NoSuchElementException
if the array is empty.
Selects the first element of this immutable sequence.
the first element of this immutable sequence.
(array: IndexedSeq[T]).head
NoSuchElementException
if the immutable sequence is empty.
Optionally selects the first element.
the first element of this array if it is nonempty, None
if it is empty.
(array: ArrayOps[T]).headOption
Optionally selects the first element.
the first element of this immutable sequence if it is nonempty, None
if it is empty.
(array: IndexedSeq[T]).headOption
Finds index of first occurrence of some value in this array after or at some start index.
the element value to search for.
the start index
the index >= from
of the first element of this array that is equal (as determined by ==
) to elem
, or -1
, if none exists.
(array: ArrayOps[T]).indexOf(elem, from)
Finds index of first occurrence of some value in this immutable sequence after or at some start index.
the type of the element elem
.
the element value to search for.
the start index
the index >= from
of the first element of this immutable sequence that is equal (as determined by ==
) to elem
, or -1
, if none exists.
(array: IndexedSeq[T]).indexOf(elem, from)
Finds index of the first element satisfying some predicate after or at some start index.
the start index
the index >= from
of the first element of this array that satisfies the predicate p
, or -1
, if none exists.
(array: ArrayOps[T]).indexWhere(f, from)
Finds index of the first element satisfying some predicate after or at some start index.
Note: may not terminate for infinite-sized collections.
the predicate used to test elements.
the start index
the index >= from
of the first element of this immutable sequence that satisfies the predicate p
, or -1
, if none exists.
(array: IndexedSeq[T]).indexWhere(p, from)
Produces the range of all indices of this sequence.
a Range
value from 0
to one less than the length of this array.
(array: ArrayOps[T]).indices
Produces the range of all indices of this sequence.
Note: Even when applied to a view or a lazy collection it will always force the elements.
a Range
value from 0
to one less than the length of this immutable sequence.
(array: IndexedSeq[T]).indices
The initial part of the array without its last element.
(array: ArrayOps[T]).init
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.
(array: IndexedSeq[T]).init
Iterates over the inits of this array. The first value will be this array and the final one will be an empty array, with the intervening values the results of successive applications of init
.
an iterator over all the inits of this array
(array: ArrayOps[T]).inits
Iterates over the inits of this immutable sequence. The first value will be this immutable sequence and the final one will be an empty immutable sequence, 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.
an iterator over all the inits of this immutable sequence
(array: IndexedSeq[T]).inits
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Tests whether the array is empty.
true
if the array contains no elements, false
otherwise.
(array: ArrayOps[T]).isEmpty
Tests whether the immutable sequence is empty.
Note: Implementations in subclasses that are not repeatedly traversable must take care not to consume any elements when isEmpty
is called.
true
if the immutable sequence contains no elements, false
otherwise.
(array: IndexedSeq[T]).isEmpty
(array: ArrayOps[T]).iterator
Iterator can be used only once
(array: IndexedSeq[T]).iterator
The size of this array.
the number of elements in this array.
(array: ArrayOps[T]).knownSize
The number of elements in this immutable sequence, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
(array: IndexedSeq[T]).knownSize
Selects the last element.
The last element of this array.
(array: ArrayOps[T]).last
NoSuchElementException
If the array is empty.
Selects the last element.
The last element of this immutable sequence.
(array: IndexedSeq[T]).last
NoSuchElementException
If the immutable sequence is empty.
Finds index of last occurrence of some value in this array before or at a given end index.
the element value to search for.
the end index.
the index <= end
of the last element of this array that is equal (as determined by ==
) to elem
, or -1
, if none exists.
(array: ArrayOps[T]).lastIndexOf(elem, end)
Finds index of last occurrence of some value in this immutable sequence before or at a given end index.
Note: will not terminate for infinite-sized collections.
the type of the element elem
.
the element value to search for.
the end index.
the index <= end
of the last element of this immutable sequence that is equal (as determined by ==
) to elem
, or -1
, if none exists.
(array: IndexedSeq[T]).lastIndexOf(elem, end)
Finds index of last element satisfying some predicate before or at given end index.
the predicate used to test elements.
the index <= end
of the last element of this array that satisfies the predicate p
, or -1
, if none exists.
(array: ArrayOps[T]).lastIndexWhere(p, end)
Finds index of last element satisfying some predicate before or at given end index.
Note: will not terminate for infinite-sized collections.
the predicate used to test elements.
the index <= end
of the last element of this immutable sequence that satisfies the predicate p
, or -1
, if none exists.
(array: IndexedSeq[T]).lastIndexWhere(p, end)
Optionally selects the last element.
the last element of this array$ if it is nonempty, None
if it is empty.
(array: ArrayOps[T]).lastOption
Optionally selects the last element.
the last element of this immutable sequence$ if it is nonempty, None
if it is empty.
(array: IndexedSeq[T]).lastOption
(array: ArrayCharSequence).length()
The length (number of elements) of the immutable sequence. size
is an alias for length
in Seq
collections.
(array: IndexedSeq[T]).length
Compares the length of this array to a test value.
the test value that gets compared with the length.
A value x
where
x < 0 if this.length < len x == 0 if this.length == len x > 0 if this.length > len
(array: ArrayOps[T]).lengthCompare(len)
Compares the length of this immutable sequence to a test value.
the test value that gets compared with the length.
A value x
where
x < 0 if this.length < len x == 0 if this.length == len x > 0 if this.length > len
The method as implemented here does not call length
directly; its running time is O(length min len)
instead of O(length)
. The method should be overridden if computing length
is cheap and knownSize
returns -1
.
(array: IndexedSeq[T]).lengthCompare(len)
Method mirroring SeqOps.lengthIs for consistency, except it returns an Int
because length
is known and comparison is constant-time.
These operations are equivalent to 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
(array: ArrayOps[T]).lengthIs
Returns a value class containing operations for comparing the length of this immutable 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
(array: IndexedSeq[T]).lengthIs
Tests whether the array is not empty.
true
if the array contains at least one element, false
otherwise.
(array: ArrayOps[T]).nonEmpty
Tests whether the immutable sequence is not empty.
true
if the immutable sequence contains at least one element, false
otherwise.
(array: IndexedSeq[T]).nonEmpty
A pair of, first, all elements that satisfy predicate p
and, second, all elements that do not.
(array: ArrayOps[T]).partition(p)
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.
(array: IndexedSeq[T]).partition(p)
Iterates over distinct permutations.
An Iterator which traverses the distinct permutations of this array.
(array: ArrayOps[T]).permutations
Array("a", "b", "b").permutations == Iterator(Array(a, b, b), Array(b, a, b), Array(b, b, a))
Iterates over distinct permutations.
Note: Even when applied to a view or a lazy collection it will always force the elements.
An Iterator which traverses the distinct permutations of this immutable sequence.
(array: IndexedSeq[T]).permutations
"abb".permutations = Iterator(abb, bab, bba)
Returns a new array with the elements in reversed order.
(array: ArrayOps[T]).reverse
Returns new immutable 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.
A new immutable sequence with all elements of this immutable sequence in reversed order.
(array: IndexedSeq[T]).reverse
An iterator yielding elements in reversed order.
Note: xs.reverseIterator
is the same as xs.reverse.iterator
but implemented more efficiently.
an iterator yielding the elements of this array in reversed order
(array: ArrayOps[T]).reverseIterator
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.
an iterator yielding the elements of this immutable sequence in reversed order
(array: IndexedSeq[T]).reverseIterator
The size of this array.
the number of elements in this array.
(array: ArrayOps[T]).size
The size of this immutable sequence.
Note: will not terminate for infinite-sized collections.
the number of elements in this immutable sequence.
(array: IndexedSeq[T]).size
Compares the size of this array to a test value.
the test value that gets compared with the size.
A value x
where
x < 0 if this.size < otherSize x == 0 if this.size == otherSize x > 0 if this.size > otherSize
(array: ArrayOps[T]).sizeCompare(otherSize)
Compares the size of this immutable sequence to a test value.
the test value that gets compared with the size.
A value x
where
x < 0 if this.size < otherSize x == 0 if this.size == otherSize x > 0 if this.size > otherSize
The method as implemented here does not call size
directly; its running time is O(size min otherSize)
instead of O(size)
. The method should be overridden if computing size
is cheap and knownSize
returns -1
.
(array: IndexedSeq[T]).sizeCompare(otherSize)
Method mirroring SeqOps.sizeIs for consistency, except it returns an Int
because size
is known and comparison is constant-time.
These operations are equivalent to 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
(array: ArrayOps[T]).sizeIs
Returns a value class containing operations for comparing the size of this immutable sequence 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
(array: IndexedSeq[T]).sizeIs
Selects an interval of elements. The returned array is made up of all elements x
which satisfy the invariant:
from <= indexOf(x) < until
the lowest index to include from this array.
the lowest index to EXCLUDE from this array.
an array containing the elements greater than or equal to index from
extending up to (but not including) index until
of this array.
(array: ArrayOps[T]).slice(from, until)
Selects an interval of elements. The returned immutable sequence is made up of all elements x
which satisfy the invariant:
from <= indexOf(x) < until
the lowest index to include from this immutable sequence.
the lowest index to EXCLUDE from this immutable sequence.
a immutable sequence containing the elements greater than or equal to index from
extending up to (but not including) index until
of this immutable sequence.
(array: IndexedSeq[T]).slice(from, until)
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
the number of elements per group
the distance between the first elements of successive groups
An iterator producing arrays of size size
, except the last element (which may be the only element) will be truncated if there are fewer than size
elements remaining to be grouped.
(array: ArrayOps[T]).sliding(size, step)
scala.collection.Iterator, method sliding
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
the number of elements per group
the distance between the first elements of successive groups
An iterator producing immutable sequences of size size
, except the last element (which may be the only element) will be truncated if there are fewer than size
elements remaining to be grouped.
(array: IndexedSeq[T]).sliding(size, step)
scala.collection.Iterator, method sliding
Sorts this array according to a comparison function.
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.
the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
an array consisting of the elements of this array sorted according to the comparison function lt
.
(array: ArrayOps[T]).sortWith(lt)
Sorts this immutable 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.
the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
a immutable sequence consisting of the elements of this immutable sequence sorted according to the comparison function lt
.
(array: IndexedSeq[T]).sortWith(lt)
List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) = List("Bob", "John", "Steve", "Tom")
Splits this array into a prefix/suffix pair according to a predicate.
Note: c span p
is equivalent to (but more efficient than) (c takeWhile p, c dropWhile p)
, provided the evaluation of the predicate p
does not cause any side-effects.
the test predicate
a pair consisting of the longest prefix of this array whose elements all satisfy p
, and the rest of this array.
(array: ArrayOps[T]).span(p)
Splits this immutable sequence 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.
the test predicate
a pair consisting of the longest prefix of this immutable sequence whose elements all satisfy p
, and the rest of this immutable sequence.
(array: IndexedSeq[T]).span(p)
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
Splits this array into two at a given position. Note: c splitAt n
is equivalent to (c take n, c drop n)
.
the position at which to split.
a pair of arrays consisting of the first n
elements of this array, and the other elements.
(array: ArrayOps[T]).splitAt(n)
Splits this immutable sequence 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)
.
the position at which to split.
a pair of immutable sequences consisting of the first n
elements of this immutable sequence, and the other elements.
(array: IndexedSeq[T]).splitAt(n)
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
The rest of the array without its first element.
(array: ArrayOps[T]).tail
The rest of the collection without its first element.
(array: IndexedSeq[T]).tail
Iterates over the tails of this array. The first value will be this array and the final one will be an empty array, with the intervening values the results of successive applications of tail
.
an iterator over all the tails of this array
(array: ArrayOps[T]).tails
Iterates over the tails of this immutable sequence. The first value will be this immutable sequence and the final one will be an empty immutable sequence, with the intervening values the results of successive applications of tail
.
an iterator over all the tails of this immutable sequence
(array: IndexedSeq[T]).tails
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
An array containing the first n
elements of this array.
(array: ArrayOps[T]).take(n)
Selects the first n elements.
the number of elements to take from this immutable sequence.
a immutable sequence consisting only of the first n
elements of this immutable sequence, or else the whole immutable sequence, if it has less than n
elements. If n
is negative, returns an empty immutable sequence.
(array: IndexedSeq[T]).take(n)
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
An array containing the last n
elements of this array.
(array: ArrayOps[T]).takeRight(n)
Selects the last n elements.
the number of elements to take from this immutable sequence.
a immutable sequence consisting only of the last n
elements of this immutable sequence, or else the whole immutable sequence, if it has less than n
elements. If n
is negative, returns an empty immutable sequence.
(array: IndexedSeq[T]).takeRight(n)
Takes longest prefix of elements that satisfy a predicate.
The predicate used to test elements.
the longest prefix of this array whose elements all satisfy the predicate p
.
(array: ArrayOps[T]).takeWhile(p)
Takes longest prefix of elements that satisfy a predicate.
The predicate used to test elements.
the longest prefix of this immutable sequence whose elements all satisfy the predicate p
.
(array: IndexedSeq[T]).takeWhile(p)
(array: ArrayOps[T]).toIndexedSeq
(array: IndexedSeq[T]).toIndexedSeq
(array: ArrayOps[T]).toSeq
This collection as a Seq[A]
. This is equivalent to to(Seq)
but might be faster.
(array: IndexedSeq[T]).toSeq
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
a String representation of the object.
(array: ArrayCharSequence).toString()
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
a String representation of the object.
(array: IndexedSeq[T]).toString()
(array: ArrayOps[T]).view
A view over the elements of this collection.
(array: IndexedSeq[T]).view
Creates a non-strict filter of this array.
Note: the difference between c filter p
and c withFilter p
is that the former creates a new array, whereas the latter only restricts the domain of subsequent map
, flatMap
, foreach
, and withFilter
operations.
the predicate used to test elements.
an object of class ArrayOps.WithFilter
, which supports map
, flatMap
, foreach
, and withFilter
operations. All these operations apply to those elements of this array which satisfy the predicate p
.
(array: ArrayOps[T]).withFilter(p)
Creates a non-strict filter of this immutable sequence.
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.
the predicate used to test elements.
an object of class WithFilter
, which supports map
, flatMap
, foreach
, and withFilter
operations. All these operations apply to those elements of this immutable sequence which satisfy the predicate p
.
(array: IndexedSeq[T]).withFilter(p)
Zips this array with its indices.
A new array containing pairs consisting of all elements of this array paired with their index. Indices start at 0
.
(array: ArrayOps[T]).zipWithIndex
Zips this immutable sequence with its indices.
A new immutable sequence containing pairs consisting of all elements of this immutable sequence paired with their index. Indices start at 0
.
(array: IndexedSeq[T]).zipWithIndex
List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/Array.html
Arrays are mutable, indexed collections of values.
Array[T]
is Scala's representation for Java'sT[]
.Arrays make use of two common pieces of Scala syntactic sugar, shown on lines 2 and 3 of the above example code. Line 2 is translated into a call to
apply(Int)
, while line 3 is translated into a call toupdate(Int, T)
.Two implicit conversions exist in scala.Predef that are frequently applied to arrays: a conversion to scala.collection.ArrayOps (shown on line 4 of the example above) and a conversion to scala.collection.mutable.ArraySeq (a subtype of scala.collection.Seq). Both types make available many of the standard operations found in the Scala collections API. The conversion to
ArrayOps
is temporary, as all operations defined onArrayOps
return anArray
, while the conversion toArraySeq
is permanent as all operations return aArraySeq
.The conversion to
ArrayOps
takes priority over the conversion toArraySeq
. For instance, consider the following code:Value
arrReversed
will be of typeArray[Int]
, with an implicit conversion toArrayOps
occurring to perform thereverse
operation. The value ofseqReversed
, on the other hand, will be computed by converting toArraySeq
first and invoking the variant ofreverse
that returns anotherArraySeq
.1.0
Scala Language Specification, for in-depth information on the transformations the Scala compiler makes on Arrays (Sections 6.6 and 6.15 respectively.)
"Scala 2.8 Arrays" the Scala Improvement Document detailing arrays since Scala 2.8.
"The Scala 2.8 Collections' API" section on
Array
by Martin Odersky for more information.