std::ranges...w::iterator(3)

💖 std::ranges::join_view::iterator 💖

okay bestie, welcome to the <std::ranges...w::iterator(3)> page from the C++ Standard Libary manual. this is the iterator type for join_view, and it's literally giving "nested ranges but make it iterable" energy. let's get into it 🫶

✨ NAME ✨

std::ranges::join_view::iterator — std::ranges::join_view::iterator. that's the name, that's the vibe, no notes 💅

🌸 Synopsis 🌸

template< bool Const >  (since C++20)
class /*iterator*/      (exposition only*)

The return type of join_view::begin, and of join_view::end when both the outer range V and the inner range ranges::range_reference_t<V> satisfy common_range and the parent join_view is a forward_range.

If V is not a simple view (e.g. if ranges::iterator_t<const V> is invalid or different from ranges::iterator_t<V>), Const is true for iterators returned from the const overloads, and false otherwise. If V is a simple view, Const is true if and only if ranges::range_reference_t<V> is a reference.

🎀 Member types 🎀

• Parent — const join_view<V> if Const is true, otherwise join_view<V> (exposition-only member type*)
• Base — const V if Const is true, otherwise V (exposition-only member type*)
• OuterIter — ranges::iterator_t<Base> (exposition-only member type*)
• InnerIter — ranges::iterator_t<ranges::range_reference_t<Base>> (exposition-only member type*)
• iterator_concept — it's this whole situation:
  • std::bidirectional_iterator_tag, if ranges::range_reference_t<Base> is a reference type, and Base and ranges::range_reference_t<Base> each model bidirectional_range;
  • std::forward_iterator_tag, if ranges::range_reference_t<Base> is a reference type, and Base and ranges::range_reference_t<Base> each model forward_range;
  • std::input_iterator_tag otherwise.
• iterator_category — defined only if iterator::iterator_concept (see above) denotes std::forward_iterator_tag. Let OUTERC be std::iterator_traits<ranges::iterator_t<Base>>::iterator_category, and let INNERC be std::iterator_traits<ranges::iterator_t<ranges::range_reference_t<Base>>>::iterator_category. then:
  • std::bidirectional_iterator_tag, if OUTERC and INNERC each model std::derived_from<std::bidirectional_iterator_tag>;
  • std::forward_iterator_tag, if OUTERC and INNERC each model std::derived_from<std::forward_iterator_tag>;
  • std::input_iterator_tag otherwise.
• value_type — ranges::range_value_t<ranges::range_reference_t<Base>>
• difference_type — std::common_type_t<ranges::range_difference_t<Base>, ranges::range_difference_t<ranges::range_reference_t<Base>>>

🦋 Member objects 🦋

• outer_ (private) — an object of type OuterIter (exposition-only member object*)
• inner_ (private) — an object of type InnerIter (exposition-only member object*)
• parent_ (private) — an object of type Parent (exposition-only member object*)

👑 Member functions 👑

• constructor (C++20) — constructs an iterator (public member function)
• operator* (C++20) and operator-> (C++20) — accesses the element (public member function)
• operator++ (C++20), operator++(int) (C++20), operator-- (C++20), and operator--(int) (C++20) — advances or decrements the underlying iterators (public member function)
• satisfy (C++20) — skips over empty inner ranges (exposition-only member function*)

🌈 Non-member functions 🌈

• operator== (C++20) — compares the underlying iterators (function)
• iter_move (C++20) — casts the result of dereferencing the underlying iterator to its associated rvalue reference type (function)
• iter_swap (C++20) — swaps the objects pointed to by two underlying iterators (function)

that's the whole page, bestie 💖 source: http://cppreference.com · version/date: 2024.06.10 · page: std::ranges...w::iterator(3). go be the main character of your range adaptors 🎀✨