Queue<T>.GetEnumerator Método

Definición

Devuelve un enumerador que recorre en iteración la colección Queue<T>.Returns an enumerator that iterates through the Queue<T>.

public:
 System::Collections::Generic::Queue<T>::Enumerator GetEnumerator();
public System.Collections.Generic.Queue<T>.Enumerator GetEnumerator ();
member this.GetEnumerator : unit -> System.Collections.Generic.Queue<'T>.Enumerator
Public Function GetEnumerator () As Queue(Of T).Enumerator

Devoluciones

Ejemplos

En el ejemplo de código siguiente se Queue<T> muestra que la clase genérica es Enumerable.The following code example demonstrates that the Queue<T> generic class is enumerable. La foreach instrucción (For Each en Visual Basic, for each en C++) se utiliza para enumerar la cola.The foreach statement (For Each in Visual Basic, for each in C++) is used to enumerate the queue.

En el ejemplo de código se crea una cola de cadenas con la capacidad Enqueue predeterminada y se usa el método para poner en cola cinco cadenas.The code example creates a queue of strings with default capacity and uses the Enqueue method to queue five strings. Los elementos de la cola se enumeran, lo que no cambia el estado de la cola.The elements of the queue are enumerated, which does not change the state of the queue. El Dequeue método se usa para quitar la cola de la primera cadena.The Dequeue method is used to dequeue the first string. El Peek método se utiliza para examinar el siguiente elemento de la cola y, a continuación, Dequeue se usa el método para quitar de la cola.The Peek method is used to look at the next item in the queue, and then the Dequeue method is used to dequeue it.

El ToArray método se utiliza para crear una matriz y copiar los elementos de la cola en ella; a continuación, la matriz Queue<T> se pasa al IEnumerable<T>constructor que toma, y crea una copia de la cola.The ToArray method is used to create an array and copy the queue elements to it, then the array is passed to the Queue<T> constructor that takes IEnumerable<T>, creating a copy of the queue. Se muestran los elementos de la copia.The elements of the copy are displayed.

Se crea una matriz dos veces el tamaño de la cola y se CopyTo usa el método para copiar los elementos de la matriz a partir de la parte central de la matriz.An array twice the size of the queue is created, and the CopyTo method is used to copy the array elements beginning at the middle of the array. El Queue<T> constructor se utiliza de nuevo para crear una segunda copia de la cola que contiene tres elementos nulos al principio.The Queue<T> constructor is used again to create a second copy of the queue containing three null elements at the beginning.

El Contains método se usa para mostrar que la cadena "cuatro" se encuentra en la primera copia de la cola, después de Clear la cual el método borra la copia Count y la propiedad muestra que la cola está vacía.The Contains method is used to show that the string "four" is in the first copy of the queue, after which the Clear method clears the copy and the Count property shows that the queue is empty.

using System;
using System.Collections.Generic;

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

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

        Console.WriteLine("\nDequeuing '{0}'", numbers.Dequeue());
        Console.WriteLine("Peek at next item to dequeue: {0}", 
            numbers.Peek());
        Console.WriteLine("Dequeuing '{0}'", numbers.Dequeue());

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

        Console.WriteLine("\nContents of the first copy:");
        foreach( string number in queueCopy )
        {
            Console.WriteLine(number);
        }
        
        // Create an array twice the size of the queue and copy the
        // elements of the queue, starting at the middle of the 
        // array. 
        string[] array2 = new string[numbers.Count * 2];
        numbers.CopyTo(array2, numbers.Count);
        
        // Create a second queue, using the constructor that accepts an
        // IEnumerable(Of T).
        Queue<string> queueCopy2 = new Queue<string>(array2);

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

        Console.WriteLine("\nqueueCopy.Contains(\"four\") = {0}", 
            queueCopy.Contains("four"));

        Console.WriteLine("\nqueueCopy.Clear()");
        queueCopy.Clear();
        Console.WriteLine("\nqueueCopy.Count = {0}", queueCopy.Count);
    }
}

