【C#】演算子のオーバーロード

int a = 1 + 2;

クラス内で 加算された際の動作 を定義しておけば、同じようにクラス (インスタンス) 同士の加算が可能になります。

演算子のオーバーロードの書き方

基本構文

public static 戻り値 operator 演算子(型 引数1, 型 引数2)
{
    // 処理
}

ポイントは以下です

• 必ず「static」メソッドにする
• 「operator 演算子(+とか-とか)」の形にする

画像クラス「Image」のコード例

class Image
{
    public int X { get; private set; }
    public int Y { get; private set; }

    private int[] data;

    public Image(int width, int height)
    {
        X = width;
        Y = height;
        data = new int[X * Y];
    }

    public void SetPixel(int x, int y, int value)
    {
        if (x < 0 || x >= X || y < 0 || y >= Y)
            throw new ArgumentOutOfRangeException("Pixel coordinates are out of bounds.");

        data[y * X + x] = value;
    }

    public int GetPixel(int x, int y)
    {
        if (x < 0 || x >= X || y < 0 || y >= Y)
            throw new ArgumentOutOfRangeException("Pixel coordinates are out of bounds.");

        return data[y * X + x];
    }

    public static Image operator +(Image a, Image b)
    {
        // 引数 a, b のサイズが同じであることを確認（異なる場合は例外をスロー）
        if (a.X != b.X || a.Y != b.Y)
            throw new InvalidOperationException("Images must be of the same dimensions to add.");

        // 加算結果用に新しい Image オブジェクトを作成
        Image result = new Image(a.X, a.Y);
        for (int i = 0; i < a.data.Length; i++)
        {
            // 各ピクセルの値を加算して結果に格納
            result.data[i] = a.data[i] + b.data[i];
        }
        return result;
    }
}

「public static Image operator +(Image a, Image b)」が加算演算子をオーバーロードしたメソッドです。
これで、「Image」クラスのインスタンス同士の加算ができるようになります。

演算子のオーバーロードの使い方

では、実際に「Image」クラスのインスタンス同士を加算していきましょう。
以下のようなコードを用意します。

namespace Main
{
    class Program
    {
        static void Main(string[] args)
        {
            Image image1 = new Image(2, 2);
            Image image2 = new Image(2, 2);

            for (int y = 0; y < 2; y++)
            {
                for (int x = 0; x < 2; x++)
                {
                    image1.SetPixel(x, y, x + y);     // image1: [[0, 1], [1, 2]]
                    image2.SetPixel(x, y, x + y + 1); // image2: [[1, 2], [2, 3]]
                }
            }

            Image result = image1 + image2; // result: [[1, 3], [3, 5]]

            string resultStr = "[";
            for (int y = 0; y < 2; y++)
            {
                resultStr += "[";
                for (int x = 0; x < 2; x++)
                {
                    resultStr += result.GetPixel(x, y);
                    resultStr += (x == 0) ? ", " : "";
                }
                resultStr += "]";
                resultStr += (y == 0) ? ", " : "";
            }
            resultStr += "]";
            Console.WriteLine(resultStr);
        }
    }
}

「Image」クラスである「image1」「image2」「result」に入るべき数値をコメントで記載しています。
実際に、「result」に入っている値がコメントと同じなら、加算演算子のオーバーロードは成功です。

それでは、実行結果を見てみましょう。

[[1, 3], [3, 5]]

やりました。ちゃんと加算ができていますね。
このように、演算子をオーバーロードすることで Image result = image1 + image2; のようにクラスのインスタンス同士で演算することが可能になります。

今回は加算のみ取り扱っていますが、四則演算はもちろん、比較演算子などもオーバーロード可能です。

演算子のオーバーロードのメリット

可読性が向上する

Add(a, b);

のように、加算メソッドを呼ぶよりも

a + b;

と、加算をしている方が一目で直感的に何をやっているのかわかります。

自然な記述ができる

画像同士の演算や座標計算など、数学的な処理を行う際に非常にわかりやすくなります。

例えば画像同士を加算しようとしたら、for文で1画素ずつ加算していかないといけません。
コード量も増えますし、わかりにくいですよね。
演算子のオーバーロードを使えば、「加算している」とすぐ判断できてわかりやすくなります。

演算子のオーバーロードの注意点

演算子のオーバーロードが便利で、コードの可読性向上に役立つことはわかっていただけたかと思います。
ですが、もちろん注意点もあります。
それは

必要以上の意味を持たせない

ということです。
どういうことでしょうか？

例えば、加算の場合に、加算した後に数値を2倍にする という処理が入っていたとします。
「c = a + b」を実施したら、cに「(a+b)×2」という結果が入ってくるということです。
これだと「直感的にわかりやすい」というメリットが活かせていませんよね。

このように、演算子のオーバーロードには、本当に必要な処理 のみを実装することが重要です。

まとめ

演算子のオーバーロードの要点は

• 演算子の動作を自身で定義できる仕組み
• クラスを直感的に使えるようになる
• 必要以上の意味を持たせるなど、使い過ぎには注意

となります。

さいごに

今回は、演算子のオーバーロードについて説明しました。

私自身、もともと専門が画像処理だったので、画像クラスを作って演算子のオーバーロードを使用していました。
とても便利でしたね。

ジェネリッククラス + 演算子のオーバーロード をやると、さらに利便性の高いクラスを作成することができます。
また別の記事で紹介したいと思います。
今回はここまで♪