Click here to Skip to main content
15,867,765 members
Articles / Programming Languages / C#

A C# List Permutation Iterator

Rate me:
Please Sign up or sign in to vote.
4.71/5 (5 votes)
14 Nov 2009CPOL 53.8K   16   13
An iterator in C# which iterates over all permutations of a given IList.

Introduction

In this article, I will present a compact, easy to use method for iterating over all permutations of a given sequence. The iteration modifies the internal order of the sequence, visiting all permutations, and eventually restoring the original order (if the enumeration process is followed through).

Using the code

The implementation of the iterator is recursive; the recursion terminal condition is when the list has only one element, in which case, it is simply returned. In the recursive case, we iterate (n) times doing a recursive call to permutate the list's first (n-1) elements, and performing a rotate-right after each iteration.

Since each full enumeration eventually restores the sequence to its original order, the rotate-right is guaranteed to position a different element at the end of the sequence each time.

C#
public static void RotateRight(IList sequence, int count)
{
    object tmp = sequence[count-1];
    sequence.RemoveAt(count - 1);
    sequence.Insert(0, tmp);
}

public static IEnumerable<IList> Permutate(IList sequence, int count)
{
    if (count == 1) yield return sequence;
    else
    {
        for (int i = 0; i < count; i++)
        {
            foreach (var perm in Permutate(sequence, count - 1))
                yield return perm;
            RotateRight(sequence, count);
        }
    }
}

Here is how we use this code to permutate a list of integers:

C#
static void PermutateIntegersTest()
{
    List<int> seq = new List<int>() { 1, 2, 3, 4 };
    foreach (var permu in Permutate(seq, seq.Count))
    {
        foreach (var i in permu)
            Console.Write(i.ToString() + " ");
        Console.WriteLine();
    }
}

Or to permutate a string:

C#
using System.Linq; // For the ToList() and ToArray() extension methods.

static void PermutateStringTest()
{
    string a = "word";
    foreach (List<char> perm in Permutate(a.ToCharArray().ToList(), a.Length))
    {
        string s = new string(perm.ToArray());
        Console.Write(s + "\t");
    }
    Console.WriteLine();
}

Remember that this implementation actually modifies the order of items in the sequence, and if that is not desired, a copy of the sequence must be made before the iteration is started.

That's it, enjoy.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
Israel Israel
Software developer since 1984, currently specializing in C# and .NET.

Comments and Discussions

 
QuestionHow to find every permutations of a List<Vector2> object and then a specific permutation? Pin
Member 132872312-Jul-17 13:50
Member 132872312-Jul-17 13:50 
GeneralMy vote of 5 Pin
Andira Muttakim12-Jan-14 3:47
professionalAndira Muttakim12-Jan-14 3:47 
GeneralPermutate() arguments Pin
Seth Morris21-Nov-09 23:02
Seth Morris21-Nov-09 23:02 
GeneralRecursion Pin
PIEBALDconsult19-Nov-09 10:32
mvePIEBALDconsult19-Nov-09 10:32 
GeneralRe: Recursion Pin
Aviad P.20-Nov-09 8:41
Aviad P.20-Nov-09 8:41 
It seems I have angered the anti-recursion police Smile | :)

I will seek a non-recursive implementation as per your advice.

Thanks.
GeneralRe: Recursion Pin
George I. Birbilis31-Oct-11 4:54
George I. Birbilis31-Oct-11 4:54 
GeneralRe: Recursion Pin
George I. Birbilis31-Oct-11 5:06
George I. Birbilis31-Oct-11 5:06 
GeneralRe: Recursion Pin
Mr.PoorEnglish9-Oct-13 11:20
Mr.PoorEnglish9-Oct-13 11:20 
GeneralRe: Recursion Pin
George I. Birbilis13-Mar-14 21:41
George I. Birbilis13-Mar-14 21:41 
GeneralRe: Recursion Pin
George I. Birbilis13-Mar-14 21:49
George I. Birbilis13-Mar-14 21:49 
GeneralSimilar to C++ STL Pin
Fredrik B17-Nov-09 3:01
Fredrik B17-Nov-09 3:01 
GeneralNeeds More Pin
#realJSOP15-Nov-09 1:36
mve#realJSOP15-Nov-09 1:36 
GeneralRe: Needs More Pin
Aviad P.15-Nov-09 2:07
Aviad P.15-Nov-09 2:07 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.