/* This code example produces the following output:

one
two
three
four
five

Dequeuing 'one'
Peek at next item to dequeue: two
Dequeuing 'two'

Contents of the copy:
three
four
five

Contents of the second copy, with duplicates and nulls:



three
four
five

queueCopy.Contains("four") = True

queueCopy.Clear()

queueCopy.Count = 0
 */
Imports System.Collections.Generic

Module Example

    Sub Main

        Dim numbers As New Queue(Of String)
        numbers.Enqueue("one")
        numbers.Enqueue("two")
        numbers.Enqueue("three")
        numbers.Enqueue("four")
        numbers.Enqueue("five")

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

        Console.WriteLine(vbLf & "Dequeuing '{0}'", numbers.Dequeue())
        Console.WriteLine("Peek at next item to dequeue: {0}", _
            numbers.Peek())    
        Console.WriteLine("Dequeuing '{0}'", numbers.Dequeue())

        ' Create a copy of the queue, using the ToArray method and the
        ' constructor that accepts an IEnumerable(Of T).
        Dim queueCopy As New Queue(Of String)(numbers.ToArray())

        Console.WriteLine(vbLf & "Contents of the first copy:")
        For Each number As String In queueCopy
            Console.WriteLine(number)
        Next
        
        ' Create an array twice the size of the queue, compensating
        ' for the fact that Visual Basic allocates an extra array 
        ' element. Copy the elements of the queue, starting at the
        ' middle of the array. 
        Dim array2((numbers.Count * 2) - 1) As String
        numbers.CopyTo(array2, numbers.Count)
        
        ' Create a second queue, using the constructor that accepts an
        ' IEnumerable(Of T).
        Dim queueCopy2 As New Queue(Of String)(array2)

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

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

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

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

Comentarios

La foreach instrucción del C# lenguajefor each (en C++, For Each en Visual Basic) oculta la complejidad de los enumeradores.The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Por lo tanto, se recomienda el uso de foreach, en lugar de manipular directamente el enumerador.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Los enumeradores pueden usarse para leer los datos de la colección, pero no para modificar la colección subyacente.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

En principio, el enumerador se coloca antes del primer elemento de la colección.Initially, the enumerator is positioned before the first element in the collection. En esta posición, el valor de propiedad Current está sin definir.At this position, Current is undefined. Por lo tanto, debe llamar a MoveNext para adelantar el enumerador hasta el primer elemento de la colección antes de leer el valor de Current.Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current devuelve el mismo objeto hasta que se llama a MoveNext.Current returns the same object until MoveNext is called. MoveNext establece Current en el siguiente elemento.MoveNext sets Current to the next element.

Si MoveNext pasa el final de la colección, el enumerador se coloca detrás del último elemento de la colección MoveNext y falsedevuelve.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Cuando el enumerador está en esta posición, las llamadas MoveNext subsiguientes a también devuelven false.When the enumerator is at this position, subsequent calls to MoveNext also return false. Si la última llamada a MoveNext devolvió Current false, no está definida.If the last call to MoveNext returned false, Current is undefined. No puede volver a establecer la propiedad Current en el primer elemento de la colección, sino que debe crear una nueva instancia del enumerador.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

Un enumerador es válido mientras la colección no cambie.An enumerator remains valid as long as the collection remains unchanged. Si se realizan cambios en la colección, como agregar, modificar o eliminar elementos, el enumerador se invalida definitivamente y la siguiente llamada a MoveNext o IEnumerator.Reset produce una InvalidOperationExceptionexcepción.If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to MoveNext or IEnumerator.Reset throws an InvalidOperationException.

El enumerador no tiene acceso exclusivo a la colección y, por tanto, la enumeración en una colección no es intrínsicamente un procedimiento seguro para subprocesos.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. A fin de garantizar la seguridad de los subprocesos, se puede bloquear la colección durante toda la enumeración.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Para permitir que varios subprocesos obtengan acceso de lectura y escritura a la colección, debe implementar su propia sincronización.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Las implementaciones predeterminadas System.Collections.Generic de las colecciones de no se sincronizan.Default implementations of collections in System.Collections.Generic are not synchronized.

Este método es una operación O (1).This method is an O(1) operation.

Se aplica a

Consulte también: