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
147
148
149
150
151
152
153
|
++++++++++++++++++++++++++++++++++
|Boost| Pointer Container Library
++++++++++++++++++++++++++++++++++
.. |Boost| image:: boost.png
Class ``ptr_vector``
--------------------
A ``ptr_vector<T>`` is a pointer container that uses an underlying ``std::vector<void*>``
to store the pointers.
**See also:**
- reversible_ptr_container_
- ptr_sequence_adapter_
- ptr_array_
.. _reversible_ptr_container: reversible_ptr_container.html
.. _ptr_sequence_adapter: ptr_sequence_adapter.html
.. _ptr_array: ptr_array.html
**Navigate:**
- `home <ptr_container.html>`_
- `reference <reference.html>`_
**Synopsis:**
.. parsed-literal::
namespace boost
{
template
<
class T,
class CloneAllocator = heap_clone_allocator,
class Allocator = std::allocator<void*>
>
class ptr_vector : public ptr_sequence_adapter
<
T,
std::vector<void*,Allocator>,
CloneAllocator
>
{
public: // `construction`_
ptr_vector( size_type to_reserve );
public: // capacity_
size_type capacity() const;
void reserve( size_type n );
public: // `element access`_
T& operator[]( size_type n );
const T& operator[]( size_type n ) const;
T& at( size_type n );
const T& at( size_type n ) const;
public: // `pointer container requirements`_
auto_type replace( size_type idx, T* x );
bool is_null( size_type idx ) const;
};
} // namespace 'boost'
Semantics
---------
.. _`construction`:
Semantics: construction
^^^^^^^^^^^^^^^^^^^^^^^
- ``ptr_vector( size_type to_reserve );``
- constructs an empty vector with a buffer
of size least ``to_reserve``
.. _`capacity`:
Semantics: capacity
^^^^^^^^^^^^^^^^^^^
- ``size_type capacity() const;``
- Effects: Returns the size of the allocated buffer
- Throws: Nothing
- ``void reserve( size_type n );``
- Requirements: ``n <= max_size()``
- Effects: Expands the allocated buffer
- Postcondition: ``capacity() >= n``
- Throws: ``std::length_error()`` if ``n > max_size()``
.. _`element access`:
Semantics: element access
^^^^^^^^^^^^^^^^^^^^^^^^^
- ``T& operator[]( size_type n );``
- ``const T& operator[]( size_type n ) const;``
- Requirements: ``n < size()``
- Effects: Returns a reference to the ``n``'th element
- Throws: Nothing
- ``T& at( size_type n );``
- ``const T& at( size_type n ) const;``
- Requirements: ``n < size()``
- Effects: Returns a reference to the ``n``'th element
- Throws: ``bad_index`` if ``n >=size()``
.. _`pointer container requirements`:
Semantics: pointer container requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- ``auto_type replace( size_type idx, T* x );``
- Requirements: `` x != 0 and idx < size()``
- Effects: returns the object indexed by ``idx`` and replaces it with ``x``.
- Throws: ``bad_index`` if ``idx >= size()`` and ``bad_pointer`` if ``x == 0``.
- Exception safety: Strong guarantee
- ``bool is_null( size_type idx ) const;``
- Requirements: ``idx < size()``
- Effects: returns whether the pointer at index ``idx`` is null
- Exception safety: Nothrow guarantee
:copyright: Thorsten Ottosen 2004-2005.
|
