Tuple<T1,T2> Tuple<T1,T2> Tuple<T1,T2> Tuple<T1,T2> Class

定义

表示 2 元组,即二元组。Represents a 2-tuple, or pair.

generic <typename T1, typename T2>
public ref class Tuple : IComparable, System::Collections::IStructuralComparable, System::Collections::IStructuralEquatable
[System.Serializable]
public class Tuple<T1,T2> : IComparable, System.Collections.IStructuralComparable, System.Collections.IStructuralEquatable
type Tuple<'T1, 'T2> = class
    interface IStructuralEquatable
    interface IStructuralComparable
    interface IComparable
Public Class Tuple(Of T1, T2)
Implements IComparable, IStructuralComparable, IStructuralEquatable

类型参数

T1

此元组的第一个组件的类型。The type of the tuple's first component.

T2

此元组的第二个组件的类型。The type of the tuple's second component.

继承
Tuple<T1,T2>Tuple<T1,T2>Tuple<T1,T2>Tuple<T1,T2>
属性
实现

注解

元组是具有特定数量和值序列的数据结构。A tuple is a data structure that has a specific number and sequence of values. Tuple<T1,T2>类表示 2 元组或对,是有两个组件的元组。The Tuple<T1,T2> class represents a 2-tuple, or pair, which is a tuple that has two components. 2 元组是类似于KeyValuePair<TKey,TValue>结构。A 2-tuple is similar to a KeyValuePair<TKey,TValue> structure.

可以实例化Tuple<T1,T2>对象通过调用Tuple<T1,T2>构造函数或静态Tuple.Create<T1,T2>(T1, T2)方法。You can instantiate a Tuple<T1,T2> object by calling either the Tuple<T1,T2> constructor or the static Tuple.Create<T1,T2>(T1, T2) method. 您可以使用只读的检索元组的组件的值Item1Item2实例属性。You can retrieve the values of the tuple's components by using the read-only Item1 and Item2 instance properties.

