Boost-Commit :

Date view	Thread view	Subject view	Author view

From: nesotto_at_[hidden]
Date: 2008-07-16 17:03:49

Next message: nesotto_at_[hidden]: "[Boost-commit] svn:boost r47495 - in branches/release/libs/range: . doc"
Previous message: emil_at_[hidden]: "[Boost-commit] svn:boost r47493 - in branches/release/libs/exception/doc: . source"

Author: nesotto
Date: 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
New Revision: 47494
URL: http://svn.boost.org/trac/boost/changeset/47494

Log:
doc update
Added:
   branches/release/libs/ptr_container/doc/comp_ptr_inserter.sh
      - copied unchanged from r47491, /trunk/libs/ptr_container/doc/comp_ptr_inserter.sh
   branches/release/libs/ptr_container/doc/ptr_inserter.html
      - copied unchanged from r47491, /trunk/libs/ptr_container/doc/ptr_inserter.html
   branches/release/libs/ptr_container/doc/ptr_inserter.rst
      - copied unchanged from r47491, /trunk/libs/ptr_container/doc/ptr_inserter.rst
Text files modified:
   branches/release/libs/ptr_container/doc/examples.html | 5 ++-
   branches/release/libs/ptr_container/doc/examples.rst | 3 +
   branches/release/libs/ptr_container/doc/guidelines.html | 2
   branches/release/libs/ptr_container/doc/guidelines.rst | 2
   branches/release/libs/ptr_container/doc/headers.html | 7 ++++-
   branches/release/libs/ptr_container/doc/headers.rst | 2 +
   branches/release/libs/ptr_container/doc/ptr_container.html | 37 +++++++++++++++++++++++++++----
   branches/release/libs/ptr_container/doc/ptr_container.rst | 47 ++++++++++++++++++++++++++++++++++-----
   branches/release/libs/ptr_container/doc/ptr_sequence_adapter.html | 4 ---
   branches/release/libs/ptr_container/doc/ptr_sequence_adapter.rst | 5 ----
   branches/release/libs/ptr_container/doc/reference.html | 23 ++++++++++---------
   branches/release/libs/ptr_container/doc/reference.rst | 25 +++++++++++----------
   12 files changed, 112 insertions(+), 50 deletions(-)

Modified: branches/release/libs/ptr_container/doc/examples.html
==============================================================================
--- branches/release/libs/ptr_container/doc/examples.html (original)
+++ branches/release/libs/ptr_container/doc/examples.html 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -423,8 +423,9 @@
</div>
<div class="section">
<h1><a class="toc-backref" href="#id10" id="a-large-example" name="a-large-example">9. A large example</a></h1>
-This examples shows many of the most common
-features at work. The example provide lots of comments.
+This example shows many of the most common
+features at work. The example provide lots of comments.
+The source code can also be found <a class="reference" href="../test/tut1.cpp">here</a>.
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">

Modified: branches/release/libs/ptr_container/doc/examples.rst
==============================================================================
--- branches/release/libs/ptr_container/doc/examples.rst (original)
+++ branches/release/libs/ptr_container/doc/examples.rst 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -160,8 +160,9 @@
9. A large example
++++++++++++++++++

-This examples shows many of the most common
+This example shows many of the most common
features at work. The example provide lots of comments.
+The source code can also be found `here <../test/tut1.cpp>`_.

.. raw:: html
:file: tutorial_example.html

Modified: branches/release/libs/ptr_container/doc/guidelines.html
==============================================================================
--- branches/release/libs/ptr_container/doc/guidelines.html (original)
+++ branches/release/libs/ptr_container/doc/guidelines.html 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -304,7 +304,7 @@
</div>
<div class="section">
<h1><a class="toc-backref" href="#id8" id="choosing-the-right-container" name="choosing-the-right-container">Choosing the right container</a></h1>
-The recommended usage pattern of the container classes are the same as the
+The recommended usage pattern of the container classes is the same as
for normal standard containers.
<tt class="docutils literal">ptr_vector</tt>, <tt class="docutils literal">ptr_list</tt> and <tt class="docutils literal">ptr_deque</tt> offer the programmer different
complexity tradeoffs and should be used accordingly. <tt class="docutils literal">ptr_vector</tt> is the

