/Src/Dependencies/Boost/libs/iterator/doc/SinglePassIterator.rst

http://hadesmem.googlecode.com/ · ReStructuredText · 32 lines · 28 code · 4 blank · 0 comment · 0 complexity · 768800b1e6bac58dcd6d0fd9197cb017 MD5 · raw file 

    

  1. .. Copyright David Abrahams 2006. Distributed under the Boost
    2. 

  2. .. Software License, Version 1.0. (See accompanying
    3. 

  3. .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
    4. 

  4. 

  5. Single Pass Iterator Concept
    6. 

  6. ............................
    7. 

  7. 

  8. A class or built-in type ``X`` models the *Single Pass Iterator*
    9. 

  9. concept if the following expressions are valid and respect the stated
    10. 

  10. semantics.
    11. 

  11. 

  12. 

  13. +------------------------------------------------------------------------------------------+
    14. 

  14. |Single Pass Iterator Requirements (in addition to Incrementable Iterator and Equality     |
    15. 

  15. |Comparable)                                                                               |
    16. 

  16. +--------------------------------+-----------------------------+---------------------------+
    17. 

  17. |Expression                      |Return Type                  |Assertion/Semantics /      | 
    18. 

  18. |                                |                             |Pre-/Post-condition        |
    19. 

  19. +================================+=============================+===========================+
    20. 

  20. |``++r``                         |``X&``                       |pre: ``r`` is              |
    21. 

  21. |                                |                             |dereferenceable; post:     |
    22. 

  22. |                                |                             |``r`` is dereferenceable or|
    23. 

  23. |                                |                             |``r`` is past-the-end      |
    24. 

  24. +--------------------------------+-----------------------------+---------------------------+
    25. 

  25. |``a == b``                      |convertible to ``bool``      |``==`` is an equivalence   |
    26. 

  26. |                                |                             |relation over its domain   |
    27. 

  27. +--------------------------------+-----------------------------+---------------------------+
    28. 

  28. |``a != b``                      |convertible to ``bool``      |``!(a == b)``              |
    29. 

  29. +--------------------------------+-----------------------------+---------------------------+
    30. 

  30. |``iterator_traversal<X>::type`` |Convertible to               |                           |
    31. 

  31. |                                |``single_pass_traversal_tag``|                           |
    32. 

  32. +--------------------------------+-----------------------------+---------------------------+
    33.