std::back_insert_iterator(3)

NAME
std::back_insert_iterator - 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.
typedef output_iterator_tag iterator_category
One of the tag types.
typedef void value_type
The type 'pointed to' by the iterator.
typedef void difference_type
Distance between iterators is represented as this type.
typedef void pointer
This type represents a pointer-to-value_type.
typedef void reference
This type represents a reference-to-value_type.

  Public Member Functions
back_insert_iterator (_Container &__x)
The only way to create this iterator is with a container.
back_insert_iterator & operator= (typename _Container::const_reference __value)
back_insert_iterator & operator * ()
Simply returns *this.
back_insert_iterator & operator++ ()
Simply returns *this. (This iterator does not 'move'.).
back_insert_iterator operator++ (int)
Simply returns *this. (This iterator does not 'move'.).

Detailed Description

  template<typename _Container> class std::back_insert_iterator< _Container >
Turns assignment into insertion. These are output iterators, constructed from a container-of-T. Assigning a T to the iterator appends it to the container using push_back.

Tip: Using the back_inserter function to create these iterators can save typing.

Definition at line 330 of file iterator.

Member Typedef Documentation

  template<typename _Container> typedef _Container std::back_insert_iterator< _Container >::container_type

A nested typedef for the type of whatever container you used.

Definition at line 338 of file iterator.

  typedef void std::iterator< output_iterator_tag, void, void, void, void >::difference_type [inherited]

Distance between iterators is represented as this type.

Definition at line 111 of file stl_iterator_base_types.h.

  typedef output_iterator_tag std::iterator< output_iterator_tag, void, void, void, void >::iterator_category [inherited]

One of the tag types.

Definition at line 107 of file stl_iterator_base_types.h.

  typedef void std::iterator< output_iterator_tag, void, void, void, void >::pointer [inherited]

This type represents a pointer-to-value_type.

Definition at line 113 of file stl_iterator_base_types.h.

  typedef void std::iterator< output_iterator_tag, void, void, void, void >::reference [inherited]

This type represents a reference-to-value_type.

Definition at line 115 of file stl_iterator_base_types.h.

  typedef void std::iterator< output_iterator_tag, void, void, void, void >::value_type [inherited]

The type 'pointed to' by the iterator.

Definition at line 109 of file stl_iterator_base_types.h.

Constructor & Destructor Documentation

  template<typename _Container> std::back_insert_iterator< _Container >::back_insert_iterator (_Container & __x) [inline, explicit]

The only way to create this iterator is with a container.

Definition at line 342 of file iterator.

Member Function Documentation

  template<typename _Container> back_insert_iterator& std::back_insert_iterator< _Container >::operator * () [inline]

Simply returns *this.

Definition at line 364 of file iterator.

  template<typename _Container> back_insert_iterator std::back_insert_iterator< _Container >::operator++ (int) [inline]

Simply returns *this. (This iterator does not 'move'.).

Definition at line 372 of file iterator.

  template<typename _Container> back_insert_iterator& std::back_insert_iterator< _Container >::operator++ () [inline]

Simply returns *this. (This iterator does not 'move'.).

Definition at line 368 of file iterator.

  template<typename _Container> back_insert_iterator& std::back_insert_iterator< _Container >::operator= (typename _Container::const_reference __value) [inline]

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 doesn't really have a 'position' in the container (you can think of the position as being permanently at the end, if you like). Assigning a value to the iterator will always append the value to the end of the container.

Definition at line 356 of file iterator.

Author

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