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

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

Tuple.cs

Represents a 6-tuple, or sextuple.

generic <typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
public ref class Tuple : IComparable, System::Collections::IStructuralComparable, System::Collections::IStructuralEquatable, System::Runtime::CompilerServices::ITuple

public class Tuple<T1,T2,T3,T4,T5,T6> : IComparable, System.Collections.IStructuralComparable, System.Collections.IStructuralEquatable, System.Runtime.CompilerServices.ITuple

type Tuple<'T1, 'T2, 'T3, 'T4, 'T5, 'T6> = class
    interface IStructuralComparable
    interface IStructuralEquatable
    interface IComparable
    interface ITuple

Public Class Tuple(Of T1, T2, T3, T4, T5, T6)
Implements IComparable, IStructuralComparable, IStructuralEquatable, ITuple

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.

T6

The type of the tuple's sixth component.

Inheritance

Object

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

Implements

IStructuralComparable IStructuralEquatable IComparable ITuple

Remarks

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

You can instantiate a Tuple<T1,T2,T3,T4,T5,T6> object by calling either the Tuple<T1,T2,T3,T4,T5,T6> or the static Tuple.Create<T1,T2,T3,T4,T5,T6>(T1, T2, T3, T4, T5, T6) method. You can retrieve the value of the tuple's components by using the read-only Item1, Item2, Item3, Item4, Item5, and Item6 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> object that contains population data for New York City for each census from 1960 through 2000. The sextuple 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 50 year period.

  using System;
  
  public class Example
  {
     public static void Main()
     {
        // Get population data for New York City, 1960-2000.
        var population = 
             Tuple.Create("New York", 7781984, 7894862, 7071639, 7322564, 8008278);
        var rate = ComputePopulationChange(population);
        // Display results.
        Console.WriteLine("Population Change, {0}, 1960-2000\n", population.Item1);
        Console.WriteLine("Year      {0,10} {1,9}", "Population", "Annual Rate");
        Console.WriteLine("1960      {0,10:N0} {1,11}", population.Item2, "NA");
        Console.WriteLine("1970      {0,10:N0} {1,11:P2}", population.Item3, rate.Item2/10);
        Console.WriteLine("1980      {0,10:N0} {1,11:P2}", population.Item4, rate.Item3/10);
        Console.WriteLine("1990      {0,10:N0} {1,11:P2}", population.Item5, rate.Item4/10);
        Console.WriteLine("2000      {0,10:N0} {1,11:P2}", population.Item6, rate.Item5/10);
        Console.WriteLine("1960-2000 {0,10:N0} {1,11:P2}", "", rate.Item6/50);
     }
  
     private static Tuple<string, double, double, double, double, double> ComputePopulationChange(
             Tuple<string, 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.Item6 - data.Item2)/data.Item2 );
        return rate;
     }           
  }
  // The example displays the following output:
  //       Population Change, New York, 1960-2000
  //       
  //       Year      Population Annual Rate
  //       1960       7,781,984          NA
  //       1970       7,894,862      0.15 %
  //       1980       7,071,639     -1.04 %
  //       1990       7,322,564      0.35 %
  //       2000       8,008,278      0.94 %
  //       1960-2000                 0.06 %
  

  open System
  
  let computePopulationChange (data: Tuple<string, int, int, int, int, int>) =  
      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.Item6 - data.Item2) / data.Item2))
  
  // Get population data for New York City, 1960-2000.
  let population = 
        Tuple.Create("New York", 7781984, 7894862, 7071639, 7322564, 8008278)
  let rate = computePopulationChange population
  // Display results.
  printfn $"Population Change, {population.Item1}, 1960-2000\n"
  printfn $"""Year      {"Population",10} {"Annual Rate",9}"""
  printfn $"""1960      {population.Item2,10:N0} {"NA",11}"""
  printfn $"1970      {population.Item3,10:N0} {rate.Item2 / 10.,11:P2}"
  printfn $"1980      {population.Item4,10:N0} {rate.Item3 / 10.,11:P2}"
  printfn $"1990      {population.Item5,10:N0} {rate.Item4 / 10.,11:P2}"
  printfn $"2000      {population.Item6,10:N0} {rate.Item5 / 10.,11:P2}"
  printfn $"""1960-2000 {"",10:N0} {rate.Item6 / 50.,11:P2}"""
  
  // The example displays the following output:
  //       Population Change, New York, 1960-2000
  //       
  //       Year      Population Annual Rate
  //       1960       7,781,984          NA
  //       1970       7,894,862      0.15 %
  //       1980       7,071,639     -1.04 %
  //       1990       7,322,564      0.35 %
  //       2000       8,008,278      0.94 %
  //       1960-2000                 0.06 %
  

  Module Example
     Public Sub Main()
        ' Get population data for New York City, 1960-2000.
        Dim population = Tuple.Create(
                       "New York", 7781984, 7894862, 7071639, 7322564, 8008278)
        Dim rate = ComputePopulationChange(population)      
        ' Display results.
        Console.WriteLine("Population Change, {0}, 1960-2000", population.Item1)
        Console.WriteLine()
        Console.WriteLine("Year      {0,10} {1,9}", "Population", "Annual Rate")
        Console.WriteLine("1960      {0,10:N0} {1,11}", population.Item2, "NA")
        Console.WriteLine("1970      {0,10:N0} {1,11:P2}", population.Item3, rate.Item2/10)
        Console.WriteLine("1980      {0,10:N0} {1,11:P2}", population.Item4, rate.Item3/10)
        Console.WriteLine("1990      {0,10:N0} {1,11:P2}", population.Item5, rate.Item4/10)
        Console.WriteLine("2000      {0,10:N0} {1,11:P2}", population.Item6, rate.Item5/10)
        Console.WriteLine("1960-2000 {0,10:N0} {1,11:P2}", "", rate.Item6/50)
     End Sub
     
        ' Compute rate of population change by decade and overall.
     Private Function ComputePopulationChange(data As Tuple(Of String, Integer, Integer, Integer, Integer, Integer)) _ 
             As Tuple(Of String, 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.Item6 - data.Item2)/data.Item2 )
        Return rate
     End Function           
  End Module
  ' The example displays the following output:
  '       Population Change, New York, 1960-2000
  '       
  '       Year      Population Annual Rate
  '       1960       7,781,984          NA
  '       1970       7,894,862      0.15 %
  '       1980       7,071,639     -1.04 %
  '       1990       7,322,564      0.35 %
  '       2000       8,008,278      0.94 %
  '       1960-2000                 0.06 %
  

