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

定義

表示 2-Tuple 或雙重 (Pair) 物件。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

Tuple 第 1 個元件的型別。The type of the tuple's first component.

T2

Tuple 第 2 個元件的型別。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 的淺層複本 (Shallow Copy)。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.

適用於

另請參閱