[ceph.git] / ceph / src / boost / libs / ptr_container / doc / conventions.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.10: http://docutils.sourceforge.net/" />
<title>Boost Pointer Container Library</title>
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date$
:Revision: $Revision$
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* "! important" is used here to override other ``margin-top`` and
   ``margin-bottom`` styles that are later in the stylesheet or 
   more specific.  See http://www.w3.org/TR/CSS1#the-cascade */
.first {
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

img.borderless {
  border: 0 }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.line-block {
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid thin gray }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid thin black }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="boost-pointer-container-library">
<h1 class="title"><img alt="Boost" src="boost.png" /> Pointer Container Library</h1>
<h2 class="subtitle" id="conventions">Conventions</h2>
<p>There are a few design decisions that will affect how the classes are 
used.  Besides these the classes are much like normal standard containers 
and provides almost the same interface.  The new conventions are:</p>
<div class="contents local topic">
<ul class="simple">
<li><a class="reference" href="#null-pointers-are-not-allowed-by-default" id="id3" name="id3">Null pointers are not allowed by default</a></li>
<li><a class="reference" href="#all-default-iterators-apply-an-extra-layer-of-indirection" id="id4" name="id4">All default iterators apply an extra layer of indirection</a></li>
<li><a class="reference" href="#all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level" id="id5" name="id5">All comparison operations are done on the pointed to objects and not at the pointer level</a></li>
<li><a class="reference" href="#stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations" id="id6" name="id6">Stored elements are required to be Cloneable for a subset of the operations</a></li>
<li><a class="reference" href="#whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion" id="id7" name="id7">Whenever objects are inserted into a container, they are cloned before insertion</a></li>
<li><a class="reference" href="#whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container" id="id8" name="id8">Whenever pointers are inserted into a container, ownership is transferred to the container</a></li>
<li><a class="reference" href="#ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis" id="id9" name="id9">Ownership can be transferred from a container on a per pointer basis</a></li>
<li><a class="reference" href="#ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis" id="id10" name="id10">Ownership can be transferred from a container to another container on a per iterator range basis</a></li>
<li><a class="reference" href="#a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container" id="id11" name="id11">A container can be cheaply returned from functions either by making a clone or by giving up ownership of the container</a></li>
<li><a class="reference" href="#iterators-are-invalidated-as-in-the-corresponding-standard-container" id="id12" name="id12">Iterators are invalidated as in the corresponding standard container</a></li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id3" id="null-pointers-are-not-allowed-by-default" name="null-pointers-are-not-allowed-by-default">Null pointers are not allowed by default</a></h1>
<p>If the user tries to insert the null pointer, the operation will throw a 
<tt class="docutils literal"><span class="pre">bad_pointer</span></tt> exception (see <a class="reference" href="examples.html">Example 1</a>).</p>
<p>Use <a class="reference" href="reference.html#class-nullable">nullable</a> to allow null pointers.</p>
<p>Please notice that all preconditions of the form</p>
<pre class="literal-block">
x != 0;
</pre>
<p>are not active when the you have instantiated a container
with <tt class="docutils literal"><span class="pre">nullable&lt;T&gt;</span></tt> as in</p>
<pre class="literal-block">
boost::ptr_vector&lt; boost::nullable&lt;animal&gt; &gt; vec;
vec.push_back( 0 ); // ok
</pre>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id4" id="all-default-iterators-apply-an-extra-layer-of-indirection" name="all-default-iterators-apply-an-extra-layer-of-indirection">All default iterators apply an extra layer of indirection</a></h1>
<p>This is done to 
make the containers easier and safer to use.  It promotes a kind of 
pointer-less programming and the user of a class needs not worry about 
pointers except when allocating them (see <a class="reference" href="examples.html">Example 2</a>).  Iterators that 
provide access to the naked pointers are also provided since they might be 
useful in rare cases. For example, whenever <tt class="docutils literal"><span class="pre">begin()</span></tt> returns an iterator, 
<tt class="docutils literal"><span class="pre">ptr_begin()</span></tt> will return an iterator that allows one to iterate over the 
stored pointers.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id5" id="all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level" name="all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level">All comparison operations are done on the pointed to objects and not at the pointer level</a></h1>
<p>For example, in <tt class="docutils literal"><span class="pre">ptr_set&lt;T&gt;</span></tt> the ordering is by default done by 
<tt class="docutils literal"><span class="pre">boost::ptr_less&lt;T&gt;</span></tt> which compares the indirected pointers. 
Similarly, <tt class="docutils literal"><span class="pre">operator==()</span></tt> for <tt class="docutils literal"><span class="pre">container&lt;Foo&gt;</span></tt> compares all objects
with <tt class="docutils literal"><span class="pre">operator==(const</span> <span class="pre">Foo&amp;,</span> <span class="pre">const</span> <span class="pre">Foo&amp;)</span></tt>.</p>
</div>
<div class="section">
<h1><a id="stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations" name="stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations">Stored elements are required to be <a class="reference" href="reference.html#the-Cloneable-concept">Cloneable</a> for a subset of the operations</a></h1>
<p>This is because most polymorphic objects cannot be copied directly, but 
they can often be so by a use of a member function (see <a class="reference" href="examples.html">Example 4</a>).  Often 
it does not even make sense to clone an object in which case a large 
subset of the operations are still workable.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id7" id="whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion" name="whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion">Whenever objects are inserted into a container, they are cloned before insertion</a></h1>
<p>This is necessary because all pointer containers take ownerships of stored objects
(see <a class="reference" href="examples.html">Example 5</a>).</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id8" id="whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container" name="whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container">Whenever pointers are inserted into a container, ownership is transferred to the container</a></h1>
<p>All containers take ownership of the stored pointers and therefore a 
container needs to have its own copies (see <a class="reference" href="examples.html">Example 5</a>).</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id9" id="ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis" name="ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis">Ownership can be transferred from a container on a per pointer basis</a></h1>
<p>This can of course also be convenient.  Whenever it happens, an 
<tt class="docutils literal"><span class="pre">SmartContainer::auto_type</span></tt> object is used to provide an exception-safe transfer 
(see <a class="reference" href="examples.html">Example 6</a>).</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id10" id="ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis" name="ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis">Ownership can be transferred from a container to another container on a per iterator range basis</a></h1>
<p>This makes it possible to exchange data safely between different pointer 
containers without cloning the objects again (see <a class="reference" href="examples.html">Example 7</a>).</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id11" id="a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container" name="a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container">A container can be cheaply returned from functions either by making a clone or by giving up ownership of the container</a></h1>
<p>Two special member functions, <tt class="docutils literal"><span class="pre">clone()</span></tt> and <tt class="docutils literal"><span class="pre">release()</span></tt>, both return an 
<tt class="docutils literal"><span class="pre">auto_ptr&lt;SmartContainer&gt;</span></tt> which can be assigned to another pointer container.  This 
effectively reduces the cost of returning a container to one 
heap-allocation plus a call to <tt class="docutils literal"><span class="pre">swap()</span></tt> (see <a class="reference" href="examples.html">Example 3</a>).</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id12" id="iterators-are-invalidated-as-in-the-corresponding-standard-container" name="iterators-are-invalidated-as-in-the-corresponding-standard-container">Iterators are invalidated as in the corresponding standard container</a></h1>
<p>Because the containers in this library wrap standard containers, the
rules for invalidation of iterators are the same as the rules
of the corresponding standard container.</p>
<p>For example, for both <tt class="docutils literal"><span class="pre">boost::ptr_vector&lt;T&gt;</span></tt> and <tt class="docutils literal"><span class="pre">std::vector&lt;U&gt;</span></tt>
insertion and deletion only invalidates the deleted
element and elements following it; all elements before the inserted/deleted
element remain valid.</p>
<hr><p><strong>Navigate:</strong></p>
<ul class="simple">
<li><a class="reference" href="ptr_container.html">home</a></li>
<li><a class="reference" href="reference.html">reference</a></li>
</ul>
<hr><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Copyright:</th><td class="field-body">Thorsten Ottosen 2004-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see <a class="reference" href="http://www.boost.org/LICENSE_1_0.txt">LICENSE_1_0.txt</a>).</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>
Commit	Line	Data
7c673cae FG	1	<?xml version="1.0" encoding="utf-8" ?>
	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	4	<head>
	5	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	6	<meta name="generator" content="Docutils 0.3.10: http://docutils.sourceforge.net/" />
	7	<title>Boost Pointer Container Library</title>
	8	<style type="text/css">
	9
	10	/*
	11	:Author: David Goodger
	12	:Contact: goodger@users.sourceforge.net
	13	:Date: $Date$
	14	:Revision: $Revision$
	15	:Copyright: This stylesheet has been placed in the public domain.
	16
	17	Default cascading style sheet for the HTML output of Docutils.
	18
	19	See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
	20	customize this style sheet.
	21	*/
	22
	23	/* "! important" is used here to override other ``margin-top`` and
	24	``margin-bottom`` styles that are later in the stylesheet or
	25	more specific. See http://www.w3.org/TR/CSS1#the-cascade */
	26	.first {
	27	margin-top: 0 ! important }
	28
	29	.last, .with-subtitle {
	30	margin-bottom: 0 ! important }
	31
	32	.hidden {
	33	display: none }
	34
	35	a.toc-backref {
	36	text-decoration: none ;
	37	color: black }
	38
	39	blockquote.epigraph {
	40	margin: 2em 5em ; }
	41
	42	dl.docutils dd {
	43	margin-bottom: 0.5em }
	44
	45	/* Uncomment (and remove this text!) to get bold-faced definition list terms
	46	dl.docutils dt {
	47	font-weight: bold }
	48	*/
	49
	50	div.abstract {
	51	margin: 2em 5em }
	52
	53	div.abstract p.topic-title {
	54	font-weight: bold ;
	55	text-align: center }
	56
	57	div.admonition, div.attention, div.caution, div.danger, div.error,
	58	div.hint, div.important, div.note, div.tip, div.warning {
	59	margin: 2em ;
	60	border: medium outset ;
	61	padding: 1em }
	62
	63	div.admonition p.admonition-title, div.hint p.admonition-title,
	64	div.important p.admonition-title, div.note p.admonition-title,
