associative_key_sequence Class Template Reference
[Collections Library]
#include <stlsoft/collections/associative_key_sequence.hpp>
Inheritance diagram for associative_key_sequence:
Detailed Description
template<typename A>
class stlsoft::associative_key_sequence< A >
Adapts an associative container to provide a sequence over the element keys. Types | |
| typedef associative_key_sequence< A > | class_type |
| The current parameterisation of the type. | |
| typedef A::value_type::first_type | value_type |
| The value type. | |
| typedef A | associative_container_type |
| The associative container type. | |
| typedef A::allocator_type | allocator_type |
| The allocator type. | |
| typedef A::const_reference | reference |
| The reference type. | |
| typedef A::const_reference | const_reference |
| The non-mutable (const) reference type. | |
| typedef A::size_type | size_type |
| The size type. | |
| typedef A::difference_type | difference_type |
| The difference type. | |
|
typedef associative_select_iterator < A_iterator_type, select_first_type > | iterator |
| typedef associative_select_iterator < A_const_iterator_type, select_first_type > | const_iterator |
| The non-mutating (const) iterator type. | |
Public Member Functions | |
Construction | |
| associative_key_sequence (associative_container_type const &container) | |
Attributes | |
| size_type | size () const |
| The number of elements in the container. | |
| size_type | max_size () const |
| The maximum number of elements that can be stored in the container. | |
| bool | empty () const |
| Indicates whether the container is empty. | |
Iteration | |
| const_iterator | begin () const |
| Begins the iteration. | |
| const_iterator | end () const |
| Ends the iteration. | |
Member Typedef Documentation
| typedef associative_key_sequence<A> class_type |
The current parameterisation of the type.
| typedef A::value_type::first_type value_type |
The value type.
| typedef A associative_container_type |
The associative container type.
| typedef A::allocator_type allocator_type |
The allocator type.
| typedef A::const_reference reference |
The reference type.
- Note:
- This is identical to the const_reference, since we will not be using this adaptor sequence to alter the contents of the underlying sequence
| typedef A::const_reference const_reference |
The non-mutable (const) reference type.
| typedef A::size_type size_type |
The size type.
| typedef A::difference_type difference_type |
The difference type.
| typedef associative_select_iterator< A_const_iterator_type , select_first_type > const_iterator |
The non-mutating (const) iterator type.
Member Function Documentation
| size_type size | ( | ) | const |
The number of elements in the container.
| size_type max_size | ( | ) | const |
The maximum number of elements that can be stored in the container.
| bool empty | ( | ) | const |
Indicates whether the container is empty.
| const_iterator begin | ( | ) | const |
Begins the iteration.
- Returns:
- A non-mutable (const) iterator representing the start of the sequence
| const_iterator end | ( | ) | const |
Ends the iteration.
- Returns:
- A non-mutable (const) iterator representing the end of the sequence
The documentation for this class was generated from the following file:
- stlsoft/collections/associative_key_sequence.hpp
