ジェネリック型数値演算

.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をスローします。
• byte.CreateSaturating(384) 384 が Byte.MaxValue (255) より大きいため、255 が返されます。
• byte.CreateTruncating(384) は、最下位 8 ビットを受け取るため 128 を返します (384 は 0x0180 の 16 進表現を持ち、最下位 8 ビットは 0x80(128) です)。

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

• byte.CreateChecked(-384) は OverflowExceptionをスローします。
• byte.CreateSaturating(-384) -384 が Byte.MinValue (0) よりも小さいため、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 の汎用数学 (ブログ記事)