std::experimental::shuffle(3)

🎀 NAME 🎀

std::experimental::shuffle — std::experimental::shuffle. That’s literally the name, bestie. Iconic behavior, no notes. 💅

okay so this is the std::experimental::shuffle(3) page from the C++ Standard Libary manual — yes, “Libary,” that’s how it’s spelled in the header, I’m not fixing it 🫶.

---

✨ Synopsis ✨

Defined in header <experimental/algorithm>, and the vibe is library fundamentals TS v2:

Defined in header <experimental/algorithm>
template< class RandomIt >                      (library fundamentals
TS v2)
void shuffle( RandomIt first, RandomIt last );

The way this works: it reorders the elements in the given range [first, last) so that each possible permutation of those elements has equal probability of appearance, using the per-thread random number engine as the random number generator. That’s the whole slay. 🌸

---

💖 Parameters 💖

• first, last — the range of elements to shuffle randomly.
• RandomIt — must meet the requirements of ValueSwappable and LegacyRandomAccessIterator.

---

🫶 Return value 🫶

(none) — that’s the whole return value section, bestie. Nothing comes back. 💀

---

🔥 Complexity 🔥

Linear in the distance between first and last. Lowkey efficient, highkey iconic. ✨

---

🌈 Example 🌈

// Run this code — yes bestie, run it, live a little 💅

#include <experimental/algorithm>
#include <iostream>
#include <string>

int main()
{
    std::string sample{"ABCDEF"};

    for (int i = 0; i != 4; ++i)
    {
        std::experimental::shuffle(sample.begin(), sample.end());
        std::cout << sample << '\n';
    }
}

Possible output:

DACBFE
CDFBAE
BDCAFE
BAFCED

---

👑 See also 👑

• random_shuffle — randomly re-orders elements in a range; function template; until C++17.
• shuffle — randomly re-orders elements in a range; function template; C++11.

---

later bestie 💖 — source: http://cppreference.com; version/date: 2024.06.10. mwah, periodt. 🎀