scala-library-sjs
DocsAPI
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL
scala-library-sjs/scala/Tuple2

Tuple2

scala.Tuple2
final case class Tuple2[+T1, +T2](_1: T1, _2: T2) extends Product2[T1, T2]

A tuple of 2 elements; the canonical representation of a scala.Product2.

Value parameters

_1

Element 1 of this Tuple2

_2

Element 2 of this Tuple2

Attributes

Constructor

Create a new tuple with 2 elements. Note that it is more idiomatic to create a Tuple2 via (t1, t2)

Graph
Supertypes
trait Serializable
trait Product2[T1, T2]
class T1 *: T2 *: EmptyTuple.type
trait Tuple
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def swap: (T2, T1)

Swaps the elements of this Tuple.

Swaps the elements of this Tuple.

Attributes

Returns

a new Tuple where the first element is the second element of this Tuple and the second element is the first element of this Tuple.

override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Inherited methods

inline def *:[H, This >: this.type <: Tuple](x: H): H *: This

Return a new tuple by prepending the element to this tuple. This operation is O(this.size)

Return a new tuple by prepending the element to this tuple. This operation is O(this.size)

Attributes

Inherited from:
Tuple
inline def ++[This >: this.type <: Tuple](that: Tuple): Concat[This, that.type]

Return a new tuple by concatenating this tuple with that tuple. This operation is O(this.size + that.size)

Return a new tuple by concatenating this tuple with that tuple. This operation is O(this.size + that.size)

Attributes

Inherited from:
Tuple
inline def :*[This >: this.type <: Tuple, L](x: L): Append[This, L]

Return a copy of this tuple with an element appended

Return a copy of this tuple with an element appended

Attributes

Inherited from:
Tuple
inline def apply[This >: this.type <: Tuple](n: Int): Elem[This, n.type]

Get the i-th element of this tuple. Equivalent to productElement but with a precise return type.

Get the i-th element of this tuple. Equivalent to productElement but with a precise return type.

Attributes

Inherited from:
Tuple
inline def drop[This >: this.type <: Tuple](n: Int): Drop[This, n.type]

Given a tuple (a1, ..., am), returns the tuple (an+1, ..., am) consisting all its elements except the first n ones.

Given a tuple (a1, ..., am), returns the tuple (an+1, ..., am) consisting all its elements except the first n ones.

Attributes

Inherited from:
Tuple
inline def head[This >: this.type <: Tuple]: Head[This]

Get the head of this tuple

Get the head of this tuple

Attributes

Inherited from:
Tuple
inline def init[This >: this.type <: Tuple]: Init[This]

Get the initial part of the tuple without its last element

Get the initial part of the tuple without its last element

Attributes

Inherited from:
Tuple
inline def last[This >: this.type <: Tuple]: Last[This]

Get the last of this tuple

Get the last of this tuple

Attributes

Inherited from:
Tuple
inline def map[F[_]](f: [t] => t => F[t]): Map[this.type, F]

Called on a tuple (a1, ..., an), returns a new tuple (f(a1), ..., f(an)). The result is typed as (F[A1], ..., F[An]) if the tuple type is fully known. If the tuple is of the form a1 *: ... *: Tuple (that is, the tail is not known to be the cons type.

Called on a tuple (a1, ..., an), returns a new tuple (f(a1), ..., f(an)). The result is typed as (F[A1], ..., F[An]) if the tuple type is fully known. If the tuple is of the form a1 *: ... *: Tuple (that is, the tail is not known to be the cons type.

Attributes

Inherited from:
Tuple
override def productArity: Int

The arity of this product.

The arity of this product.

Attributes

Returns

2

Definition Classes
Inherited from:
Product2
override def productElement(n: Int): Any

Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.

Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.

Value parameters

n

number of the projection to be returned

Attributes

Returns

same as ._(n+1), for example productElement(0) is the same as ._1.

Throws
IndexOutOfBoundsException

if the n is out of range(n < 0 || n >= 2).

Definition Classes
Inherited from:
Product2
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
inline def reverse[This >: this.type <: Tuple]: Reverse[This]

Given a tuple (a1, ..., am), returns the reversed tuple (am, ..., a1) consisting all its elements.

Given a tuple (a1, ..., am), returns the reversed tuple (am, ..., a1) consisting all its elements.

Attributes

Inherited from:
Tuple
inline def size[This >: this.type <: Tuple]: Size[This]

Return the size (or arity) of the tuple

Return the size (or arity) of the tuple

Attributes

Inherited from:
Tuple
inline def splitAt[This >: this.type <: Tuple](n: Int): Split[This, n.type]

Given a tuple (a1, ..., am), returns a pair of the tuple (a1, ..., an) consisting of the first n elements, and the tuple (an+1, ..., am) consisting of the remaining elements.

Given a tuple (a1, ..., am), returns a pair of the tuple (a1, ..., an) consisting of the first n elements, and the tuple (an+1, ..., am) consisting of the remaining elements.

Attributes

Inherited from:
Tuple
inline def tail[This >: this.type <: Tuple]: Tail[This]

Get the tail of this tuple. This operation is O(this.size)

Get the tail of this tuple. This operation is O(this.size)

Attributes

Inherited from:
Tuple
inline def take[This >: this.type <: Tuple](n: Int): Take[This, n.type]

Given a tuple (a1, ..., am), returns the tuple (a1, ..., an) consisting of its first n elements.

Given a tuple (a1, ..., am), returns the tuple (a1, ..., an) consisting of its first n elements.

Attributes

Inherited from:
Tuple
inline def toArray: Array[Object]

Create a copy of this tuple as an Array

Create a copy of this tuple as an Array

Attributes

Inherited from:
Tuple
inline def toIArray: IArray[Object]

Create a copy of this tuple as an IArray

Create a copy of this tuple as an IArray

Attributes

Inherited from:
Tuple
inline def toList: List[Union[this.type]]

Create a copy of this tuple as a List

Create a copy of this tuple as a List

Attributes

Inherited from:
Tuple
inline def zip[This >: this.type <: Tuple, T2 <: Tuple](t2: T2): Zip[This, T2]

Given two tuples, (a1, ..., an) and (b1, ..., bn), returns a tuple ((a1, b1), ..., (an, bn)). If the two tuples have different sizes, the extra elements of the larger tuple will be disregarded. The result is typed as ((A1, B1), ..., (An, Bn)) if at least one of the tuple types has a EmptyTuple tail. Otherwise the result type is (A1, B1) *: ... *: (Ai, Bi) *: Tuple

Given two tuples, (a1, ..., an) and (b1, ..., bn), returns a tuple ((a1, b1), ..., (an, bn)). If the two tuples have different sizes, the extra elements of the larger tuple will be disregarded. The result is typed as ((A1, B1), ..., (An, Bn)) if at least one of the tuple types has a EmptyTuple tail. Otherwise the result type is (A1, B1) *: ... *: (Ai, Bi) *: Tuple

Attributes

Inherited from:
Tuple
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL