range/algorithm/rotate.hpp

0001 //  Copyright Neil Groves 2009. Use, modification and
0002 //  distribution is subject to the Boost Software License, Version
0003 //  1.0. (See accompanying file LICENSE_1_0.txt or copy at
0004 //  http://www.boost.org/LICENSE_1_0.txt)
0005 //
0006 //
0007 // For more information, see http://www.boost.org/libs/range/
0008 //
0009 #ifndef BOOST_RANGE_ALGORITHM_ROTATE_HPP_INCLUDED
0010 #define BOOST_RANGE_ALGORITHM_ROTATE_HPP_INCLUDED
0011
0012 #include <boost/concept_check.hpp>
0013 #include <boost/range/begin.hpp>
0014 #include <boost/range/end.hpp>
0015 #include <boost/range/concepts.hpp>
0016 #include <algorithm>
0017
0018 namespace boost
0019 {
0020     namespace range
0021     {
0022
0023 /// \brief template function rotate
0024 ///
0025 /// range-based version of the rotate std algorithm
0026 ///
0027 /// \pre Rng meets the requirements for a Forward range
0028 template<class ForwardRange>
0029 inline ForwardRange& rotate(ForwardRange& rng,
0030     BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type middle)
0031 {
0032     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
0033     std::rotate(boost::begin(rng), middle, boost::end(rng));
0034     return rng;
0035 }
0036
0037 /// \overload
0038 template<class ForwardRange>
0039 inline const ForwardRange& rotate(const ForwardRange& rng,
0040     BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type middle)
0041 {
0042     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
0043     std::rotate(boost::begin(rng), middle, boost::end(rng));
0044     return rng;
0045 }
0046
0047     } // namespace range
0048     using range::rotate;
0049 } // namespace boost
0050
0051 #endif // include guard