Article
11/18/2011

Tuple<T1, T2, T3, T4, T5> Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a 5-tuple, or quintuple.

Inheritance Hierarchy

System.Object
System.Tuple<T1, T2, T3, T4, T5>

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Class Tuple(Of T1, T2, T3, T4, T5) _
    Implements IStructuralEquatable, IStructuralComparable, IComparable

public class Tuple<T1, T2, T3, T4, T5> : IStructuralEquatable, 
    IStructuralComparable, IComparable

Type Parameters

T1
The type of the tuple's first component.

T2
The type of the tuple's second component.

T3
The type of the tuple's third component.

T4
The type of the tuple's fourth component.

T5
The type of the tuple's fifth component.

The Tuple<T1, T2, T3, T4, T5> type exposes the following members.

Constructors

	Name	Description
	Tuple<T1, T2, T3, T4, T5>	Initializes a new instance of the Tuple<T1, T2, T3, T4, T5> class.

Top

Properties

	Name	Description
	Item1	Gets the value of the current Tuple<T1, T2, T3, T4, T5> object's first component.
	Item2	Gets the value of the current Tuple<T1, T2, T3, T4, T5> object's second component.
	Item3	Gets the value of the current Tuple<T1, T2, T3, T4, T5> object's third component.
	Item4	Gets the value of the current Tuple<T1, T2, T3, T4, T5> object's fourth component.
	Item5	Gets the value of the current Tuple<T1, T2, T3, T4, T5> object's fifth component.

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether the current Tuple<T1, T2, T3, T4, T5> 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 the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for the current Tuple<T1, T2, T3, T4, T5> 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<T1, T2, T3, T4, T5> instance. (Overrides Object.ToString().)

Top

Explicit Interface Implementations

	Name	Description
	IComparable.CompareTo	Compares the current Tuple<T1, T2, T3, T4, T5> 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<T1, T2, T3, T4, T5> 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<T1, T2, T3, T4, T5> object is equal to a specified object based on a specified comparison method.
	IStructuralEquatable.GetHashCode	Calculates the hash code for the current Tuple<T1, T2, T3, T4, T5> object by using a specified computation method.

Top

Remarks

A tuple is a data structure that has a specific number and sequence of values. The Tuple<T1, T2, T3, T4, T5> class represents a 5-tuple, or quintuple, which is a tuple that has five components.

You can instantiate a Tuple<T1, T2, T3, T4, T5> object by calling either the Tuple<T1, T2, T3, T4, T5> constructor or the static Tuple.Create<T1, T2, T3, T4, T5>(T1, T2, T3, T4, T5) method. You can retrieve the value of the tuple's components by using the read-only Item1, Item2, Item3, Item4, and Item5 instance properties.

Tuples are commonly used in four different ways:

To represent a single set of data. For example, a tuple can represent a database record, and its components can represent individual fields of the record.

To provide easy access to, and manipulation of, a data set. The following example defines an array of Tuple<T1, T2, T3, T4, T5> objects that contain the names of running backs in American football, the number of games in which they played, and the number of carries, total yards gained, and touchdowns scored during those games. The array is passed to the ComputeStatistics method, which calculates each running back's number of carries per game, average yards per game, average yards per carry, and average number of touchdowns per attempt.

Imports System.Collections.Generic

Module Example
   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Organization of runningBacks 5-tuple:
      '    Component 1: Player name
      '    Component 2: Number of games played
      '    Component 3: Number of attempts (carries)
      '    Component 4: Number of yards gained 
      '    Component 5: Number of touchdowns   
      Dim runningBacks() As Tuple(Of String, Integer, Integer, Integer, Integer) = _
          { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110), _  
            Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99), _         
            Tuple.Create("Brown, Jim", 118, 2359, 12312, 106), _           
            Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90), _            
            Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) } 
      ' Calculate statistics.
      ' Organization of runningStats 5-tuple:
      '    Component 1: Player name
      '    Component 2: Number of attempts per game
      '    Component 3: Number of yards per game
      '    Component 4: Number of yards per attempt 
      '    Component 5: Number of touchdowns per attempt   
      Dim runningStats() = ComputeStatistics(runningBacks)

      ' Display the result.          
      outputBlock.Text += String.Format("{0,-16} {1,5} {2,6} {3,7} {4,7} {5,7} {6,7} {7,5} {8,7}", _
                        "Name", "Games", "Att", "Att/Gm", "Yards", "Yds/Gm", _
                        "Yds/Att", "TD", "TD/Att") + vbCrLf
      outputBlock.Text &= vbCrLf
      For ctr As Integer = 0 To runningBacks.Length - 1
         outputBlock.Text += String.Format("{0,-16} {1,5} {2,6:N0} {3,7:N1} {4,7:N0} {5,7:N1} {6,7:N2} {7,5} {8,7:N3}", _
                           runningBacks(ctr).Item1, runningBacks(ctr).Item2, runningBacks(ctr).Item3, _
                           runningStats(ctr).Item2, runningBacks(ctr).Item4, runningStats(ctr).Item3, _
                           runningStats(ctr).Item4, runningBacks(ctr).Item5, runningStats(ctr).Item5) + vbCrLf
         outputBlock.Text &= vbCrLf
      Next
   End Sub

   Private Function ComputeStatistics(ByVal players() As Tuple(Of String, Integer, Integer, Integer, Integer)) _
                    As Tuple(Of String, Double, Double, Double, Double)()

      Dim result As Tuple(Of String, Double, Double, Double, Double)
      Dim list As New List(Of Tuple(Of String, Double, Double, Double, Double))()

      For Each player In players
         ' Create result object containing player name and statistics.
         result = Tuple.Create(player.Item1, _ 
                            player.Item3/player.Item2, player.Item4/player.Item2, _
                            player.Item4/player.Item3, player.Item5/player.Item3)
         list.Add(result)
      Next
      Return list.ToArray()
   End Function
