Yineleyiciler (C#)

Yineleyici, listeler ve diziler gibi koleksiyonlarda adım adım ilerleyebilmek için kullanılabilir.

Yineleyici yöntemi veya get erişimcisi bir koleksiyon üzerinde özel yineleme gerçekleştirir. Yineleyici yöntemi, her öğeyi birer birer döndürmek için yield return deyimini kullanır. bir yield return deyimine ulaşıldığında koddaki geçerli konum hatırlanır. Yineleyici işlevi bir sonraki çağrılışında yürütme bu konumdan yeniden başlatılır.

bir foreach deyimi veya LINQ sorgusu kullanarak istemci kodundan bir yineleyici tüketirsiniz.

Aşağıdaki örnekte, döngünün foreach ilk yinelemesi, ilk SomeNumbers deyime ulaşılana kadar yürütmenin yield return yineleyici yönteminde ilerlemesine neden olur. Bu yineleme 3 değerini döndürür ve yineleyici yöntemindeki geçerli konum korunur. Döngünün bir sonraki yinelemesinde, yineleyici yönteminde yürütme kaldığı yerden devam eder ve bir yield return deyime ulaştığında yeniden durduruluyor. Bu yineleme 5 değerini döndürür ve yineleyici yöntemindeki geçerli konum yeniden korunur. Yineleyici yönteminin sonuna ulaşıldığında döngü tamamlanır.

static void Main()
{
    foreach (int number in SomeNumbers())
    {
        Console.Write(number.ToString() + " ");
    }
    // Output: 3 5 8
    Console.ReadKey();
}

public static System.Collections.IEnumerable SomeNumbers()
{
    yield return 3;
    yield return 5;
    yield return 8;
}

Bir yineleyici metodunun veya get erişimcisinin dönüş türü IEnumerable, IEnumerable<T>, IEnumerator veya IEnumerator<T> olabilir.

Yinelemeyi sonlandırmak için bir yield break deyimi kullanabilirsiniz.

Uyarı

Basit Yineleyici örneği dışındaki bu konudaki tüm örnekler için ve System.Collections ad alanları System.Collections.Generic yönergelerini ekleyin.

Basit Yineleyici

Aşağıdaki örnekte yield return içinde yer alan tek bir deyim vardır. Main içinde, foreach deyiminin her yinelemesi, yineleyici işlevine bir çağrı oluşturur ve bunu bir sonraki yield return deyimine geçirmek için ilerler.

static void Main()
{
    foreach (int number in EvenSequence(5, 18))
    {
        Console.Write(number.ToString() + " ");
    }
    // Output: 6 8 10 12 14 16 18
    Console.ReadKey();
}

public static System.Collections.Generic.IEnumerable<int>
    EvenSequence(int firstNumber, int lastNumber)
{
    // Yield even numbers in the range.
    for (int number = firstNumber; number <= lastNumber; number++)
    {
        if (number % 2 == 0)
        {
            yield return number;
        }
    }
}

Koleksiyon Sınıfı Oluşturma

Aşağıdaki örnekte, DaysOfTheWeek sınıfı bir IEnumerable arabirimini uygular ve bu da bir GetEnumerator yöntemi gerektirir. Derleyici, bir GetEnumerator yöntemini örtük şekilde çağırır, bu da bir IEnumerator döndürür.

GetEnumerator yöntemi yield return deyimini kullanarak her dizeyi birer birer döndürür.

static void Main()
{
    DaysOfTheWeek days = new DaysOfTheWeek();

    foreach (string day in days)
    {
        Console.Write(day + " ");
    }
    // Output: Sun Mon Tue Wed Thu Fri Sat
    Console.ReadKey();
}

public class DaysOfTheWeek : IEnumerable
{
    private string[] days = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];

    public IEnumerator GetEnumerator()
    {
        for (int index = 0; index < days.Length; index++)
        {
            // Yield each day of the week.
            yield return days[index];
        }
    }
}

Aşağıdaki örnek, bir Zoo hayvan koleksiyonu içeren bir sınıf oluşturur.

foreach ifadesi, sınıf örneğine (theZoo) başvurarak örtük olarak GetEnumerator yöntemini çağırır. foreach ve Birds ile Mammals özelliklerine başvuran deyimler, AnimalsForType adlandırılmış yineleyici yöntemini kullanır.

