ジェネリック型数値演算

.NET 7 では、基本クラス ライブラリに新しい数値演算関連のジェネリック インターフェイスが導入されています。 これらのインターフェイスが使用できるということは、ジェネリック型またはメソッドの型パラメーターを "数値に似た" ものに制限できることを意味します。 さらに、C# 11 以降ではインターフェイス メンバーstatic virtualも定義できます。 演算子は static として宣言する必要があるため、この新しい C# 機能を使用すると、数値に似た型の新しいインターフェイスで演算子を宣言できます。

これらのイノベーションを組み合わせることで、数学演算を汎用的に実行できます。つまり、使用している正確な型を知る必要がありません。 たとえば、2 つの数値を加算するメソッドを記述する場合、以前は各型 (たとえば、static int Add(int first, int second) と static float Add(float first, float second)) に対してメソッドのオーバーロードを追加する必要がありました。 今回、型パラメーターが数値に似た型に制限される単一のジェネリック メソッドを記述できるようになりました。 次に例を示します。

static T Add<T>(T left, T right)
    where T : INumber<T>
{
    return left + right;
}

このメソッドでは、型パラメーター T は、新しい INumber<TSelf> インターフェイスを実装する型に制限されます。 INumber<TSelf> は、+ 演算子を含む IAdditionOperators<TSelf,TOther,TResult> インターフェイスを実装します。 これにより、メソッドは 2 つの数値を汎用的に加算できます。 このメソッドは、.NET の組み込み数値型と共に使用できます。それらはすべて .NET 7 で INumber<TSelf> を実装するように更新されているためです。

ライブラリ作成者は、"冗長な" オーバーロードを削除することでコード ベースを簡略化できるため、汎用の数学インターフェイスのベネフィットを最大限に得ることができます。 他の開発者は、使用する API でサポートされる型が増える可能性があるため、間接的にベネフィットがあります。

インターフェイス

インターフェイスは、ユーザーが独自のインターフェイスをその上に定義できる程度に詳細に、それでいて十分に使いやすい粒度にするように設計されました。 その程度では、ほとんどのユーザーが対話する、INumber<TSelf> や IBinaryInteger<TSelf> などのコア数値インターフェイスがいくつかあります。 IAdditionOperators<TSelf,TOther,TResult> や ITrigonometricFunctions<TSelf> などのより詳細なインターフェイスは、これらの型をサポートし、独自のドメイン固有の数値インターフェイスを定義する開発者が使用できます。

• 数値インターフェイス
• 演算子インターフェイス
• 関数インターフェイス
• インターフェイスの解析と書式設定

数値インターフェイス

このセクションでは、数値に似た型を記述する System.Numerics のインターフェイスと、それらに使用できる機能について説明します。

¹バイナリ浮動小数点型は Double (double)、Half、および Single (float) です。

²バイナリ整数型は Byte (byte)、Int16 (short)、Int32 (int)、Int64 (long)、Int128、IntPtr (nint)、SByte (sbyte)、UInt16 (ushort)、UInt32 (uint)、UInt64 (ulong)、UInt128、および UIntPtr (nuint) です。

直接使用する可能性が最も高いインターフェイスは INumber<TSelf> で、実数にほぼ対応しています。 型でこのインターフェイスが実装される場合は、値に符号 (これには unsigned が含まれ、正と見なされます) があり、同じ型の他の値と比較できることを意味します。 INumberBase<TSelf> は、複素数や虚数など、より高度な概念 (負の数の平方根など) と比較します。 他のインターフェイス (たとえば IFloatingPointIeee754<TSelf>) が作成されたのは、すべての演算子がすべての数値型に対して意味を持つわけではないためです。たとえば、数値の床の計算は浮動小数点型に対してのみ意味があります。 .NET 基本クラス ライブラリでは、浮動小数点型 Double は IFloatingPointIeee754<TSelf> を実装しますが、Int32 では実装しません。

インターフェイスの一部は、Char、DateOnly、DateTime、DateTimeOffset、Decimal、Guid、TimeOnly、TimeSpan といった、他のさまざまな型によっても実装されます。

