ceph/src/boost/libs/iterator/doc/LvalueIterator.rst

   1 .. Copyright David Abrahams 2006. Distributed under the Boost
   2 .. Software License, Version 1.0. (See accompanying
   3 .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   4
   5 Lvalue Iterator Concept
   6 .......................
   7
   8 The *Lvalue Iterator* concept adds the requirement that the return
   9 type of ``operator*`` type be a reference to the value type of the
  10 iterator.
  11
  12 +-------------------------------------------------------------+
  13 | Lvalue Iterator Requirements                                |
  14 +-------------+-----------+-----------------------------------+
  15 |Expression   |Return Type|Note/Assertion                     |
  16 +=============+===========+===================================+
  17 |``*a``       | ``T&``    |``T`` is *cv*                      |
  18 |             |           |``iterator_traits<X>::value_type`` |
  19 |             |           |where *cv* is an optional          |
  20 |             |           |cv-qualification.                  |
  21 |             |           |pre: ``a`` is                      |
  22 |             |           |dereferenceable. If ``a            |
  23 |             |           |== b`` then ``*a`` is              |
  24 |             |           |equivalent to ``*b``.              |
  25 +-------------+-----------+-----------------------------------+