Stack<T>.GetEnumerator 方法

定義

命名空間:

System.Collections.Generic

組件:

System.Collections.dll

來源:

Stack.cs

傳回 Stack<T> 的列舉值。

public:
 System::Collections::Generic::Stack<T>::Enumerator GetEnumerator();

public System.Collections.Generic.Stack<T>.Enumerator GetEnumerator ();

member this.GetEnumerator : unit -> System.Collections.Generic.Stack<'T>.Enumerator

Public Function GetEnumerator () As Stack(Of T).Enumerator

傳回

Stack<T>.Enumerator

Stack<T>.Enumerator 的 Stack<T>。

範例

下列程式代碼範例示範 Stack<T> 泛型類別是可列舉的。 foreach Visual Basic 中的 語句 (For Each Cfor each++) 可用來列舉堆棧。

程式代碼範例會建立具有預設容量的字串堆疊，並使用 Push 方法將五個字元串推送至堆疊。 會列舉堆疊的專案，而不會變更堆疊的狀態。 方法 Pop 可用來從堆疊中快顯第一個字串。 方法 Peek 可用來查看堆疊上的下一個專案，然後使用 Pop 方法將其快顯。

方法 ToArray 可用來建立陣列，並將堆疊元素複製到該陣列，然後將數位傳遞至 Stack<T> 採用 IEnumerable<T>的建構函式，並使用反轉元素的順序建立堆疊複本。 複本的專案隨即顯示。

建立堆疊大小的兩次數組，而 CopyTo 方法會用來複製陣列元素，從陣列中間開始。 建 Stack<T> 構函式會再次用來建立堆疊複本，並反轉元素的順序;因此，三個 Null 元素位於結尾。

方法 Contains 用來顯示字串 「four」 位在堆疊的第一個複本中，之後 Clear 方法會清除複本，而 Count 屬性會顯示堆疊是空的。

using System;
using System.Collections.Generic;

class Example
{
    public static void Main()
    {
        Stack<string> numbers = new Stack<string>();
        numbers.Push("one");
        numbers.Push("two");
        numbers.Push("three");
        numbers.Push("four");
        numbers.Push("five");

        // A stack can be enumerated without disturbing its contents.
        foreach( string number in numbers )
        {
            Console.WriteLine(number);
        }

        Console.WriteLine("\nPopping '{0}'", numbers.Pop());
        Console.WriteLine("Peek at next item to destack: {0}",
            numbers.Peek());
        Console.WriteLine("Popping '{0}'", numbers.Pop());

        // Create a copy of the stack, using the ToArray method and the
        // constructor that accepts an IEnumerable<T>.
        Stack<string> stack2 = new Stack<string>(numbers.ToArray());

        Console.WriteLine("\nContents of the first copy:");
        foreach( string number in stack2 )
        {
            Console.WriteLine(number);
        }

        // Create an array twice the size of the stack and copy the
        // elements of the stack, starting at the middle of the
        // array.
        string[] array2 = new string[numbers.Count * 2];
        numbers.CopyTo(array2, numbers.Count);

        // Create a second stack, using the constructor that accepts an
        // IEnumerable(Of T).
        Stack<string> stack3 = new Stack<string>(array2);

        Console.WriteLine("\nContents of the second copy, with duplicates and nulls:");
        foreach( string number in stack3 )
        {
            Console.WriteLine(number);
        }

        Console.WriteLine("\nstack2.Contains(\"four\") = {0}",
            stack2.Contains("four"));

        Console.WriteLine("\nstack2.Clear()");
        stack2.Clear();
        Console.WriteLine("\nstack2.Count = {0}", stack2.Count);
    }
}

/* This code example produces the following output:

five
four
three
two
one

Popping 'five'
Peek at next item to destack: four
Popping 'four'

Contents of the first copy:
one
two
three

Contents of the second copy, with duplicates and nulls:
one
two
three




stack2.Contains("four") = False

stack2.Clear()

stack2.Count = 0
 */

open System
open System.Collections.Generic

let numbers = Stack()
numbers.Push "one"
numbers.Push "two"
numbers.Push "three"
numbers.Push "four"
numbers.Push "five"

// A stack can be enumerated without disturbing its contents.
for number in numbers do
    printfn $"{number}"

printfn $"\nPopping '{numbers.Pop()}'"
printfn $"Peek at next item to destack: {numbers.Peek()}"
numbers.Peek() |> ignore
printfn $"Popping '{numbers.Pop()}'"

// Create a copy of the stack, using the ToArray method and the
// constructor that accepts an IEnumerable<T>.
let stack2 = numbers.ToArray() |> Stack

printfn "\nContents of the first copy:"

for number in stack2 do
    printfn $"{number}"

// Create an array twice the size of the stack and copy the
// elements of the stack, starting at the middle of the
// array.
let array2 = numbers.Count * 2 |> Array.zeroCreate
numbers.CopyTo(array2, numbers.Count)

// Create a second stack, using the constructor that accepts an
// IEnumerable(Of T).
let stack3 = Stack array2

