Boost 学习之算法篇 clamp

clamp
        头文件clamp.hpp包含两个函数,用来“夹紧”一对边界值之间的值。（就是返回在一对边界值——[参数2,参数3]中最接近（或者等于）参数1的值。）
        调用函数clamp (v, lo, hi),则可能有一下三种返回值:
              当v小于1o 返回lo
              当hi小于v 返回hi
             其他情况下返回v

注意:当传递给clamp的是浮点值的时候,假设其中一个的参数值为NULL则可能获得意想不到的结果。还有一个版本的clamp函数,允许调用者不适用"<"操作符,而是自己制定一个特定的比较谓词。

原文链接:http://www.boost.org/doc/libs/1_60_0/libs/algorithm/doc/html/algorithm/Misc.html

官方API

template<typename V>
V clamp ( V val, V lo, V hi );

template<typename V, typename Pred>
V clamp ( V val, V lo, V hi, Pred p );

如下代码：
int foo = 23;
foo = clamp ( foo, 1, 10 );
将会返回10赋值给foo。


时间复杂度：
clamp 将会在返回之前使用谓词做两次比较。

clamp_range
        我们有4个以范围为版本的clamp函数，这些函数可以作用于多种不同的值。也可以使用std::transform和bind自己写一个合适的，比如std::transform(first, last, out, bind ( clamp ( _1, lo, hi ))),但是为了方便，我们提供了这些版本：

template<typename InputIterator, typename OutputIterator>
OutputIterator clamp_range ( InputIterator first, InputIterator last, OutputIterator out,
    typename std::iterator_traits<InputIterator>::value_type lo,
    typename std::iterator_traits<InputIterator>::value_type hi );

template<typename Range, typename OutputIterator>
OutputIterator clamp_range ( const Range &r, OutputIterator out,
	typename std::iterator_traits<typename boost::range_iterator<const Range>::type>::value_type lo,
	typename std::iterator_traits<typename boost::range_iterator<const Range>::type>::value_type hi );

template<typename InputIterator, typename OutputIterator, typename Pred>
OutputIterator clamp_range ( InputIterator first, InputIterator last, OutputIterator out,
    typename std::iterator_traits<InputIterator>::value_type lo,
    typename std::iterator_traits<InputIterator>::value_type hi, Pred p );

template<typename Range, typename OutputIterator, typename Pred>
OutputIterator clamp_range ( const Range &r, OutputIterator out,
	typename std::iterator_traits<typename boost::range_iterator<const Range>::type>::value_type lo,
	typename std::iterator_traits<typename boost::range_iterator<const Range>::type>::value_type hi,
	Pred p );