static void Main()
{
    Zoo theZoo = new Zoo();

    theZoo.AddMammal("Whale");
    theZoo.AddMammal("Rhinoceros");
    theZoo.AddBird("Penguin");
    theZoo.AddBird("Warbler");

    foreach (string name in theZoo)
    {
        Console.Write(name + " ");
    }
    Console.WriteLine();
    // Output: Whale Rhinoceros Penguin Warbler

    foreach (string name in theZoo.Birds)
    {
        Console.Write(name + " ");
    }
    Console.WriteLine();
    // Output: Penguin Warbler

    foreach (string name in theZoo.Mammals)
    {
        Console.Write(name + " ");
    }
    Console.WriteLine();
    // Output: Whale Rhinoceros

    Console.ReadKey();
}

public class Zoo : IEnumerable
{
    // Private members.
    private List<Animal> animals = new List<Animal>();

    // Public methods.
    public void AddMammal(string name)
    {
        animals.Add(new Animal { Name = name, Type = Animal.TypeEnum.Mammal });
    }

    public void AddBird(string name)
    {
        animals.Add(new Animal { Name = name, Type = Animal.TypeEnum.Bird });
    }

    public IEnumerator GetEnumerator()
    {
        foreach (Animal theAnimal in animals)
        {
            yield return theAnimal.Name;
        }
    }

    // Public members.
    public IEnumerable Mammals
    {
        get { return AnimalsForType(Animal.TypeEnum.Mammal); }
    }

    public IEnumerable Birds
    {
        get { return AnimalsForType(Animal.TypeEnum.Bird); }
    }

    // Private methods.
    private IEnumerable AnimalsForType(Animal.TypeEnum type)
    {
        foreach (Animal theAnimal in animals)
        {
            if (theAnimal.Type == type)
            {
                yield return theAnimal.Name;
            }
        }
    }

    // Private class.
    private class Animal
    {
        public enum TypeEnum { Bird, Mammal }

        public string Name { get; set; }
        public TypeEnum Type { get; set; }
    }
}

Yineleyicileri Genel Listeyle Kullanma

Aşağıdaki örnekte, Stack<T> genel sınıf genel arabirimini uygular IEnumerable<T> . Push yöntemi, türündeki Tbir diziye değerler atar. yöntemi, GetEnumerator deyimini kullanarak yield return dizi değerlerini döndürür.

Genel GetEnumerator yöntemin yanı sıra, genel olmayan GetEnumerator yöntemi de uygulanmalıdır. Bunun nedeni IEnumerable<T>'nin IEnumerable'den devralıyor olmasıdır. Genel olmayan uygulama, genel uygulamaya saptır.

Örnek, aynı veri koleksiyonu aracılığıyla yinelemenin çeşitli yollarını desteklemek için adlandırılmış yineleyiciler kullanır. Bu adlandırılmış yineleyiciler TopToBottom ve BottomToTop özellikleri ile TopN yöntemidir.

Özellik, BottomToTop erişimcide bir yineleyiciyi get kullanır.

static void Main()
{
    Stack<int> theStack = new Stack<int>();

    //  Add items to the stack.
    for (int number = 0; number <= 9; number++)
    {
        theStack.Push(number);
    }

    // Retrieve items from the stack.
    // foreach is allowed because theStack implements IEnumerable<int>.
    foreach (int number in theStack)
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 9 8 7 6 5 4 3 2 1 0

    // foreach is allowed, because theStack.TopToBottom returns IEnumerable(Of Integer).
    foreach (int number in theStack.TopToBottom)
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 9 8 7 6 5 4 3 2 1 0

    foreach (int number in theStack.BottomToTop)
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 0 1 2 3 4 5 6 7 8 9

    foreach (int number in theStack.TopN(7))
    {
        Console.Write("{0} ", number);
    }
    Console.WriteLine();
    // Output: 9 8 7 6 5 4 3

    Console.ReadKey();
}

public class Stack<T> : IEnumerable<T>
{
    private T[] values = new T[100];
    private int top = 0;

    public void Push(T t)
    {
        values[top] = t;
        top++;
    }
    public T Pop()
    {
        top--;
        return values[top];
    }

