scala

Tuple2

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

_1

Element 1 of this Tuple2

_2

Element 2 of this Tuple2

Source
Tuple2.scala
Linear Supertypes
Serializable, Serializable, Product2[T1, T2], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Tuple2
  2. Serializable
  3. Serializable
  4. Product2
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

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

Type Members

  1. class Zipped [+Repr1, +El1, +Repr2, +El2] extends AnyRef

Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Equivalent to x.hashCode except for boxed numeric types.

    Equivalent to x.hashCode except for boxed numeric types. 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.

    returns

    a hash value consistent with ==

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality.

    returns

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

    Attributes
    final
    Definition Classes
    Any
  6. val _1 : T1

    Element 1 of this Tuple2

    Element 1 of this Tuple2

    Definition Classes
    Tuple2Product2
  7. val _2 : T2

    Element 2 of this Tuple2

    Element 2 of this Tuple2

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

    Attributes
    final
    Definition Classes
    Any
  9. def canEqual (arg0: Any): Boolean

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

    returns

    true if this instance can possibly equal that, otherwise false

    Definition Classes
    Tuple2Equals
  10. 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()
  11. def eq (arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) 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.

    Attributes
    final
    Definition Classes
    AnyRef
  12. def equals (arg0: Any): Boolean

    The universal equality method defined in AnyRef.

    The universal equality method defined in AnyRef.

    returns

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

    Definition Classes
    Tuple2Equals → AnyRef → Any
  13. 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()
  14. def getClass (): java.lang.Class[_ <: java.lang.Object]

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

    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
  15. def hashCode (): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

    the hash code value for this object.

    Definition Classes
    Tuple2 → AnyRef → Any
  16. 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.

    Attributes
    final
    Definition Classes
    Any
  17. 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.

    Attributes
    final
    Definition Classes
    AnyRef
  18. 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
  19. 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
  20. def productArity : Int

    The arity of this product.

    The arity of this product.

    returns

    2

    Definition Classes
    Product2Product
  21. 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(1) is the same as ._1.

    Definition Classes
    Product2Product
    Annotations
    @throws( clazz = classOf[IndexOutOfBoundsException] )
  22. 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]

    Definition Classes
    Product
  23. def productPrefix : String

    A string used in the toString methods of derived classes.

    A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

    returns

    in the default implementation, the empty string

    Definition Classes
    Tuple2Product
  24. 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.

  25. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  26. 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
  27. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  28. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  29. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. def zipped [Repr1, El1, Repr2, El2] (implicit w1: (T1) ⇒ TraversableLike[El1, Repr1], w2: (T2) ⇒ IterableLike[El2, Repr2]): Zipped[Repr1, El1, Repr2, El2]

    Wraps a tuple in a Zipped, which supports 2-ary generalisations of map, flatMap, filter, etc.

    Wraps a tuple in a Zipped, which supports 2-ary generalisations of map, flatMap, filter, etc. Note that there must be an implicit value to convert this tuple's types into a TraversableLike or IterableLike.

    scala> val tuple = (List(1,2,3),List('a','b','c'))
    tuple: (List[Int], List[Char]) = (List(1, 2, 3),List(a, b, c))
    
    scala> tuple.zipped map { (x,y) => x + ":" + y }
    res6: List[java.lang.String] = List(1:a, 2:b, 3:c)
    
    See also

    Zipped Note: will not terminate for infinite-sized collections.

  31. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

  32. def zip [Repr1, El1, El2, To] (implicit w1: (T1) ⇒ TraversableLike[El1, Repr1], w2: (T2) ⇒ Iterable[El2], cbf1: CanBuildFrom[Repr1, (El1, El2), To]): To

    Annotations
    @deprecated
    Deprecated

    Use zipped instead.

Inherited from Serializable

Inherited from Serializable

Inherited from Product2[T1, T2]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any