1 // (C) Copyright Jeremy Siek 2002.
\r
2 // Distributed under the Boost Software License, Version 1.0. (See
\r
3 // accompanying file LICENSE_1_0.txt or copy at
\r
4 // http://www.boost.org/LICENSE_1_0.txt)
\r
6 #ifndef BOOST_ITERATOR_CONCEPTS_HPP
\r
7 #define BOOST_ITERATOR_CONCEPTS_HPP
\r
9 #include <boost/concept_check.hpp>
\r
10 #include <boost/iterator/iterator_categories.hpp>
\r
12 // Use boost::detail::iterator_traits to work around some MSVC/Dinkumware problems.
\r
13 #include <boost/detail/iterator.hpp>
\r
15 #include <boost/type_traits/is_same.hpp>
\r
16 #include <boost/type_traits/is_integral.hpp>
\r
18 #include <boost/mpl/bool.hpp>
\r
19 #include <boost/mpl/if.hpp>
\r
20 #include <boost/mpl/and.hpp>
\r
21 #include <boost/mpl/or.hpp>
\r
23 #include <boost/static_assert.hpp>
\r
25 // Use boost/limits to work around missing limits headers on some compilers
\r
26 #include <boost/limits.hpp>
\r
27 #include <boost/config.hpp>
\r
29 #include <algorithm>
\r
31 #include <boost/concept/detail/concept_def.hpp>
\r
33 namespace boost_concepts
\r
35 // Used a different namespace here (instead of "boost") so that the
\r
36 // concept descriptions do not take for granted the names in
\r
39 //===========================================================================
\r
40 // Iterator Access Concepts
\r
42 BOOST_concept(ReadableIterator,(Iterator))
\r
43 : boost::Assignable<Iterator>
\r
44 , boost::CopyConstructible<Iterator>
\r
47 typedef BOOST_DEDUCED_TYPENAME boost::detail::iterator_traits<Iterator>::value_type value_type;
\r
48 typedef BOOST_DEDUCED_TYPENAME boost::detail::iterator_traits<Iterator>::reference reference;
\r
50 BOOST_CONCEPT_USAGE(ReadableIterator)
\r
54 boost::ignore_unused_variable_warning(v);
\r
62 , typename ValueType = BOOST_DEDUCED_TYPENAME boost::detail::iterator_traits<Iterator>::value_type
\r
64 struct WritableIterator
\r
65 : boost::CopyConstructible<Iterator>
\r
67 BOOST_CONCEPT_USAGE(WritableIterator)
\r
78 , typename ValueType = BOOST_DEDUCED_TYPENAME boost::detail::iterator_traits<Iterator>::value_type
\r
80 struct WritableIteratorConcept : WritableIterator<Iterator,ValueType> {};
\r
82 BOOST_concept(SwappableIterator,(Iterator))
\r
84 BOOST_CONCEPT_USAGE(SwappableIterator)
\r
86 std::iter_swap(i1, i2);
\r
93 BOOST_concept(LvalueIterator,(Iterator))
\r
95 typedef typename boost::detail::iterator_traits<Iterator>::value_type value_type;
\r
97 BOOST_CONCEPT_USAGE(LvalueIterator)
\r
99 value_type& r = const_cast<value_type&>(*i);
\r
100 boost::ignore_unused_variable_warning(r);
\r
107 //===========================================================================
\r
108 // Iterator Traversal Concepts
\r
110 BOOST_concept(IncrementableIterator,(Iterator))
\r
111 : boost::Assignable<Iterator>
\r
112 , boost::CopyConstructible<Iterator>
\r
114 typedef typename boost::iterator_traversal<Iterator>::type traversal_category;
\r
116 BOOST_CONCEPT_ASSERT((
\r
117 boost::Convertible<
\r
119 , boost::incrementable_traversal_tag
\r
122 BOOST_CONCEPT_USAGE(IncrementableIterator)
\r
131 BOOST_concept(SinglePassIterator,(Iterator))
\r
132 : IncrementableIterator<Iterator>
\r
133 , boost::EqualityComparable<Iterator>
\r
136 BOOST_CONCEPT_ASSERT((
\r
137 boost::Convertible<
\r
138 BOOST_DEDUCED_TYPENAME SinglePassIterator::traversal_category
\r
139 , boost::single_pass_traversal_tag
\r
143 BOOST_concept(ForwardTraversal,(Iterator))
\r
144 : SinglePassIterator<Iterator>
\r
145 , boost::DefaultConstructible<Iterator>
\r
147 typedef typename boost::detail::iterator_traits<Iterator>::difference_type difference_type;
\r
149 BOOST_MPL_ASSERT((boost::is_integral<difference_type>));
\r
150 BOOST_MPL_ASSERT_RELATION(std::numeric_limits<difference_type>::is_signed, ==, true);
\r
152 BOOST_CONCEPT_ASSERT((
\r
153 boost::Convertible<
\r
154 BOOST_DEDUCED_TYPENAME ForwardTraversal::traversal_category
\r
155 , boost::forward_traversal_tag
\r
159 BOOST_concept(BidirectionalTraversal,(Iterator))
\r
160 : ForwardTraversal<Iterator>
\r
162 BOOST_CONCEPT_ASSERT((
\r
163 boost::Convertible<
\r
164 BOOST_DEDUCED_TYPENAME BidirectionalTraversal::traversal_category
\r
165 , boost::bidirectional_traversal_tag
\r
168 BOOST_CONCEPT_USAGE(BidirectionalTraversal)
\r
177 BOOST_concept(RandomAccessTraversal,(Iterator))
\r
178 : BidirectionalTraversal<Iterator>
\r
180 BOOST_CONCEPT_ASSERT((
\r
181 boost::Convertible<
\r
182 BOOST_DEDUCED_TYPENAME RandomAccessTraversal::traversal_category
\r
183 , boost::random_access_traversal_tag
\r
186 BOOST_CONCEPT_USAGE(RandomAccessTraversal)
\r
197 typename BidirectionalTraversal<Iterator>::difference_type n;
\r
201 //===========================================================================
\r
202 // Iterator Interoperability
\r
206 template <typename Iterator1, typename Iterator2>
\r
207 void interop_single_pass_constraints(Iterator1 const& i1, Iterator2 const& i2)
\r
215 boost::ignore_unused_variable_warning(b);
\r
218 template <typename Iterator1, typename Iterator2>
\r
219 void interop_rand_access_constraints(
\r
220 Iterator1 const& i1, Iterator2 const& i2,
\r
221 boost::random_access_traversal_tag, boost::random_access_traversal_tag)
\r
224 typename boost::detail::iterator_traits<Iterator2>::difference_type n;
\r
236 boost::ignore_unused_variable_warning(b);
\r
237 boost::ignore_unused_variable_warning(n);
\r
240 template <typename Iterator1, typename Iterator2>
\r
241 void interop_rand_access_constraints(
\r
242 Iterator1 const&, Iterator2 const&,
\r
243 boost::single_pass_traversal_tag, boost::single_pass_traversal_tag)
\r
246 } // namespace detail
\r
248 BOOST_concept(InteroperableIterator,(Iterator)(ConstIterator))
\r
251 typedef typename boost::detail::pure_traversal_tag<
\r
252 typename boost::iterator_traversal<
\r
255 >::type traversal_category;
\r
257 typedef typename boost::detail::pure_traversal_tag<
\r
258 typename boost::iterator_traversal<
\r
261 >::type const_traversal_category;
\r
264 BOOST_CONCEPT_ASSERT((SinglePassIterator<Iterator>));
\r
265 BOOST_CONCEPT_ASSERT((SinglePassIterator<ConstIterator>));
\r
267 BOOST_CONCEPT_USAGE(InteroperableIterator)
\r
269 detail::interop_single_pass_constraints(i, ci);
\r
270 detail::interop_rand_access_constraints(i, ci, traversal_category(), const_traversal_category());
\r
280 } // namespace boost_concepts
\r
282 #include <boost/concept/detail/concept_undef.hpp>
\r
284 #endif // BOOST_ITERATOR_CONCEPTS_HPP
\r