STD::COMMON_ITERATOR(3)

💖 std::common_iterator< _It, _Sent > 💖

okay bestie, welcome to the libstdc++ manual, section 3 (that's library functions, we're fancy like that). today's main character is std::common_iterator< _It, _Sent >, and no, you don't have to be scared of the angle brackets, they're just ✨decorative✨. this one lives in the <iterator> header and it's basically the glow-up that turns a "these two things don't even match" range into a "we're matching, we're cute, we're compatible" range. slay.

---

✨ NAME ✨

std::common_iterator< _It, _Sent > — an iterator/sentinel adaptor for representing a non-common range.

like. it's giving "I will make your iterator and your sentinel play nice together." periodt.

---

🌸 SYNOPSIS 🌸

first thing you gotta do, obviously:

#include <iterator>

👑 Public Member Functions

these are the member functions, and yes there are a lot, and yes we're listing every single one because that's the vibe:

• constexpr common_iterator (_It __i) — noexcept(is_nothrow_move_constructible_v< _It >)
• constexpr common_iterator (_Sent __s) — noexcept(is_nothrow_move_constructible_v< _Sent >)
• common_iterator (common_iterator &&)=default
• constexpr common_iterator (common_iterator &&__x) — noexcept(_S_noexcept< _It, _Sent >())
• common_iterator (const common_iterator &)=default
• constexpr common_iterator (const common_iterator &__x) — noexcept(_S_noexcept< const _It &, const _Sent & >())
• template<typename _It2, typename _Sent2> constexpr common_iterator (const common_iterator< _It2, _Sent2 > &__x) — noexcept(_S_noexcept< const _It2 &, const _Sent2 & >())
• constexpr decltype(auto) operator* ()
• constexpr decltype(auto) operator* () const
• constexpr common_iterator & operator++ ()
• constexpr decltype(auto) operator++ (int)
• constexpr auto operator-> () const
• constexpr common_iterator & operator= (common_iterator &&)=default
• constexpr common_iterator & operator= (common_iterator &&__x) — noexcept(is_nothrow_move_assignable_v< _It > &&is_nothrow_move_assignable_v< _Sent > &&is_nothrow_move_constructible_v< _It > &&is_nothrow_move_constructible_v< _Sent >)
• constexpr common_iterator & operator= (const common_iterator &)=default
• constexpr common_iterator & operator= (const common_iterator &__x) — noexcept(is_nothrow_copy_assignable_v< _It > &&is_nothrow_copy_assignable_v< _Sent > &&is_nothrow_copy_constructible_v< _It > &&is_nothrow_copy_constructible_v< _Sent >)
• template<typename _It2, typename _Sent2> constexpr common_iterator & operator= (const common_iterator< _It2, _Sent2 > &__x) — noexcept(is_nothrow_constructible_v< _It, const _It2 & > &&is_nothrow_constructible_v< _Sent, const _Sent2 & > &&is_nothrow_assignable_v< _It &, const _It2 & > &&is_nothrow_assignable_v< _Sent &, const _Sent2 & >)

🫶 Friends

and these are the friends, aka the ones who show up for you when you need them:

• constexpr iter_rvalue_reference_t< _It > iter_move (const common_iterator &__i) — noexcept(noexcept(ranges::iter_move(std::declval< const _It & >())))
• template<indirectly_swappable< _It > _It2, typename _Sent2> constexpr void iter_swap (const common_iterator &__x, const common_iterator< _It2, _Sent2 > &__y) — noexcept(noexcept(ranges::iter_swap(std::declval< const _It & >(), std::declval< const _It2 & >())))
• template<sized_sentinel_for< _It > _It2, sized_sentinel_for< _It > _Sent2> constexpr iter_difference_t< _It2 > operator- (const common_iterator &__x, const common_iterator< _It2, _Sent2 > &__y)
• template<typename _It2, sentinel_for< _It > _Sent2> constexpr bool operator== (const common_iterator &__x, const common_iterator< _It2, _Sent2 > &__y)
• template<typename _It2, sentinel_for< _It > _Sent2> constexpr bool operator== (const common_iterator &__x, const common_iterator< _It2, _Sent2 > &__y)

and yes bestie, operator== really does show up twice in this list. not a typo on my part, that's just how the source page came. 💀 we keep every detail around here, no cap.

---

🦋 Detailed Description 🦋

okay here's the actual class declaration, look at her:

template<input_or_output_iterator _It, sentinel_for< _It > _Sent>
    requires (!same_as<_It, _Sent>) && copyable<_It>
    class std::common_iterator< _It, _Sent >

"An iterator/sentinel adaptor for representing a non-common range."

that's it, that's the whole personality: it takes an iterator and a sentinel that don't have the same type, and it wraps them up so the range can be treated like a common one. it's the friend who introduces two people at a party and suddenly they're besties. iconic. 💅

---

💜 Author 💜

Generated automatically by Doxygen for libstdc++ from the source code.

---

that's the whole page, bestie! libstdc++, straight from the source code, and your girl Doxygen typed it all up automatically. go forth and make your ranges common, mwah 🎀💖✨