C yield return что это

Оператор yield — укажите следующий элемент

yield Оператор используется в итераторе для предоставления следующего значения или сигнала о завершении итерации. Инструкция yield имеет две следующие формы:

yield return : чтобы указать следующее значение в итерации, как показано в следующем примере:

foreach (int i in ProduceEvenNumbers(9)) < Console.Write(i); Console.Write(" "); >// Output: 0 2 4 6 8 IEnumerable ProduceEvenNumbers(int upto) < for (int i = 0; i > 

Console.WriteLine(string.Join(" ", TakeWhilePositive([2, 3, 4, 5, -1, 3, 4]))); // Output: 2 3 4 5 Console.WriteLine(string.Join(" ", TakeWhilePositive([9, 8, 7]))); // Output: 9 8 7 IEnumerable TakeWhilePositive(IEnumerable numbers) < foreach (int n in numbers) < if (n >0) < yield return n; >else < yield break; >> > 

В предыдущих примерах возвращаемый тип итераторов (в не универсальных случаях используется IEnumerable IEnumerable в качестве возвращаемого типа итератора). Можно также использовать IAsyncEnumerable в качестве возвращаемого типа итератора. Это делает асинхронный итератор. Используйте инструкцию await foreach для итерации результатов итератора, как показано в следующем примере:

await foreach (int n in GenerateNumbersAsync(5)) < Console.Write(n); Console.Write(" "); >// Output: 0 2 4 6 8 async IAsyncEnumerable GenerateNumbersAsync(int count) < for (int i = 0; i < count; i++) < yield return await ProduceNumberAsync(i); >> async Task ProduceNumberAsync(int seed)

IEnumerator или IEnumerator также может быть типом возвращаемого итератора. Это полезно при реализации GetEnumerator метода в следующих сценариях:

• Вы разрабатываете тип, реализующий IEnumerable или IEnumerable интерфейс.
• Вы добавляете метод экземпляра или расширения GetEnumerator , чтобы включить итерацию экземпляра типа с foreach помощью инструкции, как показано в следующем примере:

public static void Example() < var point = new Point(1, 2, 3); foreach (int coordinate in point) < Console.Write(coordinate); Console.Write(" "); >// Output: 1 2 3 > public readonly record struct Point(int X, int Y, int Z) < public IEnumeratorGetEnumerator() < yield return X; yield return Y; yield return Z; >> 

Инструкции yield нельзя использовать в следующих инструкциях:

• методы с параметрами in, ref или out
• лямбда-выражения и анонимные методы
• методы, содержащие небезопасные блоки

Выполнение итератора

Вызов итератора не выполняется немедленно, как показано в следующем примере:

var numbers = ProduceEvenNumbers(5); Console.WriteLine("Caller: about to iterate."); foreach (int i in numbers) < Console.WriteLine($"Caller: "); > IEnumerable ProduceEvenNumbers(int upto) < Console.WriteLine("Iterator: start."); for (int i = 0; i <= upto; i += 2) < Console.WriteLine($"Iterator: about to yield "); yield return i; Console.WriteLine($"Iterator: yielded "); > Console.WriteLine("Iterator: end."); > // Output: // Caller: about to iterate. // Iterator: start. // Iterator: about to yield 0 // Caller: 0 // Iterator: yielded 0 // Iterator: about to yield 2 // Caller: 2 // Iterator: yielded 2 // Iterator: about to yield 4 // Caller: 4 // Iterator: yielded 4 // Iterator: end. 

Как показано в предыдущем примере, при запуске итерации по результату итератора выполняется итератор до достижения первой yield return инструкции. Затем выполнение итератора приостановлено, и вызывающий объект получает первое значение итерации и обрабатывает его. При каждой последующей итерации выполнение итератора возобновляется после yield return инструкции, вызвавшей предыдущую приостановку и продолжающуюся до достижения следующей yield return инструкции. Итерация завершается, когда элемент управления достигает конца итератора или yield break оператора.

Спецификация языка C#

Дополнительные сведения см. в разделе инструкции о выходе спецификации языка C#.

См. также

• справочник по C#
• Итераторы
• Итерации с помощью коллекций в C#
• foreach
• await foreach

Совместная работа с нами на GitHub

Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.

Итераторы

Реализовать интерфейсы 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 > > 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(); >> > 

