[Boost-commit] svn:boost r7540

From: asutton_at_[hidden]
Date: 2007-07-25 18:58:54

Author: asutton
Date: 2007-07-25 18:58:53 EDT (Wed, 25 Jul 2007)
New Revision: 7540
URL: http://svn.boost.org/trac/boost/changeset/7540

Log:
More docs - container this time

Text files modified: 
   sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/container.qbk  |    68 ++++++++++++++++++++++++++++++++++++++- 
   sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/containers.qbk |     3 -                                       
   sandbox/boost_docs/trunk/libs/standard/doc/std.qbk                            |     8 ++++                                    
   3 files changed, 75 insertions(+), 4 deletions(-)

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-07-25 18:58:53 EDT (Wed, 25 Jul 2007)
@@ -6,12 +6,76 @@
  /]
 
 [section Container]
+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. 
 
 [heading Refinement Of]
 [StdAssignable]
 
-[heading 
+[heading Notation]
+[table
+    [[Expression] [Description]]
+    [[`C`] [An object or type [StdContainer] - a container]]
+    [[`T`] [An object stored by `C`]]
+]
 
-[heading Notes]
+[heading Associated Types]
+[table
+    [[Name] [Expression] [Result Type] [Description]]
+    [
+        [Value Type]
+        [`C::value_type`]
+        [`T`]
+        [
+            *Semantics:* The type of the stored object or value.
+            
+            *Requirements:* `T` must model the [StdAssignable] concept.
+        ]
+    ]
+    [
+        [Reference Type]
+        [`C::reference`]
+        [lvalue of `T`]
+        [
+            *Semantics:* A reference type to the stored value type.
+        ]
+    ]
+    [
+        [Const Reference Type]
+        [`C::connst_reference`]
+        [`const` lvalue of `T`]
+        [
+            *Semantics:* A `const` reference type to the stored value type.
+        ]
+    ]
+    [
+        [Iterator Type]
+        [`C::iterator`]
+        [iterator type pointing to `T`]
+        [
+            *Semantics:* The type of object used to iterate over elements of `C`.
+            The iterator type is convertible to the const iterator type. 
+            
+            *Requirements:* The iterator type may not be a model of the 
+            [StdOutputIterator] concept.
+        ]
+    ]
+    [
+        [Const Iterator Type]
+        [`C::const_iterator`]
+        [iterator type pointing to `const T`]
+        [
+            *Semantics:* The type of object used to iterate over elements of `C`. 
+            
+            *Requirements:* The iterator type may not be a model of the 
+            [StdOutputIterator] concept.
+        ]
+    ]
+]
 
 [endsect]
\ No newline at end of file

Modified: sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/containers.qbk
==============================================================================
--- sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/containers.qbk	(original)
+++ sandbox/boost_docs/trunk/libs/standard/doc/concepts/containers/containers.qbk	2007-07-25 18:58:53 EDT (Wed, 25 Jul 2007)
@@ -26,8 +26,7 @@
 [endsect]
 
 [section Associative Containers]
-This section contains definitions of associative containers. Associative containers
-store elements in association with a key value.
+This section contains definitions of sequential and associative containers.
 
 [note
 This section currently omits hashed associative containers. These concepts need

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-07-25 18:58:53 EDT (Wed, 25 Jul 2007)
@@ -27,6 +27,14 @@
 [template StdEqualityComparable[] [link standard.concepts.utilities.equality_comparable [^EqualityComparable]]]
 [template StdLessThanComparable[] [link standard.concepts.utilities.less_than_comparable [^LessThanComparable]]]
 
+[template StdContainer[] [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]]]
+
 [/ Contents ]
 [include concepts/concepts.qbk]
 [include reference/reference.qbk]
\ No newline at end of file