std::back_insert_iterator

From cppreference.com
< cpplrm; | iterator
Defined in header <iterator>
template< class Container >

class back_insert_iterator : public std::iterator< std::output_iterator_tag,

void, void, void, void >
(until C++17)
template< class Container >
class back_insert_iterator;
(since C++17)

std::back_insert_iterator is an OutputIterator that appends to a container for which it was constructed. The container's push_back() member function is called whenever the iterator (whether dereferenced or not) is assigned to. Incrementing the std::back_insert_iterator is a no-op.

Member types

Member type Definition
container_type Container

Member functions

constructs a new back_insert_iterator
(public member function)
inserts an object into the associated container
(public member function)
no-op
(public member function)
no-op
(public member function)

Member objects

Member name Definition
container (protected) a pointer of type Container*

Member types

Member type Definition
value_type void
difference_type void
pointer void
reference void
iterator_category std::output_iterator_tag

These member types are required to be obtained by inheriting from std::iterator<std::output_iterator_tag,void,void,void,void>.

(until C++17)

Example

#include <iostream>
#include <iterator>
#include <algorithm>
#include <vector>

int main()
{
    std::vector<int> v;
    std::generate_n(std::back_insert_iterator<std::vector<int>>(v), // can be simplified
                    10, [n=0]() mutable { return ++n; });        // with std::back_inserter
    for (int n : v)
        std::cout << n << ' ';
    std::cout << '\n';
}

Output:

1 2 3 4 5 6 7 8 9 10

See also

creates a std::back_insert_iterator of type inferred from the argument
(function template)
iterator adaptor for insertion at the front of a container
(class template)
iterator adaptor for insertion into a container
(class template)