1 .. 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)
9 :Author: David Abrahams, Jeremy Siek, Thomas Witt
10 :Contact: dave@boost-consulting.com, jsiek@osl.iu.edu, witt@styleadvisor.com
11 :organization: `Boost Consulting`_, Indiana University `Open Systems
12 Lab`_, `Zephyr Associates, Inc.`_
14 :copyright: Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2004.
16 .. _`Boost Consulting`: http://www.boost-consulting.com
17 .. _`Open Systems Lab`: http://www.osl.iu.edu
18 .. _`Zephyr Associates, Inc.`: http://www.styleadvisor.com
20 :abstract: The iterator concept checking classes provide a mechanism for
21 a template to report better error messages when a user instantiates
22 the template with a type that does not meet the requirements of
26 For an introduction to using concept checking classes, see
27 the documentation for the |concepts|_ library.
29 .. |concepts| replace:: ``boost::concept_check``
30 .. _concepts: ../../concept_check/index.html
36 Iterator Access Concepts
37 ........................
44 .. |Readable| replace:: *Readable Iterator*
45 .. _Readable: ReadableIterator.html
47 .. |Writable| replace:: *Writable Iterator*
48 .. _Writable: WritableIterator.html
50 .. |Swappable| replace:: *Swappable Iterator*
51 .. _Swappable: SwappableIterator.html
53 .. |Lvalue| replace:: *Lvalue Iterator*
54 .. _Lvalue: LvalueIterator.html
57 Iterator Traversal Concepts
58 ...........................
67 .. |Incrementable| replace:: *Incrementable Iterator*
68 .. _Incrementable: IncrementableIterator.html
70 .. |SinglePass| replace:: *Single Pass Iterator*
71 .. _SinglePass: SinglePassIterator.html
73 .. |Forward| replace:: *Forward Traversal*
74 .. _Forward: ForwardTraversal.html
76 .. |Bidir| replace:: *Bidirectional Traversal*
77 .. _Bidir: BidirectionalTraversal.html
79 .. |Random| replace:: *Random Access Traversal*
80 .. _Random: RandomAccessTraversal.html
84 ``iterator_concepts.hpp`` Synopsis
85 ..................................
89 namespace boost_concepts {
91 // Iterator Access Concepts
93 template <typename Iterator>
94 class ReadableIteratorConcept;
98 , typename ValueType = std::iterator_traits<Iterator>::value_type
100 class WritableIteratorConcept;
102 template <typename Iterator>
103 class SwappableIteratorConcept;
105 template <typename Iterator>
106 class LvalueIteratorConcept;
108 // Iterator Traversal Concepts
110 template <typename Iterator>
111 class IncrementableIteratorConcept;
113 template <typename Iterator>
114 class SinglePassIteratorConcept;
116 template <typename Iterator>
117 class ForwardTraversalConcept;
119 template <typename Iterator>
120 class BidirectionalTraversalConcept;
122 template <typename Iterator>
123 class RandomAccessTraversalConcept;
127 template <typename Iterator, typename ConstIterator>
128 class InteroperableIteratorConcept;