scala

Array

object Array extends FallbackArrayBuilding

Utility methods for operating on arrays.

go to: companion
linear super types: FallbackArrayBuilding, AnyRef, Any
source: Array.scala
    version
  1. 1.0

Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Array
  2. FallbackArrayBuilding
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

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

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: Any
  8. def apply (x: Unit, xs: Unit*) : Array[Unit]

    Creates an array of Unit objects

    Creates an array of Unit objects

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

    Creates an array of Double objects

    Creates an array of Double objects

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

    Creates an array of Float objects

    Creates an array of Float objects

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

    Creates an array of Long objects

    Creates an array of Long objects

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

    Creates an array of Int objects

    Creates an array of Int objects

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

    Creates an array of Char objects

    Creates an array of Char objects

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

    Creates an array of Short objects

    Creates an array of Short objects

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

    Creates an array of Byte objects

    Creates an array of Byte objects

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

    Creates an array of Boolean objects

    Creates an array of Boolean objects

  17. def apply [T] (xs: T*)(implicit arg0: ClassManifest[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.

  18. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException 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 typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  19. implicit def canBuildFrom [T] (implicit m: ClassManifest[T]) : CanBuildFrom[Array[_], T, Array[T]]

    attributes: implicit
  20. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns 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
    definition classes: AnyRef
  21. def concat [T] (xss: Array[T]*)(implicit arg0: ClassManifest[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

  22. 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:
    1. java.lang.System#arraycopy

  23. def empty [T] (implicit arg0: ClassManifest[T]) : Array[T]

    Returns an array of length 0

    Returns an array of length 0

  24. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other 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).

    arg0

    the object to compare against this object for reference equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  25. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

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

    definition classes: AnyRef → Any
  26. implicit def fallbackCanBuildFrom [T] (implicit m: DummyImplicit) : CanBuildFrom[Array[_], T, ArraySeq[T]]

    A builder factory that generates a generic array.

    A builder factory that generates a generic array. Called instead of Array.newBuilder if the element type of an array does not have a class manifest. Note that fallbackBuilder factory needs an implicit parameter (otherwise it would not be dominated in implicit search by Array.canBuildFrom). We make sure that that implicit search is always successfull.

    attributes: implicit
    definition classes: FallbackArrayBuilding
  27. def fill [T] (n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: ⇒ T)(implicit arg0: ClassManifest[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 3nd dimension

    n4

    the number of elements in the 4th dimension

    n5

    the number of elements in the 5th dimension

    elem

    the element computation

  28. def fill [T] (n1: Int, n2: Int, n3: Int, n4: Int)(elem: ⇒ T)(implicit arg0: ClassManifest[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 3nd dimension

    n4

    the number of elements in the 4th dimension

    elem

    the element computation

  29. def fill [T] (n1: Int, n2: Int, n3: Int)(elem: ⇒ T)(implicit arg0: ClassManifest[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 3nd dimension

    elem

    the element computation

  30. def fill [T] (n1: Int, n2: Int)(elem: ⇒ T)(implicit arg0: ClassManifest[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

  31. def fill [T] (n: Int)(elem: ⇒ T)(implicit arg0: ClassManifest[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){ java.lang.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.

  32. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  33. def fromFunction [T] (f: (Int, Int, Int, Int, Int) ⇒ T)(n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(implicit arg0: ClassManifest[T]) : Array[Array[Array[Array[Array[T]]]]]

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2, 0..n3, 0..n4, 0..n5)

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2, 0..n3, 0..n4, 0..n5)

      deprecated:
    1. use Array.tabulate' instead

  34. def fromFunction [T] (f: (Int, Int, Int, Int) ⇒ T)(n1: Int, n2: Int, n3: Int, n4: Int)(implicit arg0: ClassManifest[T]) : Array[Array[Array[Array[T]]]]

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2, 0..n3, 0..n4)

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2, 0..n3, 0..n4)

      deprecated:
    1. use Array.tabulate' instead

  35. def fromFunction [T] (f: (Int, Int, Int) ⇒ T)(n1: Int, n2: Int, n3: Int)(implicit arg0: ClassManifest[T]) : Array[Array[Array[T]]]

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2, 0..n3)

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2, 0..n3)

      deprecated:
    1. use Array.tabulate' instead

  36. def fromFunction [T] (f: (Int, Int) ⇒ T)(n1: Int, n2: Int)(implicit arg0: ClassManifest[T]) : Array[Array[T]]

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2)

    Creates an array containing the values of a given function f over given range [0..n1, 0..n2)

      deprecated:
    1. use Array.tabulate' instead

  37. def fromFunction [T] (f: (Int) ⇒ T)(n: Int)(implicit arg0: ClassManifest[T]) : Array[T]

    Creates an array containing the values of a given function f over given range [0..n)

    Creates an array containing the values of a given function f over given range [0..n)

      deprecated:
    1. use Array.tabulate' instead

  38. def getClass () : java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  39. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  40. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

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

    attributes: final
    definition classes: Any
  41. def iterate [T] (start: T, len: Int)(f: (T) ⇒ T)(implicit arg0: ClassManifest[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)), ...

  42. def make [T] (n: Int, elem: T)(implicit arg0: ClassManifest[T]) : Array[T]

    Creates an array containing several copies of an element.

    Creates an array containing several copies of an element.

    n

    the length of the resulting array

    elem

    the element composing the resulting array

    returns

    an array composed of n elements all equal to elem

      deprecated:
    1. use Array.fill' instead

  43. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  44. def newBuilder [T] (implicit m: ClassManifest[T]) : ArrayBuilder[T]

    Returns a new ArrayBuilder.

    Returns a new ArrayBuilder.

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

    attributes: final
    definition classes: AnyRef
  46. 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.

    attributes: final
    definition classes: AnyRef
  47. def ofDim [T] (n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(implicit arg0: ClassManifest[T]) : Array[Array[Array[Array[Array[T]]]]]

    Creates a 5-dimensional array

    Creates a 5-dimensional array

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

    Creates a 4-dimensional array

    Creates a 4-dimensional array

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

    Creates a 3-dimensional array

    Creates a 3-dimensional array

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

    Creates a 2-dimensional array

    Creates a 2-dimensional array

  51. def ofDim [T] (n1: Int)(implicit arg0: ClassManifest[T]) : Array[T]

    Creates array with given dimensions

    Creates array with given dimensions

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

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

    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.

  54. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  55. def tabulate [T] (n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) ⇒ T)(implicit arg0: ClassManifest[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 3nd 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

  56. def tabulate [T] (n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) ⇒ T)(implicit arg0: ClassManifest[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 3nd dimension

    n4

    the number of elements in the 4th dimension

    f

    The function computing element values

  57. def tabulate [T] (n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) ⇒ T)(implicit arg0: ClassManifest[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 3nd dimension

    f

    The function computing element values

  58. def tabulate [T] (n1: Int, n2: Int)(f: (Int, Int) ⇒ T)(implicit arg0: ClassManifest[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

  59. def tabulate [T] (n: Int)(f: (Int) ⇒ T)(implicit arg0: ClassManifest[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

    A traversable consisting of elements f(0),f(1), ..., f(n - 1)

  60. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  61. def unapplySeq [T] (x: Array[T]) : Option[IndexedSeq[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 Some, if x is a Seq, otherwise None

  62. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  63. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  64. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from FallbackArrayBuilding

Inherited from AnyRef

Inherited from Any