snippetboy / Permutations

Generating all N! permutations of the numbers 0 to N-1.

Permutations

Generating all N! permutations of the numbers 0 to N-1.

• Algorithms
• Performance
• Usage
• Restrictions

Algorithms

This repository provides C# implementations for three well-known algorithms:

• Trotter's algorithm (1962)
• Heap's algorithm (1963)
• Ord-Smith's algorithm (1968)

All implementations are non-recursive and take advantage of the yield keyword, i.e. each permutation is calculated only when requested. Ord-Smith's algorithm is also lexicographically ordered.

Algorithm	Non-recursive	Iterated	Ordered
Trotter	yes	yes	no
Heap	yes	yes	no
Ord-Smith	yes	yes	yes

Performance

If you don't need an ordered list of permutations, Trotter's algorithm would be the best choice for large N.

N	N!	Passes	Trotter	Heap	Ord-Smith
1	1	10000000	759 ms	722 ms	676 ms
2	2	10000000	1051 ms	845 ms	872 ms
3	6	10000000	1637 ms	1345 ms	1454 ms
4	24	10000000	4555 ms	3812 ms	3999 ms
5	120	1000000	1658 ms	1640 ms	1726 ms
6	720	100000	889 ms	938 ms	985 ms
7	5040	100000	6718 ms	6410 ms	6857 ms
8	40320	10000	5027 ms	5621 ms	5463 ms
9	362880	1000	4918 ms	4836 ms	4898 ms
10	3628800	100	4852 ms	4821 ms	4894 ms
11	39916800	10	5235 ms	5302 ms	5377 ms
12	479001600	1	6235 ms	6449 ms	6438 ms

^{(Running 64-bit application on Intel64 Family 6 Model 60 Stepping 3 GenuineIntel ~2494 MHz)}

Usage

Example 1:

  foreach (int[] permutation in Permutations.OrdSmith(3))
  {
    Console.WriteLine(string.Join(',', permutation));
  }

Output:

0,1,2
0,2,1
1,0,2
1,2,0
2,0,1
2,1,0

Example 2:

It also works for large arguments:

  foreach (int[] permutation in Permutations.OrdSmith(40))
  {
    Console.WriteLine(string.Join(',', permutation));
  }

Output:

0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,39,38
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,38,37,39
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,38,39,37
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,39,37,38
0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,39,38,37
...

Restrictions

Don't change the iterated array!

You're not allowed to change the permutation array returned by the iterator:

  foreach (int[] permutation in Permutations.Trotter(10))
  {
    // Don't change the array!
    Array.Fill(permutation, 0);
  }

The iterator directly returns the internal array of the algorithm. It would take too much performance to return a shadow copy of the array.

Don't convert enumerations to collections for large N!

Although example 2 works, it's strongly recommended not to do the following for obvious reasons:

  // Don't do that!
  Permutations.OrdSmith(40).ToList()

It would (try to) generate a list of 815915283247897734345611269596115894272000000000 entries.