Tuple<T1,T2> クラス

定義

2 組 (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

組の 1 番目のコンポーネントの型。The type of the tuple's first component.

T2

組の 2 番目のコンポーネントの型。The type of the tuple's second component.

継承
Tuple<T1,T2>
属性
実装

注釈

組は、特定の数と値のシーケンスを持つデータ構造です。A tuple is a data structure that has a specific number and sequence of values. クラスTuple<T1,T2>は、2つのタプル (ペア) を表します。これは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. タプルのコンポーネントの値を取得するには、読み取りItem1専用プロパティとItem2インスタンスプロパティを使用します。You can retrieve the values of the tuple's components by using the read-only Item1 and Item2 instance properties.

組は、主に次の4つの方法で使用されます。Tuples are commonly used in four different ways:

  • データの1つのセットを表す場合は。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)
    
  • パラメーター (でC#は) またはパラメーター (Visual Basic) を使用ByRefせずに、メソッドから複数の値を返す場合は。 outTo 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
    
  • 1つのパラメーターを使用して複数の値をメソッドに渡す場合は。To pass multiple values to a method through a single parameter. たとえば、 Thread.Start(Object)メソッドには、起動時にスレッドが実行するメソッドに1つの値を指定できる1つのパラメーターがあります。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>してオブジェクトを指定する場合は、スレッドのスタートアップルーチンに2つのデータ項目を指定できます。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> クラスの新しいインスタンスを初期化します。Initializes a new instance of the Tuple<T1,T2> class.

プロパティ

Item1

現在の Tuple<T1,T2> オブジェクトの 1 番目のコンポーネントの値を取得します。Gets the value of the current Tuple<T1,T2> object's first component.

Item2

現在の Tuple<T1,T2> オブジェクトの 2 番目のコンポーネントの値を取得します。Gets the value of the current Tuple<T1,T2> object's second component.

メソッド

Equals(Object)

現在の Tuple<T1,T2> オブジェクトが、指定されたオブジェクトと等しいかどうかを示す値を返します。Returns a value that indicates whether the current Tuple<T1,T2> object is equal to a specified object.

GetHashCode()

現在の Tuple<T1,T2> オブジェクトのハッシュ コードを返します。Returns the hash code for the current Tuple<T1,T2> object.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

この Tuple<T1,T2> インスタンスの値を表す文字列を返します。Returns a string that represents the value of this Tuple<T1,T2> instance.

明示的なインターフェイスの実装

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)

指定された比較子を使用して現在の 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)

指定された比較メソッドに基づいて、現在の 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)

指定した計算メソッドを使用して、現在の Tuple<T1,T2> オブジェクトのハッシュ コードを計算します。Calculates the hash code for the current Tuple<T1,T2> object by using a specified computation method.

ITuple.Item[Int32]

指定した Tuple 要素の値を取得します。Gets the value of the specified Tuple element.

ITuple.Length

Tuple にある要素の数を取得します。Gets the number of elements in the Tuple.

拡張メソッド

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

2 要素を持つタプルを別個の変数に分解します。Deconstructs a tuple with 2 elements into separate variables.

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

Tuple クラスのインスタンスを ValueTuple 構造体のインスタンスに変換します。Converts an instance of the Tuple class to an instance of the ValueTuple structure.

適用対象

こちらもご覧ください