Skip to content

Conversation

RaimoNiskanen
Copy link
Contributor

This PR adds functions rand:shuffle/1 and rand:shuffle_s/2 due to a discussion on ErlangForums: https://erlangforums.com/t/random-sort-should-be-included-in-the-lists-module/5125

There are 4 algorithms in the first commit. The suggested winner is the one remaining in the second commit.

Documentation and test cases are still missing...

@RaimoNiskanen RaimoNiskanen added this to the OTP-29.0 milestone Oct 14, 2025
@RaimoNiskanen RaimoNiskanen requested a review from bjorng October 14, 2025 14:54
@RaimoNiskanen RaimoNiskanen self-assigned this Oct 14, 2025
@RaimoNiskanen RaimoNiskanen added team:VM Assigned to OTP team VM team:PS Assigned to OTP team PS feature in progress priority:medium labels Oct 14, 2025
Copy link
Contributor

github-actions bot commented Oct 14, 2025

CT Test Results

No tests were run for this PR. This is either because the build failed, or the PR is based on a branch without GH actions tests configured.

Results for commit 0280798

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

Copy link
Contributor

@bjorng bjorng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: I don't know whether you intend to keep the first commit. In case you do, the last paragraph is missing a closing parenthesis, and the word "ridiculous" is misspelled.

@RaimoNiskanen RaimoNiskanen force-pushed the raimo/stdlib/rand-shuffle branch from 70efe49 to aba9094 Compare October 15, 2025 07:55
@RaimoNiskanen RaimoNiskanen force-pushed the raimo/stdlib/rand-shuffle branch from aba9094 to 0280798 Compare October 15, 2025 10:33
Write a few shuffle algorithms for comparison.

I have found no formal statement that it is bias free,
but have tried to reason around it.  The algorithm should be
equivalent to generating more random decimals to decide
the shuffle order for elements with the same random number.
It should make no difference if the random decimals are generated
always and ignored, or when needed.

Speed: 1.2 s for 2^20 integers on my laptop.

The classical textbook shuffle.

Speed: 5 s for 2^20 integers on my laptop.

Quite a beautiful algorithm since the `gb_tree` has all
the functionality in itself.

Speed: 5 s for 2^20 integers on my laptop.

The same as the `gb_tree` above, but with a map.  Uses
the map key order instead of the general term order,
which works just fine.

Speed: 2 s for 2^20 integers on my laptop.

Suggested by Richard A. O'Keefe on ErlangForums as
"a random variant of Quicksort".  Shall we name it Quickshuffle?

Really fast. Uses random numbers efficiently by looking at
individual bits for the random split.  Has no overhead
for tagging.  Just creates intermediate lists as garbage.

This generator appears to be equivalent with shuffle1,
using a random number generator with 1 bit.

Speed: 0.8 s for 2^20 integers on my laptop.

The classical textbook shuffle.

Our standard `array` module here outperforms map, probably
because keys does not have to be stored, they are implicit.

Speed: 2 s for 2^20 integers on my laptop.

shuffle3 and shuffle4 have the theoretical limitation that
when the length of the list approaches the generator size,
it will take catastrophically much longer time to generate
a random number that has not been used.

There is no check for the list length being larger than
the generator size in which case it will be impossible
to generate unique random numbers for all list elements,
and the algorithm will simply keep on failing forever.
This is for now a theoretical problem since already for
a list length with log half the generator size
(e.g 2^28 with a generator size 2^56), my laptop
runs out of memory with a VM of about 30 GB.

shuffle1 and shuffle5 avoids that limitation.  shuffle1 by recursing
over the duplicates sublists so it is not affected much
by fairly long lists of duplicates, shuffle5 by using only
individual bits and ranges 2, 6, or 24.

The classical Fisher-Yates algorithm in shuffle2 and shuffle6
does not have this limitation, but generating random numbers
of unlimited length gets increasingly expensive, but should not be
any problem for 2 or even 4 times the generator length, that is
list lengths of well over 2^200, which is well over ridiculous.
@RaimoNiskanen RaimoNiskanen force-pushed the raimo/stdlib/rand-shuffle branch from 0280798 to a536947 Compare October 16, 2025 14:17
@RaimoNiskanen
Copy link
Contributor Author

New algorithm selected. "Quickshuffle"?

%%
%% Randomly split the list in two lists,
%% recursively shuffle the two smaller lists,
%% randomize the order between the lists according to their size.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is no longer correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature in progress priority:medium team:PS Assigned to OTP team PS team:VM Assigned to OTP team VM

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants