annotate DEPENDENCIES/generic/include/boost/range/algorithm/max_element.hpp @ 133:4acb5d8d80b6 tip

Don't fail environmental check if README.md exists (but .txt and no-suffix don't)
author Chris Cannam
date Tue, 30 Jul 2019 12:25:44 +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_MAX_ELEMENT_HPP_INCLUDED
Chris@16 10 #define BOOST_RANGE_ALGORITHM_MAX_ELEMENT_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 <boost/range/detail/range_return.hpp>
Chris@16 17 #include <algorithm>
Chris@16 18
Chris@16 19 namespace boost
Chris@16 20 {
Chris@16 21 namespace range
Chris@16 22 {
Chris@16 23
Chris@16 24 /// \brief template function max_element
Chris@16 25 ///
Chris@16 26 /// range-based version of the max_element std algorithm
Chris@16 27 ///
Chris@16 28 /// \pre ForwardRange is a model of the ForwardRangeConcept
Chris@16 29 /// \pre BinaryPredicate is a model of the BinaryPredicateConcept
Chris@16 30 template<class ForwardRange>
Chris@16 31 inline BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type
Chris@16 32 max_element(ForwardRange& rng)
Chris@16 33 {
Chris@16 34 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16 35 return std::max_element(boost::begin(rng), boost::end(rng));
Chris@16 36 }
Chris@16 37
Chris@16 38 /// \overload
Chris@16 39 template<class ForwardRange>
Chris@16 40 inline BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type
Chris@16 41 max_element(const ForwardRange& rng)
Chris@16 42 {
Chris@16 43 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16 44 return std::max_element(boost::begin(rng), boost::end(rng));
Chris@16 45 }
Chris@16 46
Chris@16 47 /// \overload
Chris@16 48 template<class ForwardRange, class BinaryPredicate>
Chris@16 49 inline BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type
Chris@16 50 max_element(ForwardRange& rng, BinaryPredicate pred)
Chris@16 51 {
Chris@16 52 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16 53 return std::max_element(boost::begin(rng), boost::end(rng), pred);
Chris@16 54 }
Chris@16 55
Chris@16 56 /// \overload
Chris@16 57 template<class ForwardRange, class BinaryPredicate>
Chris@16 58 inline BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type
Chris@16 59 max_element(const ForwardRange& rng, BinaryPredicate pred)
Chris@16 60 {
Chris@16 61 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16 62 return std::max_element(boost::begin(rng), boost::end(rng), pred);
Chris@16 63 }
Chris@16 64
Chris@16 65 // range_return overloads
Chris@16 66
Chris@16 67 /// \overload
Chris@16 68 template<range_return_value re, class ForwardRange>
Chris@16 69 inline BOOST_DEDUCED_TYPENAME range_return<ForwardRange,re>::type
Chris@16 70 max_element(ForwardRange& rng)
Chris@16 71 {
Chris@16 72 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16 73 return range_return<ForwardRange,re>::pack(
Chris@16 74 std::max_element(boost::begin(rng), boost::end(rng)),
Chris@16 75 rng);
Chris@16 76 }
Chris@16 77
Chris@16 78 /// \overload
Chris@16 79 template<range_return_value re, class ForwardRange>
Chris@16 80 inline BOOST_DEDUCED_TYPENAME range_return<const ForwardRange,re>::type
Chris@16 81 max_element(const ForwardRange& rng)
Chris@16 82 {
Chris@16 83 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16 84 return range_return<const ForwardRange,re>::pack(
Chris@16 85 std::max_element(boost::begin(rng), boost::end(rng)),
Chris@16 86 rng);
Chris@16 87 }
Chris@16 88
Chris@16 89 /// \overload
Chris@16 90 template<range_return_value re, class ForwardRange, class BinaryPredicate>
Chris@16 91 inline BOOST_DEDUCED_TYPENAME range_return<ForwardRange,re>::type
Chris@16 92 max_element(ForwardRange& rng, BinaryPredicate pred)
Chris@16 93 {
Chris@16 94 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16 95 return range_return<ForwardRange,re>::pack(
Chris@16 96 std::max_element(boost::begin(rng), boost::end(rng), pred),
Chris@16 97 rng);
Chris@16 98 }
Chris@16 99
Chris@16 100 /// \overload
Chris@16 101 template<range_return_value re, class ForwardRange, class BinaryPredicate>
Chris@16 102 inline BOOST_DEDUCED_TYPENAME range_return<const ForwardRange,re>::type
Chris@16 103 max_element(const ForwardRange& rng, BinaryPredicate pred)
Chris@16 104 {
Chris@16 105 BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16 106 return range_return<const ForwardRange,re>::pack(
Chris@16 107 std::max_element(boost::begin(rng), boost::end(rng), pred),
Chris@16 108 rng);
Chris@16 109 }
Chris@16 110
Chris@16 111 } // namespace range
Chris@16 112 using range::max_element;
Chris@16 113 } // namespace boost
Chris@16 114
Chris@16 115 #endif // include guard