Scala 3/API/scala/Tuple3

Tuple3

final case class Tuple3[+T1, +T2, +T3](_1: T1, _2: T2, _3: T3) extends Product3[T1, T2, T3]

A tuple of 3 elements; the canonical representation of a scala.Product3.

A tuple of 3 elements; the canonical representation of a scala.Product3.

Value Params
_1

Element 1 of this Tuple3

_2

Element 2 of this Tuple3

_3

Element 3 of this Tuple3

Constructor

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

trait Tuple
trait Product3[T1, T2, T3]
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

override def toString(): String
Definition Classes
Any

Inherited methods

inline def *:[H, This >: (T1, T2, T3) <: Tuple](x: H): H *: This

Return a new tuple by prepending the element to this tuple.

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

Inherited from
Tuple
inline def ++[This >: (T1, T2, T3) <: Tuple](that: Tuple): Concat[This, that]

Return a new tuple by concatenating this tuple with that tuple.

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

Inherited from
Tuple
inline def apply[This >: (T1, T2, T3) <: NonEmptyTuple](n: Int): Elem[This, n]

Get the i-th element of this tuple.

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

Inherited from
NonEmptyTuple
inline def drop[This >: (T1, T2, T3) <: Tuple](n: Int): Drop[This, n]

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.

Inherited from
Tuple
inline def head[This >: (T1, T2, T3) <: NonEmptyTuple]: Head[This]

Get the head of this tuple

Get the head of this tuple

Inherited from
NonEmptyTuple
inline def map[F[_]](f: [t] => (x$1: t) => F[t]): Map[(T1, T2, T3), F]

Called on a tuple (a1, ..., an), returns a new tuple (f(a1), ..., f(an)).

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.

Inherited from
Tuple
override def productArity: Int

The arity of this product.

The arity of this product.

Returns

3

Definition Classes
Inherited from
Product3
@throws(scala.Predef.classOf[scala.IndexOutOfBoundsException])
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 Params
n

number of the projection to be returned

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 >= 3).

Definition Classes
Inherited from
Product3
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.

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.

Returns

in the default implementation, an Iterator[Any]

Inherited from
Product
inline def size[This >: (T1, T2, T3) <: Tuple]: Size[This]

Return the size (or arity) of the tuple

Return the size (or arity) of the tuple

Inherited from
Tuple
inline def splitAt[This >: (T1, T2, T3) <: Tuple](n: Int): (This, n)

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.

Inherited from
Tuple
inline def tail[This >: (T1, T2, T3) <: NonEmptyTuple]: Tail[This]

Get the tail of this tuple.

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

Inherited from
NonEmptyTuple
inline def take[This >: (T1, T2, T3) <: Tuple](n: Int): Take[This, n]

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.

Inherited from
Tuple
inline def toArray: Array[Object]

Create a copy this tuple as an Array

Create a copy this tuple as an Array

Inherited from
Tuple
inline def toIArray: IArray[Object]

Create a copy this tuple as an IArray

Create a copy this tuple as an IArray

Inherited from
Tuple
inline def toList: List[Union[(T1, T2, T3)]]

Create a copy this tuple as a List

Create a copy this tuple as a List

Inherited from
Tuple
inline def zip[This >: (T1, T2, T3) <: Tuple, T2 <: Tuple](t2: T2): Zip[This, T2]

Given two tuples, (a1, ..., an) and (a1, ..., an), returns a tuple ((a1, b1), ..., (an, bn)).

Given two tuples, (a1, ..., an) and (a1, ..., an), 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

Inherited from
Tuple