final class Array[T] extends java.io.Serializable with java.lang.Cloneable
Arrays are mutable, indexed collections of values. Array[T]
is Scala's representation
for Java's T[]
.
val numbers = Array(1, 2, 3, 4) val first = numbers(0) // read the first element numbers(3) = 100 // replace the 4th array element with 100 val biggerNumbers = numbers.map(_ * 2) // multiply all numbers by two
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 to
update(Int, T)
.
Two implicit conversions exist in scala.Predef that are frequently applied to arrays: a conversion
to scala.collection.mutable.ArrayOps (shown on line 4 of the example above) and a conversion
to scala.collection.mutable.WrappedArray (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 on ArrayOps
return an Array
,
while the conversion to WrappedArray
is permanent as all operations return a WrappedArray
.
The conversion to ArrayOps
takes priority over the conversion to WrappedArray
. For instance,
consider the following code:
val arr = Array(1, 2, 3) val arrReversed = arr.reverse val seqReversed : Seq[Int] = arr.reverse
Value arrReversed
will be of type Array[Int]
, with an implicit conversion to ArrayOps
occurring
to perform the reverse
operation. The value of seqReversed
, on the other hand, will be computed
by converting to WrappedArray
first and invoking the variant of reverse
that returns another
WrappedArray
.
- Source
- Array.scala
- Since
1.0
- See also
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.
- Alphabetic
- By Inheritance
- Array
- Cloneable
- Serializable
- AnyRef
- Any
- by genericArrayOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from Array[T] to any2stringadd[Array[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
++[B >: A, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Array[T], B, That]): That
Returns a new mutable indexed sequence containing the elements from the left hand operand followed by the elements from the right hand operand.
Returns a new mutable indexed sequence containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the mutable indexed sequence is the most specific superclass encompassing the element types of the two operands.
- B
the element type of the returned collection.
- That
the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.- that
the traversable to append.
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
a new collection of type
That
which contains all elements of this mutable indexed sequence followed by all elements ofthat
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
++:[B >: A, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[Array[T], B, That]): That
As with
++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.As with
++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.It differs from
++
in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
This overload exists because: for the implementation of
++:
we should reuse that of++
because many collections override it with more efficient versions.Since
TraversableOnce
has no++
method, we have to implement that directly, butTraversable
and down can use the overload.- B
the element type of the returned collection.
- That
the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.- that
the traversable to append.
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
a new collection of type
That
which contains all elements of this mutable indexed sequence followed by all elements ofthat
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike
-
def
++:[B](that: collection.TraversableOnce[B]): Array[B]
[use case] As with
++
, returns a new collection containing the elements from the left operand followed by the elements from the right operand.[use case]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.Example:
scala> val x = List(1) x: List[Int] = List(1) scala> val y = LinkedList(2) y: scala.collection.mutable.LinkedList[Int] = LinkedList(2) scala> val z = x ++: y z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
- B
the element type of the returned collection.
- that
the traversable to append.
- returns
a new array which contains all elements of this array followed by all elements of
that
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike
Full Signaturedef ++:[B >: A, That](that: collection.TraversableOnce[B])(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
+:[B >: T](elem: B)(implicit arg0: ClassTag[B]): Array[B]
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps
-
def
+:(elem: A): Array[A]
[use case] A copy of the array with an element prepended.
[use case]A copy of the array with an element prepended.
Note that :-ending operators are right associative (see example). A mnemonic for
+:
vs.:+
is: the COLon goes on the COLlection side.Also, the original array 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)
- elem
the prepended element
- returns
a new array consisting of
elem
followed by all elements of this array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef +:[B >: A, That](elem: B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
->[B](y: B): (Array[T], B)
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrowAssoc[Array[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
def
:+[B >: T](elem: B)(implicit arg0: ClassTag[B]): Array[B]
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps
-
def
:+(elem: A): Array[A]
[use case] A copy of this array with an element appended.
[use case]A copy of this array with an element appended.
A mnemonic for
+:
vs.:+
is: the COLon goes on the COLlection side.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)
- elem
the appended element
- returns
a new array consisting of all elements of this array followed by
elem
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef :+[B >: A, That](elem: B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
-
def
addString(b: StringBuilder): StringBuilder
Appends all elements of this mutable indexed sequence to a string builder.
Appends all elements of this mutable indexed sequence to a string builder. The written text consists of the string representations (w.r.t. the method
toString
) of all elements of this mutable indexed 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
- b
the string builder to which elements are appended.
- returns
the string builder
b
to which elements were appended.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, sep: String): StringBuilder
Appends all elements of this mutable indexed sequence to a string builder using a separator string.
Appends all elements of this mutable indexed 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 mutable indexed sequence, separated by the stringsep
.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
- b
the string builder to which elements are appended.
- sep
the separator string.
- returns
the string builder
b
to which elements were appended.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
Appends all elements of this mutable indexed sequence to a string builder using start, end, and separator strings.
Appends all elements of this mutable indexed sequence to a string builder using start, end, and separator strings. The written text begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this mutable indexed sequence are separated by the stringsep
.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)
- b
the string builder to which elements are appended.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
the string builder
b
to which elements were appended.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce
-
def
aggregate[B](z: ⇒ B)(seqop: (B, T) ⇒ B, combop: (B, B) ⇒ B): B
Aggregates the results of applying an operator to subsequent elements.
Aggregates the results of applying an operator to subsequent elements.
This is a more general form of
fold
andreduce
. It is similar tofoldLeft
in that it doesn't require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.aggregate
splits the mutable indexed sequence into partitions and processes each partition by sequentially applyingseqop
, starting withz
(likefoldLeft
). Those intermediate results are then combined by usingcombop
(likefold
). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), socombop
may be invoked an arbitrary number of times (even 0).As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First,
seqop
transforms each input character to an Int and adds it to the sum (of the partition). Then,combop
just needs to sum up the intermediate results of the partitions:List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
- B
the type of accumulated results
- z
the initial value for the accumulated result of the partition - this will typically be the neutral element for the
seqop
operator (e.g.Nil
for list concatenation or0
for summation) and may be evaluated more than once- seqop
an operator used to accumulate results within a partition
- combop
an associative operator used to combine results from different partitions
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
apply(i: Int): T
The element at given index.
The element at given index.
Indices start at
0
;xs.apply(0)
is the first element of arrayxs
. Note the indexing syntaxxs(i)
is a shorthand forxs.apply(i)
.- i
the index
- returns
the element at the given index
- Exceptions thrown
ArrayIndexOutOfBoundsException
ifi < 0
orlength <= i
-
final
def
asInstanceOf[T0]: T0
Cast the receiver object to be of type
T0
.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 aClassCastException
at runtime, while the expressionList(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.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
-
def
canEqual(that: Any): Boolean
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
- that
The object with which this mutable indexed sequence should be compared
- returns
true
, if this mutable indexed sequence can possibly equalthat
,false
otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike → Equals
-
def
clone(): Array[T]
Clone the Array.
-
def
collect[B](pf: PartialFunction[A, B]): Array[B]
[use case] Builds a new collection by applying a partial function to all elements of this array on which the function is defined.
[use case]Builds a new collection by applying a partial function to all elements of this array on which the function is defined.
- B
the element type of the returned collection.
- pf
the partial function which filters and maps the array.
- returns
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.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
Full Signaturedef collect[B, That](pf: PartialFunction[T, B])(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
collectFirst[B](pf: PartialFunction[T, B]): Option[B]
Finds the first element of the mutable indexed sequence for which the given partial function is defined, and applies the partial function to it.
Finds the first element of the mutable indexed sequence for which the given partial function is defined, and applies the partial function to it.
- pf
the partial function
- returns
an option value containing pf applied to the first value for which it is defined, or
None
if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Example: -
def
combinations(n: Int): collection.Iterator[Array[T]]
Iterates over combinations.
Iterates over combinations. A _combination_ of length
n
is a subsequence of the original sequence, with the elements taken in order. Thus,"xy"
and"yy"
are both length-2 combinations of"xyy"
, but"yx"
is not. If there is more than one way to generate the same subsequence, only one will be returned.For example,
"xyyy"
has three different ways to generate"xy"
depending on whether the first, second, or third"y"
is selected. However, since all are identical, only one will be chosen. Which of the three will be taken is an implementation detail that is not defined.- returns
An Iterator which traverses the possible n-element combinations of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
"abbbc".combinations(2) = Iterator(ab, ac, bb, bc)
Example: -
def
contains[A1 >: A](elem: A1): Boolean
Tests whether this mutable indexed sequence contains a given value as an element.
Tests whether this mutable indexed sequence contains a given value as an element.
- elem
the element to test.
- returns
true
if this mutable indexed sequence has an element that is equal (as determined by==
) toelem
,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
-
def
containsSlice[B](that: GenSeq[B]): Boolean
Tests whether this mutable indexed sequence contains a given sequence as a slice.
Tests whether this mutable indexed sequence contains a given sequence as a slice.
- that
the sequence to test
- returns
true
if this mutable indexed sequence contains a slice with the same elements asthat
, otherwisefalse
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
-
def
copyToArray(xs: Array[A], start: Int, len: Int): Unit
[use case] Copies the elements of this array to an array.
[use case]Copies the elements of this array to an array. Fills the given array
xs
with at mostlen
elements of this array, starting at positionstart
. Copying will stop once either the end of the current array is reached, or the end of the target array is reached, orlen
elements have been copied.- xs
the array to fill.
- start
the starting index.
- len
the maximal number of elements to copy.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps → IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
copyToArray(xs: Array[A]): Unit
[use case] Copies the elements of this array to an array.
[use case]Copies the elements of this array to an array. Fills the given array
xs
with values of this array. Copying will stop once either the end of the current array is reached, or the end of the target array is reached.- xs
the array to fill.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToArray(xs: Array[A], start: Int): Unit
[use case] Copies the elements of this array to an array.
[use case]Copies the elements of this array to an array. Fills the given array
xs
with values of this array, beginning at indexstart
. Copying will stop once either the end of the current array is reached, or the end of the target array is reached.- xs
the array to fill.
- start
the starting index.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToBuffer[B >: A](dest: Buffer[B]): Unit
Copies all elements of this mutable indexed sequence to a buffer.
Copies all elements of this mutable indexed sequence to a buffer.
- dest
The buffer to which elements are copied.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce
-
def
corresponds[B](that: GenSeq[B])(p: (T, B) ⇒ Boolean): Boolean
Tests whether every element of this mutable indexed sequence relates to the corresponding element of another sequence by satisfying a test predicate.
Tests whether every element of this mutable indexed sequence relates to the corresponding element of another sequence by satisfying a test predicate.
- B
the type of the elements of
that
- that
the other sequence
- p
the test predicate, which relates elements from both sequences
- returns
true
if both sequences have the same length andp(x, y)
istrue
for all corresponding elementsx
of this mutable indexed sequence andy
ofthat
, otherwisefalse
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
-
def
count(p: (T) ⇒ Boolean): Int
Counts the number of elements in the mutable indexed sequence which satisfy a predicate.
Counts the number of elements in the mutable indexed sequence which satisfy a predicate.
- p
the predicate used to test elements.
- returns
the number of elements satisfying the predicate
p
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
deep: collection.IndexedSeq[Any]
Creates a possible nested
IndexedSeq
which consists of all the elements of this array.Creates a possible nested
IndexedSeq
which consists of all the elements of this array. If the elements are arrays themselves, thedeep
transformation is applied recursively to them. ThestringPrefix
of theIndexedSeq
is "Array", hence theIndexedSeq
prints like an array with all its elements shown, and the same recursively for any subarrays.Example:
Array(Array(1, 2), Array(3, 4)).deep.toString
prints:
Array(Array(1, 2), Array(3, 4))
- returns
An possibly nested indexed sequence of consisting of all the elements of the array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayLike
-
def
diff(that: collection.Seq[T]): Array[T]
[use case] Computes the multiset difference between this array and another sequence.
[use case]Computes the multiset difference between this array and another sequence.
- that
the sequence of elements to remove
- returns
a new array which contains all elements of this array except some of occurrences of elements that also appear in
that
. If an element valuex
appears n times inthat
, then the first n occurrences ofx
will not form part of the result, but any following occurrences will.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
-
def
distinct: Array[T]
Builds a new mutable indexed sequence from this mutable indexed sequence without any duplicate elements.
Builds a new mutable indexed sequence from this mutable indexed sequence without any duplicate elements.
- returns
A new mutable indexed sequence which contains the first occurrence of every element of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
-
def
drop(n: Int): Array[T]
Selects all elements except first n ones.
Selects all elements except first n ones.
- n
the number of elements to drop from this mutable indexed sequence.
- returns
a mutable indexed sequence consisting of all elements of this mutable indexed sequence except the first
n
ones, or else the empty mutable indexed sequence, if this mutable indexed sequence has less thann
elements. Ifn
is negative, don't drop any elements.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
def
dropRight(n: Int): Array[T]
Selects all elements except last n ones.
Selects all elements except last n ones.
- n
The number of elements to take
- returns
a mutable indexed sequence consisting of all elements of this mutable indexed sequence except the last
n
ones, or else the empty mutable indexed sequence, if this mutable indexed sequence has less thann
elements.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike
-
def
dropWhile(p: (T) ⇒ Boolean): Array[T]
Drops longest prefix of elements that satisfy a predicate.
Drops longest prefix of elements that satisfy a predicate.
- returns
the longest suffix of this mutable indexed sequence whose first element does not satisfy the predicate
p
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
-
def
endsWith[B](that: GenSeq[B]): Boolean
Tests whether this mutable indexed sequence ends with the given sequence.
Tests whether this mutable indexed sequence ends with the given sequence.
- that
the sequence to test
- returns
true
if this mutable indexed sequence hasthat
as a suffix,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
ensuring(cond: (Array[T]) ⇒ Boolean, msg: ⇒ Any): Array[T]
- Implicit
- This member is added by an implicit conversion from Array[T] to Ensuring[Array[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (Array[T]) ⇒ Boolean): Array[T]
- Implicit
- This member is added by an implicit conversion from Array[T] to Ensuring[Array[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): Array[T]
- Implicit
- This member is added by an implicit conversion from Array[T] to Ensuring[Array[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): Array[T]
- Implicit
- This member is added by an implicit conversion from Array[T] to Ensuring[Array[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
exists(p: (T) ⇒ Boolean): Boolean
Tests whether a predicate holds for at least one element of this mutable indexed sequence.
Tests whether a predicate holds for at least one element of this mutable indexed sequence.
- p
the predicate used to test elements.
- returns
false
if this mutable indexed sequence is empty, otherwisetrue
if the given predicatep
holds for some of the elements of this mutable indexed sequence, otherwisefalse
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
filter(p: (T) ⇒ Boolean): Array[T]
Selects all elements of this mutable indexed sequence which satisfy a predicate.
Selects all elements of this mutable indexed sequence which satisfy a predicate.
- p
the predicate used to test elements.
- returns
a new mutable indexed sequence consisting of all elements of this mutable indexed sequence that satisfy the given predicate
p
. The order of the elements is preserved.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
filterNot(p: (T) ⇒ Boolean): Array[T]
Selects all elements of this mutable indexed sequence which do not satisfy a predicate.
Selects all elements of this mutable indexed sequence which do not satisfy a predicate.
- p
the predicate used to test elements.
- returns
a new mutable indexed sequence consisting of all elements of this mutable indexed sequence that do not satisfy the given predicate
p
. The order of the elements is preserved.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
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 betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
-
def
find(p: (T) ⇒ Boolean): Option[T]
Finds the first element of the mutable indexed sequence satisfying a predicate, if any.
Finds the first element of the mutable indexed sequence satisfying a predicate, if any.
- p
the predicate used to test elements.
- returns
an option value containing the first element in the mutable indexed sequence that satisfies
p
, orNone
if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Array[B]
[use case] Builds a new collection by applying a function to all elements of this array and using the elements of the resulting collections.
[use case]Builds a new collection by applying a function to all elements of this array 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 array. 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 => 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)
- B
the element type of the returned collection.
- f
the function to apply to each element.
- returns
a new array resulting from applying the given collection-valued function
f
to each element of this array and concatenating the results.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
Full Signaturedef flatMap[B, That](f: (T) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
flatten[U](implicit asTrav: (T) ⇒ collection.Traversable[U], m: ClassTag[U]): Array[U]
Flattens a two-dimensional array by concatenating all its rows into a single array.
Flattens a two-dimensional array by concatenating all its rows into a single array.
- U
Type of row elements.
- asTrav
A function that converts elements of this array to rows - arrays of type
U
.- returns
An array obtained by concatenating rows of this array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps
-
def
fold[A1 >: A](z: A1)(op: (A1, A1) ⇒ A1): A1
Folds the elements of this mutable indexed sequence using the specified associative binary operator.
Folds the elements of this mutable indexed sequence using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
a type parameter for the binary operator, a supertype of
A
.- z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g.,
Nil
for list concatenation, 0 for addition, or 1 for multiplication).- op
a binary operator that must be associative.
- returns
the result of applying the fold operator
op
between all the elements andz
, orz
if this mutable indexed sequence is empty.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldLeft[B](z: B)(op: (B, T) ⇒ B): B
Applies a binary operator to a start value and all elements of this mutable indexed sequence, going left to right.
Applies a binary operator to a start value and all elements of this mutable indexed sequence, going left to right.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this mutable indexed sequence, going left to right with the start valuez
on the left:op(...op(z, x_1), x_2, ..., x_n)
where
x1, ..., xn
are the elements of this mutable indexed sequence. Returnsz
if this mutable indexed sequence is empty.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableOnce → GenTraversableOnce
-
def
foldRight[B](z: B)(op: (T, B) ⇒ B): B
Applies a binary operator to all elements of this mutable indexed sequence and a start value, going right to left.
Applies a binary operator to all elements of this mutable indexed sequence and a start value, going right to left.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this mutable indexed sequence, going right to left with the start valuez
on the right:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this mutable indexed sequence. Returnsz
if this mutable indexed sequence is empty.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
-
def
forall(p: (T) ⇒ Boolean): Boolean
Tests whether a predicate holds for all elements of this mutable indexed sequence.
Tests whether a predicate holds for all elements of this mutable indexed sequence.
- p
the predicate used to test elements.
- returns
true
if this mutable indexed sequence is empty or the given predicatep
holds for all elements of this mutable indexed sequence, otherwisefalse
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
def
foreach(f: (A) ⇒ Unit): Unit
[use case] Applies a function
f
to all elements of this array.[use case]Applies a function
f
to all elements of this array.Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.
- f
the function that is applied for its side-effect to every element. The result of function
f
is discarded.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
Full Signaturedef foreach[U](f: (T) ⇒ U): Unit
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
-
def
groupBy[K](f: (T) ⇒ K): Map[K, Array[T]]
Partitions this mutable indexed sequence into a map of mutable indexed sequences according to some discriminator function.
Partitions this mutable indexed sequence into a map of mutable indexed sequences according to some discriminator function.
Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new mutable indexed sequence.
- K
the type of keys returned by the discriminator function.
- f
the discriminator function.
- returns
A map from keys to mutable indexed 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 mutable indexed sequence of those elementsx
for whichf(x)
equalsk
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
grouped(size: Int): collection.Iterator[Array[T]]
Partitions elements in fixed size mutable indexed sequences.
Partitions elements in fixed size mutable indexed sequences.
- size
the number of elements per group
- returns
An iterator producing mutable indexed sequences of size
size
, except the last will be less than sizesize
if the elements don't divide evenly.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
grouped
-
def
hasDefiniteSize: Boolean
Tests whether this mutable indexed sequence is known to have a finite size.
Tests whether this mutable indexed sequence is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as
Stream
, the predicate returnstrue
if all elements have been computed. It returnsfalse
if the stream is not yet evaluated to the end. Non-empty Iterators usually returnfalse
even if they were created from a collection with a known finite size.Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that
hasDefiniteSize
returnstrue
. However, checkinghasDefiniteSize
can provide an assurance that size is well-defined and non-termination is not a concern.- returns
true
if this collection is known to have finite size,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
-
def
hashCode(): Int
The hashCode method for reference types.
-
def
head: T
Selects the first element of this mutable indexed sequence.
Selects the first element of this mutable indexed sequence.
- returns
the first element of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
- Exceptions thrown
NoSuchElementException
if the mutable indexed sequence is empty.
-
def
headOption: Option[T]
Optionally selects the first element.
Optionally selects the first element.
- returns
the first element of this mutable indexed sequence if it is nonempty,
None
if it is empty.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
indexOf(elem: T, from: Int): Int
[use case] Finds index of first occurrence of some value in this array after or at some start index.
[use case]Finds index of first occurrence of some value in this array after or at some start index.
- elem
the element value to search for.
- from
the start index
- returns
the index
>= from
of the first element of this array that is equal (as determined by==
) toelem
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
-
def
indexOf(elem: T): Int
[use case] Finds index of first occurrence of some value in this array.
[use case]Finds index of first occurrence of some value in this array.
- elem
the element value to search for.
- returns
the index of the first element of this array that is equal (as determined by
==
) toelem
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
Full Signaturedef indexOf[B >: A](elem: B): Int
-
def
indexOfSlice[B >: A](that: GenSeq[B], from: Int): Int
Finds first index after or at a start index where this mutable indexed sequence contains a given sequence as a slice.
Finds first index after or at a start index where this mutable indexed sequence contains a given sequence as a slice.
- that
the sequence to test
- from
the start index
- returns
the first index
>= from
such that the elements of this mutable indexed sequence starting at this index match the elements of sequencethat
, or-1
of no such subsequence exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
-
def
indexOfSlice[B >: A](that: GenSeq[B]): Int
Finds first index where this mutable indexed sequence contains a given sequence as a slice.
Finds first index where this mutable indexed sequence contains a given sequence as a slice.
- that
the sequence to test
- returns
the first index such that the elements of this mutable indexed sequence starting at this index match the elements of sequence
that
, or-1
of no such subsequence exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
-
def
indexWhere(p: (T) ⇒ Boolean, from: Int): Int
Finds index of the first element satisfying some predicate after or at some start index.
Finds index of the first element satisfying some predicate after or at some start index.
- p
the predicate used to test elements.
- from
the start index
- returns
the index
>= from
of the first element of this mutable indexed sequence that satisfies the predicatep
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
indexWhere(p: (T) ⇒ Boolean): Int
Finds index of first element satisfying some predicate.
Finds index of first element satisfying some predicate.
- p
the predicate used to test elements.
- returns
the index of the first element of this mutable indexed sequence that satisfies the predicate
p
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
-
def
indices: collection.immutable.Range
Produces the range of all indices of this sequence.
Produces the range of all indices of this sequence.
- returns
a
Range
value from0
to one less than the length of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
-
def
init: Array[T]
Selects all elements except the last.
Selects all elements except the last.
- returns
a mutable indexed sequence consisting of all elements of this mutable indexed sequence except the last one.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
- Exceptions thrown
UnsupportedOperationException
if the mutable indexed sequence is empty.
-
def
inits: collection.Iterator[Array[T]]
Iterates over the inits of this mutable indexed sequence.
Iterates over the inits of this mutable indexed sequence. The first value will be this mutable indexed sequence and the final one will be an empty mutable indexed sequence, with the intervening values the results of successive applications of
init
.- returns
an iterator over all the inits of this mutable indexed sequence
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Example: -
def
intersect(that: collection.Seq[T]): Array[T]
[use case] Computes the multiset intersection between this array and another sequence.
[use case]Computes the multiset intersection between this array and another sequence.
- that
the sequence of elements to intersect with.
- returns
a new array which contains all elements of this array which also appear in
that
. If an element valuex
appears n times inthat
, then the first n occurrences ofx
will be retained in the result, but any following occurrences will be omitted.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
-
def
isDefinedAt(idx: Int): Boolean
Tests whether this mutable indexed sequence contains given index.
Tests whether this mutable indexed sequence contains given index.
The implementations of methods
apply
andisDefinedAt
turn aSeq[A]
into aPartialFunction[Int, A]
.- idx
the index to test
- returns
true
if this mutable indexed sequence contains an element at positionidx
,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
-
def
isEmpty: Boolean
Tests whether this mutable indexed sequence is empty.
Tests whether this mutable indexed sequence is empty.
- returns
true
if the mutable indexed sequence contain no elements,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
-
final
def
isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is
T0
.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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
final
def
isTraversableAgain: Boolean
Tests whether this mutable indexed sequence can be repeatedly traversed.
Tests whether this mutable indexed sequence can be repeatedly traversed.
- returns
true
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike → GenTraversableOnce
-
def
iterator: collection.Iterator[T]
Creates a new iterator over all elements contained in this iterable object.
Creates a new iterator over all elements contained in this iterable object.
- returns
the new iterator
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqLike → IterableLike → GenIterableLike
-
def
last: T
Selects the last element.
Selects the last element.
- returns
The last element of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
- Exceptions thrown
NoSuchElementException
If the mutable indexed sequence is empty.
-
def
lastIndexOf(elem: T, end: Int): Int
[use case] Finds index of last occurrence of some value in this array before or at a given end index.
[use case]Finds index of last occurrence of some value in this array before or at a given end index.
- elem
the element value to search for.
- end
the end index.
- returns
the index
<= end
of the last element of this array that is equal (as determined by==
) toelem
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
-
def
lastIndexOf(elem: T): Int
[use case] Finds index of last occurrence of some value in this array.
[use case]Finds index of last occurrence of some value in this array.
- elem
the element value to search for.
- returns
the index of the last element of this array that is equal (as determined by
==
) toelem
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
Full Signaturedef lastIndexOf[B >: A](elem: B): Int
-
def
lastIndexOfSlice[B >: A](that: GenSeq[B], end: Int): Int
Finds last index before or at a given end index where this mutable indexed sequence contains a given sequence as a slice.
Finds last index before or at a given end index where this mutable indexed sequence contains a given sequence as a slice.
- that
the sequence to test
- end
the end index
- returns
the last index
<= end
such that the elements of this mutable indexed sequence starting at this index match the elements of sequencethat
, or-1
of no such subsequence exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
-
def
lastIndexOfSlice[B >: A](that: GenSeq[B]): Int
Finds last index where this mutable indexed sequence contains a given sequence as a slice.
Finds last index where this mutable indexed sequence contains a given sequence as a slice.
- that
the sequence to test
- returns
the last index such that the elements of this mutable indexed sequence starting a this index match the elements of sequence
that
, or-1
of no such subsequence exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
-
def
lastIndexWhere(p: (T) ⇒ Boolean, end: Int): Int
Finds index of last element satisfying some predicate before or at given end index.
Finds index of last element satisfying some predicate before or at given end index.
- p
the predicate used to test elements.
- returns
the index
<= end
of the last element of this mutable indexed sequence that satisfies the predicatep
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
lastIndexWhere(p: (T) ⇒ Boolean): Int
Finds index of last element satisfying some predicate.
Finds index of last element satisfying some predicate.
- p
the predicate used to test elements.
- returns
the index of the last element of this mutable indexed sequence that satisfies the predicate
p
, or-1
, if none exists.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
-
def
lastOption: Option[T]
Optionally selects the last element.
Optionally selects the last element.
- returns
the last element of this mutable indexed sequence$ if it is nonempty,
None
if it is empty.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
length: Int
The length of the array
-
def
lengthCompare(len: Int): Int
Compares the length of this mutable indexed sequence to a test value.
Compares the length of this mutable indexed sequence to a test value.
- len
the test value that gets compared with the length.
- returns
A value
x
wherex < 0 if this.length < len x == 0 if this.length == len x > 0 if this.length > len
The method as implemented here does not call
length
directly; its running time isO(length min len)
instead ofO(length)
. The method should be overwritten if computinglength
is cheap.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike
-
def
map[B](f: (A) ⇒ B): Array[B]
[use case] Builds a new collection by applying a function to all elements of this array.
[use case]Builds a new collection by applying a function to all elements of this array.
- B
the element type of the returned collection.
- f
the function to apply to each element.
- returns
a new array resulting from applying the given function
f
to each element of this array and collecting the results.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
Full Signaturedef map[B, That](f: (T) ⇒ B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
max: A
[use case] Finds the largest element.
[use case]Finds the largest element.
- returns
the largest element of this array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this array is empty.
Full Signaturedef max[B >: A](implicit cmp: Ordering[B]): T
-
def
maxBy[B](f: (A) ⇒ B): A
[use case] Finds the first element which yields the largest value measured by function f.
[use case]Finds the first element which yields the largest value measured by function f.
- B
The result type of the function f.
- f
The measuring function.
- returns
the first element of this array with the largest value measured by function f.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this array is empty.
Full Signaturedef maxBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T
-
def
min: A
[use case] Finds the smallest element.
[use case]Finds the smallest element.
- returns
the smallest element of this array
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this array is empty.
Full Signaturedef min[B >: A](implicit cmp: Ordering[B]): T
-
def
minBy[B](f: (A) ⇒ B): A
[use case] Finds the first element which yields the smallest value measured by function f.
[use case]Finds the first element which yields the smallest value measured by function f.
- B
The result type of the function f.
- f
The measuring function.
- returns
the first element of this array with the smallest value measured by function f.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this array is empty.
Full Signaturedef minBy[B](f: (T) ⇒ B)(implicit cmp: Ordering[B]): T
-
def
mkString: String
Displays all elements of this mutable indexed sequence in a string.
Displays all elements of this mutable indexed sequence in a string.
- returns
a string representation of this mutable indexed sequence. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this mutable indexed sequence follow each other without any separator string.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString(sep: String): String
Displays all elements of this mutable indexed sequence in a string using a separator string.
Displays all elements of this mutable indexed sequence in a string using a separator string.
- sep
the separator string.
- returns
a string representation of this mutable indexed sequence. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this mutable indexed sequence are separated by the stringsep
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("|") = "1|2|3"
Example: -
def
mkString(start: String, sep: String, end: String): String
Displays all elements of this mutable indexed sequence in a string using start, end, and separator strings.
Displays all elements of this mutable indexed sequence in a string using start, end, and separator strings.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
a string representation of this mutable indexed sequence. The resulting string begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this mutable indexed sequence are separated by the stringsep
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Example: -
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
-
def
nonEmpty: Boolean
Tests whether the mutable indexed sequence is not empty.
Tests whether the mutable indexed sequence is not empty.
- returns
true
if the mutable indexed sequence contains at least one element,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
-
final
def
notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
-
def
padTo(len: Int, elem: A): Array[A]
[use case] A copy of this array with an element value appended until a given target length is reached.
[use case]A copy of this array with an element value appended until a given target length is reached.
- len
the target length
- elem
the padding value
- returns
a new array consisting of all elements of this array followed by the minimal number of occurrences of
elem
so that the resulting array has a length of at leastlen
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef padTo[B >: A, That](len: Int, elem: B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
par: ParArray[T]
Returns a parallel implementation of this collection.
Returns a parallel implementation of this collection.
For most collection types, this method creates a new parallel collection by copying all the elements. For these collection,
par
takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.Specific collections (e.g.
ParArray
ormutable.ParHashMap
) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections,par
takes constant or sublinear time.All parallel collections return a reference to themselves.
- returns
a parallel implementation of this collection
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps → CustomParallelizable → Parallelizable
-
def
partition(p: (T) ⇒ Boolean): (Array[T], Array[T])
Partitions this mutable indexed sequence in two mutable indexed sequences according to a predicate.
Partitions this mutable indexed sequence in two mutable indexed sequences according to a predicate.
- p
the predicate on which to partition.
- returns
a pair of mutable indexed sequences: the first mutable indexed sequence consists of all elements that satisfy the predicate
p
and the second mutable indexed sequence consists of all elements that don't. The relative order of the elements in the resulting mutable indexed sequences is the same as in the original mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
patch(from: Int, that: GenSeq[A], replaced: Int): Array[A]
[use case] Produces a new array where a slice of elements in this array is replaced by another sequence.
[use case]Produces a new array where a slice of elements in this array is replaced by another sequence.
- from
the index of the first replaced element
- replaced
the number of elements to drop in the original array
- returns
a new array consisting of all elements of this array except that
replaced
elements starting fromfrom
are replaced bypatch
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef patch[B >: A, That](from: Int, patch: GenSeq[B], replaced: Int)(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
permutations: collection.Iterator[Array[T]]
Iterates over distinct permutations.
Iterates over distinct permutations.
- returns
An Iterator which traverses the distinct permutations of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
"abb".permutations = Iterator(abb, bab, bba)
Example: -
def
prefixLength(p: (T) ⇒ Boolean): Int
Returns the length of the longest prefix whose elements all satisfy some predicate.
Returns the length of the longest prefix whose elements all satisfy some predicate.
- p
the predicate used to test elements.
- returns
the length of the longest prefix of this mutable indexed sequence such that every element of the segment satisfies the predicate
p
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
-
def
product: A
[use case] Multiplies up the elements of this collection.
[use case]Multiplies up the elements of this collection.
- returns
the product of all elements in this array of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the array and as result type ofproduct
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
Full Signaturedef product[B >: A](implicit num: Numeric[B]): B
-
def
reduce[A1 >: A](op: (A1, A1) ⇒ A1): A1
Reduces the elements of this mutable indexed sequence using the specified associative binary operator.
Reduces the elements of this mutable indexed sequence using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
The result of applying reduce operator
op
between all the elements if the mutable indexed sequence is nonempty.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this mutable indexed sequence is empty.
-
def
reduceLeft[B >: A](op: (B, T) ⇒ B): B
Applies a binary operator to all elements of this mutable indexed sequence, going left to right.
Applies a binary operator to all elements of this mutable indexed sequence, going left to right.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this mutable indexed sequence, going left to right:op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
where
x1, ..., xn
are the elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this mutable indexed sequence is empty.
-
def
reduceLeftOption[B >: A](op: (B, T) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this mutable indexed sequence, going left to right.
Optionally applies a binary operator to all elements of this mutable indexed sequence, going left to right.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceLeft(op)
if this mutable indexed sequence is nonempty,None
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceOption[A1 >: A](op: (A1, A1) ⇒ A1): Option[A1]
Reduces the elements of this mutable indexed sequence, if any, using the specified associative binary operator.
Reduces the elements of this mutable indexed sequence, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
An option value containing result of applying reduce operator
op
between all the elements if the collection is nonempty, andNone
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceRight[B >: A](op: (T, B) ⇒ B): B
Applies a binary operator to all elements of this mutable indexed sequence, going right to left.
Applies a binary operator to all elements of this mutable indexed sequence, going right to left.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this mutable indexed sequence, going right to left:op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
where
x1, ..., xn
are the elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this mutable indexed sequence is empty.
-
def
reduceRightOption[B >: A](op: (T, B) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this mutable indexed sequence, going right to left.
Optionally applies a binary operator to all elements of this mutable indexed sequence, going right to left.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceRight(op)
if this mutable indexed sequence is nonempty,None
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
repr: Array[T]
The collection of type mutable indexed sequence underlying this
TraversableLike
object.The collection of type mutable indexed sequence underlying this
TraversableLike
object. By default this is implemented as theTraversableLike
object itself, but this can be overridden.- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
reverse: Array[T]
Returns new mutable indexed sequence with elements in reversed order.
Returns new mutable indexed sequence with elements in reversed order.
- returns
A new mutable indexed sequence with all elements of this mutable indexed sequence in reversed order.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
reverseIterator: collection.Iterator[T]
An iterator yielding elements in reversed order.
An iterator yielding elements in reversed order.
Note:
xs.reverseIterator
is the same asxs.reverse.iterator
but might be more efficient.- returns
an iterator yielding the elements of this mutable indexed sequence in reversed order
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike
-
def
reverseMap[B](f: (A) ⇒ B): Array[B]
[use case] Builds a new collection by applying a function to all elements of this array and collecting the results in reversed order.
[use case]Builds a new collection by applying a function to all elements of this array and collecting the results in reversed order.
Note:
xs.reverseMap(f)
is the same asxs.reverse.map(f)
but might be more efficient.- B
the element type of the returned collection.
- f
the function to apply to each element.
- returns
a new array resulting from applying the given function
f
to each element of this array and collecting the results in reversed order.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef reverseMap[B, That](f: (T) ⇒ B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
sameElements(that: GenIterable[A]): Boolean
[use case] Checks if the other iterable collection contains the same elements in the same order as this array.
[use case]Checks if the other iterable collection contains the same elements in the same order as this array.
- that
the collection to compare with.
- returns
true
, if both collections contain the same elements in the same order,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → GenIterableLike
Full Signaturedef sameElements[B >: A](that: GenIterable[B]): Boolean
-
def
scan[B >: A, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Array[T], B, That]): That
Computes a prefix scan of the elements of the collection.
Computes a prefix scan of the elements of the collection.
Note: The neutral element
z
may be applied more than once.- B
element type of the resulting collection
- That
type of the resulting collection
- z
neutral element for the operator
op
- op
the associative operator for the scan
- cbf
combiner factory which provides a combiner
- returns
a new mutable indexed sequence containing the prefix scan of the elements in this mutable indexed sequence
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanLeft[B, That](z: B)(op: (B, T) ⇒ B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
Produces a collection containing cumulative results of applying the operator going left to right.
Produces a collection containing cumulative results of applying the operator going left to right.
- B
the type of the elements in the resulting collection
- That
the actual type of the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
collection with intermediate results
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
scanRight[B, That](z: B)(op: (T, B) ⇒ B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
Produces a collection containing cumulative results of applying the operator going right to left.
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
Example:
List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
- B
the type of the elements in the resulting collection
- That
the actual type of the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- bf
an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.- returns
collection with intermediate results
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
- Annotations
- @migration
- Migration
(Changed in version 2.9.0) The behavior of
scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
-
def
segmentLength(p: (T) ⇒ Boolean, from: Int): Int
Computes length of longest segment whose elements all satisfy some predicate.
Computes length of longest segment whose elements all satisfy some predicate.
- p
the predicate used to test elements.
- from
the index where the search starts.
- returns
the length of the longest segment of this mutable indexed sequence starting from index
from
such that every element of the segment satisfies the predicatep
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
seq: collection.mutable.IndexedSeq[T]
A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).
A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).
This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.
- returns
a sequential view of the collection.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps → IndexedSeqLike → GenSeqLike → Parallelizable → TraversableOnce → GenTraversableOnce
-
def
size: Int
The size of this mutable indexed sequence, equivalent to
length
.The size of this mutable indexed sequence, equivalent to
length
.- returns
the number of elements in this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenTraversableLike → TraversableOnce → GenTraversableOnce
-
def
slice(from: Int, until: Int): Array[T]
Selects an interval of elements.
Selects an interval of elements. The returned collection is made up of all elements
x
which satisfy the invariant:from <= indexOf(x) < until
- returns
a mutable indexed sequence containing the elements greater than or equal to index
from
extending up to (but not including) indexuntil
of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps → IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
def
sliding(size: Int, step: Int): collection.Iterator[Array[T]]
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)
- size
the number of elements per group
- step
the distance between the first elements of successive groups
- returns
An iterator producing mutable indexed sequences of size
size
, except the last element (which may be the only element) will be truncated if there are fewer thansize
elements remaining to be grouped.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
sliding
-
def
sliding(size: Int): collection.Iterator[Array[T]]
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.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.- size
the number of elements per group
- returns
An iterator producing mutable indexed sequences of size
size
, except the last element (which may be the only element) will be truncated if there are fewer thansize
elements remaining to be grouped.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike
- See also
scala.collection.Iterator, method
sliding
-
def
sortBy[B](f: (T) ⇒ B)(implicit ord: math.Ordering[B]): Array[T]
Sorts this
Array
according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.Sorts this
Array
according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.- B
the target type of the transformation
f
, and the type where the orderingord
is defined.- f
the transformation function mapping elements to some other domain
B
.- ord
the ordering assumed on domain
B
.- returns
a mutable indexed sequence consisting of the elements of this mutable indexed sequence sorted according to the ordering where
x < y
iford.lt(f(x), f(y))
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
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)
- See also
Example: -
def
sortWith(lt: (T, T) ⇒ Boolean): Array[T]
Sorts this mutable indexed sequence according to a comparison function.
Sorts this mutable indexed sequence 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.- lt
the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
- returns
a mutable indexed sequence consisting of the elements of this mutable indexed sequence sorted according to the comparison function
lt
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) = List("Bob", "John", "Steve", "Tom")
Example: -
def
sorted[B >: A](implicit ord: math.Ordering[B]): Array[T]
Sorts this mutable indexed sequence according to an Ordering.
Sorts this mutable indexed sequence 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.- ord
the ordering to be used to compare elements.
- returns
a mutable indexed sequence consisting of the elements of this mutable indexed sequence sorted according to the ordering
ord
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike
- See also
-
def
span(p: (T) ⇒ Boolean): (Array[T], Array[T])
Splits this mutable indexed sequence into a prefix/suffix pair according to a predicate.
Splits this mutable indexed 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 predicatep
does not cause any side-effects.- returns
a pair consisting of the longest prefix of this mutable indexed sequence whose elements all satisfy
p
, and the rest of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
-
def
splitAt(n: Int): (Array[T], Array[T])
Splits this mutable indexed sequence into two at a given position.
Splits this mutable indexed sequence into two at a given position. Note:
c splitAt n
is equivalent to (but possibly more efficient than)(c take n, c drop n)
.- n
the position at which to split.
- returns
a pair of mutable indexed sequences consisting of the first
n
elements of this mutable indexed sequence, and the other elements.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
-
def
startsWith[B](that: GenSeq[B], offset: Int): Boolean
Tests whether this mutable indexed sequence contains the given sequence at a given index.
Tests whether this mutable indexed sequence contains the given sequence at a given index.
Note: If the both the receiver object
this
and the argumentthat
are infinite sequences this method may not terminate.- that
the sequence to test
- offset
the index where the sequence is searched.
- returns
true
if the sequencethat
is contained in this mutable indexed sequence at indexoffset
, otherwisefalse
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → SeqLike → GenSeqLike
-
def
startsWith[B](that: GenSeq[B]): Boolean
Tests whether this mutable indexed sequence starts with the given sequence.
Tests whether this mutable indexed sequence starts with the given sequence.
- that
the sequence to test
- returns
true
if this collection hasthat
as a prefix,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- GenSeqLike
-
def
stringPrefix: String
Defines the prefix of this object's
toString
representation.Defines the prefix of this object's
toString
representation.- returns
a string representation which starts the result of
toString
applied to this mutable indexed sequence. By default the string prefix is the simple name of the collection class mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → GenTraversableLike
-
def
sum: A
[use case] Sums up the elements of this collection.
[use case]Sums up the elements of this collection.
- returns
the sum of all elements in this array of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the array and as result type ofsum
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
Full Signaturedef sum[B >: A](implicit num: Numeric[B]): B
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tail: Array[T]
Selects all elements except the first.
Selects all elements except the first.
- returns
a mutable indexed sequence consisting of all elements of this mutable indexed sequence except the first one.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableLike → GenTraversableLike
- Exceptions thrown
java.lang.UnsupportedOperationException
if the mutable indexed sequence is empty.
-
def
tails: collection.Iterator[Array[T]]
Iterates over the tails of this mutable indexed sequence.
Iterates over the tails of this mutable indexed sequence. The first value will be this mutable indexed sequence and the final one will be an empty mutable indexed sequence, with the intervening values the results of successive applications of
tail
.- returns
an iterator over all the tails of this mutable indexed sequence
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Example: -
def
take(n: Int): Array[T]
Selects first n elements.
Selects first n elements.
- n
the number of elements to take from this mutable indexed sequence.
- returns
a mutable indexed sequence consisting only of the first
n
elements of this mutable indexed sequence, or else the whole mutable indexed sequence, if it has less thann
elements. Ifn
is negative, returns an empty mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
def
takeRight(n: Int): Array[T]
Selects last n elements.
Selects last n elements.
- n
the number of elements to take
- returns
a mutable indexed sequence consisting only of the last
n
elements of this mutable indexed sequence, or else the whole mutable indexed sequence, if it has less thann
elements.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike
-
def
takeWhile(p: (T) ⇒ Boolean): Array[T]
Takes longest prefix of elements that satisfy a predicate.
Takes longest prefix of elements that satisfy a predicate.
- returns
the longest prefix of this mutable indexed sequence whose elements all satisfy the predicate
p
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
-
def
to[Col[_]]: Col[A]
[use case] Converts this array into another by copying all elements.
[use case]Converts this array into another by copying all elements.
- Col
The collection type to build.
- returns
a new collection containing all elements of this array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
Full Signaturedef to[Col[_]](implicit cbf: CanBuildFrom[Nothing, T, Col[T]]): Col[T]
-
def
toArray: Array[A]
[use case] Converts this array to an array.
[use case]Converts this array to an array.
- returns
an array containing all elements of this array. An
ClassTag
must be available for the element type of this array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps → TraversableOnce → GenTraversableOnce
-
def
toBuffer[A1 >: A]: Buffer[A1]
Uses the contents of this mutable indexed sequence to create a new mutable buffer.
Uses the contents of this mutable indexed sequence to create a new mutable buffer.
- returns
a buffer containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqLike → TraversableOnce → GenTraversableOnce
-
def
toIndexedSeq: collection.immutable.IndexedSeq[T]
Converts this mutable indexed sequence to an indexed sequence.
Converts this mutable indexed sequence to an indexed sequence.
- returns
an indexed sequence containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toIterable: collection.Iterable[T]
Returns this mutable indexed sequence as an iterable collection.
Returns this mutable indexed sequence as an iterable collection.
A new collection will not be built; lazy collections will stay lazy.
- returns
an
Iterable
containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
-
def
toIterator: collection.Iterator[T]
Returns an Iterator over the elements in this mutable indexed sequence.
Returns an Iterator over the elements in this mutable indexed sequence. Produces the same result as
iterator
.- returns
an Iterator containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
- Annotations
- @deprecatedOverriding( message = ... , since = "2.11.0" )
-
def
toList: List[T]
Converts this mutable indexed sequence to a list.
Converts this mutable indexed sequence to a list.
- returns
a list containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → TraversableOnce → GenTraversableOnce
-
def
toMap[T, U]: Map[T, U]
[use case] Converts this array to a map.
[use case]Converts this array to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.
- returns
a map of type
immutable.Map[T, U]
containing all key/value pairs of type(T, U)
of this array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toSeq: collection.Seq[T]
Converts this mutable indexed sequence to a sequence.
Converts this mutable indexed sequence to a sequence.
A new collection will not be built; in particular, lazy sequences will stay lazy.
- returns
a sequence containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike → TraversableOnce → GenTraversableOnce
-
def
toSet[B >: A]: Set[B]
Converts this mutable indexed sequence to a set.
Converts this mutable indexed sequence to a set.
- returns
a set containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toStream: collection.immutable.Stream[T]
Converts this mutable indexed sequence to a stream.
Converts this mutable indexed sequence to a stream.
- returns
a stream containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
-
def
toString(): String
Creates a String representation of this object.
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.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
-
def
toTraversable: collection.Traversable[T]
Converts this mutable indexed sequence to an unspecified Traversable.
Converts this mutable indexed sequence to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
- returns
a Traversable containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
- Annotations
- @deprecatedOverriding( message = ... , since = "2.11.0" )
-
def
toVector: Vector[T]
Converts this mutable indexed sequence to a Vector.
Converts this mutable indexed sequence to a Vector.
- returns
a vector containing all elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
transpose[U](implicit asArray: (T) ⇒ Array[U]): Array[Array[U]]
Transposes a two dimensional array.
Transposes a two dimensional array.
- U
Type of row elements.
- asArray
A function that converts elements of this array to rows - arrays of type
U
.- returns
An array obtained by replacing elements of this arrays with rows the represent.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps
-
def
union(that: collection.Seq[T]): Array[T]
[use case] Produces a new sequence which contains all elements of this array and also all elements of a given sequence.
[use case]Produces a new sequence which contains all elements of this array and also all elements of a given sequence.
xs union ys
is equivalent toxs ++ ys
.Another way to express this is that
xs union ys
computes the order-preserving multi-set union ofxs
andys
.union
is hence a counter-part ofdiff
andintersect
which also work on multi-sets.- that
the sequence to add.
- returns
a new array which contains all elements of this array followed by all elements of
that
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef union[B >: A, That](that: GenSeq[B])(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
unzip[T1, T2](implicit asPair: (T) ⇒ (T1, T2), ct1: ClassTag[T1], ct2: ClassTag[T2]): (Array[T1], Array[T2])
Converts an array of pairs into an array of first elements and an array of second elements.
Converts an array of pairs into an array of first elements and an array of second elements.
- T1
the type of the first half of the element pairs
- T2
the type of the second half of the element pairs
- asPair
an implicit conversion which asserts that the element type of this Array is a pair.
- ct1
a class tag for T1 type parameter that is required to create an instance of Array[T1]
- ct2
a class tag for T2 type parameter that is required to create an instance of Array[T2]
- returns
a pair of Arrays, containing, respectively, the first and second half of each element pair of this Array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps
-
def
unzip3[T1, T2, T3](implicit asTriple: (T) ⇒ (T1, T2, T3), ct1: ClassTag[T1], ct2: ClassTag[T2], ct3: ClassTag[T3]): (Array[T1], Array[T2], Array[T3])
Converts an array of triples into three arrays, one containing the elements from each position of the triple.
Converts an array of triples into three arrays, one containing the elements from each position of the triple.
- T1
the type of the first of three elements in the triple
- T2
the type of the second of three elements in the triple
- T3
the type of the third of three elements in the triple
- asTriple
an implicit conversion which asserts that the element type of this Array is a triple.
- ct1
a class tag for T1 type parameter that is required to create an instance of Array[T1]
- ct2
a class tag for T2 type parameter that is required to create an instance of Array[T2]
- ct3
a class tag for T3 type parameter that is required to create an instance of Array[T3]
- returns
a triple of Arrays, containing, respectively, the first, second, and third elements from each element triple of this Array.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- ArrayOps
-
def
update(i: Int, x: T): Unit
Update the element at given index.
Update the element at given index.
Indices start at
0
;xs.update(i, x)
replaces the ith element in the array. Note the syntaxxs(i) = x
is a shorthand forxs.update(i, x)
.- i
the index
- x
the value to be written at index
i
- Exceptions thrown
ArrayIndexOutOfBoundsException
ifi < 0
orlength <= i
-
def
updated(index: Int, elem: A): Array[A]
[use case] A copy of this array with one single replaced element.
[use case]A copy of this array with one single replaced element.
- index
the position of the replacement
- elem
the replacing element
- returns
a copy of this array with the element at position
index
replaced byelem
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- SeqLike → GenSeqLike
Full Signaturedef updated[B >: A, That](index: Int, elem: B)(implicit bf: CanBuildFrom[Array[T], B, That]): That
-
def
view(from: Int, until: Int): IndexedSeqView[T, Array[T]]
A sub-sequence view starting at index
from
and extending up to (but not including) indexuntil
.A sub-sequence view starting at index
from
and extending up to (but not including) indexuntil
.- from
The index of the first element of the slice
- until
The index of the element following the slice
- returns
a non-strict view of a slice of this mutable indexed sequence, starting at index
from
and extending up to (but not including) indexuntil
.@note The difference betweenview
andslice
is thatview
produces a view of the current sequence, whereasslice
produces a new sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqLike → SeqLike → IterableLike → TraversableLike
- Note
view(from, to) is equivalent to view.slice(from, to)
-
def
view: IndexedSeqView[T, Array[T]]
Creates a view of this iterable @see Iterable.View
Creates a view of this iterable @see Iterable.View
- returns
a non-strict view of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqLike → SeqLike → IterableLike → TraversableLike
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- final def wait(arg0: Long): Unit
-
def
withFilter(p: (T) ⇒ Boolean): FilterMonadic[T, Array[T]]
Creates a non-strict filter of this mutable indexed sequence.
Creates a non-strict filter of this mutable indexed sequence.
Note: the difference between
c filter p
andc withFilter p
is that the former creates a new collection, whereas the latter only restricts the domain of subsequentmap
,flatMap
,foreach
, andwithFilter
operations.- p
the predicate used to test elements.
- returns
an object of class
WithFilter
, which supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this mutable indexed sequence which satisfy the predicatep
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableLike → FilterMonadic
-
def
zip[B](that: GenIterable[B]): Array[(A, B)]
[use case] Returns a array formed from this array and another iterable collection by combining corresponding elements in pairs.
[use case]Returns a 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.
- B
the type of the second half of the returned pairs
- that
The iterable providing the second half of each result pair
- returns
a new array containing pairs consisting of corresponding elements of this array and
that
. The length of the returned collection is the minimum of the lengths of this array andthat
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → GenIterableLike
Full Signaturedef zip[A1 >: A, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[Array[T], (A1, B), That]): That
-
def
zipAll[B](that: collection.Iterable[B], thisElem: A, thatElem: B): Array[(A, B)]
[use case] Returns a array formed from this array and another iterable collection by combining corresponding elements in pairs.
[use case]Returns a 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.
- B
the type of the second half of the returned pairs
- that
The iterable providing the second half of each result pair
- thisElem
the element to be used to fill up the result if this array is shorter than
that
.- thatElem
the element to be used to fill up the result if
that
is shorter than this array.- returns
a new array containing pairs consisting of corresponding elements of this array and
that
. The length of the returned collection is the maximum of the lengths of this array andthat
. If this array is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this array,thatElem
values are used to pad the result.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IterableLike → GenIterableLike
Full Signaturedef zipAll[B, A1 >: A, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Array[T], (A1, B), That]): That
-
def
zipWithIndex: Array[(A, Int)]
[use case] Zips this array with its indices.
[use case]Zips this array with its indices.
- returns
A new array containing pairs consisting of all elements of this array paired with their index. Indices start at
0
.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- IndexedSeqOptimized → IterableLike → GenIterableLike
List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))
Full Signaturedef zipWithIndex[A1 >: A, That](implicit bf: CanBuildFrom[Array[T], (A1, Int), That]): That
Example: -
def
→[B](y: B): (Array[T], B)
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrowAssoc[Array[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
def
apply(idx: Int): T
Selects an element by its index in the mutable indexed sequence.
Selects an element by its index in the mutable indexed sequence.
Example:
scala> val x = List(1, 2, 3, 4, 5) x: List[Int] = List(1, 2, 3, 4, 5) scala> x(3) res1: Int = 4
- idx
The index to select.
- returns
the element of this mutable indexed sequence at index
idx
, where0
indicates the first element.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(array: ArrayOps[T]).apply(idx)
- Definition Classes
- SeqLike → GenSeqLike
- Exceptions thrown
IndexOutOfBoundsException
ifidx
does not satisfy0 <= idx < length
.
-
def
equals(that: Any): Boolean
The equals method for arbitrary sequences.
The equals method for arbitrary sequences. Compares this sequence to some other object.
- that
The object to compare the sequence to
- returns
true
ifthat
is a sequence that has the same elements as this sequence in the same order,false
otherwise
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(array: ArrayOps[T]).equals(that)
- Definition Classes
- GenSeqLike → Equals → Any
-
def
hashCode(): Int
Hashcodes for
Array
produce a value from the hashcodes of all the elements of the mutable indexed sequence.Hashcodes for
Array
produce a value from the hashcodes of all the elements of the mutable indexed sequence.- returns
the hash code value for this object.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(array: ArrayOps[T]).hashCode()
- Definition Classes
- IndexedSeqLike → GenSeqLike → Any
-
def
length: Int
The length of the mutable indexed sequence.
The length of the mutable indexed sequence.
Note:
xs.length
andxs.size
yield the same result.- returns
the number of elements in this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(array: ArrayOps[T]).length
- Definition Classes
- SeqLike → GenSeqLike
- Exceptions thrown
IllegalArgumentException
if the length of the sequence cannot be represented in anInt
, for example,(-1 to Int.MaxValue).length
.
-
def
toString(): String
Converts this mutable indexed sequence to a string.
Converts this mutable indexed sequence to a string.
- returns
a string representation of this collection. By default this string consists of the
stringPrefix
of this mutable indexed sequence, followed by all elements separated by commas and enclosed in parentheses.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(array: ArrayOps[T]).toString()
- Definition Classes
- SeqLike → TraversableLike → Any
-
def
update(idx: Int, elem: T): Unit
Replaces element at given index with a new value.
Replaces element at given index with a new value.
- idx
the index of the element to replace.
- elem
the new value.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(array: ArrayOps[T]).update(idx, elem)
- Definition Classes
- IndexedSeqLike
- Exceptions thrown
IndexOutOfBoundsException
if the index is not valid.
Deprecated Value Members
-
def
/:[B](z: B)(op: (B, T) ⇒ B): B
Applies a binary operator to a start value and all elements of this mutable indexed sequence, going left to right.
Applies a binary operator to a start value and all elements of this mutable indexed sequence, going left to right.
Note:
/:
is alternate syntax forfoldLeft
;z /: xs
is the same asxs foldLeft z
.Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (5 /: a)(_+_) b: Int = 15 scala> val c = (5 /: a)((x,y) => x + y) c: Int = 15
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this mutable indexed sequence, going left to right with the start valuez
on the left:op(...op(op(z, x_1), x_2), ..., x_n)
where
x1, ..., xn
are the elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.10) Use foldLeft instead of /:
-
def
:\[B](z: B)(op: (T, B) ⇒ B): B
Applies a binary operator to all elements of this mutable indexed sequence and a start value, going right to left.
Applies a binary operator to all elements of this mutable indexed sequence and a start value, going right to left.
Note:
:\
is alternate syntax forfoldRight
;xs :\ z
is the same asxs foldRight z
.Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (a :\ 5)(_+_) b: Int = 15 scala> val c = (a :\ 5)((x,y) => x + y) c: Int = 15
- B
the result type of the binary operator.
- z
the start value
- op
the binary operator
- returns
the result of inserting
op
between consecutive elements of this mutable indexed sequence, going right to left with the start valuez
on the right:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this mutable indexed sequence.
- Implicit
- This member is added by an implicit conversion from Array[T] to ArrayOps[T] performed by method genericArrayOps in scala.Predef.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Annotations
- @deprecated
- Deprecated
(Since version 2.12.10) Use foldRight instead of :\
-
def
formatted(fmtstr: String): String
Returns string formatted according to given
format
string.Returns string formatted according to given
format
string. Format strings are as forString.format
(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from Array[T] to StringFormat[Array[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.collection.parallel.immutable
- Immutable, parallel data-structures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
- Mutable, parallel data-structures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.