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 deyime 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 yield return deyime ulaşılana kadar yürütmenin SomeNumbers 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;
}
Yineleyici yönteminin veya get erişimcinin dönüş türü , , IEnumerable<T>IEnumeratorveya IEnumerator<T>olabilirIEnumerable.
Yinelemeyi sonlandırmak için bir yield break deyimi kullanabilirsiniz.
Not
Bu konudaki Basit Yineleyici örneği dışındaki tüm örnekler için ve ad alanları için System.Collections kullanma yönergelerini ekleyin.System.Collections.Generic
Basit Yineleyici
Aşağıdaki örnekte for döngüsünün içinde yer alan tek yield return bir deyim vardır. içinde Main, deyim gövdesinin foreach her yinelemesi, bir sonraki yield return deyime devam eden yineleyici işlevine bir çağrı oluşturur.
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 sınıfı, DaysOfTheWeek bir GetEnumerator yöntem gerektiren arabirimini uygularIEnumerable. Derleyici, bir IEnumeratordöndüren yöntemini örtük olarak çağırırGetEnumerator.
yöntemi, GetEnumerator deyimini kullanarak her dizeyi yield return 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 Sınıf örneğine (theZoo) başvuran deyimi örtük olarak yöntemini çağırırGetEnumerator. ve özelliklerine Birds başvuran deyimler adlandırılmış yineleyici yöntemini kullanırAnimalsForType.Mammalsforeach
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 yönteme ek olarak, genel GetEnumeratorGetEnumerator olmayan yöntem de uygulanmalıdır. Bunun nedeni, öğesinden IEnumerabledevralınıyor olmasıdırIEnumerable<T>. 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, ve BottomToTop özellikleri ve yöntemidir.TopToBottomTopN
özelliği, BottomToTop bir erişimcide yineleyici 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 oluşabilir. Yineleyici bir olayda, örnek oluşturucusunda, statik oluşturucuda veya statik sonlandırıcıda gerçekleşemez.
Deyimdeki yield return ifade türünden yineleyici tarafından döndürülen için tür bağımsız değişkenine IEnumerable<T> örtük bir dönüştürme bulunmalıdır.
C# dilinde, yineleyici yönteminde herhangi bir in, refveya out parametresi olamaz.
C# dilinde ayrılmış yield bir sözcük değildir ve yalnızca veya break anahtar sözcüğü öncesinde kullanıldığında özel bir return anlamı vardı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, veya IEnumerator<T> arabiriminin Current, MoveNextve Dispose yöntemlerini IEnumerator 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. Ardından yineleyici gövdesinin yield return sonuna ulaşılana kadar veya bir deyimle karşılaşılana kadar sonraki yield break deyime devam eder.
Yineleyiciler yöntemini desteklemez IEnumerator.Reset . Baştan yinelemek için yeni bir yineleyici edinmeniz gerekir. Yineleyici yöntemi tarafından döndürülen yineleyicide çağrılması Reset bir NotSupportedExceptionoluş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
foreachdöngü yinelemesinin ardından liste dizisini değiştirin.Döngünün ilk yinelenmesinden önce büyük bir listeyi tam olarak
foreachyü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 .Listeyi yineleyicide derlemeyi kapsülleyin. Yineleyici yönteminde, listeyi derleyebilir ve ardından her sonucu bir döngü halinde vekleyebilirsiniz.
