• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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)
4
5++++++++++++++++++
6 Iterator Concepts
7++++++++++++++++++
8
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.`_
13:date: $Date$
14:copyright: Copyright David Abrahams, Jeremy Siek, and Thomas Witt 2004.
15
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
19
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
23  the template.
24
25
26For an introduction to using concept checking classes, see
27the documentation for the |concepts|_ library.
28
29.. |concepts| replace:: ``boost::concept_check``
30.. _concepts: ../../concept_check/index.html
31
32
33Reference
34=========
35
36Iterator Access Concepts
37........................
38
39* |Readable|_
40* |Writable|_
41* |Swappable|_
42* |Lvalue|_
43
44.. |Readable| replace:: *Readable Iterator*
45.. _Readable: ReadableIterator.html
46
47.. |Writable| replace:: *Writable Iterator*
48.. _Writable: WritableIterator.html
49
50.. |Swappable| replace:: *Swappable Iterator*
51.. _Swappable: SwappableIterator.html
52
53.. |Lvalue| replace:: *Lvalue Iterator*
54.. _Lvalue: LvalueIterator.html
55
56
57Iterator Traversal Concepts
58...........................
59
60* |Incrementable|_
61* |SinglePass|_
62* |Forward|_
63* |Bidir|_
64* |Random|_
65
66
67.. |Incrementable| replace:: *Incrementable Iterator*
68.. _Incrementable: IncrementableIterator.html
69
70.. |SinglePass| replace:: *Single Pass Iterator*
71.. _SinglePass: SinglePassIterator.html
72
73.. |Forward| replace:: *Forward Traversal*
74.. _Forward: ForwardTraversal.html
75
76.. |Bidir| replace:: *Bidirectional Traversal*
77.. _Bidir: BidirectionalTraversal.html
78
79.. |Random| replace:: *Random Access Traversal*
80.. _Random: RandomAccessTraversal.html
81
82
83
84``iterator_concepts.hpp`` Synopsis
85..................................
86
87::
88
89    namespace boost_concepts {
90
91        // Iterator Access Concepts
92
93        template <typename Iterator>
94        class ReadableIteratorConcept;
95
96        template <
97            typename Iterator
98          , typename ValueType = std::iterator_traits<Iterator>::value_type
99        >
100        class WritableIteratorConcept;
101
102        template <typename Iterator>
103        class SwappableIteratorConcept;
104
105        template <typename Iterator>
106        class LvalueIteratorConcept;
107
108        // Iterator Traversal Concepts
109
110        template <typename Iterator>
111        class IncrementableIteratorConcept;
112
113        template <typename Iterator>
114        class SinglePassIteratorConcept;
115
116        template <typename Iterator>
117        class ForwardTraversalConcept;
118
119        template <typename Iterator>
120        class BidirectionalTraversalConcept;
121
122        template <typename Iterator>
123        class RandomAccessTraversalConcept;
124
125        // Interoperability
126
127        template <typename Iterator, typename ConstIterator>
128        class InteroperableIteratorConcept;
129
130    }
131