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

Inheritance Hierarchy

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

Syntax

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

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

Constructors

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

Top

Properties

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

Top

Methods

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

Top

Explicit Interface Implementations

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

You can instantiate a Tuple<T1, T2, T3, T4, T5, T6, T7> object by calling either the Tuple<T1, T2, T3, T4, T5, T6, T7> or the static Tuple.Create<T1, T2, T3, T4, T5, T6, T7>(T1, T2, T3, T4, T5, T6, T7) method. You can retrieve the value of the tuple's components by using the read-only Item1, Item2, Item3, Item4, Item5, Item6, and Item7 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 a Tuple<T1, T2, T3, T4, T5, T6, T7> object that contains population data for New York City for each census from 1950 through 2000. The septuple is passed to the ComputePopulationChange method, which calculates the annual rate of change between censuses, as well as the annual rate of change for the entire 60 year period.

  Module Example
     Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
        ' Get population data for New York City, 1950-2000.
        Dim population = Tuple.Create("New York", 7891957, 7781984, _ 
                                      7894862, 7071639, 7322564, 8008278)
        Dim rate = ComputePopulationChange(population)
        ' Display results.
        outputBlock.Text += String.Format("Population Change, {0}, 1950-2000", population.Item1) & vbCrLf
        outputBlock.Text &= vbCrLf
        outputBlock.Text &= String.Format("Year      {0,10} {1,9}", "Population", "Annual Rate") & vbCrLf
        outputBlock.Text &= String.Format("1950      {0,10:N0} {1,11}", population.Item2, "NA") & vbCrLf
        outputBlock.Text &= String.Format("1960      {0,10:N0} {1,11:P2}", population.Item3, rate.Item2 / 10) & vbCrLf
        outputBlock.Text &= String.Format("1970      {0,10:N0} {1,11:P2}", population.Item4, rate.Item3 / 10) & vbCrLf
        outputBlock.Text &= String.Format("1980      {0,10:N0} {1,11:P2}", population.Item5, rate.Item4 / 10) & vbCrLf
        outputBlock.Text &= String.Format("1990      {0,10:N0} {1,11:P2}", population.Item6, rate.Item5 / 10) & vbCrLf
        outputBlock.Text &= String.Format("2000      {0,10:N0} {1,11:P2}", population.Item7, rate.Item6 / 10) & vbCrLf
        outputBlock.Text &= String.Format("1950-2000 {0,10:N0} {1,11:P2}", "", rate.Item7 / 50) & vbCrLf
     End Sub
  
     ' Compute rate of population change by decade and overall.
     Private Function ComputePopulationChange(ByVal data As Tuple(Of String, Integer, Integer, Integer, Integer, Integer, Integer)) _
             As Tuple(Of String, Double, Double, Double, Double, Double, Double)
        Dim rate = Tuple.Create( data.Item1, _
                         (data.Item3 - data.Item2)/data.Item2, _
                         (data.Item4 - data.Item3)/data.Item3, _
                         (data.Item5 - data.Item4)/data.Item4, _
                         (data.Item6 - data.Item5)/data.Item5, _
                         (data.Item7 - data.Item6)/data.Item6, _
                         (data.Item7 - data.Item2)/data.Item2 )
        Return rate
     End Function
  End Module
  ' The example displays the following output:
  '       Population Change, New York, 1950-2000
  '       
  '       Year      Population Annual Rate
  '       1950       7,891,957          NA
  '       1960       7,781,984     -0.14 %
  '       1970       7,894,862      0.15 %
  '       1980       7,071,639     -1.04 %
  '       1990       7,322,564      0.35 %
  '       2000       8,008,278      0.94 %
  '       1950-2000                 0.03 %
  

  using System;
  
  public class Example
  {
     public static void Demo(System.Windows.Controls.TextBlock outputBlock)
     {
        // Get population data for New York City, 1950-2000.
        var population = Tuple.Create("New York", 7891957, 7781984,
                                      7894862, 7071639, 7322564, 8008278);
        var rate = ComputePopulationChange(population);
        // Display results.
        outputBlock.Text += String.Format("Population Change, {0}, 1950-2000\n", population.Item1) + "\n";
        outputBlock.Text += String.Format("Year      {0,10} {1,9}", "Population", "Annual Rate") + "\n";
        outputBlock.Text += String.Format("1950      {0,10:N0} {1,11}", population.Item2, "NA") + "\n";
        outputBlock.Text += String.Format("1960      {0,10:N0} {1,11:P2}", population.Item3, rate.Item2 / 10) + "\n";
        outputBlock.Text += String.Format("1970      {0,10:N0} {1,11:P2}", population.Item4, rate.Item3 / 10) + "\n";
        outputBlock.Text += String.Format("1980      {0,10:N0} {1,11:P2}", population.Item5, rate.Item4 / 10) + "\n";
        outputBlock.Text += String.Format("1990      {0,10:N0} {1,11:P2}", population.Item6, rate.Item5 / 10) + "\n";
        outputBlock.Text += String.Format("2000      {0,10:N0} {1,11:P2}", population.Item7, rate.Item6 / 10) + "\n";
        outputBlock.Text += String.Format("1950-2000 {0,10:N0} {1,11:P2}", "", rate.Item7 / 50) + "\n";
     }
  
     private static Tuple<string, double, double, double, double, double, double>
          ComputePopulationChange(
             Tuple<string, int, int, int, int, int, int> data)
     {
        var rate = Tuple.Create(data.Item1,
                         (double)(data.Item3 - data.Item2) / data.Item2,
                         (double)(data.Item4 - data.Item3) / data.Item3,
                         (double)(data.Item5 - data.Item4) / data.Item4,
                         (double)(data.Item6 - data.Item5) / data.Item5,
                         (double)(data.Item7 - data.Item6) / data.Item6,
                         (double)(data.Item7 - data.Item2) / data.Item2);
        return rate;
     }
  }
  // The example displays the following output:
  //       Population Change, New York, 1950-2000
  //       
  //       Year      Population Annual Rate
  //       1950       7,891,957          NA
  //       1960       7,781,984     -0.14 %
  //       1970       7,894,862      0.15 %
  //       1980       7,071,639     -1.04 %
  //       1990       7,322,564      0.35 %
  //       2000       8,008,278      0.94 %
  //       1950-2000                 0.03 %
  

• 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 city name, in a Tuple<T1, T2, T3, T4, T5, T6, T7> object.

• 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, T6, T7> object as the method argument, you can supply the thread’s startup routine with seven 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