IEnumerableとは？IEnumerableを使った自作クラスについて解説！

IEnumerableとは？

「IEnumerable」とは、C#の標準機能として使用できるインターフェイスの一つです。

List、Stack、Queueといったコレクションのクラスに実装されており、それらのクラスから反復処理をするIEnumeratorを実装したクラスインスタンスを取得することができます。

また、IEnumerableを自作のクラスに実装することで、Listクラス等と同じようにIEnumeratorを取得して反復処理ができるようになります。

この記事では、その使い方について解説いたします。
 

 

Listのサンプル

以下のサンプルは、Listクラスの中身をforeachで表示します。

ソースの先頭には「using System.Collections.Generic;」を記述してください。

List<string> list = new List<string>();
list.Add(“りんご”);
list.Add(“みかん”);
list.Add(“バナナ”);

foreach (string s in list)
{
Console.WriteLine(s);
}

結果は以下のようになります。

りんご
みかん
バナナ

IEnumerableを使ったサンプル

上のサンプルを、IEnumerableを使って以下のようにすることもできます。

ソースの先頭には「using System.Collections;」を記述してください。

List<string> list = new List<string>();
list.Add(“りんご”);
list.Add(“みかん”);
list.Add(“バナナ”);

IEnumerable ie = list;
IEnumerator ier = ie.GetEnumerator();
while(ier.MoveNext())
{
Console.WriteLine(ier.Current);
}

サンプルの解説

1つ目のListのサンプルは、まずList型のlistをIEnumerableにキャストしています。

List型はIEnumerableを実装しているため、これが可能です。その結果のieから、GetEnumeratorというメソッドでIEnumeratorを実装したインスタンスを取り出しています。IEnumerableには、このメソッドだけが定義されています。

そして、IEnumeratorのMoveNextメソッドとCurrentプロパティで中身を表示する処理を行っています。

MoveNextはデータのリストのインデックスを移動して、中身がまだある場合はtrueを返します。trueが返る間whileループが繰り返され、その中で呼んでいるCurrentは現在のインデックスの中身を返します。

IEnumeratorのResetを使用する

2つ目のサンプルは、foreachを使ったサンプルよりも記述が増えたにもかかわらず結果は同じですので、無意味に思う方もいるでしょう。

しかしながら、IEnumeratorには、Resetというインデックスの位置を戻すメソッドがあります。2つ目のサンプルのwhileの箇所を以下のように変えてみましょう。

bool reset_flag = false; // 一度リセットしたかどうかのフラグ
while(ier.MoveNext())
{
string str = ier.Current.ToString();
if (str == “みかん” && !reset_flag)
{
ier.Reset();
reset_flag = true;
}
Console.WriteLine(str);
}

結果は以下になります。これは、foreachではできません。

りんご
みかん
りんご
みかん
バナナ

IEnumerableを使った自作クラス

IEnumeratorのResetメソッドを使わないのであればforeachで済みますので、ListクラスでIEnumerableのGetEnumeratorメソッドを使う機会は少ないでしょう。

実際のところ、IEnumerableは、自作のクラスをforeachなどで使えるようにしたい場合に利用します。

では、実際に自作クラスでIEnumerableを使用してみましょう。以下がサンプルです。

using System;
using System.Collections;
using System.Collections.Generic;

class Program
{
class NedanList : IEnumerable
{
private int idx = 0;
private List<int> list = new List<int>();
public IEnumerator GetEnumerator()
{
return new NedanListIEnum(list);
}

public void Add(int val)
{
list.Add(val);
}

class NedanListIEnum : IEnumerator
{

private int idx;
private List<int> list;
public NedanListIEnum(List<int> l)
{
list = l;
idx = -1;
}
public object Current
{
get
{
if (idx < 0 || idx >= list.Count)
{
return null;
}
else
{
return list[idx] + “円”;
}
}
}

public bool MoveNext()
{
if (++idx>=list.Count)
{
return false;
}
else
{
return true;
}
}

public void Reset()
{
idx = -1;
}
}
}

public static void Main()
{
NedanList nl = new NedanList();
nl.Add(100);
nl.Add(150);
nl.Add(280);

foreach(object o in nl)
{
Console.WriteLine(o);
}
}
}

自作クラスの解説　その１

上記のサンプルは、NedanListというクラスと、その内部クラスのNedanListIEnumから構成されます。

NedanListはAddメソッドで内部のListに値を追加することができます。また、IEnumerableを実装しているため、GetEnumeratorでIEnumeratorを実装しているNedanListIEnumクラスのインスタンスを生成して返します。

自作クラスの解説　その２

NedanListIEnumは、生成されるとコンストラクタのパラメータでNedanListの持つListクラスを渡され、それを受け取ります。その時に、インデックス変数を-1に初期化します。

この時、0でなく-1にする理由は、foreachではCurrentの前にMoveNextが呼ばれますので、その時点で加算して0にするためです。

ただし、MoveNextの前にCurrentが呼ばれると範囲外で例外が発生してしまうため、Currentではidxが範囲外だった場合は、nullを返すようにしています。

自作クラスの解説　その３

MainメソッドではNedanListを生成し、Addで値を追加してforeachで表示しています。

結果は以下のようになります。

100円
150円
280円

この自作クラスの独自の機能は、Currentで「円」を末尾に追加して返すだけです。

それだけならば既存のListクラスで値を取り出す時に「円」を追加すれば済みますが、実際は、自作クラスではもっと様々な機能を追加することが多くなります。

そういった場合に、IEnumerableを使う意味が出てくるでしょう。

自作クラスでIEnumerableを活用しよう

本記事では、IEnumerableを解説しましたがご理解頂けましたでしょうか。

独自の機能を追加した自作クラスをforeachで使用したい場合は、IEnumerableが必須となります。

是非、IEnumerableを活用してみましょう。