Chris@16: //  Copyright Neil Groves 2009. Use, modification and
Chris@16: //  distribution is subject to the Boost Software License, Version
Chris@16: //  1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16: //  http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: //
Chris@16: // For more information, see http://www.boost.org/libs/range/
Chris@16: //
Chris@16: #ifndef BOOST_RANGE_ALGORITHM_MAX_ELEMENT_HPP_INCLUDED
Chris@16: #define BOOST_RANGE_ALGORITHM_MAX_ELEMENT_HPP_INCLUDED
Chris@16: 
Chris@16: #include <boost/concept_check.hpp>
Chris@16: #include <boost/range/begin.hpp>
Chris@16: #include <boost/range/end.hpp>
Chris@16: #include <boost/range/concepts.hpp>
Chris@16: #include <boost/range/detail/range_return.hpp>
Chris@16: #include <algorithm>
Chris@16: 
Chris@16: namespace boost
Chris@16: {
Chris@16:     namespace range
Chris@16:     {
Chris@16: 
Chris@16: /// \brief template function max_element
Chris@16: ///
Chris@16: /// range-based version of the max_element std algorithm
Chris@16: ///
Chris@16: /// \pre ForwardRange is a model of the ForwardRangeConcept
Chris@16: /// \pre BinaryPredicate is a model of the BinaryPredicateConcept
Chris@16: template<class ForwardRange>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type
Chris@16: max_element(ForwardRange& rng)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16:     return std::max_element(boost::begin(rng), boost::end(rng));
Chris@16: }
Chris@16: 
Chris@16: /// \overload
Chris@16: template<class ForwardRange>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type
Chris@16: max_element(const ForwardRange& rng)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16:     return std::max_element(boost::begin(rng), boost::end(rng));
Chris@16: }
Chris@16: 
Chris@16: /// \overload
Chris@16: template<class ForwardRange, class BinaryPredicate>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type
Chris@16: max_element(ForwardRange& rng, BinaryPredicate pred)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16:     return std::max_element(boost::begin(rng), boost::end(rng), pred);
Chris@16: }
Chris@16: 
Chris@16: /// \overload
Chris@16: template<class ForwardRange, class BinaryPredicate>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type
Chris@16: max_element(const ForwardRange& rng, BinaryPredicate pred)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16:     return std::max_element(boost::begin(rng), boost::end(rng), pred);
Chris@16: }
Chris@16: 
Chris@16: // range_return overloads
Chris@16: 
Chris@16: /// \overload
Chris@16: template<range_return_value re, class ForwardRange>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_return<ForwardRange,re>::type
Chris@16: max_element(ForwardRange& rng)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16:     return range_return<ForwardRange,re>::pack(
Chris@16:         std::max_element(boost::begin(rng), boost::end(rng)),
Chris@16:         rng);
Chris@16: }
Chris@16: 
Chris@16: /// \overload
Chris@16: template<range_return_value re, class ForwardRange>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_return<const ForwardRange,re>::type
Chris@16: max_element(const ForwardRange& rng)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16:     return range_return<const ForwardRange,re>::pack(
Chris@16:         std::max_element(boost::begin(rng), boost::end(rng)),
Chris@16:         rng);
Chris@16: }
Chris@16: 
Chris@16: /// \overload
Chris@16: template<range_return_value re, class ForwardRange, class BinaryPredicate>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_return<ForwardRange,re>::type
Chris@16: max_element(ForwardRange& rng, BinaryPredicate pred)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
Chris@16:     return range_return<ForwardRange,re>::pack(
Chris@16:         std::max_element(boost::begin(rng), boost::end(rng), pred),
Chris@16:         rng);
Chris@16: }
Chris@16: 
Chris@16: /// \overload
Chris@16: template<range_return_value re, class ForwardRange, class BinaryPredicate>
Chris@16: inline BOOST_DEDUCED_TYPENAME range_return<const ForwardRange,re>::type
Chris@16: max_element(const ForwardRange& rng, BinaryPredicate pred)
Chris@16: {
Chris@16:     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
Chris@16:     return range_return<const ForwardRange,re>::pack(
Chris@16:         std::max_element(boost::begin(rng), boost::end(rng), pred),
Chris@16:         rng);
Chris@16: }
Chris@16: 
Chris@16:     } // namespace range
Chris@16:     using range::max_element;
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #endif // include guard