Итераторы

C# --- Руководство по C# --- Итераторы

Реализовать интерфейсы IEnumerator и IEnumerable нетрудно. Но еще проще воспользоваться итератором, который представляет собой метод, оператор или аксессор, возвращающий по очереди члены совокупности объектов от ее начала и до конца. Так, если некоторый массив состоит из пяти элементов, то итератор данного массива возвратит все эти элементы по очереди. Реализовав итератор, можно обращаться к объектам определяемого пользователем класса в цикле foreach.

Обозначение yield служит в языке C# в качестве контекстного ключевого слова. Это означает, что оно имеет специальное назначение только в блоке итератора. А вне этого блока оно может быть использовано аналогично любому другому идентификатору. Следует особо подчеркнуть, что итератор не обязательно должен опираться на массив или коллекцию другого типа. Он должен просто возвращать следующий элемент из совокупности элементов. Это означает, что элементы могут быть построены динамически с помощью соответствующего алгоритма.

Для преждевременного прерывания итератора служит следующая форма оператора yield:

yield break;

Когда этот оператор выполняется, итератор уведомляет о том, что достигнут конец коллекции. А это, по существу, останавливает сам итератор. В итераторе допускается применение нескольких операторов yield. Но каждый такой оператор должен возвращать следующий элемент в коллекции.

Именованный итератор представляет собой метод, общая форма которого приведена ниже:

public IEnumerable имя_итератора(список_параметров) {
  // ...
  yield return obj;
}

где имя_итератора обозначает конкретное имя метода; список_параметров — от нуля до нескольких параметров, передаваемых методу итератора; obj — следующий объект, возвращаемый итератором. Как только именованный итератор будет создан, его можно использовать везде, где он требуется, например для управления циклом foreach.

Именованные итераторы оказываются весьма полезными в некоторых ситуациях, поскольку они позволяют передавать аргументы итератору, управляющему процессом получения конкретных элементов из коллекции. Например, итератору можно передать начальный и конечный пределы совокупности элементов, возвращаемых из коллекции итератором. Эту форму итератора можно перегрузить, расширив ее функциональные возможности.

Давайте рассмотрим пример использования итераторов:

using System;
using System.Collections;

namespace ConsoleApplication1
{
    class Letter
    {
        char ch = 'А';
        int end;

        public Letter(int end)
        {
            this.end = end;
        }

        // Итератор, возвращающий end-букв
        public IEnumerator GetEnumerator()
        {
            for (int i = 0; i < this.end; i++)
            {
                if (i == 33) yield break; // Выход из итератора, если закончится алфавит
                yield return (char)(ch + i);
            }
        }

        // Создание именованного итератора
        public IEnumerable MyItr(int begin, int end)
        {
            for (int i = begin; i <= end; i++)
            {
                yield return (char)(ch + i);
            }
        }
    }

    class Program
    {
        static void Main()
        {
            Console.Write("Сколько букв вывести? "); 
            int i = int.Parse(Console.ReadLine());

            Letter lt = new Letter(i);
            Console.WriteLine("\nРезультат: \n");

            foreach (char c in lt)
                Console.Write(c + " ");

            Console.Write("\nВведите пределы\n\nMin: ");
            int j = int.Parse(Console.ReadLine());
            Console.Write("Max: ");
            int y = int.Parse(Console.ReadLine());
            Console.WriteLine("\nРезультат: \n");

            foreach (char c in lt.MyItr(j,y))
                Console.Write(c + " ");

            Console.ReadLine();
        }
    }
}