元组通常使用四个不同的方式:Tuples are commonly used in four different ways:

  • 表示一组数据。To represent a single set of data. 例如,元组可以表示某一记录在数据库中,并且其组件可以表示该记录的字段。For example, a tuple can represent a record in a database, and its components can represent that record's fields.

  • 若要提供轻松访问和数据集的操作。To provide easy access to, and manipulation of, a data set. 下面的示例定义一个数组Tuple<T1,T2>包含学生和及其相应的名称的对象测试分数。The following example defines an array of Tuple<T1,T2> objects that contain the names of students and their corresponding test scores. 然后循环访问数组来计算平均测试分数。It then iterates the array to calculate the mean test score.

    using System;
    
    public class Example
    {
       public static void Main()
       {
          Tuple<string, Nullable<int>>[] scores = 
                        { new Tuple<string, Nullable<int>>("Jack", 78),
                          new Tuple<string, Nullable<int>>("Abbey", 92), 
                          new Tuple<string, Nullable<int>>("Dave", 88),
                          new Tuple<string, Nullable<int>>("Sam", 91), 
                          new Tuple<string, Nullable<int>>("Ed", null),
                          new Tuple<string, Nullable<int>>("Penelope", 82),
                          new Tuple<string, Nullable<int>>("Linda", 99),
                          new Tuple<string, Nullable<int>>("Judith", 84) };
          int number;
          double mean = ComputeMean(scores, out number);
          Console.WriteLine("Average test score: {0:N2} (n={1})", mean, number);
       }
    
       private static double ComputeMean(Tuple<string, Nullable<int>>[] scores, out int n) 
       {
          n = 0;      
          int sum = 0;
          foreach (var score in scores)
          {
             if (score.Item2.HasValue)
             { 
                n += 1;
                sum += score.Item2.Value;
             }
          }     
          if (n > 0)
             return sum / (double) n;
          else
             return 0;
       }
    }
    // The example displays the following output:
    //       Average test score: 88 (n=7)
    
    Module Example
       Public Sub Main()
          Dim scores() As Tuple(Of String, Nullable(Of Integer)) = 
                          { New Tuple(Of String, Nullable(Of Integer))("Jack", 78),
                            New Tuple(Of String, Nullable(Of Integer))("Abbey", 92), 
                            New Tuple(Of String, Nullable(Of Integer))("Dave", 88),
                            New Tuple(Of String, Nullable(Of Integer))("Sam", 91), 
                            New Tuple(Of String, Nullable(Of Integer))("Ed", Nothing),
                            New Tuple(Of String, Nullable(Of Integer))("Penelope", 82),
                            New Tuple(Of String, Nullable(Of Integer))("Linda", 99),
                            New Tuple(Of String, Nullable(Of Integer))("Judith", 84) }
          Dim number As Integer
          Dim mean As Double = ComputeMean(scores, number)
          Console.WriteLine("Average test score: {0:N2} (n={1})", mean, number)
       End Sub
       
       Private Function ComputeMean(scores() As Tuple(Of String, Nullable(Of Integer)), 
                                    ByRef n As Integer) As Double
          n = 0      
          Dim sum As Integer
          For Each score In scores
             If score.Item2.HasValue Then 
                n += 1
                sum += score.Item2.Value
             End If
          Next     
          If n > 0 Then
             Return sum / n
          Else
             Return 0
          End If             
       End Function
    End Module
    ' The example displays the following output:
    '       Average test score: 88 (n=7)
    
  • 若要从无需使用方法返回多个值out参数 (在 C#) 或ByRef参数 (在 Visual Basic 中)。To return multiple values from a method without the use of out parameters (in C#) or ByRef parameters (in Visual Basic). 例如,下面的示例使用Tuple<T1,T2>对象返回商和产生整数除法的余数。For example, the following example uses a Tuple<T1,T2> object to return the quotient and the remainder that result from integer division.

    using System;
    
    public class Class1
    {
       public static void Main()
       {
          int dividend, divisor;
          Tuple<int, int> result;
          
          dividend = 136945; divisor = 178;
          result = IntegerDivide(dividend, divisor);
          if (result != null)
             Console.WriteLine(@"{0} \ {1} = {2}, remainder {3}", 
                               dividend, divisor, result.Item1, result.Item2);
          else
             Console.WriteLine(@"{0} \ {1} = <Error>", dividend, divisor);
                            
          dividend = Int32.MaxValue; divisor = -2073;
          result = IntegerDivide(dividend, divisor);
          if (result != null)
             Console.WriteLine(@"{0} \ {1} = {2}, remainder {3}", 
                               dividend, divisor, result.Item1, result.Item2);
          else
             Console.WriteLine(@"{0} \ {1} = <Error>", dividend, divisor);
       }
    
       private static Tuple<int, int> IntegerDivide(int dividend, int divisor)
       {
          try {
             int remainder;
             int quotient = Math.DivRem(dividend, divisor, out remainder);
             return new Tuple<int, int>(quotient, remainder);
          }   
          catch (DivideByZeroException) {
             return null;
          }      
       }
    }
    // The example displays the following output:
    //       136945 \ 178 = 769, remainder 63
    //       2147483647 \ -2073 = -1035930, remainder 757
    
    Module modMain
       Public Sub Main()
          Dim dividend, divisor As Integer
          Dim result As Tuple(Of Integer, Integer)
          
          dividend = 136945 : divisor = 178
          result = IntegerDivide(dividend, divisor)
          If result IsNot Nothing Then
             Console.WriteLine("{0} \ {1} = {2}, remainder {3}", 
                               dividend, divisor, result.Item1, result.Item2)
          Else
             Console.WriteLine("{0} \ {1} = <Error>", dividend, divisor)
          End If
                            
          dividend = Int32.MaxValue : divisor = -2073
          result = IntegerDivide(dividend, divisor)
          If result IsNot Nothing Then
             Console.WriteLine("{0} \ {1} = {2}, remainder {3}", 
                               dividend, divisor, result.Item1, result.Item2)
          Else
             Console.WriteLine("{0} \ {1} = <Error>", dividend, divisor)
          End If
       End Sub
       
       Private Function IntegerDivide(dividend As Integer, divisor As Integer) As Tuple(Of Integer, Integer)
          Try
             Dim remainder As Integer
             Dim quotient As Integer = Math.DivRem(dividend, divisor, remainder)
             Return New Tuple(Of Integer, Integer)(quotient, remainder)
          Catch e As DivideByZeroException
             Return Nothing
          End Try      
       End Function
    End Module
    ' The example displays the following output:
    '       136945 \ 178 = 769, remainder 63
    '       2147483647 \ -2073 = -1035930, remainder 757
    
  • 若要将多个值传递给通过单个参数的方法。To pass multiple values to a method through a single parameter. 例如,Thread.Start(Object)方法只有一个参数,可提供一个值,则该线程在启动时执行的方法。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. 如果提供Tuple<T1,T2>对象作为方法自变量,则可以提供以下两个项的数据的线程的启动例程。If you supply a Tuple<T1,T2> object as the method argument, you can supply the thread's startup routine with two items of data.

构造函数

Tuple<T1,T2>(T1, T2) Tuple<T1,T2>(T1, T2) Tuple<T1,T2>(T1, T2) Tuple<T1,T2>(T1, T2)

初始化 Tuple<T1,T2> 类的新实例。Initializes a new instance of the Tuple<T1,T2> class.

属性

Item1 Item1 Item1 Item1

获取当前 Tuple<T1,T2> 对象的第一个分量的值。Gets the value of the current Tuple<T1,T2> object's first component.

Item2 Item2 Item2 Item2

获取当前 Tuple<T1,T2> 对象的第二个分量的值。Gets the value of the current Tuple<T1,T2> object's second component.

方法

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

返回一个值,该值指示当前的 Tuple<T1,T2> 对象是否与指定对象相等。Returns a value that indicates whether the current Tuple<T1,T2> object is equal to a specified object.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

返回当前 Tuple<T1,T2> 对象的哈希代码。Returns the hash code for the current Tuple<T1,T2> object.

GetType() GetType() GetType() GetType()

获取当前实例的 TypeGets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

返回表示此 Tuple<T1,T2> 实例的值的字符串。Returns a string that represents the value of this Tuple<T1,T2> instance.

显式界面实现

IComparable.CompareTo(Object) IComparable.CompareTo(Object) IComparable.CompareTo(Object) IComparable.CompareTo(Object)

比较当前 Tuple<T1,T2> 对象与指定对象,并返回一个整数,该整数指示当前对象在排序顺序中的位置:是在指定对象之前、之后还是在与指定对象相同的位置。Compares the current Tuple<T1,T2> 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) IStructuralComparable.CompareTo(Object, IComparer) IStructuralComparable.CompareTo(Object, IComparer) IStructuralComparable.CompareTo(Object, IComparer)

