File: BidirectionalTraversal.rst

package info (click to toggle)
boost1.35 1.35.0-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 203,856 kB
  • ctags: 337,867
  • sloc: cpp: 938,683; xml: 56,847; ansic: 41,589; python: 18,999; sh: 11,566; makefile: 664; perl: 494; yacc: 456; asm: 353; csh: 6
file content (41 lines) | stat: -rw-r--r-- 3,062 bytes parent folder | download | duplicates (15)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.. Copyright David Abrahams 2006. Distributed under 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)

Bidirectional Traversal Concept
...............................

A class or built-in type ``X`` models the *Bidirectional Traversal*
concept if, in addition to ``X`` meeting the requirements of Forward
Traversal Iterator, the following expressions are valid and respect
the stated semantics.

+--------------------------------------------------------------------------------------+
|Bidirectional Traversal Iterator Requirements (in addition to Forward Traversal       |
|Iterator)                                                                             |
+--------------------------------+-------------------------------+---------------------+
|Expression                      |Return Type                    |Assertion/Semantics /|
|                                |                               |Pre-/Post-condition  |
+================================+===============================+=====================+
|``--r``                         |``X&``                         |pre: there exists    |
|                                |                               |``s`` such that ``r  |
|                                |                               |== ++s``.  post:     |
|                                |                               |``s`` is             |
|                                |                               |dereferenceable.     |
|                                |                               |``--(++r) == r``.    |
|                                |                               |``--r == --s``       |
|                                |                               |implies ``r ==       |
|                                |                               |s``. ``&r == &--r``. |
+--------------------------------+-------------------------------+---------------------+
|``r--``                         |convertible to ``const X&``    |::                   |
|                                |                               |                     |
|                                |                               | {                   |
|                                |                               |   X tmp = r;        |
|                                |                               |   --r;              |
|                                |                               |   return tmp;       |
|                                |                               | }                   |
+--------------------------------+-------------------------------+---------------------+
|``iterator_traversal<X>::type`` |Convertible to                 |                     |
|                                |``bidirectional_traversal_tag``|                     |
|                                |                               |                     |
+--------------------------------+-------------------------------+---------------------+