    // This method implements the GetEnumerator method. It allows
    // an instance of the class to be used in a foreach statement.
    public IEnumerator<T> GetEnumerator()
    {
        for (int index = top - 1; index >= 0; index--)
        {
            yield return values[index];
        }
    }

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

    public IEnumerable<T> TopToBottom
    {
        get { return this; }
    }

    public IEnumerable<T> BottomToTop
    {
        get
        {
            for (int index = 0; index <= top - 1; index++)
            {
                yield return values[index];
            }
        }
    }

    public IEnumerable<T> TopN(int itemsFromTop)
    {
        // Return less than itemsFromTop if necessary.
        int startIndex = itemsFromTop >= top ? 0 : top - itemsFromTop;

        for (int index = top - 1; index >= startIndex; index--)
        {
            yield return values[index];
        }
    }

}

Söz Dizimi Bilgileri

Yineleyici bir yöntem veya get erişimci olarak yer alabilir. Döngüleme elemanı bir etkinlikte, örnek yapıcıda, statik yapıcıda veya statik sonlayıcıda gerçekleşemez.

yield return deyimindeki ifade türünden, yineleyici tarafından döndürülen IEnumerable<T> tür bağımsız değişkenine otomatik bir dönüşüm mevcut olmalıdır.

C# dilinde, yineleyici yönteminde herhangi bir in, refveya out parametresi olamaz.

C# dilinde, yield ayrılmış bir sözcük değildir ve yalnızca return veya break anahtar sözcüğü öncesinde kullanıldığında özel bir anlam taşır.

Teknik Uygulama

Bir yineleyiciyi bir yöntem olarak yazmanıza rağmen, derleyici bunu iç içe geçmiş bir sınıfa (aslında bir durum makinesi) çevirir. Bu sınıf, istemci kodundaki döngü devam ettikçe yineleyicinin foreach konumunu izler.

Derleyicinin ne yaptığını görmek için Ildasm.exe aracını kullanarak yineleyici yöntemi için oluşturulan ortak ara dil kodunu görüntüleyebilirsiniz.

Bir sınıf veya yapı için yineleyici oluşturduğunuzda arabirimin tamamını IEnumerator uygulamanız gerekmez. Derleyici yineleyiciyi algıladığında, Current veya MoveNext arabiriminin Dispose, IEnumerator, ve IEnumerator<T> yöntemlerini otomatik olarak oluşturur.

Döngünün foreach her ardışık yinelemesinde (veya doğrudan çağrısında IEnumerator.MoveNext), sonraki yineleyici kod gövdesi önceki yield return deyimden sonra devam eder. Yineleyici gövdesinin sonuna ulaşılana kadar veya bir yield return deyimiyle karşılaşılana kadar, ardından bir sonraki yield break deyimine devam eder.

Yineleyiciler IEnumerator.Reset yöntemini desteklemez. Baştan yinelemek için yeni bir yineleyici edinmeniz gerekir. Yineleyici yöntem tarafından döndürülen yineleyicide Reset çağrılması, bir NotSupportedException oluşturur.

Daha fazla bilgi için bkz. C# Dil Belirtimi.

Yineleyicilerin Kullanımı

Yineleyiciler, bir liste dizisini doldurmak için karmaşık kod kullanmanız gerektiğinde döngünün foreach basitliğini korumanızı sağlar. Bu, aşağıdakileri yapmak istediğinizde yararlı olabilir:

• İlk foreach döngü yinelemesinin ardından liste dizisini değiştirin.

• Döngünün ilk yinelemesinden önce büyük bir listeyi tamamen foreach yüklemekten kaçının. Tablo satırlarından oluşan bir toplu iş yüklemek için sayfalanmış getirme işlemi örnek olarak verilmiştir. Bir diğer örnek de .NET'te yineleyicileri uygulayan yöntemdir EnumerateFiles .

• Liste oluşturmayı yineleyici içinde kapsülleyin. Yineleyici yönteminde, listeyi derleyebilir ve ardından her sonucu bir döngü halinde vekleyebilirsiniz.

Ayrıca bakınız

• System.Collections.Generic
• IEnumerable<T>
• foreach,
• Generikler