range/algorithm/find.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_FIND_HPP_INCLUDED
0010 #define BOOST_RANGE_ALGORITHM_FIND_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 <boost/range/detail/range_return.hpp>
0017 #include <algorithm>
0018
0019 namespace boost
0020 {
0021     namespace range
0022     {
0023
0024 /// \brief template function find
0025 ///
0026 /// range-based version of the find std algorithm
0027 ///
0028 /// \pre SinglePassRange is a model of the SinglePassRangeConcept
0029 template< class SinglePassRange, class Value >
0030 inline BOOST_DEDUCED_TYPENAME disable_if<
0031     is_const<SinglePassRange>,
0032     BOOST_DEDUCED_TYPENAME range_iterator<SinglePassRange>::type
0033 >::type
0034 find( SinglePassRange& rng, const Value& val )
0035 {
0036     BOOST_RANGE_CONCEPT_ASSERT(( SinglePassRangeConcept<SinglePassRange> ));
0037     return std::find(boost::begin(rng), boost::end(rng), val);
0038 }
0039
0040 /// \overload
0041 template< class SinglePassRange, class Value >
0042 inline BOOST_DEDUCED_TYPENAME range_iterator<const SinglePassRange>::type
0043 find( const SinglePassRange& rng, const Value& val )
0044 {
0045     BOOST_RANGE_CONCEPT_ASSERT(( SinglePassRangeConcept<const SinglePassRange> ));
0046     return std::find(boost::begin(rng), boost::end(rng), val);
0047 }
0048
0049 // range_return overloads
0050
0051 /// \overload
0052 template< range_return_value re, class SinglePassRange, class Value >
0053 inline BOOST_DEDUCED_TYPENAME disable_if<
0054     is_const<SinglePassRange>,
0055     BOOST_DEDUCED_TYPENAME range_return<SinglePassRange,re>::type
0056 >::type
0057 find( SinglePassRange& rng, const Value& val )
0058 {
0059     BOOST_RANGE_CONCEPT_ASSERT(( SinglePassRangeConcept<SinglePassRange> ));
0060     return range_return<SinglePassRange,re>::
0061         pack(std::find(boost::begin(rng), boost::end(rng), val),
0062              rng);
0063 }
0064
0065 /// \overload
0066 template< range_return_value re, class SinglePassRange, class Value >
0067 inline BOOST_DEDUCED_TYPENAME range_return<const SinglePassRange,re>::type
0068 find( const SinglePassRange& rng, const Value& val )
0069 {
0070     BOOST_RANGE_CONCEPT_ASSERT(( SinglePassRangeConcept<const SinglePassRange> ));
0071     return range_return<const SinglePassRange,re>::
0072         pack(std::find(boost::begin(rng), boost::end(rng), val),
0073              rng);
0074 }
0075
0076     } // namespace range
0077     using range::find;
0078 }
0079
0080 #endif // include guard