Modified: branches/release/libs/ptr_container/doc/guidelines.rst
==============================================================================
--- branches/release/libs/ptr_container/doc/guidelines.rst (original)
+++ branches/release/libs/ptr_container/doc/guidelines.rst 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -13,7 +13,7 @@
Choosing the right container
----------------------------

-The recommended usage pattern of the container classes are the same as the
+The recommended usage pattern of the container classes is the same as
for normal standard containers.

``ptr_vector``, ``ptr_list`` and ``ptr_deque`` offer the programmer different

Modified: branches/release/libs/ptr_container/doc/headers.html
==============================================================================
--- branches/release/libs/ptr_container/doc/headers.html (original)
+++ branches/release/libs/ptr_container/doc/headers.html 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -292,8 +292,8 @@
<h2 class="subtitle" id="library-headers">Library headers</h2>
<table border="1" class="docutils">
<colgroup>
-<col width="34%" />
-<col width="66%" />
+<col width="29%" />
+<col width="71%" />
</colgroup>
<tbody valign="top">
<tr><td>Header</td>
@@ -323,6 +323,9 @@
<td>classes <a class="reference" href="ptr_map.html">ptr_map</a> and <a class="reference" href="ptr_multimap.html">ptr_multimap</a>
(and <tt class="docutils literal">std::map</tt> and <tt class="docutils literal">std::multimap</tt>)</td>
</tr>
+<tr><td><tt class="docutils literal"><boost/ptr_container/ptr_inserter.hpp></tt></td>
+<td>functions <a class="reference" href="ptr_inserter.html">ptr_back_inserter</a>, <a class="reference" href="ptr_inserter.html">ptr_front_inserter</a> and <a class="reference" href="ptr_inserter.html">ptr_inserter</a></td>
+</tr>
<tr><td><tt class="docutils literal"><boost/ptr_container/ptr_container.hpp></tt></td>
<td>all classes</td>
</tr>

Modified: branches/release/libs/ptr_container/doc/headers.rst
==============================================================================
--- branches/release/libs/ptr_container/doc/headers.rst (original)
+++ branches/release/libs/ptr_container/doc/headers.rst 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -28,6 +28,8 @@
``<boost/ptr_container/ptr_map.hpp>`` classes `ptr_map <ptr_map.html>`_ and `ptr_multimap <ptr_multimap.html>`_
(and ``std::map`` and ``std::multimap``)

+``<boost/ptr_container/ptr_inserter.hpp>`` functions `ptr_back_inserter <ptr_inserter.html>`_, `ptr_front_inserter <ptr_inserter.html>`_ and `ptr_inserter <ptr_inserter.html>`_
+
``<boost/ptr_container/ptr_container.hpp>`` all classes

``<boost/ptr_container/ptr_sequence_adapter.hpp>`` class `ptr_sequence_adapter <ptr_sequence_adapter.html>`_

Modified: branches/release/libs/ptr_container/doc/ptr_container.html
==============================================================================
--- branches/release/libs/ptr_container/doc/ptr_container.html (original)
+++ branches/release/libs/ptr_container/doc/ptr_container.html 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -325,6 +325,7 @@
<li><a class="reference" href="faq.html">FAQ</a></li>
<li><a class="reference" href="#upgrading-from-boost-v-1-33">Upgrading from Boost v. 1.33.*</a></li>
<li><a class="reference" href="#upgrading-from-boost-v-1-34">Upgrading from Boost v. 1.34.*</a></li>
+<li><a class="reference" href="#upgrading-from-boost-v-1-35">Upgrading from Boost v. 1.35.*</a></li>
<li><a class="reference" href="#future-developments">Future Developments</a></li>
<li><a class="reference" href="#acknowledgements">Acknowledgements</a></li>
<li><a class="reference" href="#references">References</a></li>
@@ -401,7 +402,7 @@
</ol>

