Tuple<T1, T2, T3, T4> Class

Inheritance Hierarchy

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

Syntax

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

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

Constructors

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

Top

Properties

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

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether the current Tuple<T1, T2, T3, T4> 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> 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> instance. (Overrides Object.ToString().)

Top

Explicit Interface Implementations

	Name	Description
	IComparable.CompareTo	Compares the current Tuple<T1, T2, T3, T4> 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> 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> 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> 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> class represents a 4-tuple, or quadruple, which is a tuple that has four components.

You can instantiate a Tuple<T1, T2, T3, T4> object by calling either the Tuple<T1, T2, T3, T4> constructor or the static Tuple.Create<T1, T2, T3, T4>(T1, T2, T3, T4) method. You can retrieve the value of the tuple's components by using the read-only Item1, Item2, Item3, and Item4 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> objects that contain the names of baseball pitchers, the number of innings they pitched, and the number of earned runs (runs that scored without fielding errors), and hits that they gave up. The array is passed to the ComputeStatistics method, which calculates each pitcher's earned run average (the average number of runs given up in a nine-inning game), and the average number of hits given up per inning. The method also uses these two averages to compute a hypothetical effectiveness average.

  Imports System.Collections.Generic
  
  Module Example
     Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
        outputBlock.FontFamily = new System.Windows.Media.FontFamily("Courier New")
  
        Dim pitchers() As Tuple(Of String, Decimal, Integer, Integer) = _ 
                 { Tuple.Create("McHale, Joe", 240.1d, 221, 96), _
                   Tuple.Create("Paul, Dave", 233.1d, 231, 84), _
                   Tuple.Create("Williams, Mike", 193.2d, 183, 86), _
                   Tuple.Create("Blair, Jack", 168.1d, 146, 65), _
                   Tuple.Create("Henry, Walt", 140.1d, 96, 30), _
                   Tuple.Create("Lee, Adam", 137.2d, 109, 45), _
                   Tuple.Create("Rohr, Don", 101.0d, 110, 42) }
  
        Dim results() = ComputeStatistics(pitchers)
  
        ' Display the results.
        outputBlock.Text &= String.Format("{0,-20} {1,9} {2,11} {3,15}", "Pitcher", "ERA", "Hits/Inn.", "Effectiveness") & vbCrLf
        outputBlock.Text &= vbCrLf
        For Each result In results
           outputBlock.Text += String.Format("{0,-20} {1,9:F2} {2,11:F2} {3,15:F2}", _
                          result.Item1, result.Item2, result.Item3, result.Item4) + vbCrLf
        Next
     End Sub
  
     Private Function ComputeStatistics(ByVal pitchers() As Tuple(Of String, Decimal, Integer, Integer)) _
                                  As Tuple(Of String, Double, Double, Double)()
  
        Dim list As New List(Of Tuple(Of String, Double, Double, Double))
        Dim result As Tuple(Of String, Double, Double, Double)
  
        For Each pitcher As Tuple(Of String, Decimal, Integer, Integer) In pitchers
           ' Decimal portion of innings pitched represents 1/3 of an inning
           Dim innings As Double = Math.Floor(CDbl(pitcher.Item2))
           innings = innings + ((pitcher.Item2 - innings) * 0.33)
  
           Dim ERA As Double = pitcher.Item4 / innings * 9
           Dim hitsPerInning As Double = pitcher.Item3 / innings
           Dim EI As Double = (ERA * 2 + hitsPerInning * 9) / 3
           result = New Tuple(Of String, Double, Double, Double) _
                             (pitcher.Item1, ERA, hitsPerInning, EI)
           list.Add(result)
        Next
        Return list.ToArray()
     End Function
  End Module
  ' The example displays the following output:
  '       Pitcher                    ERA   Hits/Inn.   Effectiveness
  '       
  '       McHale, Joe               3.60        0.92            5.16
  '       Paul, Dave                3.24        0.99            5.14
  '       Williams, Mike            4.01        0.95            5.52
  '       Blair, Jack               3.48        0.87            4.93
  '       Henry, Walt               1.93        0.69            3.34
  '       Lee, Adam                 2.95        0.80            4.36
  '       Rohr, Don                 3.74        1.09            5.76
  

  using System;
  using System.Collections.Generic;
  
  public class Example
  {
     public static void Demo(System.Windows.Controls.TextBlock outputBlock)
     {
        outputBlock.FontFamily = new System.Windows.Media.FontFamily("Courier New");
  
        Tuple<string, decimal, int, int>[] pitchers =  
             { Tuple.Create("McHale, Joe", 240.1m, 221, 96),
               Tuple.Create("Paul, Dave", 233.1m, 231, 84), 
               Tuple.Create("Williams, Mike", 193.2m, 183, 86),
               Tuple.Create("Blair, Jack", 168.1m, 146, 65), 
               Tuple.Create("Henry, Walt", 140.1m, 96, 30),
               Tuple.Create("Lee, Adam", 137.2m, 109, 45),
               Tuple.Create("Rohr, Don", 101.0m, 110, 42) };
        Tuple<string, double, double, double>[] results = ComputeStatistics(pitchers);
  
        // Display the results.
        outputBlock.Text += String.Format("{0,-20} {1,9} {2,11} {3,15}\n",
                          "Pitcher", "ERA", "Hits/Inn.", "Effectiveness") + "\n";
        foreach (var result in results)
           outputBlock.Text += String.Format("{0,-20} {1,9:F2} {2,11:F2} {3,15:F2}",
                          result.Item1, result.Item2, result.Item3, result.Item4) + "\n";
     }
  
     private static Tuple<string, double, double, double>[] ComputeStatistics(Tuple<string, decimal, int, int>[] pitchers)
     {
        var list = new List<Tuple<string, double, double, double>>();
        Tuple<string, double, double, double> result;
  
        foreach (var pitcher in pitchers)
        {
           // Decimal portion of innings pitched represents 1/3 of an inning
           double innings = Math.Floor((double) pitcher.Item2);
           innings = innings + (((double)pitcher.Item2 - innings) * .33);
  
           double ERA = pitcher.Item4 / innings * 9;
           double hitsPerInning = pitcher.Item3 / innings;
           double EI = (ERA * 2 + hitsPerInning * 9) / 3;
           result = new Tuple<string, double, double, double>
                             (pitcher.Item1, ERA, hitsPerInning, EI);
           list.Add(result);
        }
        return list.ToArray();
     }
  }
  // The example displays the following output;
  //       Pitcher                    ERA   Hits/Inn.   Effectiveness
  //       
  //       McHale, Joe               3.60        0.92            5.16
  //       Paul, Dave                3.24        0.99            5.14
  //       Williams, Mike            4.01        0.95            5.52
  //       Blair, Jack               3.48        0.87            4.93
  //       Henry, Walt               1.93        0.69            3.34
  //       Lee, Adam                 2.95        0.80            4.36
  //       Rohr, Don                 3.74        1.09            5.76
  

• 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 pitcher, in an array of Tuple<T1, T2, T3, T4> 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> object as the method argument, you can supply the thread’s startup routine with four 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.

See Also

Reference