【C#】インデクサの使い方

はじめに

以前、以下の記事で「演算子のオーバーロード」の紹介をしました。

関連記事

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

はじめに こうちゃ こんにちは、こうちゃです。 みなさんは、C#を扱っていて、「インスタンス同士で演算できたら良いのにな〜」と思ったことはありませんか？ 私はあります。(笑) ということで今回は、C#で演算子をオー[…]

インデクサとは

var a = image.GetPixel(x, y);

var a = image[x, y];

インデクサの書き方

基本構文

public 戻り値 this[型 引数]
{
    get { /* 取得処理 */ }
    set { /* 設定処理 */ }
}

ポイントは以下です：

• this[...] という特殊な構文を使う
• getter と setter で値の取得・設定を行う

画像クラス「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 int this[int x, int y]
    {
        get
        {
            if (x < 0 || x >= X || y < 0 || y >= Y)
                throw new ArgumentOutOfRangeException("Pixel coordinates are out of bounds.");
            return data[y * X + x];
        }
        set
        {
            if (x < 0 || x >= X || y < 0 || y >= Y)
                throw new ArgumentOutOfRangeException("Pixel coordinates are out of bounds.");
            data[y * X + x] = value;
        }
    }
}

インデクサの使い方

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

            for (int y = 0; y < 2; y++)
            {
                for (int x = 0; x < 2; x++)
                {
                    // インデクサ使用前
                    // image.SetPixel(x, y, x + y);     // image: [[0, 1], [1, 2]]

                    // インデクサ使用後
                    image[x, y] = x + y;     // image: [[0, 1], [1, 2]]
                }
            }
 
            string resultStr = "[";
            for (int y = 0; y < 2; y++)
            {
                resultStr += "[";
                for (int x = 0; x < 2; x++)
                {
                    // インデクサ使用前
                    // resultStr += image.GetPixel(x, y);

                    // インデクサ使用後
                    resultStr += image[x, y];
                    resultStr += (x == 0) ? ", " : "";
                }
                resultStr += "]";
                resultStr += (y == 0) ? ", " : "";
            }
            resultStr += "]";
            Console.WriteLine(resultStr);
        }
    }
}

// インデクサ使用前
// image.SetPixel(x, y, x + y);     // image: [[0, 1], [1, 2]]

// インデクサ使用後
image[x, y] = x + y;     // image: [[0, 1], [1, 2]]

// インデクサ使用前
// resultStr += image.GetPixel(x, y);

// インデクサ使用後
resultStr += image[x, y];

[[0, 1], [1, 2]]

インデクサのメリット

可読性が向上する

これまでも書いてきましたが、インデクサを使用するメリットとしては、可読性の向上が大きいです。

image.GetPixel(x, y);

よりも

image[x, y];

の方が直感的で読みやすいですよね。

さらには

image3[x, y] = image1[x, y] + image2[x, y]

なんていう書き方もできてしまいます。
これはもう、配列を扱っているのと変わらないくらいわかりやすいですね！

自由度が高い

public int this[int index] { get; set; }

はたまた、Dictionaryのような形式にすることも可能です。

public string this[int key] { get; set; }

このように、クラスの内容によって、さまざまな形でインデクサを使用することができます。

インデクサの注意点

複雑な内容にしないようにする

• シンプルな取得・設定に留める
• 副作用を持つ可能性があるような処理を入れない

まとめ

インデクサの要点は

• 配列のようにアクセスできる仕組み
• this[...] を使って定義する
• 可読性が向上し、直感的なコードになる
• 複雑な処理を入れすぎないように注意する

となります。

さいごに