Fast batch generation of permutations

Version 1.0.0.0 (4.56 KB) by Peter Li
Get next block of lexicographic permutations of input vector
420 Downloads
Updated 23 Dec 2013

View License

I simply wrapped the C++ STL function next_permutation in Mex. To use, first compile for your system with 'mex nextperms.cpp'.

See nextperms.m and nextperms_example_script.m for documentation.

Typical use case would be you need to iterate through a large number of permutations that will not all fit in memory at once. You could call this in a loop, requesting blocks of 1M permutations each or so.

(This is also significantly faster than Matlab's perms on my system just for generating all permutations, although it does not generate them in the same order.)

You pass in an initial vector and a number of next permutations to generate. If the first input isn't a vector it is treated as a vector column-wise. You can use any numeric type (if you want long long / int64 you have to uncomment some code lines).

The permutations are returned as a matrix columnwise. They are generated in lexicographic order (as per STL spec). The initial vector passed in is not included in the output; output starts at the next permutation after the input vector.

** IMPORTANT **
There is currently no check for when the permutations wrap back around to the initial permutation, so it is the user's responsibility to check for this or only request an appropriate number of permutations.

If you're not sure how to use this after looking at nextperms.m and nextperms_example_script.m, try just running it on some small inputs and inspecting the results: nextperms(3:-1:1, 4); nextperms(3:-1:1, factorial(3)); nextperms(3:-1:1, factorial(3)*2);

Cite As

Peter Li (2024). Fast batch generation of permutations (https://www.mathworks.com/matlabcentral/fileexchange/44785-fast-batch-generation-of-permutations), MATLAB Central File Exchange. Retrieved .

MATLAB Release Compatibility
Created with R2012a
Compatible with any release
Platform Compatibility
Windows macOS Linux
Categories
Find more on MATLAB Compiler in Help Center and MATLAB Answers
Acknowledgements

Inspired by: nextperm, Next Combination/Permutation

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!
Version Published Release Notes
1.0.0.0