Tuple Class

Definition

generic 
public ref class Tuple : IComparable, System::Collections::IStructuralComparable, System::Collections::IStructuralEquatable

generic 
public ref class Tuple : IComparable, System::Collections::IStructuralComparable, System::Collections::IStructuralEquatable, System::Runtime::CompilerServices::ITuple

public class Tuple : IComparable, System.Collections.IStructuralComparable, System.Collections.IStructuralEquatable

public class Tuple : IComparable, System.Collections.IStructuralComparable, System.Collections.IStructuralEquatable, System.Runtime.CompilerServices.ITuple

[System.Serializable]
public class Tuple : IComparable, System.Collections.IStructuralComparable, System.Collections.IStructuralEquatable

type Tuple<'T1, 'T2, 'T3> = class
    interface IStructuralComparable
    interface IStructuralEquatable
    interface IComparable

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

[]
type Tuple<'T1, 'T2, 'T3> = class
    interface IStructuralEquatable
    interface IStructuralComparable
    interface IComparable

[]
type Tuple<'T1, 'T2, 'T3> = class
    interface IStructuralEquatable
    interface IStructuralComparable
    interface IComparable
    interface ITuple

Public Class Tuple(Of T1, T2, T3)
Implements IComparable, IStructuralComparable, IStructuralEquatable

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

Type Parameters

Inheritance

Object

Tuple

Attributes

SerializableAttribute

Implements

IStructuralComparable IStructuralEquatable IComparable ITuple

Remarks

A tuple is a data structure that has a specific number and sequence of values. The Tuple class represents a 3-tuple, or triple, which is a tuple that has three components.

You can instantiate a Tuple object by calling either the Tuple constructor or the static Tuple.Create(T1, T2, T3) method. You can retrieve the values of the tuple's components by using the read-only Item1, Item2, and Item3 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 objects that contain the names of students, their average test scores, and the number of tests taken. The array is passed to the ComputeStatistics method, which calculates the mean and standard deviation of the test scores.

  using System;
  
  public class Example
  {
     public static void Main()
     {
        Tuple[] scores = 
                      { Tuple.Create("Jack", 78.8, 8),
                        Tuple.Create("Abbey", 92.1, 9), 
                        Tuple.Create("Dave", 88.3, 9),
                        Tuple.Create("Sam", 91.7, 8), 
                        Tuple.Create("Ed", 71.2, 5),
                        Tuple.Create("Penelope", 82.9, 8),
                        Tuple.Create("Linda", 99.0, 9),
                        Tuple.Create("Judith", 84.3, 9) };
        var result = ComputeStatistics(scores);
        Console.WriteLine("Mean score: {0:N2} (SD={1:N2}) (n={2})", 
                          result.Item2, result.Item3, result.Item1);
     }
  
     private static Tuple ComputeStatistics(Tuple[] scores) 
     {
        int n = 0;
        double sum = 0;
  
        // Compute the mean.
        foreach (var score in scores)
        {
           n += score.Item3;
           sum += score.Item2 * score.Item3;
        }
        double mean = sum / n;
        
        // Compute the standard deviation.
        double ss = 0;
        foreach (var score in scores)
        {
           ss = Math.Pow(score.Item2 - mean, 2);
        }
        double sd = Math.Sqrt(ss/scores.Length);
        return Tuple.Create(scores.Length, mean, sd);
     }
  }
  // The example displays the following output:
  //       Mean score: 87.02 (SD=0.96) (n=8)
  

  open System
  
  let computeStatistics (scores: Tuple[]) = 
      let mutable n = 0
      let mutable sum = 0.
  
      // Compute the mean.
      for score in scores do
          n <- n + score.Item3
          sum <- sum + score.Item2 * double score.Item3
      let mean = sum / double n
      
      // Compute the standard deviation.
      let mutable ss = 0.
      for score in scores do
          ss <- (score.Item2 - mean) ** 2.
      let sd = sqrt (ss / double scores.Length)
      Tuple.Create(scores.Length, mean, sd)
  
  let scores = 
      [| Tuple.Create("Jack", 78.8, 8)
         Tuple.Create("Abbey", 92.1, 9) 
         Tuple.Create("Dave", 88.3, 9)
         Tuple.Create("Sam", 91.7, 8) 
         Tuple.Create("Ed", 71.2, 5)
         Tuple.Create("Penelope", 82.9, 8)
         Tuple.Create("Linda", 99.0, 9)
         Tuple.Create("Judith", 84.3, 9) |]
  let result = computeStatistics scores
  printfn $"Mean score: {result.Item2:N2} (SD={result.Item3:N2}) (n={result.Item1})"
  // The example displays the following output:
  //       Mean score: 87.02 (SD=0.96) (n=8)
  

  Module Example
     Public Sub Main()
        Dim scores() = 
                        { Tuple.Create("Jack", 78.8, 8),
                          Tuple.Create("Abbey", 92.1, 9), 
                          Tuple.Create("Dave", 88.3, 9),
                          Tuple.Create("Sam", 91.7, 8), 
                          Tuple.Create("Ed", 71.2, 5),
                          Tuple.Create("Penelope", 82.9, 8),
                          Tuple.Create("Linda", 99.0, 9),
                          Tuple.Create("Judith", 84.3, 9) }
        Dim result = ComputeStatistics(scores)
        Console.WriteLine("Mean score: {0:N2} (SD={1:N2}) (n={2})", 
                          result.Item2, result.Item3, result.Item1)
     End Sub
     
     Private Function ComputeStatistics(scores() As Tuple(Of String, Double, Integer)) _ 
                                  As Tuple(Of Integer, Double, Double)
        Dim n As Integer = 0      
        Dim sum As Double = 0
        
        ' Compute the mean.
        For Each score In scores
           n+= score.Item3 
           sum += score.Item2 * score.Item3
        Next     
        Dim mean As Double = sum / n
  
        ' Compute the standard deviation.
        Dim ss As Double = 0
        For Each score In scores
           ss = Math.Pow(score.Item2 - mean, 2)
        Next
        Dim sd As Double = Math.Sqrt(ss/scores.Length)
        Return Tuple.Create(scores.Length, mean, sd)
     End Function
  End Module
  ' The example displays the following output:
  '       Mean score: 87.02 (SD=0.96) (n=8)
  

• 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 summary test score statistics in a Tuple 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 object as the method argument, you can supply the thread's startup routine with three items of data.

See also

• Tuple
• Tuple
• Tuple
• Tuple
• Tuple
• Tuple
• Tuple
• Tuple