Iterátory (C#)

Iterátor lze použít k procházení kolekcí, jako jsou seznamy a pole.

Metoda iterátoru nebo get příslušenství provádí vlastní iteraci v kolekci. Metoda iterátoru používá příkaz yield return k vrácení každého prvku po jednom. yield return Po dosažení příkazu se aktuální umístění v kódu zapamatuje. Spuštění se restartuje z daného umístění při příštím volání funkce iterátoru.

Iterátor z klientského kódu využíváte pomocí příkazu foreach nebo pomocí dotazu LINQ.

V následujícím příkladu první iterace smyčky foreach způsobí, že provádění bude pokračovat v SomeNumbers iterátoru metody, dokud nebude dosaženo prvního yield return příkazu. Tato iterace vrátí hodnotu 3 a aktuální umístění v metodě iterátoru se zachová. Při další iteraci smyčky pokračuje spuštění v metodě iterátoru tam, kde skončil, a znovu se zastaví, když dosáhne yield return příkazu. Tato iterace vrátí hodnotu 5 a aktuální umístění v metodě iterátoru se znovu zachová. Smyčka se dokončí po dosažení konce metody iterátoru.

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;
}

Návratový typ metody iterátoru nebo get přístupového objektu může být IEnumerable, IEnumerable<T>, IEnumerator, nebo IEnumerator<T>.

K ukončení iterace můžete použít yield break příkaz.

Jednoduchý iterátor

Následující příklad obsahuje jeden yield return příkaz, který je uvnitř smyčky for . Každá Mainiterace foreach těla příkazu vytvoří volání funkce iterátoru, která pokračuje k dalšímu yield return příkazu.

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;
        }
    }
}

Vytvoření třídy kolekce

V následujícím příkladu DaysOfTheWeek třída implementuje IEnumerable rozhraní, které vyžaduje metodu GetEnumerator . Kompilátor implicitně volá metoduGetEnumerator, která vrací .IEnumerator

Metoda GetEnumerator vrátí každý řetězec po jednom pomocí yield return příkazu.

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];
        }
    }
}

Následující příklad vytvoří Zoo třídu, která obsahuje kolekci zvířat.

Příkaz foreach , který odkazuje na instanci třídy (theZoo) implicitně volá metodu GetEnumerator . Příkazy foreach , které odkazují na Birds a Mammals vlastnosti, používají pojmenovanou metodu AnimalsForType iterátoru.

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; }
    }
}

Používání iterátorů v obecných seznamech

V následujícím příkladu Stack<T> obecná třída implementuje IEnumerable<T> obecné rozhraní. Metoda Push přiřadí hodnoty k poli typu T. Metoda GetEnumerator vrátí maticové hodnoty pomocí yield return příkazu.

Kromě obecné GetEnumerator metody musí být také implementována ne generická GetEnumerator metoda. Je to proto, že IEnumerable<T> dědí z IEnumerable. Ne generická implementace vzdoruje obecné implementaci.

Příklad používá pojmenované iterátory k podpoře různých způsobů iterace prostřednictvím stejné kolekce dat. Tyto pojmenované iterátory jsou a TopToBottomBottomToTop vlastnosti a TopN metoda.

Vlastnost BottomToTop používá iterátor v přístupovém objektu get .

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];
        }
    }

}

Informace o syntaxi

Iterátor může nastat jako metoda nebo get příslušenství. Iterátor nemůže nastat v události, konstruktoru instance, statickém konstruktoru nebo statickém finalizátoru.

Implicitní převod musí existovat z typu výrazu yield return v příkazu na argument typu pro IEnumerable<T> vrácený iterátorem.

V jazyce C# nemůže metoda iterátoru obsahovat žádné inrefparametry ani out parametry.

V jazyce C# není vyhrazené slovo a má zvláštní význam pouze v případě, yield že se používá před slovem nebo break klíčovým slovemreturn.

Technická implementace

I když jako metodu napíšete iterátor, kompilátor ho přeloží do vnořené třídy, která je v podstatě stavový počítač. Tato třída sleduje pozici iterátoru, dokud smyčka foreach v kódu klienta pokračuje.

Pokud chcete zjistit, co kompilátor dělá, můžete pomocí nástroje Ildasm.exe zobrazit kód společného zprostředkujícího jazyka vygenerovaný pro metodu iterátoru.

Při vytváření iterátoru pro třídu nebo strukturu nemusíte implementovat celé IEnumerator rozhraní. Když kompilátor zjistí iterátor, automaticky vygeneruje Current, MoveNexta Dispose metody IEnumerator rozhraní.IEnumerator<T>

Při každé následné iteraci foreach smyčky (nebo přímé volání IEnumerator.MoveNext) se další tělo kódu iterátoru obnoví po předchozím yield return příkazu. Potom pokračuje k dalšímu yield return příkazu, dokud nebude dosaženo konce textu iterátoru nebo dokud yield break nebude nalezen příkaz.

Iterátory metodu IEnumerator.Reset nepodporují. Pokud chcete znovu začít, musíte získat nový iterátor. Volání Reset iterátoru vráceného metodou iterátoru NotSupportedExceptionvyvolá chybu .

Další informace najdete ve specifikaci jazyka C#.

Používání iterátorů

Iterátory umožňují udržovat jednoduchost foreach smyčky, když potřebujete použít složitý kód k naplnění sekvence seznamu. To může být užitečné, když chcete udělat toto:

• Upravte posloupnost seznamu po první foreach iteraci smyčky.

• Vyhněte se úplnému načtení velkého seznamu před první iterací smyčky foreach . Příkladem je načtení stránky pro načtení dávky řádků tabulky. Dalším příkladem je EnumerateFiles metoda, která implementuje iterátory v .NET.

• Zapouzdřte sestavení seznamu v iterátoru. V metodě iterátoru můžete vytvořit seznam a pak získat každý výsledek ve smyčce.

Viz také

• System.Collections.Generic
• IEnumerable<T>
• foreach, in
• Obecné typy