annotate DEPENDENCIES/generic/include/boost/range/algorithm/random_shuffle.hpp @ 125:34e428693f5d vext

Vext -> Repoint
author Chris Cannam
date Thu, 14 Jun 2018 11:15:39 +0100
parents 2665513ce2d3
children
rev   line source
Chris@16 1 // Copyright Neil Groves 2009. Use, modification and
Chris@16 2 // distribution is subject to the Boost Software License, Version
Chris@16 3 // 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16 4 // http://www.boost.org/LICENSE_1_0.txt)
Chris@16 5 //
Chris@16 6 //
Chris@16 7 // For more information, see http://www.boost.org/libs/range/
Chris@16 8 //
Chris@16 9 #ifndef BOOST_RANGE_ALGORITHM_RANDOM_SHUFFLE_HPP_INCLUDED
Chris@16 10 #define BOOST_RANGE_ALGORITHM_RANDOM_SHUFFLE_HPP_INCLUDED
Chris@16 11
Chris@16 12 #include <boost/concept_check.hpp>
Chris@16 13 #include <boost/range/begin.hpp>
Chris@16 14 #include <boost/range/end.hpp>
Chris@16 15 #include <boost/range/concepts.hpp>
Chris@16 16 #include <algorithm>
Chris@16 17
Chris@16 18 namespace boost
Chris@16 19 {
Chris@16 20 namespace range
Chris@16 21 {
Chris@16 22
Chris@16 23 /// \brief template function random_shuffle
Chris@16 24 ///
Chris@16 25 /// range-based version of the random_shuffle std algorithm
Chris@16 26 ///
Chris@16 27 /// \pre RandomAccessRange is a model of the RandomAccessRangeConcept
Chris@16 28 /// \pre Generator is a model of the UnaryFunctionConcept
Chris@16 29 template<class RandomAccessRange>
Chris@16 30 inline RandomAccessRange& random_shuffle(RandomAccessRange& rng)
Chris@16 31 {
Chris@16 32 BOOST_RANGE_CONCEPT_ASSERT(( RandomAccessRangeConcept<RandomAccessRange> ));
Chris@16 33 std::random_shuffle(boost::begin(rng), boost::end(rng));
Chris@16 34 return rng;
Chris@16 35 }
Chris@16 36
Chris@16 37 /// \overload
Chris@16 38 template<class RandomAccessRange>
Chris@16 39 inline const RandomAccessRange& random_shuffle(const RandomAccessRange& rng)
Chris@16 40 {
Chris@16 41 BOOST_RANGE_CONCEPT_ASSERT(( RandomAccessRangeConcept<const RandomAccessRange> ));
Chris@16 42 std::random_shuffle(boost::begin(rng), boost::end(rng));
Chris@16 43 return rng;
Chris@16 44 }
Chris@16 45
Chris@16 46 /// \overload
Chris@16 47 template<class RandomAccessRange, class Generator>
Chris@16 48 inline RandomAccessRange& random_shuffle(RandomAccessRange& rng, Generator& gen)
Chris@16 49 {
Chris@16 50 BOOST_RANGE_CONCEPT_ASSERT(( RandomAccessRangeConcept<RandomAccessRange> ));
Chris@16 51 std::random_shuffle(boost::begin(rng), boost::end(rng), gen);
Chris@16 52 return rng;
Chris@16 53 }
Chris@16 54
Chris@16 55 /// \overload
Chris@16 56 template<class RandomAccessRange, class Generator>
Chris@16 57 inline const RandomAccessRange& random_shuffle(const RandomAccessRange& rng, Generator& gen)
Chris@16 58 {
Chris@16 59 BOOST_RANGE_CONCEPT_ASSERT(( RandomAccessRangeConcept<const RandomAccessRange> ));
Chris@16 60 std::random_shuffle(boost::begin(rng), boost::end(rng), gen);
Chris@16 61 return rng;
Chris@16 62 }
Chris@16 63
Chris@16 64 } // namespace range
Chris@16 65 using range::random_shuffle;
Chris@16 66 } // namespace boost
Chris@16 67
Chris@16 68 #endif // include guard