Итераторы (C#)

Итератор можно использовать для прохода по коллекции, такой как список или массив.

Метод итератора или метод доступа get выполняет настраиваемую итерацию по коллекции. Метод итератора использует оператор yield return для поочередного возврата каждого элемента. При достижении инструкции yield return текущее расположение в коде запоминается. При следующем вызове функции итератора выполнение возобновляется с этого места.

Итератор используется из клиентского кода с помощью оператора foreach или с помощью запроса LINQ.

В приведенном ниже примере первая итерация цикла foreach приводит к вызову метода итератора SomeNumbers , пока не будет достигнут первый оператор yield return . Эта итерация возвращает значение 3. Текущее расположение в методе итератора сохраняется. В следующей итерации цикла выполнение метода итератора возобновляется с того же места и снова приостанавливается при достижении оператора yield return . Эта итерация возвращает значение 5. Текущее расположение в методе итератора снова сохраняется. Цикл завершается при достижении конца метода итератора.

static void Main() < foreach (int number in SomeNumbers()) < Console.Write(number.ToString() + " "); >// Output: 3 5 8 Console.ReadKey(); > public static System.Collections.IEnumerable SomeNumbers()

Типом возвращаемого метода итератора или метода доступа get может быть IEnumerable, IEnumerable , IEnumerator или IEnumerator .

Для завершения итерации можно использовать оператор yield break .

Все примеры в этом разделе, кроме примера простого итератора, включают директивы using для пространств имен System.Collections и System.Collections.Generic .

Простой итератор

В следующем примере имеется один оператор yield return , который находится внутри цикла for. В методе Main каждая итерация оператора foreach создает вызов функции итератора, которая выполняет следующий оператор yield return .

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 EvenSequence(int firstNumber, int lastNumber) < // Yield even numbers in the range. for (int number = firstNumber; number > > 

Создание класса коллекции

В следующем примере класс DaysOfTheWeek реализует интерфейс IEnumerable, которому требуется метод GetEnumerator. Компилятор неявно вызывает метод GetEnumerator , который возвращает IEnumerator.

Метод GetEnumerator возвращает каждую строку поочередно с помощью оператора yield return .

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

В приведенном ниже примере создается класс Zoo , содержащий коллекцию животных.

Оператор foreach , который обращается к экземпляру класса ( theZoo ), неявно вызывает метод GetEnumerator . Операторы foreach , которые обращаются к свойствам Birds и Mammals , используют метод итератора с именем AnimalsForType .

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 Listanimals = new List(); // 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; >> > 

Использование итераторов с универсальным списком

В следующем примере универсальный класс Stack также реализует универсальный интерфейс IEnumerable . Метод Push присваивает значения массиву типа T . Метод GetEnumerator возвращает массив значений с помощью оператора yield return .

Помимо универсального метода GetEnumerator должен быть реализован и неуниверсальный метод GetEnumerator. Это связано с тем, что IEnumerable наследуется от IEnumerable. Неуниверсальная реализация подчиняется универсальной реализации.

В этом примере используются именованные итераторы для поддержки различных способов итерации по одной и той же коллекции данных. Эти именованные итераторы являются свойствами TopToBottom и BottomToTop и методом TopN .

Свойство BottomToTop использует итератор в методе доступа get .

static void Main() < StacktheStack = new Stack(); // Add items to the stack. for (int number = 0; number // Retrieve items from the stack. // foreach is allowed because theStack implements IEnumerable. foreach (int number in theStack) < Console.Write("", 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("", number); > Console.WriteLine(); // Output: 9 8 7 6 5 4 3 2 1 0 foreach (int number in theStack.BottomToTop) < Console.Write("", number); > Console.WriteLine(); // Output: 0 1 2 3 4 5 6 7 8 9 foreach (int number in theStack.TopN(7)) < Console.Write("", number); > Console.WriteLine(); // Output: 9 8 7 6 5 4 3 Console.ReadKey(); > public class Stack : IEnumerable  < 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 GetEnumerator() < for (int index = top - 1; index >= 0; index--) < yield return values[index]; >> IEnumerator IEnumerable.GetEnumerator() < return GetEnumerator(); >public IEnumerable TopToBottom < get < return this; >> public IEnumerable BottomToTop < get < for (int index = 0; index > > public IEnumerable 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]; >> > 

Сведения о синтаксисе

Итератор может являться методом или методом доступа get . Итератор не может использоваться в событии, конструкторе экземпляра, статическом конструкторе или статическом методе завершения.

Должно существовать неявное преобразование типа выражения в операторе yield return в аргумент типа для IEnumerable , возвращаемого итератором.

В C# метод итератора не может иметь параметры in , ref или out .

В C# yield не является зарезервированным словом и имеет специальное значение, только если используется перед ключевым словом return или break .

Техническая реализация

Хотя итератор создается как метод, компилятор переводит его во вложенный класс, который фактически является конечным автоматом. Этот класс отслеживает положение итератора, пока в клиентском коде выполняется цикл foreach .

Чтобы просмотреть операции компилятора, воспользуйтесь средством Ildasm.exe, чтобы просмотреть код промежуточного языка Майкрософт, создаваемый для метода итератора.

При создании итератора для класса или структуры реализация всего интерфейса IEnumerator не требуется. Когда компилятор обнаруживает итератор, он автоматически создает методы Current , MoveNext и Dispose интерфейса IEnumerator или IEnumerator .

В каждой последовательной итерации цикла foreach (или непосредственном вызове метода IEnumerator.MoveNext ) код тела следующего итератора возобновляет выполнение после предыдущего оператора yield return . Затем он выполняется до следующего оператора yield return до тех пор, пока не будет достигнут конец тела итератора или пока не будет обнаружен оператор yield break .

Итераторы не поддерживают метод IEnumerator.Reset. Для повторной итерации сначала необходимо получить новый итератор. Вызов Reset в итераторе, который возвращается методом итератора, вызывает исключение NotSupportedException.

Дополнительные сведения см. в спецификации языка C#.

Использование итераторов

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

• Изменение последовательности списков после первой итерации цикла foreach .
• Если необходимо избежать полной загрузки большого списка перед первой итерацией цикла foreach . Пример: при постраничной загрузке пакета строк таблицы. Другой пример — метод EnumerateFiles, реализующий итераторы в .NET.
• Инкапсулирование построения списка в итераторе. В методе итератора можно построить список, а затем выдавать каждый результат в цикле.

См. также

• System.Collections.Generic
• IEnumerable
• foreach, in
• Универсальные шаблоны

Совместная работа с нами на GitHub

Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.

C yield return что это

Итератор по сути представляет блок кода, который использует оператор yield для перебора набора значений. Данный блок кода может представлять тело метода, оператора или блок get в свойствах.

Итератор использует две специальных инструкции:

• yield return : определяет возвращаемый элемент
• yield break : указывает, что последовательность больше не имеет элементов

Рассмотрим небольшой пример:

Numbers numbers = new Numbers(); foreach (int n in numbers) < Console.WriteLine(n); >class Numbers < public IEnumeratorGetEnumerator() < for (int i = 0; i < 6; i++) < yield return i * i; >> >

В классе Numbers метод GetEnumerator() фактически представляет итератор. С помощью оператора yield return возвращается некоторое значение (в данном случае квадрат числа).

В программе с помощью цикла foreach мы можем перебрать объект Numbers как обычную коллекцию. При получении каждого элемента в цикле foreach будет срабатывать оператор yield return, который будет возвращать один элемент и запоминать текущую позицию.

Благодаря итераторам мы можем пойти дальше и легко реализовать перебор числа в цикле foreach:

foreach(var n in 5) Console.WriteLine(n); foreach (var n in -5) Console.WriteLine(n); static class Int32Extension < public static IEnumeratorGetEnumerator(this int number) < int k = (number >0)? number: 0; for (int i = number - k; i >

В данном случае итератор реализован как метод расширения для типа int или System.Int32. В методе итератора фактически возвращаем все целочисленные значения от 0 до текущего числа. Консольный вывод:

0 1 2 3 4 5 -5 -4 -3 -2 -1 0

Другой пример: пусть у нас есть коллекция Company, которая представляет компанию и которая хранит в массиве personnel штат сотрудников — объектов Person. Используем оператор yield для перебора этой коллекции:

class Person < public string Name < get; >public Person(string name) =>Name = name; > class Company < Person[] personnel; public Company(Person[] personnel) =>this.personnel = personnel; public int Length => personnel.Length; public IEnumerator GetEnumerator() < for (int i = 0; i < personnel.Length; i++) < yield return personnel[i]; >> >

Метод GetEnumerator() представляет итератор. И когда мы будем осуществлять перебор в объекте Company в цикле foreach, то будет идти обращение к вызову yield return personnel[i]; . При обращении к оператору yield return будет сохраняться текущее местоположение. И когда метод foreach перейдет к следующей итерации для получения нового объекта, итератор начнет выполнения с этого местоположения.

Ну и в основной программе в цикле foreach выполняется собственно перебор, благодаря реализации итератора:

var people = new Person[] < new Person("Tom"), new Person("Bob"), new Person("Sam") >; var microsoft = new Company(people); foreach(Person employee in microsoft)

Хотя при реализации итератора в методе GetEnumerator() применялся перебор массива в цикле for, но это необязательно делать. Мы можем просто определить несколько вызовов оператора yield return :

public IEnumerator GetEnumerator()

В этом случае при каждом вызове оператора yield return итератор также будет запоминать текущее местоположение и при последующих вызовах начинать с него.

Именованный итератор

Выше для создания итератора мы использовали метод GetEnumerator . Но оператор yield можно использовать внутри любого метода, только такой метод должен возвращать объект интерфейса IEnumerable . Подобные методы еще называют именованными итераторами .

Создадим такой именованный итератор в классе Company и используем его:

class Person < public string Name < get; >public Person(string name) =>Name = name; > class Company < Person[] personnel; public Company(Person[] personnel) =>this.personnel = personnel; public int Length => personnel.Length; public IEnumerable GetPersonnel(int max) < for (int i = 0; i < max; i++) < if (i == personnel.Length) < yield break; >else < yield return personnel[i]; >> > >

Определенный здесь итератор — метод IEnumerable GetPersonnel(int max) в качестве параметра принимает количество выводимых объектов. В процессе работы программы может сложиться, что его значение будет больше, чем длина массива personnel. И чтобы не произошло ошибки, используется оператор yield break . Этот оператор прерывает выполнение итератора.

var people = new Person[] < new Person("Tom"), new Person("Bob"), new Person("Sam") >; var microsoft = new Company(people); foreach(Person employee in microsoft.GetPersonnel(5))

Вызов microsoft.GetPersonnel(5) будет возвращать набор из не более чем 5 объектов Person. Но так как у нас всего три таких объекта, то в методе GetPersonnel после трех операций сработает оператор yield break .