65	div.tip p.admonition-title {
66	font-weight: bold ;
67	font-family: sans-serif }
68
69	div.attention p.admonition-title, div.caution p.admonition-title,
70	div.danger p.admonition-title, div.error p.admonition-title,
71	div.warning p.admonition-title {
72	color: red ;
73	font-weight: bold ;
74	font-family: sans-serif }
75
76	/* Uncomment (and remove this text!) to get reduced vertical space in
77	compound paragraphs.
78	div.compound .compound-first, div.compound .compound-middle {
79	margin-bottom: 0.5em }
80
81	div.compound .compound-last, div.compound .compound-middle {
82	margin-top: 0.5em }
83	*/
84
85	div.dedication {
86	margin: 2em 5em ;
87	text-align: center ;
88	font-style: italic }
89
90	div.dedication p.topic-title {
91	font-weight: bold ;
92	font-style: normal }
93
94	div.figure {
95	margin-left: 2em }
96
97	div.footer, div.header {
98	clear: both;
99	font-size: smaller }
100
101	div.line-block {
102	display: block ;
103	margin-top: 1em ;
104	margin-bottom: 1em }
105
106	div.line-block div.line-block {
107	margin-top: 0 ;
108	margin-bottom: 0 ;
109	margin-left: 1.5em }
110
111	div.sidebar {
112	margin-left: 1em ;
113	border: medium outset ;
114	padding: 1em ;
115	background-color: #ffffee ;
116	width: 40% ;
117	float: right ;
118	clear: right }
119
120	div.sidebar p.rubric {
121	font-family: sans-serif ;
122	font-size: medium }
123
124	div.system-messages {
125	margin: 5em }
126
127	div.system-messages h1 {
128	color: red }
129
130	div.system-message {
131	border: medium outset ;
132	padding: 1em }
133
134	div.system-message p.system-message-title {
135	color: red ;
136	font-weight: bold }
137
138	div.topic {
139	margin: 2em }
140
141	h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
142	h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
143	margin-top: 0.4em }
144
145	h1.title {
146	text-align: center }
147
148	h2.subtitle {
149	text-align: center }
150
151	hr.docutils {
152	width: 75% }
153
154	img.align-left {
155	clear: left }
156
157	img.align-right {
158	clear: right }
159
160	img.borderless {
161	border: 0 }
162
163	ol.simple, ul.simple {
164	margin-bottom: 1em }
165
166	ol.arabic {
167	list-style: decimal }
168
169	ol.loweralpha {
170	list-style: lower-alpha }
171
172	ol.upperalpha {
173	list-style: upper-alpha }
174
175	ol.lowerroman {
176	list-style: lower-roman }
177
178	ol.upperroman {
179	list-style: upper-roman }
180
181	p.attribution {
182	text-align: right ;
183	margin-left: 50% }
184
185	p.caption {
186	font-style: italic }
187
188	p.credits {
189	font-style: italic ;
190	font-size: smaller }
191
192	p.label {
193	white-space: nowrap }
194
195	p.rubric {
196	font-weight: bold ;
197	font-size: larger ;
198	color: maroon ;
199	text-align: center }
200
201	p.sidebar-title {
202	font-family: sans-serif ;
203	font-weight: bold ;
204	font-size: larger }
205
206	p.sidebar-subtitle {
207	font-family: sans-serif ;
208	font-weight: bold }
209
210	p.topic-title {
211	font-weight: bold }
212
213	pre.address {
214	margin-bottom: 0 ;
215	margin-top: 0 ;
216	font-family: serif ;
217	font-size: 100% }
218
219	pre.line-block {
220	font-family: serif ;
221	font-size: 100% }
222
223	pre.literal-block, pre.doctest-block {
224	margin-left: 2em ;
225	margin-right: 2em ;
226	background-color: #eeeeee }
227
228	span.classifier {
229	font-family: sans-serif ;
230	font-style: oblique }
231
232	span.classifier-delimiter {
233	font-family: sans-serif ;
234	font-weight: bold }
235
236	span.interpreted {
237	font-family: sans-serif }
238
239	span.option {
240	white-space: nowrap }
241
242	span.pre {
243	white-space: pre }
244
245	span.problematic {
246	color: red }
247
248	span.section-subtitle {
249	/* font-size relative to parent (h1..h6 element) */
250	font-size: 80% }
251
252	table.citation {
253	border-left: solid thin gray }
254
255	table.docinfo {
256	margin: 2em 4em }
257
258	table.docutils {
259	margin-top: 0.5em ;
260	margin-bottom: 0.5em }
261
262	table.footnote {
263	border-left: solid thin black }
264
265	table.docutils td, table.docutils th,
266	table.docinfo td, table.docinfo th {
267	padding-left: 0.5em ;
268	padding-right: 0.5em ;
269	vertical-align: top }
270
271	table.docutils th.field-name, table.docinfo th.docinfo-name {
272	font-weight: bold ;
273	text-align: left ;
274	white-space: nowrap ;
275	padding-left: 0 }
276
277	h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
278	h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
279	font-size: 100% }
280
281	tt.docutils {
282	background-color: #eeeeee }
283
284	ul.auto-toc {
285	list-style-type: none }
286
287	</style>
288	</head>
289	<body>
290	<div class="document" id="boost-pointer-container-library">
291	<h1 class="title"><img alt="Boost" src="boost.png" /> Pointer Container Library</h1>
292	<h2 class="subtitle" id="conventions">Conventions</h2>
293	<p>There are a few design decisions that will affect how the classes are
294	used. Besides these the classes are much like normal standard containers
295	and provides almost the same interface. The new conventions are:</p>
296	<div class="contents local topic">
297	<ul class="simple">
298	<li><a class="reference" href="#null-pointers-are-not-allowed-by-default" id="id3" name="id3">Null pointers are not allowed by default</a></li>
299	<li><a class="reference" href="#all-default-iterators-apply-an-extra-layer-of-indirection" id="id4" name="id4">All default iterators apply an extra layer of indirection</a></li>
300	<li><a class="reference" href="#all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level" id="id5" name="id5">All comparison operations are done on the pointed to objects and not at the pointer level</a></li>
301	<li><a class="reference" href="#stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations" id="id6" name="id6">Stored elements are required to be Cloneable for a subset of the operations</a></li>
302	<li><a class="reference" href="#whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion" id="id7" name="id7">Whenever objects are inserted into a container, they are cloned before insertion</a></li>
303	<li><a class="reference" href="#whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container" id="id8" name="id8">Whenever pointers are inserted into a container, ownership is transferred to the container</a></li>
304	<li><a class="reference" href="#ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis" id="id9" name="id9">Ownership can be transferred from a container on a per pointer basis</a></li>
305	<li><a class="reference" href="#ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis" id="id10" name="id10">Ownership can be transferred from a container to another container on a per iterator range basis</a></li>
306	<li><a class="reference" href="#a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container" id="id11" name="id11">A container can be cheaply returned from functions either by making a clone or by giving up ownership of the container</a></li>
307	<li><a class="reference" href="#iterators-are-invalidated-as-in-the-corresponding-standard-container" id="id12" name="id12">Iterators are invalidated as in the corresponding standard container</a></li>
308	</ul>
309	</div>
310	<div class="section">
311	<h1><a class="toc-backref" href="#id3" id="null-pointers-are-not-allowed-by-default" name="null-pointers-are-not-allowed-by-default">Null pointers are not allowed by default</a></h1>
312	<p>If the user tries to insert the null pointer, the operation will throw a
313	<tt class="docutils literal"><span class="pre">bad_pointer</span></tt> exception (see <a class="reference" href="examples.html">Example 1</a>).</p>
314	<p>Use <a class="reference" href="reference.html#class-nullable">nullable</a> to allow null pointers.</p>
315	<p>Please notice that all preconditions of the form</p>
316	<pre class="literal-block">
317	x != 0;
318	</pre>
319	<p>are not active when the you have instantiated a container
320	with <tt class="docutils literal"><span class="pre">nullable<T></span></tt> as in</p>
321	<pre class="literal-block">
322	boost::ptr_vector< boost::nullable<animal> > vec;
323	vec.push_back( 0 ); // ok
324	</pre>
325	</div>
326	<div class="section">
327	<h1><a class="toc-backref" href="#id4" id="all-default-iterators-apply-an-extra-layer-of-indirection" name="all-default-iterators-apply-an-extra-layer-of-indirection">All default iterators apply an extra layer of indirection</a></h1>
328	<p>This is done to
329	make the containers easier and safer to use. It promotes a kind of
330	pointer-less programming and the user of a class needs not worry about
331	pointers except when allocating them (see <a class="reference" href="examples.html">Example 2</a>). Iterators that
332	provide access to the naked pointers are also provided since they might be
333	useful in rare cases. For example, whenever <tt class="docutils literal"><span class="pre">begin()</span></tt> returns an iterator,
334	<tt class="docutils literal"><span class="pre">ptr_begin()</span></tt> will return an iterator that allows one to iterate over the
335	stored pointers.</p>
336	</div>
337	<div class="section">
338	<h1><a class="toc-backref" href="#id5" id="all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level" name="all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level">All comparison operations are done on the pointed to objects and not at the pointer level</a></h1>
339	<p>For example, in <tt class="docutils literal"><span class="pre">ptr_set<T></span></tt> the ordering is by default done by
340	<tt class="docutils literal"><span class="pre">boost::ptr_less<T></span></tt> which compares the indirected pointers.
341	Similarly, <tt class="docutils literal"><span class="pre">operator==()</span></tt> for <tt class="docutils literal"><span class="pre">container<Foo></span></tt> compares all objects
342	with <tt class="docutils literal"><span class="pre">operator==(const</span> <span class="pre">Foo&,</span> <span class="pre">const</span> <span class="pre">Foo&)</span></tt>.</p>
343	</div>
344	<div class="section">
345	<h1><a id="stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations" name="stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations">Stored elements are required to be <a class="reference" href="reference.html#the-Cloneable-concept">Cloneable</a> for a subset of the operations</a></h1>
346	<p>This is because most polymorphic objects cannot be copied directly, but
347	they can often be so by a use of a member function (see <a class="reference" href="examples.html">Example 4</a>). Often
348	it does not even make sense to clone an object in which case a large
349	subset of the operations are still workable.</p>
350	</div>
351	<div class="section">
352	<h1><a class="toc-backref" href="#id7" id="whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion" name="whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion">Whenever objects are inserted into a container, they are cloned before insertion</a></h1>
353	<p>This is necessary because all pointer containers take ownerships of stored objects
354	(see <a class="reference" href="examples.html">Example 5</a>).</p>
355	</div>
356	<div class="section">
357	<h1><a class="toc-backref" href="#id8" id="whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container" name="whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container">Whenever pointers are inserted into a container, ownership is transferred to the container</a></h1>
358	<p>All containers take ownership of the stored pointers and therefore a
359	container needs to have its own copies (see <a class="reference" href="examples.html">Example 5</a>).</p>
360	</div>
361	<div class="section">
362	<h1><a class="toc-backref" href="#id9" id="ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis" name="ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis">Ownership can be transferred from a container on a per pointer basis</a></h1>
363	<p>This can of course also be convenient. Whenever it happens, an
364	<tt class="docutils literal"><span class="pre">SmartContainer::auto_type</span></tt> object is used to provide an exception-safe transfer
365	(see <a class="reference" href="examples.html">Example 6</a>).</p>
366	</div>
367	<div class="section">
368	<h1><a class="toc-backref" href="#id10" id="ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis" name="ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis">Ownership can be transferred from a container to another container on a per iterator range basis</a></h1>
369	<p>This makes it possible to exchange data safely between different pointer
370	containers without cloning the objects again (see <a class="reference" href="examples.html">Example 7</a>).</p>
371	</div>
372	<div class="section">
373	<h1><a class="toc-backref" href="#id11" id="a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container" name="a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container">A container can be cheaply returned from functions either by making a clone or by giving up ownership of the container</a></h1>
374	<p>Two special member functions, <tt class="docutils literal"><span class="pre">clone()</span></tt> and <tt class="docutils literal"><span class="pre">release()</span></tt>, both return an
375	<tt class="docutils literal"><span class="pre">auto_ptr<SmartContainer></span></tt> which can be assigned to another pointer container. This
376	effectively reduces the cost of returning a container to one
377	heap-allocation plus a call to <tt class="docutils literal"><span class="pre">swap()</span></tt> (see <a class="reference" href="examples.html">Example 3</a>).</p>
378	</div>
379	<div class="section">
380	<h1><a class="toc-backref" href="#id12" id="iterators-are-invalidated-as-in-the-corresponding-standard-container" name="iterators-are-invalidated-as-in-the-corresponding-standard-container">Iterators are invalidated as in the corresponding standard container</a></h1>
381	<p>Because the containers in this library wrap standard containers, the
382	rules for invalidation of iterators are the same as the rules
383	of the corresponding standard container.</p>
384	<p>For example, for both <tt class="docutils literal"><span class="pre">boost::ptr_vector<T></span></tt> and <tt class="docutils literal"><span class="pre">std::vector<U></span></tt>
385	insertion and deletion only invalidates the deleted
386	element and elements following it; all elements before the inserted/deleted
387	element remain valid.</p>
388	<hr><p><strong>Navigate:</strong></p>
389	<ul class="simple">
390	<li><a class="reference" href="ptr_container.html">home</a></li>
391	<li><a class="reference" href="reference.html">reference</a></li>
392	</ul>
393	<hr><table class="docutils field-list" frame="void" rules="none">
394	<col class="field-name" />
395	<col class="field-body" />
396	<tbody valign="top">
397	<tr class="field"><th class="field-name">Copyright:</th><td class="field-body">Thorsten Ottosen 2004-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see <a class="reference" href="http://www.boost.org/LICENSE_1_0.txt">LICENSE_1_0.txt</a>).</td>
398	</tr>
399	</tbody>
400	</table>
401	</div>
402	</div>
403	</body>
404	</html>