<ol class="arabic simple" start="8">
-<li>Built-in support for deep-copy semantics via the <a class="reference" href="reference.html#the-cloneable-concept">the Cloneable concept</a></li>
+<li>Built-in support for deep-copy semantics via the <a class="reference" href="reference.html#the-clonable-concept">the Clonable concept</a></li>
</ol>
The disadvantages are
<ol class="arabic simple">
@@ -455,7 +456,7 @@
</div>
<div class="section">
<h1><a id="upgrading-from-boost-v-1-34" name="upgrading-from-boost-v-1-34">Upgrading from Boost v. <tt class="docutils literal">1.34.*</tt></a></h1>
-Serialization have now been made optional thanks to Sebastian Ramacher.
+Serialization has now been made optional thanks to Sebastian Ramacher.
You simply include <tt class="docutils literal"><boost/ptr_container/serialize.hpp></tt> or perhaps
just one of the more specialized headers.
All containers are now copy-constructible and assignable. So you can e.g. now
@@ -472,7 +473,7 @@
const VoidPtrContainer& base() const;
</pre>
These allow direct access to the wrapped container which is
-somtimes needed when you want to provide extra functionality.
+sometimes needed when you want to provide extra functionality.
A few new functions have been added to sequences:
<pre class="literal-block">
void resize( size_type size );
@@ -483,18 +484,44 @@
void transfer( iterator before, T** from, size_type size, bool delete_from = true );
T** c_array();
</pre>
-Finally you can now also "copy" and "assign" an <tt class="docutils literal">auto_type</tt> ptr by calling <tt class="docutils literal">move()</tt>:
+Finally, you can now also "copy" and "assign" an <tt class="docutils literal">auto_type</tt> ptr by calling <tt class="docutils literal">move()</tt>:
<pre class="literal-block">
boost::ptr_vector<T>::auto_type move_ptr = ...;
return boost::ptr_container::move( move_ptr );
</pre>
</div>
<div class="section">
+<h1><a id="upgrading-from-boost-v-1-35" name="upgrading-from-boost-v-1-35">Upgrading from Boost v. <tt class="docutils literal">1.35.*</tt></a></h1>
+The library has been fairly stable, but a few new containers have been supported:
+<ul class="simple">
+<li><tt class="docutils literal">boost::ptr_unordered_set<T></tt> in <tt class="docutils literal"><boost/ptr_container/ptr_unordered_set.hpp></tt></li>
+<li><tt class="docutils literal">boost::ptr_unordered_map<Key,T></tt> in <tt class="docutils literal"><boost/ptr_container/ptr_unordered_map.hpp></tt></li>
+<li><tt class="docutils literal">boost::ptr_circular_buffer<T></tt> in <tt class="docutils literal"><boost/ptr_container/ptr_circular_buffer.hpp></tt></li>
+</ul>
+There are no docs for these classes yet, but they are almost identical to
+<tt class="docutils literal">boost::ptr_set<T></tt>, <tt class="docutils literal">boost::ptr_map<Key,T></tt> and <tt class="docutils literal">boost::ptr_array<T,N></tt>, respectively.
+The underlying containers stem from the two boost libraries
+<ul class="simple">
+<li><a class="reference" href="../../unordered/index.html">Boost.Unordered</a></li>
+<li><a class="reference" href="../../circular_buffer/index.html">Boost.Circular Buffer</a></li>
+</ul>
+Furthermore, <a class="reference" href="ptr_inserter.html">insert iterators</a> have been added.
+</div>
+<div class="section">
<h1><a id="future-developments" name="future-developments">Future Developments</a></h1>
There are indications that the <tt class="docutils literal">void*</tt> implementation has a slight
performance overhead compared to a <tt class="docutils literal">T*</tt> based implementation. Furthermore, a
<tt class="docutils literal">T*</tt> based implementation is so much easier to use type-safely
with algorithms. Therefore I anticipate to move to a <tt class="docutils literal">T*</tt> based implementation.
+Furthermore, the clone allocator might be allowed to have state.
+This design requires some thought, so if you have good ideas and use-cases'
+for this, please don't hesitate to contact me.
+Also, support for Boost.Interprocess is on the todo list.
+There has been a few request for <tt class="docutils literal">boost::ptr_multi_index_container<T,...></tt>.
+I investigated how difficult it would be, and it did turn out to be difficult, albeit
+not impossible. But I don't have the resources to implement this beast
+for years to come, so if someone really needs this container, I suggest that they
+talk with me in private about how it can be done.
</div>
<div class="section">
<h1><a id="acknowledgements" name="acknowledgements">Acknowledgements</a></h1>
@@ -515,7 +542,7 @@
<li>Pavel Chikulaev for comments and bug-fixes</li>
<li>Andreas Hommel for fixing the nasty Metrowerks bug</li>
<li>Charles Brockman for his many comments on the documentation</li>
-<li>Sebastian Ramacher for implementing the optinal serialization support</li>
+<li>Sebastian Ramacher for implementing the optional serialization support</li>
</ul>
</div>
<div class="section">

