(cache) C# インターフェース - IEnumerable(T)

C# インターフェース - IEnumerable(T)

今回は C# のインターフェースの IEnumerable<T> に関する説明です。
このインターフェースは非常に便利なのですが、実装するにはちょっとしたテクニックが必要となります。知らないとなかなか思いつきにくいところなので、覚えておいて損はないと思います。

用途

前回紹介したIEnumerable インターフェースと同様に IEnumerable<T> は自作のコンテナークラス などで継承します。

どちらのインターフェースでも foreach は使えます。
しかし、 IEnumerable<T> の場合はそれに加えて大きなメリットがあります。

それは System.Linq を using しておくことによって、 LINQ で定義された多くの拡張メソッドが使用可能になることです。

IEnumerable(T) インターフェイス (System.Collections.Generic)

これは Ruby で言えば、 Enumerable を Mix-in したようなものです。
自前のコンテナークラスを用意した場合には、 IEnumerable<T> を継承しておくのがお勧めです。

実装するメソッド

IEnumerable<T> を継承するには GetEnumerator()メソッドを実装します。

IEnumerator<T> GetEnumerator();

加えて、 IEnumerator の GetEnumerator() メソッドも実装する必要があります。

IEnumerator GetEnumerator()

これは IEnumerator<T> が単に IEnumerator のジェネリック版というだけでなく、 IEnumerator を継承しているインターフェースだからです。

IEnumerator<T> を継承すると IEnumerator も継承することになります。
実際にはIEnumerator<T> の GetEnumerator() しかまず使われません。しかし、両方の GetEnumerator() メソッドを実装しないとコンパイルに失敗してしまいます。

この IEnumerator 側の GetEnumerator() の実装ではよく使われる常套句的な記述があります。

実装方法

サンプルを使ってこの IEnumerator<T> の実装方法を説明していきたいと思います。

IEnumerableSample_T.cs

コンパイル:

 > csc IEnumerableSample_T.cs

Jagged Array と呼ばれる配列の配列を自作のコンテナーのサンプルとします。

IEnumerableSample_T.cs (クラス定義部) :

class JaggedArray<TSource> : IEnumerable<TSource>
{
    private List<TSource>[]  _list;
        
    public JaggedArray(int rowmax)
    {
        _list = new List<TSource>[rowmax];
    }
        
    public bool Add(int row, TSource val, params TSource[] restvals)
    {
        // :
    }
        
    public IEnumerator<TSource> GetEnumerator()
    {
        foreach (List<TSource> sublist in _list)
        {
            if (sublist != null)
            {
                // 子側の配列をイテレート
                foreach (TSource val in sublist)
                {
                    yield return val;
                }
            }   
        }
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        return this.GetEnumerator();
    }
}

この IEnumerable.GetEnumerator() の定義部分がポイントです。
IEnumerable のメソッドであることを IEnumerable. で明示的に指定しています。これがないと戻り値だけが違うメソッドのオーバーロードとなり、コンパイルエラーとなります。
定義内は IEnumerable<T> の GetEnumerator() を呼び出すだけの処理です。

次に作成した JaggedArray を実際に使ってみます。

// 結果表示用のメソッド
static string Dump<TSource>(IEnumerable<TSource> source)
{
    return "{" + string.Join(", ", source) + "}";
}

static void Main()
{
    JaggedArray<int> jagary = new JaggedArray<int>(5);
    jagary.Add(0, 1);
    jagary.Add(2, 1, 2, 3, 4);
    jagary.Add(3, 1, 2);
    jagary.Add(4, 5);

    foreach (int it in jagary)
    {
        Console.Write("{0} ", it);
    }
    Console.WriteLine("\n");

    // LINQ
    Console.WriteLine("Count = {0}", jagary.Count());
    Console.WriteLine("3 Contains ? = {0}", jagary.Contains(3));
    Console.WriteLine("Max = {0}", jagary.Max());
    Console.WriteLine("Sum = {0}", jagary.Sum());
    Console.WriteLine("Average = {0}", jagary.Average());
    Console.WriteLine("ToArray = {0}", Dump(jagary.ToArray()));
    Console.WriteLine("(Source) / 2.0 = {0}", Dump(jagary.Select(it=>it/2.0)));
}

実行結果 :

1 1 2 3 4 1 2 5 

Count = 8
3 Contains ? = True
Max = 5
Sum = 19
Average = 2.375
ToArray = {1, 1, 2, 3, 4, 1, 2, 5}
(Source) / 2.0 = {0.5, 0.5, 1, 1.5, 2, 0.5, 1, 2.5}

まず foreach で要素を順にアクセスする処理を行なっています。

その後に LINQ の演算子メソッドの幾つかを使用しています。
これは多くの演算子メソッドの中のほんの一部です。これらを自分で実装することなく、使用することができるようになっています。

関連記事