Scala Standard Library2.13.9 < Back


# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` 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 framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other 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.collection.parallel` - Parallel collections (scala-parallel-collections.jar)
  - `scala.util.parsing` - Parser combinators (scala-parser-combinators.jar)
  - `scala.swing` - A convenient wrapper around Java's GUI framework called Swing (scala-swing.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 for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package collection
  Definition Classes
    scala
-  package immutable
  Definition Classes
    collection
- ::
- AbstractMap
- AbstractSeq
- AbstractSet
- ArraySeq
- BitSet
- HashMap
- HashSet
- IndexedSeq
- IndexedSeqDefaults
- IndexedSeqOps
- IntMap
- Iterable
- LazyList
- LinearSeq
- LinearSeqOps
- List
- ListMap
- ListSet
- LongMap
- Map
- MapOps
- Nil
- NumericRange
- Queue
- Range
- Seq
- SeqMap
- SeqOps
- Set
- SetOps
- SortedMap
- SortedMapOps
- SortedSet
- SortedSetOps
- Stream
- StrictOptimizedMapOps
- StrictOptimizedSeqOps
- StrictOptimizedSetOps
- StrictOptimizedSortedMapOps
- StrictOptimizedSortedSetOps
- TreeMap
- TreeSeqMap
- TreeSet
- Vector
- VectorBuilder
- VectorMap
- WrappedString

o

scala.collection.immutable

# Vector

###
Companion class Vector

#### object Vector extends StrictOptimizedSeqFactory[Vector]

This object provides a set of operations to create `Vector` values.

Annotations
  @SerialVersionUID()
Source
  Vector.scala

Linear Supertypes
StrictOptimizedSeqFactory[Vector], SeqFactory[Vector], IterableFactory[Vector], java.io.Serializable, AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Vector
2. StrictOptimizedSeqFactory
3. SeqFactory
4. IterableFactory
5. Serializable
6. AnyRef
7. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### 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[A](elems: A*): Vector[A]

   Creates a vector with the specified elements.

   Creates a vector with the specified elements.

   A

     the type of the vector's elements

   elems

     the elements of the created vector

   returns

     a new vector with elements `elems`

   Definition Classes
     IterableFactory