Modified: branches/release/libs/ptr_container/doc/ptr_container.rst
==============================================================================
--- branches/release/libs/ptr_container/doc/ptr_container.rst (original)
+++ branches/release/libs/ptr_container/doc/ptr_container.rst 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -37,6 +37,7 @@
* FAQ_
* `Upgrading from Boost v. 1.33.*`_
* `Upgrading from Boost v. 1.34.*`_
+* `Upgrading from Boost v. 1.35.*`_
* `Future Developments`_
* Acknowledgements_
* References_
@@ -134,9 +135,9 @@

..

-8. Built-in support for deep-copy semantics via the `the Cloneable concept`__
+8. Built-in support for deep-copy semantics via the `the Clonable concept`__

-.. __: reference.html#the-cloneable-concept
+.. __: reference.html#the-clonable-concept

The disadvantages are

@@ -191,7 +192,7 @@
 Upgrading from Boost v. ``1.34.*``
====================================

-Serialization have now been made optional thanks to Sebastian Ramacher.
+Serialization has now been made optional thanks to Sebastian Ramacher.
You simply include ``<boost/ptr_container/serialize.hpp>`` or perhaps
just one of the more specialized headers.

@@ -210,7 +211,7 @@
 const VoidPtrContainer& base() const;

These allow direct access to the wrapped container which is
-somtimes needed when you want to provide extra functionality.
+sometimes needed when you want to provide extra functionality.

A few new functions have been added to sequences::

@@ -222,11 +223,33 @@
 void transfer( iterator before, T** from, size_type size, bool delete_from = true );
 T** c_array();

-Finally you can now also "copy" and "assign" an ``auto_type`` ptr by calling ``move()``::
+Finally, you can now also "copy" and "assign" an ``auto_type`` ptr by calling ``move()``::

 boost::ptr_vector<T>::auto_type move_ptr = ...;
 return boost::ptr_container::move( move_ptr );