• 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> 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> object as the method argument, you can supply the thread's startup routine with six items of data.

Constructors

Tuple<T1,T2,T3,T4,T5,T6>(T1, T2, T3, T4, T5, T6)

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

Properties

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

Methods

Equals(Object)	Returns a value that indicates whether the current Tuple<T1,T2,T3,T4,T5,T6> object is equal to a specified object.
GetHashCode()	Returns the hash code for the current Tuple<T1,T2,T3,T4,T5,T6> object.
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> instance.

Explicit Interface Implementations

IComparable.CompareTo(Object)	Compares the current Tuple<T1,T2,T3,T4,T5,T6> 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(Object, IComparer)	Compares the current Tuple<T1,T2,T3,T4,T5,T6> 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(Object, IEqualityComparer)	Returns a value that indicates whether the current Tuple<T1,T2,T3,T4,T5,T6> object is equal to a specified object based on a specified comparison method.
IStructuralEquatable.GetHashCode(IEqualityComparer)	Calculates the hash code for the current Tuple<T1,T2,T3,T4,T5,T6> object by using a specified computation method.
ITuple.Item[Int32]	Gets the value of the specified Tuple element.
ITuple.Length	Gets the number of elements in the Tuple.

Extension Methods

Deconstruct<T1,T2,T3,T4,T5,T6>(Tuple<T1,T2,T3,T4,T5,T6>, T1, T2, T3, T4, T5, T6)	Deconstructs a tuple with 6 elements into separate variables.
ToValueTuple<T1,T2,T3,T4,T5,T6>(Tuple<T1,T2,T3,T4,T5,T6>)	Converts an instance of the Tuple class to an instance of the ValueTuple structure.

See also

• Tuple
• Tuple<T1>
• Tuple<T1,T2>
• Tuple<T1,T2,T3>
• Tuple<T1,T2,T3,T4>
• Tuple<T1,T2,T3,T4,T5>
• Tuple<T1,T2,T3,T4,T5,T6,T7>
• Tuple<T1,T2,T3,T4,T5,T6,T7,TRest>