C# | Get an enumerator that iterates through the SortedSet

SortedSet<T>.GetEnumerator Method is used to return an enumerator that iterates through the SortedSet<T>.

Syntax:

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

Return Value: This method returns an enumerator that iterates through the SortedSet<T> in sorted order.

Below programs illustrate the use of the above-discussed method:

Example 1:

// C# code to get an IDictionaryEnumerator
// that iterates through the SortedSet
using System;
using System.Collections.Generic;

class GFG {

    // Driver code
    public static void Main()
    {

        // Creating a SortedSet of integers
        SortedSet<int> mySortedSet = new SortedSet<int>();

        // adding elements in mySortedSet
        mySortedSet.Add(2);
        mySortedSet.Add(4);
        mySortedSet.Add(6);
        mySortedSet.Add(8);
        mySortedSet.Add(10);

        // To get an Enumerator
        // for the SortedSet
        SortedSet<int>.Enumerator em = mySortedSet.GetEnumerator();
        display(em);
    }

    // display method
    static void display(IEnumerator<int> em)
    {
        while (em.MoveNext()) {
            int val = em.Current;
            Console.WriteLine(val);
        }
    }
}

Output:

2
4
6
8
10

Example 2:

// C# code to get an IDictionaryEnumerator
// that iterates through the SortedSet
using System;
using System.Collections.Generic;

class GFG {

    // Driver code
    public static void Main()
    {

        // Creating a SortedSet of integers
        SortedSet<string> mySortedSet = new SortedSet<string>();

        // adding elements in mySortedSet
        mySortedSet.Add("C#");
        mySortedSet.Add("PHP");
        mySortedSet.Add("HTML");
        mySortedSet.Add("Java");
        mySortedSet.Add("C++");

        // To get an Enumerator
        // for the SortedSet
        SortedSet<string>.Enumerator em = mySortedSet.GetEnumerator();
        display(em);
    }

    // display method
    static void display(IEnumerator<string> em)
    {
        while (em.MoveNext()) {
            string val = em.Current;
            Console.WriteLine(val);
        }
    }
}

Output:

C#
C++
HTML
Java
PHP

Note:

• The foreach statement of the C# language hides the complexity of the enumerators. Therefore, using foreach is recommended, instead of directly manipulating the enumerator.
• Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.
• Current returns the same object until either MoveNext or Reset is called. MoveNext sets Current to the next element.
• An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined.
• This method is an O(log n) operation.

Reference:

• https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.sortedset-1.getenumerator?view=netframework-4.7.2