+====================================
+ Upgrading from Boost v. ``1.35.*``
+====================================
+
+The library has been fairly stable, but a few new containers have been supported:
+
+- ``boost::ptr_unordered_set<T>`` in ``<boost/ptr_container/ptr_unordered_set.hpp>``
+
+- ``boost::ptr_unordered_map<Key,T>`` in ``<boost/ptr_container/ptr_unordered_map.hpp>``
+
+- ``boost::ptr_circular_buffer<T>`` in ``<boost/ptr_container/ptr_circular_buffer.hpp>``
+
+There are no docs for these classes yet, but they are almost identical to
+``boost::ptr_set<T>``, ``boost::ptr_map<Key,T>`` and ``boost::ptr_array<T,N>``, respectively.
+The underlying containers stem from the two boost libraries
+
+- `Boost.Unordered <../../unordered/index.html>`_
+
+- `Boost.Circular Buffer <../../circular_buffer/index.html>`_
+
+Furthermore, `insert iterators <ptr_inserter.html>`_ have been added.
+
=====================
 Future Developments
=====================
@@ -236,6 +259,18 @@
``T*`` based implementation is so much easier to use type-safely
with algorithms. Therefore I anticipate to move to a ``T*`` based implementation.

+Furthermore, the clone allocator might be allowed to have state.
+This design requires some thought, so if you have good ideas and use-cases'
+for this, please don't hesitate to contact me.
+
+Also, support for Boost.Interprocess is on the todo list.
+
+There has been a few request for ``boost::ptr_multi_index_container<T,...>``.
+I investigated how difficult it would be, and it did turn out to be difficult, albeit
+not impossible. But I don't have the resources to implement this beast
+for years to come, so if someone really needs this container, I suggest that they
+talk with me in private about how it can be done.
+
================
Acknowledgements
================
@@ -257,7 +292,7 @@
- Pavel Chikulaev for comments and bug-fixes
- Andreas Hommel for fixing the nasty Metrowerks bug
- Charles Brockman for his many comments on the documentation
-- Sebastian Ramacher for implementing the optinal serialization support
+- Sebastian Ramacher for implementing the optional serialization support

==========
References

Modified: branches/release/libs/ptr_container/doc/ptr_sequence_adapter.html
==============================================================================
--- branches/release/libs/ptr_container/doc/ptr_sequence_adapter.html (original)
+++ branches/release/libs/ptr_container/doc/ptr_sequence_adapter.html 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -467,7 +467,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *begin();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>
@@ -476,7 +475,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *begin();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>
@@ -485,7 +483,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *--end();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>
@@ -494,7 +491,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *--end();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>

Modified: branches/release/libs/ptr_container/doc/ptr_sequence_adapter.rst
==============================================================================
--- branches/release/libs/ptr_container/doc/ptr_sequence_adapter.rst (original)
+++ branches/release/libs/ptr_container/doc/ptr_sequence_adapter.rst 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -197,7 +197,6 @@

     - Effects: ``return *begin();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``

- ``const T& front() const;``

@@ -205,7 +204,6 @@

     - Effects: ``return *begin();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``

- ``T& back();``

@@ -213,7 +211,6 @@

     - Effects: ``return *--end();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``

- ``const T& back() const;``

@@ -221,8 +218,6 @@

     - Effects: ``return *--end();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``
-

.. _`modifiers`:

