fix doc example typo
[boost.git] / boost / range / begin.hpp
bloba4a5e10fe0f24fdb5bd447435a145b397566a7b4
1 // Boost.Range library
2 //
3 // Copyright Thorsten Ottosen 2003-2004. Use, modification and
4 // distribution is subject to the Boost Software License, Version
5 // 1.0. (See accompanying file LICENSE_1_0.txt or copy at
6 // http://www.boost.org/LICENSE_1_0.txt)
7 //
8 // For more information, see http://www.boost.org/libs/range/
9 //
11 #ifndef BOOST_RANGE_BEGIN_HPP
12 #define BOOST_RANGE_BEGIN_HPP
14 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
15 # pragma once
16 #endif
18 #include <boost/range/config.hpp>
20 #ifdef BOOST_NO_FUNCTION_TEMPLATE_ORDERING
21 #include <boost/range/detail/begin.hpp>
22 #else
24 #include <boost/range/iterator.hpp>
26 namespace boost
29 #if !BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x564)) && \
30 !BOOST_WORKAROUND(__GNUC__, < 3) \
31 /**/
32 namespace range_detail
34 #endif
36 //////////////////////////////////////////////////////////////////////
37 // primary template
38 //////////////////////////////////////////////////////////////////////
40 template< typename C >
41 inline BOOST_DEDUCED_TYPENAME range_iterator<C>::type
42 range_begin( C& c )
45 // If you get a compile-error here, it is most likely because
46 // you have not implemented range_begin() properly in
47 // the namespace of C
49 return c.begin();
52 //////////////////////////////////////////////////////////////////////
53 // pair
54 //////////////////////////////////////////////////////////////////////
56 template< typename Iterator >
57 inline Iterator range_begin( const std::pair<Iterator,Iterator>& p )
59 return p.first;
62 template< typename Iterator >
63 inline Iterator range_begin( std::pair<Iterator,Iterator>& p )
65 return p.first;
68 //////////////////////////////////////////////////////////////////////
69 // array
70 //////////////////////////////////////////////////////////////////////
73 // May this be discarded? Or is it needed for bad compilers?
75 template< typename T, std::size_t sz >
76 inline const T* range_begin( const T (&a)[sz] )
78 return a;
81 template< typename T, std::size_t sz >
82 inline T* range_begin( T (&a)[sz] )
84 return a;
88 #if !BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x564)) && \
89 !BOOST_WORKAROUND(__GNUC__, < 3) \
90 /**/
91 } // namespace 'range_detail'
92 #endif
95 template< class T >
96 inline BOOST_DEDUCED_TYPENAME range_iterator<T>::type begin( T& r )
98 #if !BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x564)) && \
99 !BOOST_WORKAROUND(__GNUC__, < 3) \
100 /**/
101 using namespace range_detail;
102 #endif
103 return range_begin( r );
106 template< class T >
107 inline BOOST_DEDUCED_TYPENAME range_iterator<const T>::type begin( const T& r )
109 #if !BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x564)) && \
110 !BOOST_WORKAROUND(__GNUC__, < 3) \
111 /**/
112 using namespace range_detail;
113 #endif
114 return range_begin( r );
117 } // namespace boost
119 #endif // BOOST_NO_FUNCTION_TEMPLATE_ORDERING
121 namespace boost
123 template< class T >
124 inline BOOST_DEDUCED_TYPENAME range_iterator<const T>::type
125 const_begin( const T& r )
127 return boost::begin( r );
131 #endif