std::front_insert_iterator(3)
NAME
std::front_insert_iterator
SYNOPSIS
Inherits std::iterator< std::output_iterator_tag, void, void, void, void >.
Detailed Description
- template<typename _Container> class std::front_insert_iterator< _Container
- >
Turns assignment into insertion. - These are output iterators, constructed from a container-of-T.
Assigning a T to the iterator prepends it to the container using push_front. - Tip: Using the front_inserter function to create these iterators can
save typing. - Definition at line 470 of file stl_iterator.h.
- Public Types
- typedef _Container container_type
typedef _Distance difference_type
typedef _Category iterator_category
typedef _Pointer pointer
typedef _Reference reference
typedef _Tp value_type - Public Member Functions
- front_insert_iterator (_Container &__x)
front_insert_iterator & operator* ()
front_insert_iterator operator++ (int)
front_insert_iterator & operator++ ()
front_insert_iterator & operator= (typename _Container::const_reference
__value)
- Protected Attributes
- _Container * container
Member Typedef Documentation
- template<typename _Container> typedef _Container
- std::front_insert_iterator< _Container >::container_type A nested typedef for the type of whatever container you used.
- Definition at line 478 of file stl_iterator.h.
- 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 [inherited] Distance between iterators is represented as this type.
- Reimplemented in std::reverse_iterator< _Iterator >.
- Definition at line 117 of file stl_iterator_base_types.h.
- 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 [inherited] One of the tag types.
- Definition at line 113 of file stl_iterator_base_types.h.
- 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 [inherited]
This type represents a pointer-to-value_type. - Reimplemented in std::reverse_iterator< _Iterator >.
- Definition at line 119 of file stl_iterator_base_types.h.
- 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 [inherited] This type represents a reference-to-value_type.
- Reimplemented in std::reverse_iterator< _Iterator >.
- Definition at line 121 of file stl_iterator_base_types.h.
- 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 [inherited] The type 'pointed to' by the iterator.
- Definition at line 115 of file stl_iterator_base_types.h.
Constructor & Destructor Documentation
- template<typename _Container> std::front_insert_iterator< _Container
- >::front_insert_iterator (_Container & __x) [inline, explicit] The only way to create this iterator is with a container.
- Definition at line 481 of file stl_iterator.h.
Member Function Documentation
- template<typename _Container> front_insert_iterator&
- std::front_insert_iterator< _Container >::operator* () [inline] Simply returns *this.
- Definition at line 512 of file stl_iterator.h.
- template<typename _Container> front_insert_iterator
- std::front_insert_iterator< _Container >::operator++ (int) [inline] Simply returns *this. (This iterator does not 'move'.).
- Definition at line 522 of file stl_iterator.h.
- template<typename _Container> front_insert_iterator&
- std::front_insert_iterator< _Container >::operator++ () [inline] Simply returns *this. (This iterator does not 'move'.).
- Definition at line 517 of file stl_iterator.h.
- template<typename _Container> front_insert_iterator&
- std::front_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 front, if
you like). Assigning a value to the iterator will always prepend the
value to the front of the container. - Definition at line 495 of file stl_iterator.h.
Author
- Generated automatically by Doxygen for libstdc++ from the source code.