std::sortable(3)

🎀 NAME 🎀

okay so welcome to the std::sortable(3) page from the C++ Standard Libary 💅 bestie, this is the manual for std::sortable — yes, the NAME line is literally std::sortable - std::sortable, it's giving self-titled debut album and honestly? iconic ✨

🌸 Synopsis 🌸

std::sortable lives in the header <iterator>, and here's the exact signature vibe:

          Defined in header <iterator>
          template< class I, class Comp = ranges::less, class Proj =
          std::identity >

          concept sortable =
       (since C++20)
              std::permutable<I> &&

              std::indirect_strict_weak_order<Comp, std::projected<I, Proj>>;

So yeah: it's a concept (since C++20) and it's built from std::permutable<I> and std::indirect_strict_weak_order<Comp, std::projected<I, Proj>> — no cap, that's the whole formula 🧚

The sortable concept is basically the requirements checklist for algorithms that permute a range into an ordered range according to Comp. It's the vibe check for sort-ish algorithms 👑

🧠 Semantic requirements 🧠

std::sortable<I, Comp, Proj> is modeled only if all concepts it subsumes are modeled. That's it, that's the rule — if the concepts it subsumes aren't modeled, it's not modeled either, periodt 💀

👀 See also 👀

• ranges::sort — sorts a range into ascending order (C++20) (niebloid) 🔥
• ranges::stable_sort — sorts a range of elements while preserving order between equal elements (C++20) (niebloid) 🫶
• ranges::partial_sort — sorts the first N elements of a range (C++20) (niebloid) ✨
• ranges::nth_element — partially sorts the given range making sure that it is partitioned by the given element (C++20) (niebloid) 🦋
• ranges::inplace_merge — merges two ordered ranges in-place (C++20) (niebloid) 🌈
• ranges::push_heap — adds an element to a max heap (C++20) (niebloid) 💖
• ranges::pop_heap — removes the largest element from a max heap (C++20) (niebloid) 💅
• ranges::make_heap — creates a max heap out of a range of elements (C++20) (niebloid) 🎀
• ranges::sort_heap — turns a max heap into a range of elements sorted in ascending order (C++20) (niebloid) ⭐
• ranges::next_permutation — generates the next greater lexicographic permutation of a range of elements (C++20) (niebloid) 🍓
• ranges::prev_permutation — generates the next smaller lexicographic permutation of a range of elements (C++20) (niebloid) 🧚

---

Signed, sealed, delivered: source/version http://cppreference.com, date 2024.06.10, page std::sortable(3) — bye bestie, go sort something cute 💜🫶