123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478 |
- <?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.14: http://docutils.sourceforge.net/" />
- <title>Boost Pointer Container Library</title>
- <style type="text/css">
- /*
- :Author: David Goodger (goodger@python.org)
- :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
- :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.
- */
- /* used to remove borders from tables and images */
- .borderless, table.borderless td, table.borderless th {
- border: 0 }
- table.borderless td, table.borderless th {
- /* Override padding for "table.docutils td" with "! important".
- The right padding separates the table cells. */
- padding: 0 0.5em 0 0 ! important }
- .first {
- /* Override more specific margin styles with "! important". */
- margin-top: 0 ! important }
- .last, .with-subtitle {
- margin-bottom: 0 ! important }
- .hidden {
- display: none }
- .subscript {
- vertical-align: sub;
- font-size: smaller }
- .superscript {
- vertical-align: super;
- font-size: smaller }
- a.toc-backref {
- text-decoration: none ;
- color: black }
- blockquote.epigraph {
- margin: 2em 5em ; }
- dl.docutils dd {
- margin-bottom: 0.5em }
- object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
- overflow: hidden;
- }
- /* 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, .code .error {
- 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 ;
- margin-right: 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: 0 0 0.5em 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, .figure.align-left, object.align-left, table.align-left {
- clear: left ;
- float: left ;
- margin-right: 1em }
- img.align-right, .figure.align-right, object.align-right, table.align-right {
- clear: right ;
- float: right ;
- margin-left: 1em }
- img.align-center, .figure.align-center, object.align-center {
- display: block;
- margin-left: auto;
- margin-right: auto;
- }
- table.align-center {
- margin-left: auto;
- margin-right: auto;
- }
- .align-left {
- text-align: left }
- .align-center {
- clear: both ;
- text-align: center }
- .align-right {
- text-align: right }
- /* reset inner alignment in figures */
- div.align-right {
- text-align: inherit }
- /* div.align-center * { */
- /* text-align: left } */
- .align-top {
- vertical-align: top }
- .align-middle {
- vertical-align: middle }
- .align-bottom {
- vertical-align: bottom }
- 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: inherit }
- pre.literal-block, pre.doctest-block, pre.math, pre.code {
- margin-left: 2em ;
- margin-right: 2em }
- pre.code .ln { color: grey; } /* line numbers */
- pre.code, code { background-color: #eeeeee }
- pre.code .comment, code .comment { color: #5C6576 }
- pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
- pre.code .literal.string, code .literal.string { color: #0C5404 }
- pre.code .name.builtin, code .name.builtin { color: #352B84 }
- pre.code .deleted, code .deleted { background-color: #DEB0A1}
- pre.code .inserted, code .inserted { background-color: #A3D289}
- 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 1px gray;
- margin-left: 1px }
- table.docinfo {
- margin: 2em 4em }
- table.docutils {
- margin-top: 0.5em ;
- margin-bottom: 0.5em }
- table.footnote {
- border-left: solid 1px black;
- margin-left: 1px }
- 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 }
- /* "booktabs" style (no vertical lines) */
- table.docutils.booktabs {
- border: 0px;
- border-top: 2px solid;
- border-bottom: 2px solid;
- border-collapse: collapse;
- }
- table.docutils.booktabs * {
- border: 0px;
- }
- table.docutils.booktabs th {
- border-bottom: thin solid;
- text-align: left;
- }
- h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
- h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
- font-size: 100% }
- 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" id="contents">
- <ul class="simple">
- <li><a class="reference internal" href="#null-pointers-are-not-allowed-by-default" id="id3">Null pointers are not allowed by default</a></li>
- <li><a class="reference internal" href="#all-default-iterators-apply-an-extra-layer-of-indirection" id="id4">All default iterators apply an extra layer of indirection</a></li>
- <li><a class="reference internal" href="#all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level" id="id5">All comparison operations are done on the pointed to objects and not at the pointer level</a></li>
- <li><a class="reference internal" href="#stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations" id="id6">Stored elements are required to be Cloneable for a subset of the operations</a></li>
- <li><a class="reference internal" href="#whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion" id="id7">Whenever objects are inserted into a container, they are cloned before insertion</a></li>
- <li><a class="reference internal" href="#whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container" id="id8">Whenever pointers are inserted into a container, ownership is transferred to the container</a></li>
- <li><a class="reference internal" href="#ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis" id="id9">Ownership can be transferred from a container on a per pointer basis</a></li>
- <li><a class="reference internal" href="#ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis" id="id10">Ownership can be transferred from a container to another container on a per iterator range basis</a></li>
- <li><a class="reference internal" href="#a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container" id="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 internal" href="#iterators-are-invalidated-as-in-the-corresponding-standard-container" id="id12">Iterators are invalidated as in the corresponding standard container</a></li>
- </ul>
- </div>
- <div class="section" id="null-pointers-are-not-allowed-by-default">
- <h1><a class="toc-backref" href="#id3">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">bad_pointer</tt> exception (see <a class="reference external" href="examples.html">Example 1</a>).</p>
- <p>Use <a class="reference external" 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">nullable<T></tt> as in</p>
- <pre class="literal-block">
- boost::ptr_vector< boost::nullable<animal> > vec;
- vec.push_back( 0 ); // ok
- </pre>
- </div>
- <div class="section" id="all-default-iterators-apply-an-extra-layer-of-indirection">
- <h1><a class="toc-backref" href="#id4">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 external" 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">begin()</tt> returns an iterator,
- <tt class="docutils literal">ptr_begin()</tt> will return an iterator that allows one to iterate over the
- stored pointers.</p>
- </div>
- <div class="section" id="all-comparison-operations-are-done-on-the-pointed-to-objects-and-not-at-the-pointer-level">
- <h1><a class="toc-backref" href="#id5">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">ptr_set<T></tt> the ordering is by default done by
- <tt class="docutils literal"><span class="pre">boost::ptr_less<T></span></tt> which compares the indirected pointers.
- Similarly, <tt class="docutils literal"><span class="pre">operator==()</span></tt> for <tt class="docutils literal">container<Foo></tt> compares all objects
- with <tt class="docutils literal"><span class="pre">operator==(const</span> Foo&, const Foo&)</tt>.</p>
- </div>
- <div class="section" id="stored-elements-are-required-to-be-cloneable-for-a-subset-of-the-operations">
- <h1>Stored elements are required to be <a class="reference external" href="reference.html#the-Cloneable-concept">Cloneable</a> for a subset of the operations</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 external" 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" id="whenever-objects-are-inserted-into-a-container-they-are-cloned-before-insertion">
- <h1><a class="toc-backref" href="#id7">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 external" href="examples.html">Example 5</a>).</p>
- </div>
- <div class="section" id="whenever-pointers-are-inserted-into-a-container-ownership-is-transferred-to-the-container">
- <h1><a class="toc-backref" href="#id8">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 external" href="examples.html">Example 5</a>).</p>
- </div>
- <div class="section" id="ownership-can-be-transferred-from-a-container-on-a-per-pointer-basis">
- <h1><a class="toc-backref" href="#id9">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 external" href="examples.html">Example 6</a>).</p>
- </div>
- <div class="section" id="ownership-can-be-transferred-from-a-container-to-another-container-on-a-per-iterator-range-basis">
- <h1><a class="toc-backref" href="#id10">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 external" href="examples.html">Example 7</a>).</p>
- </div>
- <div class="section" id="a-container-can-be-cheaply-returned-from-functions-either-by-making-a-clone-or-by-giving-up-ownership-of-the-container">
- <h1><a class="toc-backref" href="#id11">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">clone()</tt> and <tt class="docutils literal">release()</tt>, both return a
- <tt class="docutils literal"><span class="pre"><a class="reference external" href="compatible_smart_ptr.html"><em>compatible-smart-ptr</em></a><SmartContainer></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">swap()</tt> (see <a class="reference external" href="examples.html">Example 3</a>).</p>
- </div>
- <div class="section" id="iterators-are-invalidated-as-in-the-corresponding-standard-container">
- <h1><a class="toc-backref" href="#id12">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<T></span></tt> and <tt class="docutils literal"><span class="pre">std::vector<U></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 external" href="ptr_container.html">home</a></li>
- <li><a class="reference external" 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 external" href="http://www.boost.org/LICENSE_1_0.txt">LICENSE_1_0.txt</a>).</td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </body>
- </html>
|