From 44d7dfeb9bef58b36da06cb7ba385758abf06268 Mon Sep 17 00:00:00 2001 From: Jeremy Siek Date: Wed, 17 Dec 2003 19:32:31 +0000 Subject: [PATCH] more edits [SVN r21307] --- doc/facade-and-adaptor.html | 50 +++++++++++++++++++----------- doc/indirect_iterator_ref.rst | 57 +++++++++++++++++++++-------------- 2 files changed, 66 insertions(+), 41 deletions(-) diff --git a/doc/facade-and-adaptor.html b/doc/facade-and-adaptor.html index e171bcf..465c920 100755 --- a/doc/facade-and-adaptor.html +++ b/doc/facade-and-adaptor.html @@ -1286,31 +1286,45 @@ private: // as-if specification return **this->base(); } }; + +template <class Dereferenceable> +struct referent { + typedef /* see below */ type; +}; + +

If Value is not use_default then the the argument for the +iterator_adaptor base class' Value parameter is Value with +cv-qualifiers removed. If Value is use_default, then the +argument for the iterator_adaptor base class' Value parameter +is computed as follows. We use the abbreviation +V=iterator_traits<Iterator>::value_type and v is an object of +type V.:

+
+if (*v returns a constant lvalue or an rvalue) then
+    referent<V>::type
+else
+    add_const<referent<V>::type>::type
+
+

The algorithm for the type member of referent traits class is +as follows:

+
+if (Dereferenceable is a class and has member element_type)
+    Dereferenceable::element_type
+else
+    iterator_traits<Dereferenceable>::value_type

indirect_iterator requirements

-

The following requirements are placed on the type +

The Iterator type must meet the requirements of Readable +Iterator. Also, the following requirements are placed on iterator_traits<Iterator>::value_type. Let i be an object of type iterator_traits<Iterator>::value_type. Then *i must be a valid expression, and the type of *i must be the same as the -Reference template parameter.

-

The Value template parameter will be the value_type for the -indirect_iterator, unless Value is cv-qualified. If Value -is cv-qualified then value_type will be non-qualified version of -the type. The default for Value is

-
-iterator_traits< iterator_traits<Iterator>::value_type >::value_type
-
-

If the default is used for Value, then there must be a valid -specialization of iterator_traits for the value type of the base -iterator.

- -

The indirect iterator will model the most refined standard traversal -concept that is modeled by the Iterator type and that refines the -traversal category specified in the CategoryOrTraversal parameter. -The indirect iterator will model the most refined standard access -concept that is modeled by the value type of Iterator.

+iterator_adaptor::reference. Also, there are further requirements +on the iterator_traits<Iterator>::value_type if the Value +parameter is not use_default, as implied by the algorithm for deducing +the default.

indirect_iterator operations

diff --git a/doc/indirect_iterator_ref.rst b/doc/indirect_iterator_ref.rst index 4d30b2f..a28aaab 100644 --- a/doc/indirect_iterator_ref.rst +++ b/doc/indirect_iterator_ref.rst @@ -39,36 +39,47 @@ } }; + template + struct referent { + typedef /* see below */ type; + }; + + +If ``Value`` is not ``use_default`` then the the argument for the +``iterator_adaptor`` base class' ``Value`` parameter is ``Value`` with +cv-qualifiers removed. If ``Value`` is ``use_default``, then the +argument for the ``iterator_adaptor`` base class' ``Value`` parameter +is computed as follows. We use the abbreviation +``V=iterator_traits::value_type`` and ``v`` is an object of +type ``V``.:: + + if (*v returns a constant lvalue or an rvalue) then + referent::type + else + add_const::type>::type + +The algorithm for the ``type`` member of ``referent`` traits class is +as follows:: + + if (Dereferenceable is a class and has member element_type) + Dereferenceable::element_type + else + iterator_traits::value_type + + ``indirect_iterator`` requirements .................................. -The following requirements are placed on the type +The ``Iterator`` type must meet the requirements of Readable +Iterator. Also, the following requirements are placed on ``iterator_traits::value_type``. Let ``i`` be an object of type ``iterator_traits::value_type``. Then ``*i`` must be a valid expression, and the type of ``*i`` must be the same as the -``Reference`` template parameter. +``iterator_adaptor::reference``. Also, there are further requirements +on the ``iterator_traits::value_type`` if the ``Value`` +parameter is not ``use_default``, as implied by the algorithm for deducing +the default. -The ``Value`` template parameter will be the ``value_type`` for the -``indirect_iterator``, unless ``Value`` is cv-qualified. If ``Value`` -is cv-qualified then ``value_type`` will be non-qualified version of -the type. The default for ``Value`` is - -:: - - iterator_traits< iterator_traits::value_type >::value_type - -If the default is used for ``Value``, then there must be a valid -specialization of ``iterator_traits`` for the value type of the base -iterator. - -.. THE ABOVE IS NO LONGER IN SYNC WITH THE CODE. -Jeremy - - -The indirect iterator will model the most refined standard traversal -concept that is modeled by the ``Iterator`` type and that refines the -traversal category specified in the ``CategoryOrTraversal`` parameter. -The indirect iterator will model the most refined standard access -concept that is modeled by the value type of ``Iterator``. ``indirect_iterator`` operations