range/algorithm/remove.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_REMOVE_HPP_INCLUDED
0010 #define BOOST_RANGE_ALGORITHM_REMOVE_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 remove
0025 ///
0026 /// range-based version of the remove std algorithm
0027 ///
0028 /// \pre ForwardRange is a model of the ForwardRangeConcept
0029 template< class ForwardRange, class Value >
0030 inline BOOST_DEDUCED_TYPENAME range_iterator<ForwardRange>::type
0031 remove(ForwardRange& rng, const Value& val)
0032 {
0033     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
0034     return std::remove(boost::begin(rng),boost::end(rng),val);
0035 }
0036
0037 /// \overload
0038 template< class ForwardRange, class Value >
0039 inline BOOST_DEDUCED_TYPENAME range_iterator<const ForwardRange>::type
0040 remove(const ForwardRange& rng, const Value& val)
0041 {
0042     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
0043     return std::remove(boost::begin(rng),boost::end(rng),val);
0044 }
0045
0046 // range_return overloads
0047
0048 /// \overload
0049 template< range_return_value re, class ForwardRange, class Value >
0050 inline BOOST_DEDUCED_TYPENAME range_return<ForwardRange,re>::type
0051 remove(ForwardRange& rng, const Value& val)
0052 {
0053     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<ForwardRange> ));
0054     return range_return<ForwardRange,re>::pack(
0055         std::remove(boost::begin(rng), boost::end(rng), val),
0056         rng);
0057 }
0058
0059 /// \overload
0060 template< range_return_value re, class ForwardRange, class Value >
0061 inline BOOST_DEDUCED_TYPENAME range_return<const ForwardRange,re>::type
0062 remove(const ForwardRange& rng, const Value& val)
0063 {
0064     BOOST_RANGE_CONCEPT_ASSERT(( ForwardRangeConcept<const ForwardRange> ));
0065     return range_return<const ForwardRange,re>::pack(
0066         std::remove(boost::begin(rng), boost::end(rng), val),
0067         rng);
0068 }
0069
0070     } // namespace range
0071     using range::remove;
0072 } // namespace boost
0073
0074 #endif // include guard