1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
++++++++++++++++++++++++++++++++++
|Boost| Pointer Container Library
++++++++++++++++++++++++++++++++++
.. |Boost| image:: boost.png
Class ``ptr_map_adapter``
-------------------------
This class is used to build custom pointer containers with
an underlying map-like container. The interface of the class is an extension
of the interface from ``associative_ptr_container``.
**See also:**
- reversible_ptr_container_
- associative_ptr_container_
- ptr_map_
- `new map iterators <reference.html#map-iterator-operations>`_
.. _reversible_ptr_container: reversible_ptr_container.html
.. _associative_ptr_container: associative_ptr_container.html
.. _ptr_map: ptr_map.html
**Navigate:**
- `home <ptr_container.html>`_
- `reference <reference.html>`_
**Synopsis:**
.. parsed-literal::
namespace boost
{
template
<
class T,
class VoidPtrMap,
class CloneAllocator = heap_clone_allocator
>
class ptr_map_adapter
{
public: // `modifiers`_
std::pair<iterator,bool> insert( key_type& k, value_type x );
public; // `lookup`_
T& operator[]( const key_type& key );
T& at( const key_type& key );
const T& at( const key_type& key ) const;
public: // `pointer container requirements`_
bool transfer( iterator object, ptr_map_adapter& from );
size_type transfer( iterator first, iterator last, ptr_map_adapter& from );
template< class Range >
size_type transfer( const Range& r, ptr_map_adapter& from );
size_type transfer( ptr_map_adapter& from );
}; // class 'ptr_map_adapter'
} // namespace 'boost'
Semantics
---------
.. _`modifiers`:
Semantics: modifiers
^^^^^^^^^^^^^^^^^^^^
- ``std::pair<iterator,bool> insert( key_type& k, value_type x );``
- Requirements: ``x != 0``
- Effects: Takes ownership of ``x`` and insert it iff there is no equivalent of it already. The bool part of the return value indicates insertion and the iterator points to the element with key ``x``.
- Throws: bad_pointer if ``x == 0``
- Exception safety: Strong guarantee
..
- ``std::pair<iterator,bool> insert( key_type& k, const_reference x );``
- Effects: ``return insert( allocate_clone( x ) );``
- Exception safety: Strong guarantee
.. _`lookup`:
Semantics: lookup
^^^^^^^^^^^^^^^^^
- ``T& operator[]( const key_type& key );``
- Effects: returns the object with key ``key`` if it exists; otherwise a new object is allocated and inserted and its reference returned.
- Exception-safety: Strong guarantee
- ``T& at( const key_type& key );``
- ``const T& at( const key_type& jey ) const;``
- Requirement: the key exists
- Throws: ``bad_ptr_container_operation`` if the key does not exist
.. _`pointer container requirements`:
Semantics: pointer container requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- ``bool transfer( iterator object, ptr_map_adapter& from );``
- Requirements: ``not from.empty()``
- Effects: Inserts the object defined by ``object`` into the container and remove it from ``from``
iff no equivalent object exists.
- Returns: whether the object was transfered
- Exception safety: Strong guarantee
- ``size_type transfer( iterator first, iterator last, ptr__set_adapter& from );``
- Requirements: ``not from.empty()``
- Effects: Inserts the objects defined by the range ``[first,last)`` into the container and remove it from ``from``.
An object is only transferred if no equivalent object exists.
- Returns: the number of transfered objects
- Exception safety: Basic guarantee
- ``template< class Range > void transfer( const Range& r, ptr_map_adapter& from );``
- Effects: ``return transfer( boost::begin(r), boost::end(r), from );``
- ``size_type transfer( ptr_set_adapter& from );``
- Effects: ``return transfer( from.begin(), from.end(), from );``.
:copyright: Thorsten Ottosen 2004-2005.
|