次の表は、各インターフェイスによって公開されるコア API の一部を示しています。

¹3 つの Create* メソッドの動作を理解するには、次の例を考えてみてください。

大きすぎる値を指定した場合の例:

• byte.CreateChecked(384) は OverflowException をスローします。
• 384 は Byte.MaxValue (255) より大きいため、byte.CreateSaturating(384) は 255 を返します。
• byte.CreateTruncating(384) は、最も小さい 8 ビットを受け取るため、128 を返します (384 は 0x0180 の 16 進表現であり、最も小さい 8 ビットは 0x80、つまり 128 です)。

小さすぎる値を指定した場合の例:

• byte.CreateChecked(-384) は OverflowException をスローします。
• -384 は Byte.MinValue (0) より小さいため、byte.CreateSaturating(-384) は 0 を返します。
• byte.CreateTruncating(-384) は、最も小さい 8 ビットを受け取るため、128 を返します (384 は 0xFE80 の 16 進表現であり、最も小さい 8 ビットは 0x80、つまり 128 です)。

Create* メソッドには、float や double などの、IEEE 754 浮動小数点型に関する特別な考慮事項もあります。それらには PositiveInfinity、NegativeInfinity、NaN の特殊な値が含まれるためです。 3 つの Create* API はすべて CreateSaturating のように動作します。 また、MinValue と MaxValue は最大の正/負の "正規" 数を表しますが、実際の最小と最大の値は NegativeInfinity と PositiveInfinity であるため、代わりにこれらの値にクランプされます。

演算子インターフェイス

演算子インターフェイスは、C# 言語で使用できるさまざまな演算子に対応しています。

• 乗算や除算などの演算は、すべての型に対して正しいとは限らないため、明示的にはペアになりません。 たとえば、Matrix4x4 * Matrix4x4 は有効ですが、Matrix4x4 / Matrix4x4 は有効ではありません。
• 通常、入力と結果の型は、2 つの整数を除算して double (3 / 2 = 1.5 など) を取得したり、整数のセットの平均を計算したりするなどのシナリオをサポートするために異なるものにすることができます。

関数インターフェイス

関数インターフェイスは、特定の数値インターフェイスよりも広く適用される一般的な数学 API を定義します。 これらのインターフェイスはすべて IFloatingPointIeee754<TSelf> によって実装され、今後、他の関連する型によって実装される可能性があります。

インターフェイスの解析と書式設定

解析と書式設定は、プログラミングにおいて核となる概念です。 ユーザー入力を特定の型に変換したり、ユーザーに型を表示したりする場合に一般的に使用されます。 これらのインターフェイスは、System 名前空間にあります。

¹このインターフェイスは新しいものではなく、汎用的でもありません。 ただし、すべての数値型によって実装され、IParsable の逆演算を表します。

たとえば、次のプログラムは入力として 2 つの数値を受け取り、型パラメーターが IParsable<TSelf> に制約されるジェネリック メソッドを使用してそれをコンソールから読み取ります。 入力と結果の値の型パラメーターが INumber<TSelf> に制約されるジェネリック メソッドを使用して平均を計算し、結果をコンソールに表示します。

using System.Globalization;
using System.Numerics;

static TResult Average<T, TResult>(T first, T second)
    where T : INumber<T>
    where TResult : INumber<TResult>
{
    return TResult.CreateChecked( (first + second) / T.CreateChecked(2) );
}

static T ParseInvariant<T>(string s)
    where T : IParsable<T>
{
    return T.Parse(s, CultureInfo.InvariantCulture);
}

Console.Write("First number: ");
var left = ParseInvariant<float>(Console.ReadLine());

Console.Write("Second number: ");
var right = ParseInvariant<float>(Console.ReadLine());

Console.WriteLine($"Result: {Average<float, float>(left, right)}");

/* This code displays output similar to:

First number: 5.0
Second number: 6
Result: 5.5
*/

関連項目

• .NET 7 の汎用数学 (ブログ記事)