|
|
Boost-Commit : |
From: asutton_at_[hidden]
Date: 2007-08-31 08:28:51
Author: asutton
Date: 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
New Revision: 39084
URL: http://svn.boost.org/trac/boost/changeset/39084
Log:
Doc updates
Added:
sandbox/boost_docs/trunk/libs/standard/doc/Jamfile (contents, props changed)
Removed:
sandbox/boost_docs/trunk/libs/standard/doc/Jamfile.v2
Text files modified:
sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/container.qbk | 96 ++++++++++++++++------------------
sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/forward_container.qbk | 32 +++++-----
sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/reversible_container.qbk | 110 ++++++++++++++++++++++++++++++++++++++++
sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/assignable.qbk | 6 +-
sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/copy_constructible.qbk | 10 +-
sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/default_constructible.qbk | 6 +-
sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/destructible.qbk | 10 +-
sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/equality_comparable.qbk | 16 ++--
sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/less_than_comparable.qbk | 20 +++---
sandbox/boost_docs/trunk/libs/standard/doc/std.qbk | 24 ++++----
10 files changed, 217 insertions(+), 113 deletions(-)
Added: sandbox/boost_docs/trunk/libs/standard/doc/Jamfile
==============================================================================
--- (empty file)
+++ sandbox/boost_docs/trunk/libs/standard/doc/Jamfile 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -0,0 +1,79 @@
+
+# Copyright John Maddock 2005. Use, modification, and distribution are
+# subject to the Boost Software License, Version 1.0. (See accompanying
+# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+using quickbook ;
+
+xml std : std.qbk ;
+
+boostbook standalone
+ :
+ std
+ :
+ # HTML options first:
+ # Use graphics not text for navigation:
+ <xsl:param>navig.graphics=1
+ # How far down we chunk nested sections, basically all of them:
+ <xsl:param>chunk.section.depth=10
+ # Don't put the first section on the same page as the TOC:
+ <xsl:param>chunk.first.sections=1
+ # How far down sections get TOC's
+ <xsl:param>toc.section.depth=10
+ # Max depth in each TOC:
+ <xsl:param>toc.max.depth=4
+ # How far down we go with TOC's
+ <xsl:param>generate.section.toc.level=10
+ # Logo location:
+ <xsl:param>boost.logo=../boost.png
+ <xsl:param>annotation.support=1
+
+ # The page style
+ <xsl:param>page.style="'website'"
+ # Show chapters select box
+ <xsl:param>grouped.links.chapters.show="'true'"
+ # GroupedLinks xml definition chapters location
+ <xsl:param>grouped.links.chapters.xml="'boost_libs_grouped_links.xml'"
+ # Select the base url for the chapters GroupedLinks
+ <xsl:param>grouped.links.chapters.url="'http://www.boost.org/libs/'"
+ # Show sections select box
+ <xsl:param>grouped.links.sections.show="'true'"
+ # GroupedLinks xml definition sections location
+ <xsl:param>grouped.links.sections.xml="'sections_grouped_links.xml'"
+ # Select the base url for the chapters GroupedLinks
+ <xsl:param>grouped.links.sections.url="'./'"
+ # Show the Google Search Box
+ <xsl:param>search.box.show="'true'"
+ # Location of the cse defintion
+ <xsl:param>search.box.cse.definition.src="'http://www.drivehq.com/web/matias.capeletto/bimap/doc/html/context8.xml'"
+
+ # PDF Options:
+ # TOC Generation: this is needed for FOP-0.9 and later:
+ # <xsl:param>fop1.extensions=1
+ <xsl:param>xep.extensions=1
+ # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
+ <xsl:param>fop.extensions=0
+ # No indent on body text:
+ <xsl:param>body.start.indent=0pt
+ # Margin size:
+ <xsl:param>page.margin.inner=0.5in
+ # Margin size:
+ <xsl:param>page.margin.outer=0.5in
+ # Yes, we want graphics for admonishments:
+ <xsl:param>admon.graphics=1
+ # Set this one for PDF generation *only*:
+ # default pnd graphics are awful in PDF form,
+ # better use SVG's instead:
+ #<xsl:param>admon.graphics.extension=".svg"
+ ;
+
+
+
+
+
+
+
+
+
+
+
Deleted: sandbox/boost_docs/trunk/libs/standard/doc/Jamfile.v2
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/Jamfile.v2 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
+++ (empty file)
@@ -1,79 +0,0 @@
-
-# Copyright John Maddock 2005. Use, modification, and distribution are
-# subject to the Boost Software License, Version 1.0. (See accompanying
-# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-
-using quickbook ;
-
-xml std : std.qbk ;
-
-boostbook standalone
- :
- std
- :
- # HTML options first:
- # Use graphics not text for navigation:
- <xsl:param>navig.graphics=1
- # How far down we chunk nested sections, basically all of them:
- <xsl:param>chunk.section.depth=10
- # Don't put the first section on the same page as the TOC:
- <xsl:param>chunk.first.sections=1
- # How far down sections get TOC's
- <xsl:param>toc.section.depth=10
- # Max depth in each TOC:
- <xsl:param>toc.max.depth=4
- # How far down we go with TOC's
- <xsl:param>generate.section.toc.level=10
- # Logo location:
- <xsl:param>boost.logo=../boost.png
- <xsl:param>annotation.support=1
-
- # The page style
- <xsl:param>page.style="'website'"
- # Show chapters select box
- <xsl:param>grouped.links.chapters.show="'true'"
- # GroupedLinks xml definition chapters location
- <xsl:param>grouped.links.chapters.xml="'boost_libs_grouped_links.xml'"
- # Select the base url for the chapters GroupedLinks
- <xsl:param>grouped.links.chapters.url="'http://www.boost.org/libs/'"
- # Show sections select box
- <xsl:param>grouped.links.sections.show="'true'"
- # GroupedLinks xml definition sections location
- <xsl:param>grouped.links.sections.xml="'sections_grouped_links.xml'"
- # Select the base url for the chapters GroupedLinks
- <xsl:param>grouped.links.sections.url="'./'"
- # Show the Google Search Box
- <xsl:param>search.box.show="'true'"
- # Location of the cse defintion
- <xsl:param>search.box.cse.definition.src="'http://www.drivehq.com/web/matias.capeletto/bimap/doc/html/context8.xml'"
-
- # PDF Options:
- # TOC Generation: this is needed for FOP-0.9 and later:
- # <xsl:param>fop1.extensions=1
- <xsl:param>xep.extensions=1
- # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
- <xsl:param>fop.extensions=0
- # No indent on body text:
- <xsl:param>body.start.indent=0pt
- # Margin size:
- <xsl:param>page.margin.inner=0.5in
- # Margin size:
- <xsl:param>page.margin.outer=0.5in
- # Yes, we want graphics for admonishments:
- <xsl:param>admon.graphics=1
- # Set this one for PDF generation *only*:
- # default pnd graphics are awful in PDF form,
- # better use SVG's instead:
- #<xsl:param>admon.graphics.extension=".svg"
- ;
-
-
-
-
-
-
-
-
-
-
-
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/container.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/container.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/container.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -6,21 +6,21 @@
/]
[section Container]
-A type `C` is a /container/ if an object of type `C` is capble of storing other
+A type `C` is a /container/ if an object of type `C` is capble of storing other
objects. Types modeling the container concept are associated with an /iterator/,
a type of object that can be used to iterate over the elements of the container.
The elements of a container are not guaranteed to be stored in any particular
-order, nor is the order of visitation guaranteed to be the same between
-iterations.
+order, nor is the order of visitation guaranteed to be the same between
+iterations.
[heading Refinement Of]
-[StdAssignable]
+[Assignable]
[heading Notation]
[table
[[Expression] [Description]]
- [[`C`] [A type that models the [StdContainer] concept.]]
+ [[`C`] [A type that models the [Container] concept.]]
[[`c`, `d`] [Objects of type `C`.]]
[[`T`] [The type of an object stored by `C`.]]
]
@@ -34,8 +34,8 @@
[`T`]
[
The type of the stored object or value.
-
- *Requirements:* `T` must model the [StdAssignable] concept.
+
+ *Requirements:* `T` must model the [Assignable] concept.
]
]
[
@@ -48,7 +48,7 @@
]
[
[Const Reference Type]
- [`C::connst_reference`]
+ [`C::const_reference`]
[`const` lvalue of `T`]
[
A `const` reference type to the stored value type.
@@ -57,24 +57,24 @@
[
[Iterator Type]
[`C::iterator`]
- [iterator type pointing to `T`]
+ [iterator pointing to objects of type `T`]
[
The type of object used to iterate over elements of `C`.
- The iterator type is convertible to the const iterator type.
-
- *Requirements:* This type models any [StdIterator] concept except
- [StdOutputIterator].
+ The iterator type is convertible to the const iterator type.
+
+ *Requirements:* This type models any [Iterator] concept except
+ [OutputIterator].
]
]
[
[Const Iterator Type]
[`C::const_iterator`]
- [iterator type pointing to `const T`]
+ [iterator pointing to objects of type `const T`]
[
The type of object used to iterate over elements of `C`.
-
- *Requirements:* This type models any [StdIterator] concept except
- [StdOutputIterator].
+
+ *Requirements:* This type models any [Iterator] concept except
+ [OutputIterator].
]
]
]
@@ -91,9 +91,9 @@
[]
[
Construct a new container of type `C` with no sotred elements.
-
+
*Postcondition:* The created container has `size() == 0`.
-
+
*Complexity:* Constant.
]
]
@@ -108,10 +108,10 @@
[
Construct a new container of type `C` with a copy of the contents
of container `d`.
-
+
*Postcondition:* The constructed container `c` is equivalent to `d`,
containing a copy of each of `d`'s elements.
-
+
*Complexity:* Linear in `d.size()`.
]
]
@@ -122,7 +122,7 @@
[
The destructor of every element in `c` is called and any memory
allocated by the container is deallocated.
-
+
*Complexity:* Linear in `c.size()`.
]
]
@@ -130,15 +130,15 @@
[Beginning of Range]
[`c.begin()`]
[
- `iterator` if `c` is mutable.[br]
- `const_iterator if `c` is `const`.
+ `C::iterator` if `c` is mutable.[br]
+ `C::const_iterator` if `c` is `const`.
]
[
Returns an iterator pointing to the first element in the container.
-
+
*Postcondition:* If `c` is not empty, `c.begin()` is dereferenceable.
Otherwise, it is past the end.
-
+
*Complexity:* Amortized constant.
]
]
@@ -146,57 +146,51 @@
[End of Range]
[`c.end()`]
[
- `iterator` if `c` is mutable.[br]
- `const_iterator if `c` is `const`.
+ `C::iterator` if `c` is mutable.[br]
+ `C::const_iterator` if `c` is `const`.
]
[
Returns an iterator pointing past the end of the container.
-
- *Postcondition:* `c.end()` is past the edn of the array.
-
+
+ *Postcondition:* `c.end()` is past the end of the container.
+
*Complexity:* Amortized constant.
]
]
[
[Size]
[`c.size()`]
- [
- `size_type`
- ]
+ [`C::size_type`]
[
Returns the size of the container `c`, frequently meaning the number
of elements stored in the container.
-
- *Postcondition:* `c.size() >= 0` and `c.size() <= `c.max_size()`.
-
- *Complexity:* Lineaar in `c.size()`.
+
+ *Postcondition:* `c.size() >= 0` and `c.size() <= c.max_size()`.
+
+ *Complexity:* Linear in `c.size()`.
]
]
[
[Maximum Size]
[`c.max_size()`]
- [
- `size_type`
- ]
+ [`size_type`]
[
Returns the largest possible size of the container, also the
maximum number of elements that `c` can store.
-
+
*Postcondition:* `c.max_size() >= 0` and `c.max_size() >= c.size()`.
-
+
*Complexity:* Amortized constant.
]
]
[
[Empty]
[`c.empty()`]
- [
- Convertible to `bool`.
- ]
+ [Convertible to `bool`.]
[
Returns `true` if the container `c` is empty, also equivalent to
`c.size() == 0`.
-
+
*Complexity:* Amortized constant.
]
]
@@ -206,7 +200,7 @@
[]
[
Swap the contents of container `c` with `d`.
-
+
*Requirements:* `d` must be of type `C`.
]
]
@@ -223,7 +217,7 @@
{
return c.size();
}
-
+
// Accessing the begin() and end() iterator ranges of a container
// of type C requires that type to model the Container concept.
template <typename C>
@@ -231,7 +225,7 @@
{
return std::make_pair(c.begin(), c.end());
}
-
+
// Testing whether a container of type C is empty() requires
// that type to model the Container concept.
template <typename C>
@@ -239,5 +233,5 @@
{
return c.empty();
}
-
+
[endsect]
\ No newline at end of file
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/forward_container.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/forward_container.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/forward_container.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -6,20 +6,24 @@
/]
[section Forward Container]
-A type `C` is a /forward container/ if an object of type `C` is a [StdContainer]
+A type `C` is a /forward container/ if an object of type `C` is a [Container]
that stores its objects in a definite order, and the order of objects do not
spontaneously change from iteration to iteration. The definite ordering of objects
within the forward container allows the definition of equality and lexicographical
-ordering (if the contained type is [StdEqualityComparable] and [StdLessThanComparable]
+ordering (if the contained type is [EqualityComparable] and [LessThanComparable]
respectively).
+The iterators of a [ForwardContainer] model the [ForwardIterator] concept. Containers
+modeling this concept support "multipass" algorithsm and allow multiple iterators
+into the same container to be active at the same time.
+
[heading Refinement Of]
-[StdEqualityComparable], [StdLessThanComparable], [StdContainer]
+[EqualityComparable], [LessThanComparable], [Container]
[heading Notation]
[table
[[Expression] [Description]]
- [[`C`] [A type that models the [StdContainer] concept.]]
+ [[`C`] [A type that models the [ForwardContainer] concept.]]
[[`c`, `d`] [Objects of type `C`.]]
[[`T`] [The type of an object stored by `C`.]]
]
@@ -29,30 +33,26 @@
[[Name] [Expression] [Result Type] [Description]]
[
[Equality Comparison]
- [
- `c == d`
- ]
+ [`c == d`]
[Convertible to `bool`]
[
Returns `true` if the container `c` is element-wise equivalent
to `d`.
-
- *Requirements:* The type of stored objects `T` is [StdEqualityComparable].
-
+
+ *Requirements:* The type of stored objects `T` is [EqualityComparable].
+
*Complexity:* Linear in `c.size()`.
]
]
[
[Less-Than Comparison]
- [
- `c < d`
- ]
+ [`c < d`]
[Convertible to `bool`]
[
Returns `true` if the container `c` is element-wise less-than `d`.
-
- *Requirements:* The type of stored objects `T` is [StdLessThanComparable].
-
+
+ *Requirements:* The type of stored objects `T` is [LessThanComparable].
+
*Complexity:* Linear in `c.size()`.
]
]
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/reversible_container.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/reversible_container.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/reversible_container.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -6,5 +6,115 @@
/]
[section Reversible Container]
+A type `C` is a /reversible container/ if an object of type `C` is a [ForwardContainer]
+that allows backwards iteration through the container.
+
+The iterators of a [ReversibleContainer] model the [BidirectionalIterators] concept.
+Containers modeling this concept support "multipass" algorithsm and allow multiple
+iterators into the same container to be active at the same time.
+
+[heading Refinement Of]
+[ForwardContainer]
+
+[heading Notation]
+[table
+ [[Expression] [Description]]
+ [[`C`] [A type that models the [ReversibleContainer] concept.]]
+ [[`c`, `d`] [Objects of type `C`.]]
+ [[`T`] [The type of an object stored by `C`.]]
+]
+
+[heading Associated Types]
+[table
+ [[Name] [Expression] [Result Type] [Description]]
+ [
+ [Reverse Iterator]
+ [`C::reverse_iterator`]
+ [iterator pointing to objects of type `T`]
+ [
+ An adaptor over the container's `iterator` type that allows it to
+ iterate backwards over the elements in the container.
+
+ *Requirements:* This type models any [Iterator] concept except
+ [OutputIterator].
+ ]
+ ]
+ [
+ [Reverse Iterator]
+ [`C::const_reverse_iterator`]
+ [iterator pointing to objects of type `const T`]
+ [
+ An adaptor over the container's `const_iterator` type that allows it to
+ iterate backwards over the elements in the container.
+
+ *Requirements:* This type models any [Iterator] concept except
+ [OutputIterator].
+ ]
+ ]
+]
+
+[heading Requirements]
+[table
+ [[Name] [Expression] [Result Type] [Description]]
+ [
+ [Beginning of Range]
+ [`c.rbegin()`]
+ [
+ `C::reverse_iterator` if `c` is mutable.[br]
+ `C::const_reverse_iterator` if `c` is `const`.
+ ]
+ [
+ Returns an iterator pointing to the first element in the container.
+
+ *Postcondition:* If `c` is not empty, `c.rbegin()` is dereferenceable.
+ Otherwise, it is past the end.
+
+ *Complexity:* Amortized constant.
+ ]
+ ]
+ [
+ [End of Range]
+ [`c.rend()`]
+ [
+ `C::iterator` if `c` is mutable.[br]
+ `C::const_iterator` if `c` is `const`.
+ ]
+ [
+ Returns an iterator pointing past the end of the container.
+
+ *Postcondition:* `c.rend()` is past the end of the container.
+
+ *Complexity:* Amortized constant.
+ ]
+ ]
+]
+
+[heading Invariants]
+[table
+ [[Name] [Description]]
+ [
+ [Valid Range]
+ [
+ \[`c.rbegin()`, `c.rend()`) is a valid range.
+ ]
+ ]
+ [
+ [Equivalence of Ranges]
+ [
+ The distance from `c.begin()` to `c.end()` is the same as the distance
+ from `c.rbegin()` to `c.rend()`.
+ ]
+ ]
+]
+
+[heading Examples]
+
+ // Asserts that the forward and reverse iterator ranges of a container
+ // are the same distance.
+ template <typename C>
+ void equivalent_ranges(const C& c)
+ {
+ assert(distance(c.begin(), c.end) == distance(c.rbegin(), c.rend()));
+ }
[endsect]
\ No newline at end of file
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/assignable.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/assignable.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/assignable.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -18,13 +18,13 @@
[note
Two objects `t` and `u` are equivalent if the expression `t == u` returns
-`true`. See [StdEqualityComparable] for more information.
+`true`. See [EqualityComparable] for more information.
]
[heading Notation]
[table
[[Expression] [Description]]
- [[T] [An [StdAssignable] type.]]
+ [[T] [An [Assignable] type.]]
[[t] [An instance of type `T`.]]
[[u] [An instance of type `T` or const `T`.]]
]
@@ -46,7 +46,7 @@
]
[heading Examples]
-A type `T` is required to be [StdAssignable] when an object of type `T` is
+A type `T` is required to be [Assignable] when an object of type `T` is
assigned to an object of type `T` or `const T`.
// The assignment of the object t to the value u requires T to be Assignable.
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/copy_constructible.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/copy_constructible.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/copy_constructible.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -15,17 +15,17 @@
[note
Two objects `t` and `u` are equivalent if the expression `t == u` returns
-`true`. See [StdEqualityComparable] for more information.
+`true`. See [EqualityComparable] for more information.
]
[heading Refinement of]
-[StdDestructible]
+[Destructible]
[heading Notation]
The following expressions are used within this document:
[table
[[Expression] [Description]]
- [[T] [A [StdCopyConstructible] type.]]
+ [[T] [A [CopyConstructible] type.]]
[[t] [An object of type `T`.]]
[[u] [An object of type `T` or `const T`.]]
]
@@ -66,10 +66,10 @@
[heading Notes]
A type that explicitly defines a private copy constructor is not
-[StdCopyConstructible]. These types are called non-copyable types.
+[CopyConstructible]. These types are called non-copyable types.
[heading Examples]
-A type `T` is required to be [StdCopyConstructible] when an object of type `T`
+A type `T` is required to be [CopyConstructible] when an object of type `T`
is when the copy constructor of `T` is invoked passing another object of
type `T` as an argument.
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/default_constructible.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/default_constructible.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/default_constructible.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -12,7 +12,7 @@
that can be called without arguments.
[note
-[StdDefaultConstructible] types may or may not initilize objects to a default value
+[StdDefaultConstructible] types may or may not initialize objects to a default value
or state depending on the type itself and the syntax used for construction. Objects
that are not initialized to a default are /uninitialized. Reading from or otherwise
using uninitialized objects often results in undefined behavior.
@@ -22,7 +22,7 @@
[StdDestructible]
[heading Notation]
-The folllowing expressions are used in this document:
+The following expressions are used in this document:
[table
[[Expression] [Description]]
[[T] [A [StdDefaultConstructible] type.]]
@@ -39,7 +39,7 @@
[
The object `x` is constructed as an object of type `T` and may or may not
initialized to a default value[footnote This syntax leaves fundamental
- types unitialized while class types are default-initialized.].
+ types uninitialized while class types are default-initialized.].
]
]
[
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/destructible.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/destructible.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/destructible.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -13,7 +13,7 @@
The following expressions are used within this document:
[table
[[Expression] [Description]]
- [[T] [A [StdDestructible] type.]]
+ [[T] [A [Destructible] type.]]
[[t] [An object of type `T`.]]
]
@@ -34,13 +34,13 @@
[heading Notes]
A class that provides a user-defined, `private` or `protected` destructor
-is not [StdDestructible].
+is not [Destructible].
[heading Examples]
-In practice, there are non-[StdDestructible] types are infrequent. Any type
+In practice, there are non-[Destructible] types are infrequent. Any type
whose objects are statically or locally declared is required to be model the
-[StdDestructible] concept. Any type whose objects are `delete`d are also required
-to be [StdDestructible].
+[Destructible] concept. Any type whose objects are `delete`d are also required
+to be [Destructible].
// An object of type T that goes out of scope is required to be
// Destructible. Note that this function also requires T to be
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/equality_comparable.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/equality_comparable.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/equality_comparable.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -7,10 +7,10 @@
[section Equality Comparable]
A type `T` is /equality comparable/ objects of type `T` can be compared using
-the equality comparison operator (`==`) and that comparison defines an /equivalence
-relation/. An equivalence relation over type a `T` is a binary relation between any
-two objects of type `T` that denotes them as being "equivalent". The specific
-meaning of the term "equivalent" depends on the semantics of the type modeling this
+the equality comparison operator (`==`) and that comparison defines an /equivalence
+relation/. An equivalence relation over type a `T` is a binary relation between any
+two objects of type `T` that denotes them as being "equivalent". The specific
+meaning of the term "equivalent" depends on the semantics of the type modeling this
concept.
Equivalence relations have the following properties:
@@ -22,7 +22,7 @@
[heading Notation]
[table
[[Expression] [Description]]
- [[T] [An [StdEqualityComparable] type.]]
+ [[T] [An [EqualityComparable] type.]]
[[`t`, `u`, `v`] [Objects of type `T`.]]
]
@@ -60,8 +60,8 @@
}
[heading Examples]
-A type `T` is required to be [StdEqualityComparable] when an object of type `T` is
-compared to another object of type `T` using either the equality comparison (`==`)
+A type `T` is required to be [EqualityComparable] when an object of type `T` is
+compared to another object of type `T` using either the equality comparison (`==`)
or the inequality comparison (`!=`) operator.
// Using the equality comparison operator to compare two objects of type T
@@ -71,7 +71,7 @@
{
return t == u;
}
-
+
// Using the inequality comparison operator to compare two objects of type T
// requires that type to be EqualityComparable since inequality can be
// implemented in terms of equality.
Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/less_than_comparable.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/less_than_comparable.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/utilities/less_than_comparable.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -21,7 +21,7 @@
[heading Notation]
[table
[[Expression] [Description]]
- [[T] [An [StdLessThanComparable] type.]]
+ [[T] [An [LessThanComparable] type.]]
[[`t`, `u`, `v`] [Objects of type `T`.]]
]
@@ -75,19 +75,19 @@
{
return u < t;
}
-
+
bool operator <=(const T& t, const T& u)
{
return !(u < t);
}
-
+
bool operator >=(const T& t, const T& u)
{
return !(t < u);
}
-
+
[heading Examples]
-A type `T` is required to be [StdLessthanComparable] when an object of type `T` is
+A type `T` is required to be [LessthanComparable] when an object of type `T` is
compared to another object of type `T` using the less-than comparison (`<`), the
greater-than comparison (`>`), the less-than or equal-to comparison (`<=`), or
the greater-than or equal-to (`>=`) operators.
@@ -101,7 +101,7 @@
}
// Using the greater-than comparison operator to compare two objects of
- // type T requires T to be LessThanComparable since that comparison can be
+ // type T requires T to be LessThanComparable since that comparison can be
// derived from the less-than comparison.
template <typename T>
bool greater_than_compare(cont T& t, const T& u)
@@ -109,8 +109,8 @@
return t > u;
}
- // Using the less-than or equal-to comparison operator to compare two objects
- // of type T requires T to be LessThanComparable since that comparison can be
+ // Using the less-than or equal-to comparison operator to compare two objects
+ // of type T requires T to be LessThanComparable since that comparison can be
// derived from the less-than comparison.
template <typename T>
bool less_than_or_equal_to_compare(cont T& t, const T& u)
@@ -118,8 +118,8 @@
return t <= u;
}
- // Using the greater-than or equal-to comparison operator to compare two
- // objects of type T requires T to be LessThanComparable since that comparison
+ // Using the greater-than or equal-to comparison operator to compare two
+ // objects of type T requires T to be LessThanComparable since that comparison
// can be derived from the less-than comparison.
template <typename T>
bool greater_than_or_equal_to_compare(cont T& t, const T& u)
Modified: sandbox/boost_docs/trunk/libs/standard/doc/std.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/std.qbk (original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/std.qbk 2007-08-31 08:28:50 EDT (Fri, 31 Aug 2007)
@@ -20,20 +20,20 @@
]
[/ Quick Reference Templates /]
-[template StdDestructible[] [link standards.concepts.utilities.destructible [^Destructible]]]
-[template StdDefaultConstructible[] [link standard.concepts.utilities.default_constructible [^DefaultConstructible]]]
-[template StdCopyConstructible[] [link standard.concepts.utilities.copy_constructible [^CopyConstructible]]]
-[template StdAssignable[] [link standard.concepts.utilities.assignable [^Assignable]]]
-[template StdEqualityComparable[] [link standard.concepts.utilities.equality_comparable [^EqualityComparable]]]
-[template StdLessThanComparable[] [link standard.concepts.utilities.less_than_comparable [^LessThanComparable]]]
+[template Destructible[] [link standards.concepts.utilities.destructible [^Destructible]]]
+[template DefaultConstructible[] [link standard.concepts.utilities.default_constructible [^DefaultConstructible]]]
+[template CopyConstructible[] [link standard.concepts.utilities.copy_constructible [^CopyConstructible]]]
+[template Assignable[] [link standard.concepts.utilities.assignable [^Assignable]]]
+[template EqualityComparable[] [link standard.concepts.utilities.equality_comparable [^EqualityComparable]]]
+[template LessThanComparable[] [link standard.concepts.utilities.less_than_comparable [^LessThanComparable]]]
-[template StdContainer[] [link standard.concepts.containers.general_concepts.container [^Container]]]
+[template Container[] [link standard.concepts.containers.general_concepts.container [^Container]]]
-[template StdInputIterator[] [link standard.concepts.iterators.input_iterator [^InputIterator]]]
-[template StdOutputIterator[] [link standard.concepts.iterators.output_iterator [^OutputIterator]]]
-[template StdForwardIterator[] [link standard.concepts.iterators.forward_iterator [^ForwardIterator]]]
-[template StdBidirectionalIterator[] [link standard.concepts.iterators.bidirectional_iterator [^BidirectionalIterator]]]
-[template StdRandomAccessIterator[] [link standard.concepts.iterators.random_access_iterator [^RandomAccessIterator]]]
+[template InputIterator[] [link standard.concepts.iterators.input_iterator [^InputIterator]]]
+[template OutputIterator[] [link standard.concepts.iterators.output_iterator [^OutputIterator]]]
+[template ForwardIterator[] [link standard.concepts.iterators.forward_iterator [^ForwardIterator]]]
+[template BidirectionalIterator[] [link standard.concepts.iterators.bidirectional_iterator [^BidirectionalIterator]]]
+[template RandomAccessIterator[] [link standard.concepts.iterators.random_access_iterator [^RandomAccessIterator]]]
[/ Contents ]
[include concepts/concepts.qbk]
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