昨日のビットフィールド用コード生成の副産物の話。

M~Nビット目

「int型変数のM~Nビットの範囲を取り出す処理をしたい」みたいなときに、「M~Nビット目を表す型」を作りたいときがあったりします。 (まあ、ビットフィールドの利用頻度自体がそんなに高くないので、この型の需要もそこまで大きくはないですが。)

ってことで、書きたいのはこんなコード:

// C# では書けない書き方。C++だとこんな感じのことができたりする。
// [M, N) (N は含まない)の範囲のビットを読み書きする構造体。
struct Bit<T, M, N>
{
    // C# で書けないことその1: 参照フィールド
    ref T _r;
    public Bit(ref T r) => _r = ref r;

    // C# で書けないことその2: ジェネリック引数が型じゃなくて int
    private const int Shift = M;
    private const T Mask = (1 << N) - (1 << M);

    // C# で書けないことその3: ジェネリックな型に対して静的な処理(& とかの演算子)
    public T Value
    {
        get => (r >> Shift) & Mask;
        set => r = (r & (~Mask)) | ((value << Shift) & Mask);
    }
}

素直にできないことが3つほどあります。

  1. 参照フィールド
  2. int 型なジェネリック引数
  3. ジェネリックな型に対して静的な処理(特に、& などの演算子)

1つ目の参照フィールドに関しては、unsafeでよければポインターを使って近いことはできます。 (ポインターなので、使う際にfixed必須だったり、参照先が残っている保証がなかったり、いろいろ問題あり。) 今、ByReference<T>とかいう、ランタイムで特殊処理して「参照フィールドっぽいもの」を実現しようとしている動きもあります。

まあ、今日の話は残りの2つ、特に、2つ目のint型ジェネリック引数です。

ジェネリクスに静的な処理を

素直な手段では、C#で静的な処理に対してジェネリクスを使う手段がなかったりします。 だいたいインターフェイス越しにメソッドを呼ぶことになっちゃって、仮想呼び出しになる。 仮想呼び出しなので、インライン展開とかも効かず、あんまり実行性能はよろしくない。

ですが、まあ、ちょっと煩雑なコードを書いていいなら、ジェネリック、かつ、高性能なコードを書く手段は一応あります。

参考:

こういうトリックを使って、「M~Nビット目を表す型」を作ってみたのが以下のコード:

int 型なジェネリック引数の需要

まあ、上記のBits<T, TOp, LowBit, HighBit>だと、やってることが多すぎてちょっと細かく見て行くのしんどいかなぁとか思って、「int 型なジェネリック引数」もどきを実現する部分だけを抜き出したのがこちら:

この手の要件に対してよく例として使われるガロアの有限体を実装しています。

またちょっと、数学わからない人には申し訳ない感じの例ですが… 要するに、Nが素数のとき、N個の値から成る「四則演算全部まっとうにできる型」が作れるって話です。 (整数の部分集合なのに、整数÷整数で、同じ範囲の整数値に収まる。任意の値 a に対して、a × b = 1 となる b がただ1つ定まります。)

2値からなるF2と、3値からなるF3は当然「別の型」なわけで、 プログラムを書く場合にも、型引数にして2と3で「別の具象型」を作れる仕組みが欲しくなります。

GaloisField<N>

ということで、それをC#で、GaloisField<N>って書き方で書けるようにしたのが今日のポイント。

必要な個所だけ抜き出すと、以下のような感じ。

public interface IConstant<T>
{
    T Value { get; }
}

public struct GaloisField<N>
    where N : struct, IConstant<int>
{
    // ガロアの有限体を作るにあたって必要なのは、拡張ユークリッド互除法っていうアルゴリズム
    // https://github.com/ufcpp/UfcppSample/blob/master/Demo/2017/IntTemplateParameter/IntTemplateParameter/GaloisField_N.cs#L43

    // で、その中で、「i を N で割った余り」を使う
    // (C# の % だと、i が負の時に結果が負になるので、その場合には N を足して正にする。)
    static int Mod(int i)
    {
        // 定数「N」の代わりに、default(N).Value って書く
        i %= default(N).Value;
        if (i < 0) i += default(N).Value;
        return i;
    }
}

ただし、定数代わりに、以下のような構造体を作っておく必要あり。

public static class ConstantInt
{
    public struct _0 : IConstant<int> { public int Value => 0; }
    public struct _1 : IConstant<int> { public int Value => 1; }
    public struct _2 : IConstant<int> { public int Value => 2; }
    //...
}

いちいち必要な分だけ構造体を定義しておかないといけないので、定数の置き換えとしては不完全ですけども、 実行性能的には結構いい結果になるはずです。 (ちゃんと静的に展開されて、インライン化もされる状態になります。)