End Module
' The example displays the following output:
'    Name             Games    Att  Att/Gm   Yards  Yds/Gm Yds/Att    TD  TD/Att
'    
'    Payton, Walter     190  3,838    20.2  16,726    88.0    4.36   110   0.029
'    
'    Sanders, Barry     153  3,062    20.0  15,269    99.8    4.99    99   0.032
'    
'    Brown, Jim         118  2,359    20.0  12,312   104.3    5.22   106   0.045
'    
'    Dickerson, Eric    144  2,996    20.8  13,259    92.1    4.43    90   0.030
'    
'    Faulk, Marshall    176  2,836    16.1  12,279    69.8    4.33   100   0.035

using System;
using System.Collections.Generic;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // Organization of runningBacks 5-tuple:
      //    Component 1: Player name
      //    Component 2: Number of games played
      //    Component 3: Number of attempts (carries)
      //    Component 4: Number of yards gained 
      //    Component 5: Number of touchdowns   
      Tuple<string, int, int, int, int>[] runningBacks =
           { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
             Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
             Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
             Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
             Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) };
      // Calculate statistics.
      // Organization of runningStats 5-tuple:
      //    Component 1: Player name
      //    Component 2: Number of attempts per game
      //    Component 3: Number of yards per game
      //    Component 4: Number of yards per attempt 
      //    Component 5: Number of touchdowns per attempt   
      Tuple<string, double, double, double, double>[] runningStats =
          ComputeStatistics(runningBacks);

      // Display the result.          
      outputBlock.Text += String.Format("{0,-16} {1,5} {2,6} {3,7} {4,7} {5,7} {6,7} {7,5} {8,7}\n",
                        "Name", "Games", "Att", "Att/Gm", "Yards", "Yds/Gm",
                        "Yds/Att", "TD", "TD/Att") + "\n";
      for (int ctr = 0; ctr < runningBacks.Length; ctr++)
         outputBlock.Text += String.Format("{0,-16} {1,5} {2,6:N0} {3,7:N1} {4,7:N0} {5,7:N1} {6,7:N2} {7,5} {8,7:N3}\n",
                           runningBacks[ctr].Item1, runningBacks[ctr].Item2, runningBacks[ctr].Item3,
                           runningStats[ctr].Item2, runningBacks[ctr].Item4, runningStats[ctr].Item3,
                           runningStats[ctr].Item4, runningBacks[ctr].Item5, runningStats[ctr].Item5) + "\n";
   }

   private static Tuple<string, double, double, double, double>[] ComputeStatistics(
                Tuple<string, int, int, int, int>[] players)
   {
      Tuple<string, double, double, double, double> result;
      var list = new List<Tuple<string, double, double, double, double>>();

      foreach (var player in players)
      {
         // Create result object containing player name and statistics.
         result = Tuple.Create(player.Item1,
                               player.Item3 / ((double)player.Item2),
                               player.Item4 / ((double)player.Item2),
                               player.Item4 / ((double)player.Item3),
                               player.Item5 / ((double)player.Item3));
         list.Add(result);
      }
      return list.ToArray();
   }
}
// The example displays the following output:
//    Name             Games    Att  Att/Gm   Yards  Yds/Gm Yds/Att    TD  TD/Att
//    
//    Payton, Walter     190  3,838    20.2  16,726    88.0    4.36   110   0.029
//    
//    Sanders, Barry     153  3,062    20.0  15,269    99.8    4.99    99   0.032
//    
//    Brown, Jim         118  2,359    20.0  12,312   104.3    5.22   106   0.045
//    
//    Dickerson, Eric    144  2,996    20.8  13,259    92.1    4.43    90   0.030
//    
//    Faulk, Marshall    176  2,836    16.1  12,279    69.8    4.33   100   0.035

To return multiple values from a method without the use of out parameters (in C#) or ByRef parameters (in Visual Basic). For example, the previous example returns its computed statistics, along with the name of the player, in an array of Tuple<T1, T2, T3, T4, T5> objects.
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<T1, T2, T3, T4, T5> object as the method argument, you can supply the thread’s startup routine with five items of data.

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.