Tuple(Of T1, T2) Class
Represents a 2-tuple, or pair.
Assembly: mscorlib (in mscorlib.dll)
The Tuple(Of T1, T2) type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | Equals | Returns a value that indicates whether the current Tuple(Of T1, T2) object is equal to a specified object. (Overrides Object.Equals(Object).) |
![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetHashCode | Returns the hash code for the current Tuple(Of T1, T2) object. (Overrides Object.GetHashCode.) |
![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | ToString | Returns a string that represents the value of this Tuple(Of T1, T2) instance. (Overrides Object.ToString.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IComparable.CompareTo | Compares the current Tuple(Of T1, T2) object to a specified object and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order. |
![]() ![]() | IStructuralComparable.CompareTo | Compares the current Tuple(Of T1, T2) object to a specified object by using a specified comparer, and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order. |
![]() ![]() | IStructuralEquatable.Equals | Returns a value that indicates whether the current Tuple(Of T1, T2) object is equal to a specified object based on a specified comparison method. |
![]() ![]() | IStructuralEquatable.GetHashCode | Calculates the hash code for the current Tuple(Of T1, T2) object by using a specified computation method. |
A tuple is a data structure that has a specific number and sequence of values. The Tuple(Of T1, T2) class represents a 2-tuple, or pair, which is a tuple that has two components. A 2-tuple is similar to a KeyValuePair(Of TKey, TValue) structure.
You can instantiate a Tuple(Of T1, T2) object by calling either the Tuple(Of T1, T2) constructor or the static Tuple.Create(Of T1, T2)(T1, T2) method. You can retrieve the values of the tuple's components by using the read-only Item1 and Item2 instance properties.
Tuples are commonly used in four different ways:
To represent a single set of data. For example, a tuple can represent a record in a database, and its components can represent that record's fields.
To provide easy access to, and manipulation of, a data set. The following example defines an array of Tuple(Of T1, T2) objects that contain the names of students and their corresponding test scores. It then iterates the array to calculate the mean test score.
Module Example Public Sub Main() Dim scores() As Tuple(Of String, Nullable(Of Integer)) = { New Tuple(Of String, Nullable(Of Integer))("Jack", 78), New Tuple(Of String, Nullable(Of Integer))("Abbey", 92), New Tuple(Of String, Nullable(Of Integer))("Dave", 88), New Tuple(Of String, Nullable(Of Integer))("Sam", 91), New Tuple(Of String, Nullable(Of Integer))("Ed", Nothing), New Tuple(Of String, Nullable(Of Integer))("Penelope", 82), New Tuple(Of String, Nullable(Of Integer))("Linda", 99), New Tuple(Of String, Nullable(Of Integer))("Judith", 84) } Dim number As Integer Dim mean As Double = ComputeMean(scores, number) Console.WriteLine("Average test score: {0:N2} (n={1})", mean, number) End Sub Private Function ComputeMean(scores() As Tuple(Of String, Nullable(Of Integer)), ByRef n As Integer) As Double n = 0 Dim sum As Integer For Each score In scores If score.Item2.HasValue Then n += 1 sum += score.Item2.Value End If Next If n > 0 Then Return sum / n Else Return 0 End If End Function End Module ' The example displays the following output: ' Average test score: 88 (n=7)
To return multiple values from a method without the use of out parameters (in C#) or ByRef parameters (in Visual Basic). For example, the following example uses a Tuple(Of T1, T2) object to return the quotient and the remainder that result from integer division.
Module modMain Public Sub Main() Dim dividend, divisor As Integer Dim result As Tuple(Of Integer, Integer) dividend = 136945 : divisor = 178 result = IntegerDivide(dividend, divisor) If result IsNot Nothing Then Console.WriteLine("{0} \ {1} = {2}, remainder {3}", dividend, divisor, result.Item1, result.Item2) Else Console.WriteLine("{0} \ {1} = <Error>", dividend, divisor) End If dividend = Int32.MaxValue : divisor = -2073 result = IntegerDivide(dividend, divisor) If result IsNot Nothing Then Console.WriteLine("{0} \ {1} = {2}, remainder {3}", dividend, divisor, result.Item1, result.Item2) Else Console.WriteLine("{0} \ {1} = <Error>", dividend, divisor) End If End Sub Private Function IntegerDivide(dividend As Integer, divisor As Integer) As Tuple(Of Integer, Integer) Try Dim remainder As Integer Dim quotient As Integer = Math.DivRem(dividend, divisor, remainder) Return New Tuple(Of Integer, Integer)(quotient, remainder) Catch e As DivideByZeroException Return Nothing End Try End Function End Module ' The example displays the following output: ' 136945 \ 178 = 769, remainder 63 ' 2147483647 \ -2073 = -1035930, remainder 757
To pass multiple values to a method through a single parameter. For example, the Thread.Start(Object) method has a single parameter that lets you supply one value to the method that the thread executes at startup. If you supply a Tuple(Of T1, T2) object as the method argument, you can supply the thread’s startup routine with two items of data.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.