5.  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 a `ClassCastException` at runtime, while the expression `List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

   returns

     the receiver object.

   Definition Classes
     Any
   Exceptions thrown

     `ClassCastException` if the receiver object is not an instance of the erasure of type `T0`.

6.  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

7.  def concat[A](xss: collection.Iterable[A]*): Vector[A]

   Concatenates all argument collections into a single vector.

   Concatenates all argument collections into a single vector.

   xss

     the collections that are to be concatenated.

   returns

     the concatenation of all the collections.

   Definition Classes
     StrictOptimizedSeqFactory → IterableFactory
8.  def empty[A]: Vector[A]

   An empty collection

   An empty collection

   A

     the type of the vector's elements

   Definition Classes
     Vector → IterableFactory
9.  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
10.  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
11.  def fill[A](n: Int)(elem: => A): Vector[A]

    Produces a vector containing the results of some element computation a number of times.

    Produces a vector containing the results of some element computation a number of times.

    n

      the number of elements contained in the vector.

    elem

      the element computation

    returns

      A vector that contains the results of `n` evaluations of `elem`.

    Definition Classes
      StrictOptimizedSeqFactory → IterableFactory
12.  def fill[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: => A): Vector[Vector[Vector[Vector[Vector[A]]]]]

    Produces a five-dimensional vector containing the results of some element computation a number of times.

    Produces a five-dimensional vector containing 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

    returns

      A vector that contains the results of `n1 x n2 x n3 x n4 x n5` evaluations of `elem`.

    Definition Classes
      IterableFactory
13.  def fill[A](n1: Int, n2: Int, n3: Int, n4: Int)(elem: => A): Vector[Vector[Vector[Vector[A]]]]

    Produces a four-dimensional vector containing the results of some element computation a number of times.

    Produces a four-dimensional vector containing 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

    returns

      A vector that contains the results of `n1 x n2 x n3 x n4` evaluations of `elem`.

    Definition Classes
      IterableFactory
14.  def fill[A](n1: Int, n2: Int, n3: Int)(elem: => A): Vector[Vector[Vector[A]]]

    Produces a three-dimensional vector containing the results of some element computation a number of times.

    Produces a three-dimensional vector containing 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

    returns

      A vector that contains the results of `n1 x n2 x n3` evaluations of `elem`.

    Definition Classes
      IterableFactory
15.  def fill[A](n1: Int, n2: Int)(elem: => A): Vector[Vector[A]]

    Produces a two-dimensional vector containing the results of some element computation a number of times.

    Produces a two-dimensional vector containing 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

    returns

      A vector that contains the results of `n1 x n2` evaluations of `elem`.

    Definition Classes
      IterableFactory
16.  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

17.  def from[E](it: IterableOnce[E]): Vector[E]

    Creates a target vector from an existing source collection

    Creates a target vector from an existing source collection

    returns

      a new vector with the elements of `source`

    Definition Classes
      Vector → IterableFactory
18.  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()
19.  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()
20.  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.

21.  implicit def iterableFactory[A]: Factory[A, Vector[A]]
    Definition Classes
      IterableFactory
22.  def iterate[A](start: A, len: Int)(f: (A) => A): Vector[A]

    Produces a vector containing repeated applications of a function to a start value.

    Produces a vector containing repeated applications of a function to a start value.

    start

      the start value of the vector

    len

      the number of elements contained in the vector

    f

      the function that's repeatedly applied

    returns

      a vector with `len` values in the sequence `start, f(start), f(f(start)), ...`

    Definition Classes
      IterableFactory
23.  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
24.  def newBuilder[A]: ReusableBuilder[A, Vector[A]]

    A

      the type of the vector’s elements

    returns

      A builder for `Vector` objects.

    Definition Classes
      Vector → IterableFactory
25.  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

26.  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

27.  def range[A](start: A, end: A, step: A)(implicit arg0: Integral[A]): Vector[A]

    Produces a vector containing equally spaced values in some integer interval.

    Produces a vector containing equally spaced values in some integer interval.

    start

      the start value of the vector

    end

      the end value of the vector (the first value NOT contained)

    step

      the difference between successive elements of the vector (must be positive or negative)

    returns

      a vector with values `start, start + step, ...` up to, but excluding `end`

    Definition Classes
      IterableFactory
28.  def range[A](start: A, end: A)(implicit arg0: Integral[A]): Vector[A]

    Produces a vector containing a sequence of increasing of integers.

    Produces a vector containing a sequence of increasing of integers.

    start

      the first element of the vector

    end

      the end value of the vector (the first value NOT contained)

    returns

      a vector with values `start, start + 1, ..., end - 1`

    Definition Classes
      IterableFactory
29.  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
30.  def tabulate[A](n: Int)(f: (Int) => A): Vector[A]

    Produces a vector containing values of a given function over a range of integer values starting from 0.

    Produces a vector containing values of a given function over a range of integer values starting from 0.

    n

      The number of elements in the vector

    f

      The function computing element values

    returns

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

    Definition Classes
      StrictOptimizedSeqFactory → IterableFactory
31.  def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) => A): Vector[Vector[Vector[Vector[Vector[A]]]]]

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

    Produces a five-dimensional vector 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

    returns

      A vector consisting of elements `f(i1, i2, i3, i4, i5)` for `0 <= i1 < n1`, `0 <= i2 < n2`, `0 <= i3 < n3`, `0 <= i4 < n4`, and `0 <= i5 < n5`.

    Definition Classes
      IterableFactory
32.  def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) => A): Vector[Vector[Vector[Vector[A]]]]

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

    Produces a four-dimensional vector 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

    returns

      A vector consisting of elements `f(i1, i2, i3, i4)` for `0 <= i1 < n1`, `0 <= i2 < n2`, `0 <= i3 < n3`, and `0 <= i4 < n4`.

    Definition Classes
      IterableFactory
33.  def tabulate[A](n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) => A): Vector[Vector[Vector[A]]]

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

    Produces a three-dimensional vector 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

    returns

      A vector consisting of elements `f(i1, i2, i3)` for `0 <= i1 < n1`, `0 <= i2 < n2`, and `0 <= i3 < n3`.

    Definition Classes
      IterableFactory
34.  def tabulate[A](n1: Int, n2: Int)(f: (Int, Int) => A): Vector[Vector[A]]

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

    Produces a two-dimensional vector 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

    returns

      A vector consisting of elements `f(i1, i2)` for `0 <= i1 < n1` and `0 <= i2 < n2`.

    Definition Classes
      IterableFactory
35.  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
36.  final def unapplySeq[A](x: Vector[A]): UnapplySeqWrapper[A]
    Definition Classes
      SeqFactory
37.  def unfold[A, S](init: S)(f: (S) => Option[(A, S)]): Vector[A]

    Produces a vector that uses a function `f` to produce elements of type `A` and update an internal state of type `S`.

    Produces a vector that uses a function `f` to produce elements of type `A` and update an internal state of type `S`.

    A

      Type of the elements

    S

      Type of the internal state

    init

      State initial value

    f

      Computes the next element (or returns `None` to signal the end of the collection)

    returns

      a vector that produces elements using `f` until `f` returns `None`

    Definition Classes
      IterableFactory
38.  final def wait(): Unit

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

    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

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

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

    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

40.  final def wait(arg0: Long): Unit

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

    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 StrictOptimizedSeqFactory[Vector]

### Inherited from SeqFactory[Vector]

### Inherited from IterableFactory[Vector]

### Inherited from java.io.Serializable

### Inherited from AnyRef

### Inherited from Any

### Ungrouped