STD::ITERATOR(3)

💖 NAME 💖

std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference > — Common iterator class.

okay so bestie, this is straight out of the Library Functions Manual, and it's literally the blueprint every iterator class wants to be when it grows up. no cap. 💅

---

✨ SYNOPSIS ✨

#include <iterator>

Inherited by std::reverse_iterator< iterator >, and std::reverse_iterator< const_iterator >.

so like, reverse iterators? they're the nepo babies of this class. iconic behaviour fr fr. 👑

---

🎀 Public Types 🎀

• typedef _Distance difference_type — Distance between iterators is represented as this type.
• typedef _Category iterator_category — One of the tag types.
• typedef _Pointer pointer — This type represents a pointer-to-value_type.
• typedef _Reference reference — This type represents a reference-to-value_type.
• typedef _Tp value_type — The type "pointed to" by the iterator.

five typedefs, zero drama, all vibes. slay. ✨

---

🦋 Detailed Description 🦋

template<typename _Category, typename _Tp, typename _Distance = ptrdiff_t,
    typename _Pointer = _Tp*, typename _Reference = _Tp&>
    struct std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >

Common iterator class.

This class does nothing but define nested typedefs. Iterator classes can inherit from this class to save some work. The typedefs are then used in specializations and overloading.

the way that it literally does NOTHING except define typedefs… and that's the whole job. main character energy that doesn't even need a personality. 💀✨

In particular, there are no default implementations of requirements such as operator++ and the like. (How could there be?)

and the manpage itself hit us with the sass: "(How could there be?)" — honestly? ate. no notes. 🔥

---

💜 Member Typedef Documentation 💜

🌸 difference_type 🌸

template<typename _Category, typename _Tp, typename _Distance = ptrdiff_t,
    typename _Pointer = _Tp*, typename _Reference = _Tp&>
    typedef _Distance
    std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::difference_type

Distance between iterators is represented as this type.

it's giving "how far apart are we bestie" energy. 🫶

---

🌈 iterator_category 🌈

template<typename _Category, typename _Tp, typename _Distance = ptrdiff_t,
    typename _Pointer = _Tp*, typename _Reference = _Tp&>
    typedef _Category
    std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::iterator_category

One of the tag types.

tag types!! like friendship bracelets but for iterators. 🎀

---

⭐ pointer ⭐

template<typename _Category, typename _Tp, typename _Distance = ptrdiff_t,
    typename _Pointer = _Tp*, typename _Reference = _Tp&>
    typedef _Pointer
    std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::pointer

This type represents a pointer-to-value_type.

pointer to the value_type. we love a direct line of communication. ✨

---

🦋 reference 🦋

template<typename _Category, typename _Tp, typename _Distance = ptrdiff_t,
    typename _Pointer = _Tp*, typename _Reference = _Tp&>
    typedef _Reference
    std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::reference

This type represents a reference-to-value_type.

reference to the value_type. it's the pointer's emotionally available cousin. 💜

---

🍓 value_type 🍓

template<typename _Category, typename _Tp, typename _Distance = ptrdiff_t,
    typename _Pointer = _Tp*, typename _Reference = _Tp&>
    typedef _Tp
    std::iterator< _Category, _Tp, _Distance, _Pointer, _Reference >::value_type

The type "pointed to" by the iterator.

yes the quotes around "pointed to" are in the original and yes they're camp. keep them. 💅

---

👑 Author 👑

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

not a human author, just Doxygen doing its little robot thing. respect tho. 🤖✨

---

a lil sign-off bestie 🫶 — this whole page came from libstdc++, auto-generated by Doxygen straight from the source code, and it's filed under that std::itera...eference >(3) name (the header truncates it, the footer says it too, so you're not missing anything 💖). go build something cute with your typedefs, mwah. 🌸💅

periodt.