printfn "\nContents of the second copy, with duplicates and nulls:"

for number in stack3 do
    printfn $"{number}"

printfn
    $"""
stack2.Contains "four" = {stack2.Contains "four"}"""

printfn "\nstack2.Clear()"
stack2.Clear()
printfn $"\nstack2.Count = {stack2.Count}"

// This code example produces the following output:
//       five
//       four
//       three
//       two
//       one
//
//       Popping 'five'
//       Peek at next item to destack: four
//       Popping 'four'
//
//       Contents of the first copy:
//       one
//       two
//       three
//
//       Contents of the second copy, with duplicates and nulls:
//       one
//       two
//       three
//
//       stack2.Contains("four") = False
//
//       stack2.Clear()
//
//       stack2.Count = 0

Imports System.Collections.Generic

Module Example

    Sub Main

        Dim numbers As New Stack(Of String)
        numbers.Push("one")
        numbers.Push("two")
        numbers.Push("three")
        numbers.Push("four")
        numbers.Push("five")

        ' A stack can be enumerated without disturbing its contents.
        For Each number As String In numbers
            Console.WriteLine(number)
        Next

        Console.WriteLine(vbLf & "Popping '{0}'", numbers.Pop())
        Console.WriteLine("Peek at next item to pop: {0}", _
            numbers.Peek())    
        Console.WriteLine("Popping '{0}'", numbers.Pop())

        ' Create another stack, using the ToArray method and the
        ' constructor that accepts an IEnumerable(Of T). Note that
        ' the order of items on the new stack is reversed.
        Dim stack2 As New Stack(Of String)(numbers.ToArray())

        Console.WriteLine(vbLf & "Contents of the first copy:")
        For Each number As String In stack2
            Console.WriteLine(number)
        Next
        
        ' Create an array twice the size of the stack, compensating
        ' for the fact that Visual Basic allocates an extra array 
        ' element. Copy the elements of the stack, starting at the
        ' middle of the array. 
        Dim array2((numbers.Count * 2) - 1) As String
        numbers.CopyTo(array2, numbers.Count)
        
        ' Create a second stack, using the constructor that accepts an
        ' IEnumerable(Of T). The elements are reversed, with the null
        ' elements appearing at the end of the stack when enumerated.
        Dim stack3 As New Stack(Of String)(array2)

        Console.WriteLine(vbLf & _
            "Contents of the second copy, with duplicates and nulls:")
        For Each number As String In stack3
            Console.WriteLine(number)
        Next

        Console.WriteLine(vbLf & "stack2.Contains(""four"") = {0}", _
            stack2.Contains("four"))

        Console.WriteLine(vbLf & "stack2.Clear()")
        stack2.Clear()
        Console.WriteLine(vbLf & "stack2.Count = {0}", _
            stack2.Count)
    End Sub
End Module

' This code example produces the following output:
'
'five
'four
'three
'two
'one
'
'Popping 'five'
'Peek at next item to pop: four
'Popping 'four'
'
'Contents of the first copy:
'one
'two
'three
'
'Contents of the second copy, with duplicates and nulls:
'one
'two
'three
'
'
'
'
'stack2.Contains("four") = False
'
'stack2.Clear()
'
'stack2.Count = 0

備註

foreach C++ 中 C# 語言 (for each 語句，For Each在 Visual Basic 中) 會隱藏列舉值的複雜度。 因此，建議您使用 foreach，而不要直接使用列舉值。

列舉程式可以用來讀取集合中的資料，但是無法用來修改基礎集合。

一開始，列舉程式位在集合中的第一個項目之前。 在這個位置上，Current 並未定義。 因此，在讀取 MoveNext 的值之前，必須呼叫 Current 以將列舉值前移至集合的第一個項目。

Current 會傳回相同的物件直到呼叫 MoveNext。 MoveNext 會將 Current 設定為下一個項目。

如果 MoveNext 傳遞集合的結尾，列舉值會放置在集合的最後一個專案後面，並 MoveNext 傳 false回 。 當列舉值位於這個位置時，後續呼叫 MoveNext 也會傳回 false。 如果最後一次 MoveNext 呼叫傳 false回 ， Current 則為未定義。 您不能再次將 Current 設定為集合的第一個項目；您必須建立新的列舉值執行個體。

只要集合維持不變，列舉值就仍維持有效。 如果對集合進行變更，例如新增、修改或刪除專案，列舉值會無法復原，而下一次InvalidOperationException呼叫 MoveNext 或 IEnumerator.Reset 會擲回 。

列舉程式沒有集合的獨佔存取權，因此，列舉集合內容本質上並不是安全的執行緒程序。 若要確保列舉期間的執行緒安全性，您可以在整個列舉期間鎖定集合。 若要讓多重執行緒能夠存取集合以便進行讀取和寫入，您必須實作自己的同步處理。

中的 System.Collections.Generic 集合預設實作不會同步處理。

這個方法是 O (1) 作業。

另請參閱

• Stack<T>.Enumerator
• IEnumerator<T>