Modified: branches/release/libs/ptr_container/doc/reference.html
==============================================================================
--- branches/release/libs/ptr_container/doc/reference.html (original)
+++ branches/release/libs/ptr_container/doc/reference.html 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -294,11 +294,11 @@
each container. When containers have the same interface, that common interface is explained only once,
but links are always provided to more relevant information.
Please make sure you understand
-the <a class="reference" href="reference.html#the-Cloneable-concept">Cloneable</a> concept and
+the <a class="reference" href="reference.html#the-Clonable-concept">Clonable</a> concept and
the <a class="reference" href="reference.html#the-clone-allocator-concept">Clone Allocator</a> concept.
<ul class="simple">
<li><a class="reference" href="conventions.html">Conventions</a></li>
-<li><a class="reference" href="#the-cloneable-concept">The Cloneable concept</a></li>
+<li><a class="reference" href="#the-clonable-concept">The Clonable concept</a></li>
<li><a class="reference" href="#the-clone-allocator-concept">The Clone Allocator concept</a></li>
<li><a class="reference" href="#class-hierarchy">Class hierarchy</a>:<ul>
<li><a class="reference" href="reversible_ptr_container.html">reversible_ptr_container</a><ul>
@@ -328,6 +328,7 @@
</li>
<li><a class="reference" href="#serialization">Serialization</a></li>
<li><a class="reference" href="indirect_fun.html">Indirected functions</a></li>
+<li><a class="reference" href="ptr_inserter.html">Insert iterators</a></li>
<li><a class="reference" href="#class-nullable">Class nullable</a></li>
<li><a class="reference" href="#exception-classes">Exception classes</a></li>
<li><a class="reference" href="#disabling-the-use-of-exceptions">Disabling the use of exceptions</a></li>
@@ -354,16 +355,16 @@
- `ptr_map <ptr_map.html>`_
- `ptr_multimap <ptr_multimap.html>`_ -->
<div class="section">
-<h1><a id="the-cloneable-concept" name="the-cloneable-concept">The Cloneable concept</a></h1>
+<h1><a id="the-clonable-concept" name="the-clonable-concept">The Clonable concept</a></h1>
Refinement of
<ul class="simple">
<li>Heap Allocable</li>
<li>Heap Deallocable</li>
</ul>
-The Cloneable concept is introduced to formalize the requirements for
-copying heap-allocated objects. A type <tt class="docutils literal">T</tt> might be Cloneable even though it
+The Clonable concept is introduced to formalize the requirements for
+copying heap-allocated objects. A type <tt class="docutils literal">T</tt> might be Clonable even though it
is not Assignable or Copy Constructible. Notice that many operations on
-the containers do not even require the stored type to be Cloneable.
+the containers do not even require the stored type to be Clonable.
Notation
<table border="1" class="docutils">
<colgroup>
@@ -381,7 +382,7 @@
<tr><td><tt class="docutils literal">T</tt></td>
<td><tt class="docutils literal">a</tt></td>
<td><tt class="docutils literal">ptr</tt></td>
-<td>A Cloneable type</td>
+<td>A Clonable type</td>
</tr>
</tbody>
</table>
@@ -432,7 +433,7 @@
}
</pre>
Notice that this implementation makes normal Copy Constructible classes automatically
-Cloneable unless <tt class="docutils literal">operator new()</tt> or <tt class="docutils literal">operator delete()</tt> are hidden.
+Clonable unless <tt class="docutils literal">operator new()</tt> or <tt class="docutils literal">operator delete()</tt> are hidden.
The two functions represent a layer of indirection which is necessary to support
classes that are not Copy Constructible by default. Notice that the implementation
relies on argument-dependent lookup (ADL) to find the right version of
@@ -584,7 +585,7 @@
The pointer container adapters are used when you
want to make a pointer container starting from
your own "normal" container. For example, you
-might have a map class that is extends <tt class="docutils literal">std::map</tt>
+might have a map class that extends <tt class="docutils literal">std::map</tt>
in some way; the adapter class then allows you
to use your map class as a basis for a new
pointer container.
@@ -646,7 +647,7 @@
</div>
<div class="section">
<h1><a id="serialization" name="serialization">Serialization</a></h1>
-As of version 1.34.0 of Boost, the library support
+As of version 1.34.0 of Boost, the library supports
serialization via <a class="reference" href="../../serialization/index.html">Boost.Serialization</a>.
Of course, for serialization to work it is required
that the stored type itself is serializable. For maps, both
@@ -786,7 +787,7 @@
completely. This means the library is more fit for domains where exceptions
are not used. Furthermore, it also speeds up a operations a little. Instead
of throwing an exception, the library simply calls <a class="reference" href="../../utility/assert.html">BOOST_ASSERT</a>.
-To disable exceptions, simly define this macro before including any header:
+To disable exceptions, simply define this macro before including any header:
<pre class="literal-block">
#define BOOST_PTR_CONTAINER_NO_EXCEPTIONS 1
#include <boost/ptr_container/ptr_vector.hpp>