使用指定的比较器将当前的 Tuple<T1,T2> 对象与指定对象进行比较,并返回一个整数,该整数指示当前对象在排序顺序中的位置是在指定对象之前、之后还是与其相同。Compares the current Tuple<T1,T2> 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) IStructuralEquatable.Equals(Object, IEqualityComparer) IStructuralEquatable.Equals(Object, IEqualityComparer) IStructuralEquatable.Equals(Object, IEqualityComparer)

返回一个值,该值根据指定的比较方法指示当前的 Tuple<T1,T2> 对象是否与指定对象相等。Returns a value that indicates whether the current Tuple<T1,T2> object is equal to a specified object based on a specified comparison method.

IStructuralEquatable.GetHashCode(IEqualityComparer) IStructuralEquatable.GetHashCode(IEqualityComparer) IStructuralEquatable.GetHashCode(IEqualityComparer) IStructuralEquatable.GetHashCode(IEqualityComparer)

使用指定的计算方法计算当前 Tuple<T1,T2> 对象的哈希代码。Calculates the hash code for the current Tuple<T1,T2> object by using a specified computation method.

ITuple.Item[Int32] ITuple.Item[Int32] ITuple.Item[Int32] ITuple.Item[Int32]

获取指定 Tuple 元素的值。Gets the value of the specified Tuple element.

ITuple.Length ITuple.Length ITuple.Length ITuple.Length

获取 Tuple 中的元素数。Gets the number of elements in the Tuple.

扩展方法

Deconstruct<T1,T2>(Tuple<T1,T2>, T1, T2) Deconstruct<T1,T2>(Tuple<T1,T2>, T1, T2) Deconstruct<T1,T2>(Tuple<T1,T2>, T1, T2) Deconstruct<T1,T2>(Tuple<T1,T2>, T1, T2)

将具有 2 个元素的元组解构为不同的变量。Deconstructs a tuple with 2 elements into separate variables.

ToValueTuple<T1,T2>(Tuple<T1,T2>) ToValueTuple<T1,T2>(Tuple<T1,T2>) ToValueTuple<T1,T2>(Tuple<T1,T2>) ToValueTuple<T1,T2>(Tuple<T1,T2>)

Tuple 类的实例转换为 ValueTuple 结构的实例。Converts an instance of the Tuple class to an instance of the ValueTuple structure.

适用于

另请参阅