タプル型 (C# リファレンス)

C# 7.0 以降で利用できる "タプル" 機能により、軽量データ構造に複数のデータ要素をグループ化するための簡潔な構文が提供されています。 次の例は、タプル変数を宣言して初期化し、そのデータ メンバーにアクセスする方法を示しています。

(double, int) t1 = (4.5, 3);
Console.WriteLine($"Tuple with elements {t1.Item1} and {t1.Item2}.");
// Output:
// Tuple with elements 4.5 and 3.

(double Sum, int Count) t2 = (4.5, 3);
Console.WriteLine($"Sum of {t2.Count} elements is {t2.Sum}.");
// Output:
// Sum of 3 elements is 4.5.

前の例で示したように、タプル型を定義するには、すべてのデータ メンバーの型と、必要に応じてフィールド名を指定します。 タプル型でメソッドを定義することはできませんが、次の例に示すように、.NET によって提供されるメソッドを使用できます。

(double, int) t = (4.5, 3);
Console.WriteLine(t.ToString());
Console.WriteLine($"Hash code of {t} is {t.GetHashCode()}.");
// Output:
// (4.5, 3)
// Hash code of (4.5, 3) is 718460086.

C# 7.3 以降では、タプル型で等値演算子 ==!= がサポートされます。 詳しくは、「タプルの等値性」セクションをご覧ください。

タプル型は値型であり、タプル要素はパブリック フィールドです。 そのため、タプルは "変更可能な" 値の型になります。

注意

タプルの機能には、System.ValueTuple 型と、.NET Core と .NET Framework 4.7 以降で使用できる、関連のジェネリック型 (たとえば、System.ValueTuple<T1,T2>) が必要です。 4.6.2 以前の .NET Framework を対象とするプロジェクトでタプルを使用するには、NuGet パッケージ System.ValueTuple をプロジェクトに追加します。

任意の多数の要素を持つタプルを定義できます。

var t = 
(1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15, 16, 17, 18,
19, 20, 21, 22, 23, 24, 25, 26);
Console.WriteLine(t.Item26);  // output: 26

タプルのユース ケース

特に一般的なタプルのユース ケースの 1 つが、メソッドの戻り値の型です。 つまり、out メソッド パラメーターを定義するのではなく、次の例のようにメソッドの結果をタプルの戻り値の型でグループ化できます。

var xs = new[] { 4, 7, 9 };
var limits = FindMinMax(xs);
Console.WriteLine($"Limits of [{string.Join(" ", xs)}] are {limits.min} and {limits.max}");
// Output:
// Limits of [4 7 9] are 4 and 9

var ys = new[] { -9, 0, 67, 100 };
var (minimum, maximum) = FindMinMax(ys);
Console.WriteLine($"Limits of [{string.Join(" ", ys)}] are {minimum} and {maximum}");
// Output:
// Limits of [-9 0 67 100] are -9 and 100

(int min, int max) FindMinMax(int[] input)
{
    if (input is null || input.Length == 0)
    {
        throw new ArgumentException("Cannot find minimum and maximum of a null or empty array.");
    }

    var min = int.MaxValue;
    var max = int.MinValue;
    foreach (var i in input)
    {
        if (i < min)
        {
            min = i;
        }
        if (i > max)
        {
            max = i;
        }
    }
    return (min, max);
}

前の例で示したように、返されたタプルのインスタンスを直接操作することも、別の変数に分解することもできます。

タプル型は匿名型の代わりに、たとえば LINQ クエリで使用することもできます。 詳細については、「匿名型またはタプル型の選択」を参照してください。

通常、タプルは関連性の低いデータ要素をグループ化するために使用します。 これは通常、非公開および内部のユーティリティ メソッド内で役に立ちます。 パブリック API の場合は、クラスまたは構造体型を定義することを検討してください。

タプルのフィールド名

次の例に示すように、タプルの初期化式またはタプルの型の定義でタプル フィールドの名前を明示的に指定できます。

var t = (Sum: 4.5, Count: 3);
Console.WriteLine($"Sum of {t.Count} elements is {t.Sum}.");

(double Sum, int Count) d = (4.5, 3);
Console.WriteLine($"Sum of {d.Count} elements is {d.Sum}.");

C# 7.1 以降では、フィールド名を指定しない場合、次の例に示すように、タプルの初期化式で対応する変数の名前からそれが推論される場合があります。

var sum = 4.5;
var count = 3;
var t = (sum, count);
Console.WriteLine($"Sum of {t.count} elements is {t.sum}.");

これはタプル プロジェクション初期化子と呼ばれます。 変数の名前は、次の場合、タプル フィールド名に投影されません。

  • 候補名が Item3ToStringRest などのタプル型のメンバー名である。
  • 候補名が、別のタプル フィールド名 (明示的または暗黙的のいずれか) の複製である。

このような場合は、フィールドの名前を明示的に指定するか、既定の名前でフィールドにアクセスします。

タプル フィールドの既定の名前は、Item1Item2Item3 などです。 次の例に示すように、フィールド名が明示的に指定されていたり推論されていたりする場合でも、フィールドの既定の名前をいつでも使用できます。

var a = 1;
var t = (a, b: 2, 3);
Console.WriteLine($"The 1st element is {t.Item1} (same as {t.a}).");
Console.WriteLine($"The 2nd element is {t.Item2} (same as {t.b}).");
Console.WriteLine($"The 3rd element is {t.Item3}.");
// Output:
// The 1st element is 1 (same as 1).
// The 2nd element is 2 (same as 2).
// The 3rd element is 3.

タプルの代入タプルの等価比較では、フィールド名が考慮されません。

コンパイル時に、コンパイラは既定以外のフィールド名を、対応する既定の名前に置き換えます。 このため、明示的に指定された、または推論されたフィールド名は実行時に使用できません。

タプルの代入と分解

C# では、次の両方の条件を満たすタプル型間の代入がサポートされます。

  • 両方のタプル型に、同じ数の要素がある
  • タプルのそれぞれの位置で、右側のタプル要素の型が対応する左側のタプル要素の型と同じか、暗黙的に変換可能である

タプル要素の値は、タプル要素の順序に従って代入されます。 次の例に示すように、タプル フィールドの名前は無視され、代入されません。

(int, double) t1 = (17, 3.14);
(double First, double Second) t2 = (0.0, 1.0);
t2 = t1;
Console.WriteLine($"{nameof(t2)}: {t2.First} and {t2.Second}");
// Output:
// t2: 17 and 3.14

(double A, double B) t3 = (2.0, 3.0);
t3 = t2;
Console.WriteLine($"{nameof(t3)}: {t3.A} and {t3.B}");
// Output:
// t3: 17 and 3.14

また、代入演算子 = を使用して、別の変数でタプル インスタンスを "分解する" こともできます。 これは、次の方法のいずれかで実行できます。

  • かっこ内の各変数の型を明示的に宣言する。

    var t = ("post office", 3.6);
    (string destination, double distance) = t;
    Console.WriteLine($"Distance to {destination} is {distance} kilometers.");
    // Output:
    // Distance to post office is 3.6 kilometers.
    
  • かっこの外にある var キーワードを使用して、暗黙的に型指定された変数を宣言し、コンパイラによってその型が推論されるようにする。

    var t = ("post office", 3.6);
    var (destination, distance) = t;
    Console.WriteLine($"Distance to {destination} is {distance} kilometers.");
    // Output:
    // Distance to post office is 3.6 kilometers.
    
  • 既存の変数を使用する。

    var destination = string.Empty;
    var distance = 0.0;
    
    var t = ("post office", 3.6);
    (destination, distance) = t;
    Console.WriteLine($"Distance to {destination} is {distance} kilometers.");
    // Output:
    // Distance to post office is 3.6 kilometers.
    

タプルとその他の型の分解の詳細については、「タプルとその他の型の分解」を参照してください。

タプルの等値性

C# 7.3 以降では、タプル型で == および != 演算子がサポートされます。 これらの演算子により、左側のオペランドのメンバーが、タプル要素の順序に従って、右側のオペランドの対応するメンバーと比較されます。

(int a, byte b) left = (5, 10);
(long a, int b) right = (5, 10);
Console.WriteLine(left == right);  // output: True
Console.WriteLine(left != right);  // output: False

var t1 = (A: 5, B: 10);
var t2 = (B: 5, A: 10);
Console.WriteLine(t1 == t2);  // output: True
Console.WriteLine(t1 != t2);  // output: False

前の例で示したように、==!= の演算では、タプルのフィールド名は考慮されません。

2 つのタプルは、次の両方の条件が満たされている場合に比較できます。

  • 両方のタプルが、同じ数の要素を保持している。 たとえば、t1t2 の要素数が異なる場合、t1 != t2 はコンパイルされません。
  • タプルの位置ごとに、左側と右側のタプルのオペランドの対応する要素が、==!= の演算子と比較されます。 たとえば、1(1, 2) と比較できないため、(1, (2, 3)) == ((1, 2), 3) はコンパイルされません。

==!= の演算子によって、タプルがショートサーキット方式で比較されます。 つまり、等しくない要素のペアか、タプルの端に到達するとすぐに、演算が停止します。 ただし、比較の前には必ず、次の例に示すように、"すべての" タプル要素が評価されます。

Console.WriteLine((Display(1), Display(2)) == (Display(3), Display(4)));

int Display(int s)
{
    Console.WriteLine(s);
    return s;
}
// Output:
// 1
// 2
// 3
// 4
// False

out パラメーターとしてのタプル

通常は、out パラメーターを持つメソッドを、タプルを返すメソッドにリファクタリングします。 ただし、out パラメーターがタプル型である場合もあります。 次の例に、out パラメーターとしてタプルを操作する方法を示します。

var limitsLookup = new Dictionary<int, (int Min, int Max)>()
{
    [2] = (4, 10),
    [4] = (10, 20),
    [6] = (0, 23)
};

if (limitsLookup.TryGetValue(4, out (int Min, int Max) limits))
{
    Console.WriteLine($"Found limits: min is {limits.Min}, max is {limits.Max}");
}
// Output:
// Found limits: min is 10, max is 20

タプルと System.Tuple

System.ValueTuple 型によってサポートされる C# のタプルは、System.Tuple タプルで表されるタプルとは異なります。 主な相違点は、次のとおりです。

  • ValueTuple 型は値の型です。 Tuple 型は参照型です。
  • ValueTuple 型は変更可能です。 Tuple 型は変更不可能です。
  • ValueTuple 型のデータ メンバーはフィールドです。 Tuple 型のデータ メンバーはプロパティです。

C# 言語仕様

詳しくは、次の機能提案メモをご覧ください。

関連項目