Packages

c

scala

Tuple2

final case class Tuple2[+T1, +T2](_1: T1, _2: T2) extends Product2[T1, T2] with Product with Serializable

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

_1

Element 1 of this Tuple2

_2

Element 2 of this Tuple2

Source
Tuple2.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Tuple2
  2. Serializable
  3. Product2
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by tuple2ToZippedOps
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Tuple2(_1: T1, _2: T2)

    Create a new tuple with 2 elements.

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

    _1

    Element 1 of this Tuple2

    _2

    Element 2 of this Tuple2

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. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from (T1, T2) toany2stringadd[(T1, T2)] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): ((T1, T2), B)
    Implicit
    This member is added by an implicit conversion from (T1, T2) toArrowAssoc[(T1, T2)] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. 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
  6. val _1: T1

    A projection of element 1 of this Product.

    A projection of element 1 of this Product.

    returns

    A projection of element 1.

    Definition Classes
    Tuple2Product2
  7. val _2: T2

    A projection of element 2 of this Product.

    A projection of element 2 of this Product.

    returns

    A projection of element 2.

    Definition Classes
    Tuple2Product2
  8. 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.

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

  10. def ensuring(cond: ((T1, T2)) => Boolean, msg: => Any): (T1, T2)
    Implicit
    This member is added by an implicit conversion from (T1, T2) toEnsuring[(T1, T2)] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: ((T1, T2)) => Boolean): (T1, T2)
    Implicit
    This member is added by an implicit conversion from (T1, T2) toEnsuring[(T1, T2)] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): (T1, T2)
    Implicit
    This member is added by an implicit conversion from (T1, T2) toEnsuring[(T1, T2)] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): (T1, T2)
    Implicit
    This member is added by an implicit conversion from (T1, T2) toEnsuring[(T1, T2)] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. 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
  15. 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

  16. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit
    This member is added by an implicit conversion from (T1, T2) toStringFormat[(T1, T2)] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. 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()
  18. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.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 specified type.

    returns

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

    Definition Classes
    Any
  19. 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
  20. 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

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

  22. def productArity: Int

    The arity of this product.

    The arity of this product.

    returns

    2

    Definition Classes
    Product2Product
  23. 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.

    n

    number of the projection to be returned

    returns

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

    Definition Classes
    Product2Product
    Annotations
    @throws(clazz = classOf[IndexOutOfBoundsException])
    Exceptions thrown

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

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

    Definition Classes
    Product
  25. def swap: (T2, T1)

    Swaps the elements of this Tuple.

    Swaps the elements of this Tuple.

    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.

  26. 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
  27. 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
    Tuple2 → AnyRef → Any
  28. 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

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

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

Deprecated Value Members

  1. def invert[El1, It1[a] <: Iterable[a], El2, It2[a] <: Iterable[a], That](implicit w1: <:<[T1, It1[El1]], w2: <:<[T2, It2[El2]], bf: BuildFrom[T1, (El1, El2), That]): That
    Implicit
    This member is added by an implicit conversion from (T1, T2) toOps[T1, T2] performed by method tuple2ToZippedOps in scala.Predef.
    Definition Classes
    Ops
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use xs.lazyZip(yz).map((_, _))

  2. def zipped[El1, It1 <: Iterable[El1], El2, It2 <: Iterable[El2]](implicit w1: (T1) => IterableOps[El1, Iterable, It1] with It1, w2: (T2) => IterableOps[El2, Iterable, It2] with It2): Tuple2Zipped[El1, It1, El2, It2]
    Implicit
    This member is added by an implicit conversion from (T1, T2) toOps[T1, T2] performed by method tuple2ToZippedOps in scala.Predef.
    Definition Classes
    Ops
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use xs.lazyZip(ys)

  3. def [B](y: B): ((T1, T2), B)
    Implicit
    This member is added by an implicit conversion from (T1, T2) toArrowAssoc[(T1, T2)] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from java.io.Serializable

Inherited from Product2[T1, T2]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion tuple2ToZippedOps from(T1, T2) to Ops[T1, T2]

Inherited by implicit conversion any2stringadd from(T1, T2) to any2stringadd[(T1, T2)]

Inherited by implicit conversion StringFormat from(T1, T2) to StringFormat[(T1, T2)]

Inherited by implicit conversion Ensuring from(T1, T2) to Ensuring[(T1, T2)]

Inherited by implicit conversion ArrowAssoc from(T1, T2) to ArrowAssoc[(T1, T2)]

Ungrouped