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