Modified: branches/release/libs/ptr_container/doc/reference.rst
==============================================================================
--- branches/release/libs/ptr_container/doc/reference.rst (original)
+++ branches/release/libs/ptr_container/doc/reference.rst 2008-07-16 17:03:47 EDT (Wed, 16 Jul 2008)
@@ -12,11 +12,11 @@
each container. When containers have the same interface, that common interface is explained only once,
but links are always provided to more relevant information.
Please make sure you understand
-the `Cloneable <reference.html#the-Cloneable-concept>`_ concept and
+the `Clonable <reference.html#the-Clonable-concept>`_ concept and
the `Clone Allocator <reference.html#the-clone-allocator-concept>`_ concept.

- `Conventions <conventions.html>`_
-- `The Cloneable concept`_
+- `The Clonable concept`_
- `The Clone Allocator concept`_

- `Class hierarchy`_:
@@ -44,6 +44,7 @@

- `Serialization`_
- `Indirected functions <indirect_fun.html>`_
+- `Insert iterators <ptr_inserter.html>`_
- `Class nullable`_
- `Exception classes`_
- `Disabling the use of exceptions`_
@@ -74,24 +75,24 @@

-The Cloneable concept
-+++++++++++++++++++++
+The Clonable concept
+++++++++++++++++++++

**Refinement of**

- Heap Allocable
- Heap Deallocable

-The Cloneable concept is introduced to formalize the requirements for
-copying heap-allocated objects. A type ``T`` might be Cloneable even though it
+The Clonable concept is introduced to formalize the requirements for
+copying heap-allocated objects. A type ``T`` might be Clonable even though it
is not Assignable or Copy Constructible. Notice that many operations on
-the containers do not even require the stored type to be Cloneable.
+the containers do not even require the stored type to be Clonable.

**Notation**

======================= ============================================ =================== =====================
 **Type** **Object** (``const`` or non-``const``) **Pointer** **Describes**
- ``T`` ``a`` ``ptr`` A Cloneable type
+ ``T`` ``a`` ``ptr`` A Clonable type
======================= ============================================ =================== =====================

**Valid expressions**
@@ -128,7 +129,7 @@

Notice that this implementation makes normal Copy Constructible classes automatically
-Cloneable unless ``operator new()`` or ``operator delete()`` are hidden.
+Clonable unless ``operator new()`` or ``operator delete()`` are hidden.

The two functions represent a layer of indirection which is necessary to support
classes that are not Copy Constructible by default. Notice that the implementation
@@ -260,7 +261,7 @@
The pointer container adapters are used when you
want to make a pointer container starting from
your own "normal" container. For example, you
-might have a map class that is extends ``std::map``
+might have a map class that extends ``std::map``
in some way; the adapter class then allows you
to use your map class as a basis for a new
pointer container.
@@ -318,7 +319,7 @@
Serialization
+++++++++++++

-As of version 1.34.0 of Boost, the library support
+As of version 1.34.0 of Boost, the library supports
serialization via `Boost.Serialization`__.

.. __: ../../serialization/index.html
@@ -471,7 +472,7 @@

.. __: ../../utility/assert.html

-To disable exceptions, simly define this macro before including any header::
+To disable exceptions, simply define this macro before including any header::

 #define BOOST_PTR_CONTAINER_NO_EXCEPTIONS 1
 #include <boost/ptr_container/ptr_vector.hpp>

Next message: nesotto_at_[hidden]: "[Boost-commit] svn:boost r47495 - in branches/release/libs/range: . doc"
Previous message: emil_at_[hidden]: "[Boost-commit] svn:boost r47493 - in branches/release/libs/exception/doc: . source"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk