Packages

object Array extends java.io.Serializable

Utility methods for operating on arrays. For example:

val a = Array(1, 2)
val b = Array.ofDim[Int](2)
val c = Array.concat(a, b)

where the array objects a, b and c have respectively the values Array(1, 2), Array(0, 0) and Array(1, 2, 0, 0).

Source
Array.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Array
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class UnapplySeqWrapper[T] extends AnyVal

Value Members

  1. 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
  2. final def ##: Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (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
  4. def apply(x: Unit, xs: Unit*): Array[Unit]

    Creates an array of Unit objects

  5. def apply(x: Double, xs: Double*): Array[Double]

    Creates an array of Double objects

  6. def apply(x: Float, xs: Float*): Array[Float]

    Creates an array of Float objects

  7. def apply(x: Long, xs: Long*): Array[Long]

    Creates an array of Long objects

  8. def apply(x: Int, xs: Int*): Array[Int]

    Creates an array of Int objects

  9. def apply(x: Char, xs: Char*): Array[Char]

    Creates an array of Char objects

  10. def apply(x: Short, xs: Short*): Array[Short]

    Creates an array of Short objects

  11. def apply(x: Byte, xs: Byte*): Array[Byte]

    Creates an array of Byte objects

  12. def apply(x: Boolean, xs: Boolean*): Array[Boolean]

    Creates an array of Boolean objects

  13. def apply[T](xs: T*)(implicit arg0: ClassTag[T]): Array[T]

    Creates an array with given elements.

    Creates an array with given elements.

    xs

    the elements to put in the array

    returns

    an array containing all elements from xs.

  14. final def asInstanceOf[T0]: T0

    Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.

    Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.

    This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.

    It is platform dependent whether asInstanceOf has any effect at runtime. It might do a runtime type test on the erasure of T0, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.

    In particular, asInstanceOf is not a type test. It does **not** mean:

    this match {
     case x: T0 => x
     case _     => throw ClassCastException("...")

    Use pattern matching or isInstanceOf for type testing instead.

    Situations where asInstanceOf is useful:

    • when flow analysis fails to deduce T0 automatically
    • when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.

    Be careful of using asInstanceOf when T0 is a primitive type. When T0 is primitive, asInstanceOf may insert a conversion instead of a type test. If your intent is to convert, use a toT method (x.toChar, x.toByte, etc.).

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver is not an instance of the erasure of T0, if that can be checked on this platform

  15. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  16. def concat[T](xss: Array[T]*)(implicit arg0: ClassTag[T]): Array[T]

    Concatenates all arrays into a single array.

    Concatenates all arrays into a single array.

    xss

    the given arrays

    returns

    the array created from concatenating xss

  17. def copy(src: AnyRef, srcPos: Int, dest: AnyRef, destPos: Int, length: Int): Unit

    Copy one array to another.

    Copy one array to another. Equivalent to Java's System.arraycopy(src, srcPos, dest, destPos, length), except that this also works for polymorphic and boxed arrays.

    Note that the passed-in dest array will be modified by this call.

    src

    the source array.

    srcPos

    starting position in the source array.

    dest

    destination array.

    destPos

    starting position in the destination array.

    length

    the number of array elements to be copied.

    See also

    java.lang.System#arraycopy

  18. def copyAs[A](original: Array[_], newLength: Int)(implicit ct: ClassTag[A]): Array[A]

    Copy one array to another, truncating or padding with default values (if necessary) so the copy has the specified length.

    Copy one array to another, truncating or padding with default values (if necessary) so the copy has the specified length. The new array can have a different type than the original one as long as the values are assignment-compatible. When copying between primitive and object arrays, boxing and unboxing are supported.

    Equivalent to Java's java.util.Arrays.copyOf(original, newLength, newType), except that this works for all combinations of primitive and object arrays in a single method.

    See also

    java.util.Arrays#copyOf

  19. def copyOf[A](original: Array[A], newLength: Int): Array[A]

    Copy one array to another, truncating or padding with default values (if necessary) so the copy has the specified length.

    Copy one array to another, truncating or padding with default values (if necessary) so the copy has the specified length.

    Equivalent to Java's java.util.Arrays.copyOf(original, newLength), except that this works for primitive and object arrays in a single method.

    See also

    java.util.Arrays#copyOf

  20. def empty[T](implicit arg0: ClassTag[T]): Array[T]

    Returns an array of length 0

  21. val emptyBooleanArray: Array[Boolean]
  22. val emptyByteArray: Array[Byte]
  23. val emptyCharArray: Array[Char]
  24. val emptyDoubleArray: Array[Double]
  25. val emptyFloatArray: Array[Float]
  26. val emptyIntArray: Array[Int]
  27. val emptyLongArray: Array[Long]
  28. val emptyObjectArray: Array[AnyRef]
  29. val emptyShortArray: Array[Short]
  30. 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 of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  31. def equals(xs: Array[AnyRef], ys: Array[AnyRef]): Boolean

    Compare two arrays per element.

    Compare two arrays per element.

    A more efficient version of xs.sameElements(ys).

    Note that arrays are invariant in Scala, but it may be sound to cast an array of arbitrary reference type to Array[AnyRef]. Arrays on the JVM are covariant in their element type.

    Array.equals(xs.asInstanceOf[Array[AnyRef]], ys.asInstanceOf[Array[AnyRef]])

    xs

    an array of AnyRef

    ys

    an array of AnyRef

    returns

    true if corresponding elements are equal

  32. def equals(arg0: AnyRef): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  33. def fill[T](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: => T)(implicit arg0: ClassTag[T]): Array[Array[Array[Array[Array[T]]]]]

    Returns a five-dimensional array that contains the results of some element computation a number of times.

    Returns a five-dimensional array that contains the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3rd dimension

    n4

    the number of elements in the 4th dimension

    n5

    the number of elements in the 5th dimension

    elem

    the element computation

  34. def fill[T](n1: Int, n2: Int, n3: Int, n4: Int)(elem: => T)(implicit arg0: ClassTag[T]): Array[Array[Array[Array[T]]]]

    Returns a four-dimensional array that contains the results of some element computation a number of times.

    Returns a four-dimensional array that contains the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3rd dimension

    n4

    the number of elements in the 4th dimension

    elem

    the element computation

  35. def fill[T](n1: Int, n2: Int, n3: Int)(elem: => T)(implicit arg0: ClassTag[T]): Array[Array[Array[T]]]

    Returns a three-dimensional array that contains the results of some element computation a number of times.

    Returns a three-dimensional array that contains the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3rd dimension

    elem

    the element computation

  36. def fill[T](n1: Int, n2: Int)(elem: => T)(implicit arg0: ClassTag[T]): Array[Array[T]]

    Returns a two-dimensional array that contains the results of some element computation a number of times.

    Returns a two-dimensional array that contains the results of some element computation a number of times.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    elem

    the element computation

  37. def fill[T](n: Int)(elem: => T)(implicit arg0: ClassTag[T]): Array[T]

    Returns an array that contains the results of some element computation a number of times.

    Returns an array that contains the results of some element computation a number of times.

    Note that this means that elem is computed a total of n times:

    scala> Array.fill(3){ math.random }
    res3: Array[Double] = Array(0.365461167592537, 1.550395944913685E-4, 0.7907242137333306)
    n

    the number of elements desired

    elem

    the element computation

    returns

    an Array of size n, where each element contains the result of computing elem.

  38. 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 between finalize 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

  39. def from[A](it: IterableOnce[A])(implicit arg0: ClassTag[A]): Array[A]

    Build an array from the iterable collection.

    Build an array from the iterable collection.

    scala> val a = Array.from(Seq(1, 5))
    val a: Array[Int] = Array(1, 5)
    
    scala> val b = Array.from(Range(1, 5))
    val b: Array[Int] = Array(1, 2, 3, 4)
    it

    the iterable collection

    returns

    an array consisting of elements of the iterable collection

  40. final def getClass(): Class[_ <: AnyRef]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

    a class object corresponding to the runtime type of the receiver.

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Test whether the dynamic type of the receiver object has the same erasure as T0.

    Depending on what T0 is, the test is done in one of the below ways:

    • T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
    • T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
    • T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
    • T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
    • T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
    • T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

    This is exactly equivalent to the type pattern _: T0

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  43. def iterate[T](start: T, len: Int)(f: (T) => T)(implicit arg0: ClassTag[T]): Array[T]

    Returns an array containing repeated applications of a function to a start value.

    Returns an array containing repeated applications of a function to a start value.

    start

    the start value of the array

    len

    the number of elements returned by the array

    f

    the function that is repeatedly applied

    returns

    the array returning len values in the sequence start, f(start), f(f(start)), ...

  44. 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
  45. def newBuilder[T](implicit t: ClassTag[T]): ArrayBuilder[T]

    Returns a new scala.collection.mutable.ArrayBuilder.

  46. 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

  47. 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

  48. def ofDim[T](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(implicit arg0: ClassTag[T]): Array[Array[Array[Array[Array[T]]]]]

    Creates a 5-dimensional array

  49. def ofDim[T](n1: Int, n2: Int, n3: Int, n4: Int)(implicit arg0: ClassTag[T]): Array[Array[Array[Array[T]]]]

    Creates a 4-dimensional array

  50. def ofDim[T](n1: Int, n2: Int, n3: Int)(implicit arg0: ClassTag[T]): Array[Array[Array[T]]]

    Creates a 3-dimensional array

  51. def ofDim[T](n1: Int, n2: Int)(implicit arg0: ClassTag[T]): Array[Array[T]]

    Creates a 2-dimensional array

  52. def ofDim[T](n1: Int)(implicit arg0: ClassTag[T]): Array[T]

    Creates array with given dimensions

  53. def range(start: Int, end: Int, step: Int): Array[Int]

    Returns an array containing equally spaced values in some integer interval.

    Returns an array containing equally spaced values in some integer interval.

    start

    the start value of the array

    end

    the end value of the array, exclusive (in other words, this is the first value not returned)

    step

    the increment value of the array (may not be zero)

    returns

    the array with values in start, start + step, ... up to, but excluding end

  54. def range(start: Int, end: Int): Array[Int]

    Returns an array containing a sequence of increasing integers in a range.

    Returns an array containing a sequence of increasing integers in a range.

    start

    the start value of the array

    end

    the end value of the array, exclusive (in other words, this is the first value not returned)

    returns

    the array with values in range start, start + 1, ..., end - 1 up to, but excluding, end.

  55. final def synchronized[T0](arg0: => T0): T0

    Executes the code in body with an exclusive lock on this.

    Executes the code in body with an exclusive lock on this.

    returns

    the result of body

    Definition Classes
    AnyRef
  56. def tabulate[T](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) => T)(implicit arg0: ClassTag[T]): Array[Array[Array[Array[Array[T]]]]]

    Returns a five-dimensional array containing values of a given function over ranges of integer values starting from 0.

    Returns a five-dimensional array containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3rd dimension

    n4

    the number of elements in the 4th dimension

    n5

    the number of elements in the 5th dimension

    f

    The function computing element values

  57. def tabulate[T](n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) => T)(implicit arg0: ClassTag[T]): Array[Array[Array[Array[T]]]]

    Returns a four-dimensional array containing values of a given function over ranges of integer values starting from 0.

    Returns a four-dimensional array containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3rd dimension

    n4

    the number of elements in the 4th dimension

    f

    The function computing element values

  58. def tabulate[T](n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) => T)(implicit arg0: ClassTag[T]): Array[Array[Array[T]]]

    Returns a three-dimensional array containing values of a given function over ranges of integer values starting from 0.

    Returns a three-dimensional array containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    n3

    the number of elements in the 3rd dimension

    f

    The function computing element values

  59. def tabulate[T](n1: Int, n2: Int)(f: (Int, Int) => T)(implicit arg0: ClassTag[T]): Array[Array[T]]

    Returns a two-dimensional array containing values of a given function over ranges of integer values starting from 0.

    Returns a two-dimensional array containing values of a given function over ranges of integer values starting from 0.

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    f

    The function computing element values

  60. def tabulate[T](n: Int)(f: (Int) => T)(implicit arg0: ClassTag[T]): Array[T]

    Returns an array containing values of a given function over a range of integer values starting from 0.

    Returns an array containing values of a given function over a range of integer values starting from 0.

    n

    The number of elements in the array

    f

    The function computing element values

    returns

    An Array consisting of elements f(0),f(1), ..., f(n - 1)

  61. implicit def toFactory[A](dummy: Array.type)(implicit arg0: ClassTag[A]): Factory[A, Array[A]]

    Provides an implicit conversion from the Array object to a collection Factory

  62. 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
  63. def unapplySeq[T](x: Array[T]): UnapplySeqWrapper[T]

    Called in a pattern match like { case Array(x,y,z) => println('3 elements')}.

    Called in a pattern match like { case Array(x,y,z) => println('3 elements')}.

    x

    the selector value

    returns

    sequence wrapped in a scala.Some, if x is an Array, otherwise None

  64. final def wait(): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  65. final def wait(arg0: Long, arg1: Int): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
    Note

    not specified by SLS as a member of AnyRef

  66. final def wait(arg0: Long): Unit

    See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped