STD::INSERT_ITERATOR(3cxx)

💅 std::insert_iterator< _Container > 💅

okay so you opened the std::insert_ite...r< _Container >(3cxx) manual page, bestie, and honestly? iconic. this one is all about turning assignment into insertion, no cap ✨.

✨ NAME ✨

std::insert_iterator< _Container > — turns assignment into insertion 💖

🌸 SYNOPSIS 🌸

#include <iterator>

Inherits std::iterator< output_iterator_tag, void, void, void, void >.

🎀 Public Types 🎀

• typedef _Container container_type — a nested typedef for the type of whatever container you used, periodt.
• using difference_type = ptrdiff_t
• typedef output_iterator_tag iterator_category — one of the tag types.
• typedef void pointer — this type represents a pointer-to-value_type.
• typedef void reference — this type represents a reference-to-value_type.
• typedef void value_type — the type 'pointed to' by the iterator.

🦋 Public Member Functions 🦋

• constexpr insert_iterator (_Container &__x, _Iter __i)
• constexpr insert_iterator & operator* () — simply returns *this.
• constexpr insert_iterator & operator++ () — simply returns *this. (this iterator does not move.)
• constexpr insert_iterator & operator++ (int) — simply returns *this. (this iterator does not move.)
• constexpr insert_iterator & operator= (const typename _Container::value_type &__value)
• constexpr insert_iterator & operator= (typename _Container::value_type &&__value)

🌈 Protected Attributes 🌈

• _Container * container
• _Iter iter

💖 Detailed Description 💖

template<typename _Container>
    class std::insert_iterator< _Container >

Turns assignment into insertion. literally its whole brand 💅.

These are output iterators, constructed from a container-of-T. Assigning a T to the iterator inserts it in the container at the iterator's position, rather than overwriting the value at that position.

(Sequences will actually insert a copy of the value before the iterator's position.) lowkey important, bestie 🫶.

Tip: Using the inserter function to create these iterators can save typing. your fingers will thank you 😌.

🦋 Member Typedef Documentation 🦋

• template<typename _Container > typedef _Container std::insert_iterator< _Container >::container_type — a nested typedef for the type of whatever container you used.
• typedef output_iterator_tag std::iterator< output_iterator_tag , void , void , void , void >::iterator_category [inherited] — one of the tag types.
• typedef void std::iterator< output_iterator_tag , void , void , void , void >::pointer [inherited] — this type represents a pointer-to-value_type.
• typedef void std::iterator< output_iterator_tag , void , void , void , void >::reference [inherited] — this type represents a reference-to-value_type.
• typedef void std::iterator< output_iterator_tag , void , void , void , void >::value_type [inherited] — the type 'pointed to' by the iterator.

🧚 Constructor & Destructor Documentation 🧚

template<typename _Container > constexpr std::insert_iterator< _Container >::insert_iterator (_Container & __x, _Iter __i) [inline],  [constexpr]

The only way to create this iterator is with a container and an initial position (a normal iterator into the container). that's the whole entrance exam, bestie 🎀.

🔥 Member Function Documentation 🔥

template<typename _Container > constexpr insert_iterator & std::insert_iterator< _Container >::operator* () [inline],  [constexpr]

Simply returns *this. no thoughts, just *this 💅.

template<typename _Container > constexpr insert_iterator & std::insert_iterator< _Container >::operator++ () [inline],  [constexpr]

Simply returns *this. (This iterator does not move.) it's giving stationary main character energy ⭐.

template<typename _Container > constexpr insert_iterator & std::insert_iterator< _Container >::operator++ (int) [inline],  [constexpr]

Simply returns *this. (This iterator does not move.) same vibe, postfix edition ✨.

template<typename _Container > constexpr insert_iterator & std::insert_iterator< _Container >::operator= (const typename _Container::value_type & __value) [inline],  [constexpr]

• Parameters: __value — an instance of whatever type container_type::const_reference is; presumably a reference-to-const T for container<T>.
• Returns: this iterator, for chained operations 🫶.

This kind of iterator maintains its own position in the container. Assigning a value to the iterator will insert the value into the container at the place before the iterator.

The position is maintained such that subsequent assignments will insert values immediately after one another. For example:

// vector v contains A and Z

insert_iterator i (v, ++v.begin());
i = 1;
i = 2;
i = 3;

// vector v contains A, 1, 2, 3, and Z

and that's the flex: assignments line up one after another, no chaos 😭🔥.

the other operator= overload, typename _Container::value_type &&__value, is listed up in Public Member Functions; this docs section only spells out the const-ref one, iykyk.

👑 Author 👑

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

---

mwah 💋 this page's cute little sign-off is literally libststd::insert_ite...r< _Container >(3cxx), and the source/version vibe is: generated automatically by Doxygen for libstdc++ from the source code. date? not on this page, bestie — we're not inventing one, periodt 🌸🫶.