From d9efcc6b6df4ba42bf9d10bc7a73b9cd6b7fbec4 Mon Sep 17 00:00:00 2001 From: Marshall Clow Date: Sun, 28 Jun 2009 23:04:50 +0000 Subject: [PATCH] Updated per Olaf's suggestions [SVN r54484] --- clamp/test/clamp_test.cpp | 86 +++++++++++++++---------------- include/boost/algorithm/clamp.hpp | 8 +-- 2 files changed, 46 insertions(+), 48 deletions(-) diff --git a/clamp/test/clamp_test.cpp b/clamp/test/clamp_test.cpp index 50019cf..775c6d4 100644 --- a/clamp/test/clamp_test.cpp +++ b/clamp/test/clamp_test.cpp @@ -16,32 +16,32 @@ void test_ints() { // Inside the range, equal to the endpoints, and outside the endpoints. - BOOST_CHECK_EQUAL ( 3, ba::clamp ( 1, 10, 3 )); - BOOST_CHECK_EQUAL ( 1, ba::clamp ( 1, 10, 1 )); - BOOST_CHECK_EQUAL ( 1, ba::clamp ( 1, 10, 0 )); - BOOST_CHECK_EQUAL ( 10, ba::clamp ( 1, 10, 10 )); - BOOST_CHECK_EQUAL ( 10, ba::clamp ( 1, 10, 11 )); + BOOST_CHECK_EQUAL ( 3, ba::clamp ( 3, 1, 10 )); + BOOST_CHECK_EQUAL ( 1, ba::clamp ( 1, 1, 10 )); + BOOST_CHECK_EQUAL ( 1, ba::clamp ( 0, 1, 10 )); + BOOST_CHECK_EQUAL ( 10, ba::clamp ( 10, 1, 10 )); + BOOST_CHECK_EQUAL ( 10, ba::clamp ( 11, 1, 10 )); // Negative numbers - BOOST_CHECK_EQUAL ( -3, ba::clamp ( -10, -1, -3 )); - BOOST_CHECK_EQUAL ( -1, ba::clamp ( -10, -1, -1 )); - BOOST_CHECK_EQUAL ( -1, ba::clamp ( -10, -1, 0 )); - BOOST_CHECK_EQUAL ( -10, ba::clamp ( -10, -1, -10 )); - BOOST_CHECK_EQUAL ( -10, ba::clamp ( -10, -1, -11 )); + BOOST_CHECK_EQUAL ( -3, ba::clamp ( -3, -10, -1 )); + BOOST_CHECK_EQUAL ( -1, ba::clamp ( -1, -10, -1 )); + BOOST_CHECK_EQUAL ( -1, ba::clamp ( 0, -10, -1 )); + BOOST_CHECK_EQUAL ( -10, ba::clamp ( -10, -10, -1 )); + BOOST_CHECK_EQUAL ( -10, ba::clamp ( -11, -10, -1 )); // Mixed positive and negative numbers - BOOST_CHECK_EQUAL ( 5, ba::clamp ( -10, 10, 5 )); - BOOST_CHECK_EQUAL ( -10, ba::clamp ( -10, 10, -10 )); - BOOST_CHECK_EQUAL ( -10, ba::clamp ( -10, 10, -15 )); - BOOST_CHECK_EQUAL ( 10, ba::clamp ( -10, 10, 10 )); - BOOST_CHECK_EQUAL ( 10, ba::clamp ( -10, 10, 15 )); + BOOST_CHECK_EQUAL ( 5, ba::clamp ( 5, -10, 10 )); + BOOST_CHECK_EQUAL ( -10, ba::clamp ( -10, -10, 10 )); + BOOST_CHECK_EQUAL ( -10, ba::clamp ( -15, -10, 10 )); + BOOST_CHECK_EQUAL ( 10, ba::clamp ( 10, -10, 10 )); + BOOST_CHECK_EQUAL ( 10, ba::clamp ( 15, -10, 10 )); // Unsigned - BOOST_CHECK_EQUAL ( 5U, ba::clamp ( 1U, 10U, 5U )); - BOOST_CHECK_EQUAL ( 1U, ba::clamp ( 1U, 10U, 1U )); - BOOST_CHECK_EQUAL ( 1U, ba::clamp ( 1U, 10U, 0U )); - BOOST_CHECK_EQUAL ( 10U, ba::clamp ( 1U, 10U, 10U )); - BOOST_CHECK_EQUAL ( 10U, ba::clamp ( 1U, 10U, 15U )); + BOOST_CHECK_EQUAL ( 5U, ba::clamp ( 5U, 1U, 10U )); + BOOST_CHECK_EQUAL ( 1U, ba::clamp ( 1U, 1U, 10U )); + BOOST_CHECK_EQUAL ( 1U, ba::clamp ( 0U, 1U, 10U )); + BOOST_CHECK_EQUAL ( 10U, ba::clamp ( 10U, 1U, 10U )); + BOOST_CHECK_EQUAL ( 10U, ba::clamp ( 15U, 1U, 10U )); } @@ -49,25 +49,25 @@ void test_floats() { // Inside the range, equal to the endpoints, and outside the endpoints. - BOOST_CHECK_EQUAL ( 3.0, ba::clamp ( 1.0, 10.0, 3.0 )); - BOOST_CHECK_EQUAL ( 1.0, ba::clamp ( 1.0, 10.0, 1.0 )); - BOOST_CHECK_EQUAL ( 1.0, ba::clamp ( 1.0, 10.0, 0.0 )); - BOOST_CHECK_EQUAL ( 10.0, ba::clamp ( 1.0, 10.0, 10.0 )); - BOOST_CHECK_EQUAL ( 10.0, ba::clamp ( 1.0, 10.0, 11.0 )); + BOOST_CHECK_EQUAL ( 3.0, ba::clamp ( 3.0, 1.0, 10.0 )); + BOOST_CHECK_EQUAL ( 1.0, ba::clamp ( 1.0, 1.0, 10.0 )); + BOOST_CHECK_EQUAL ( 1.0, ba::clamp ( 0.0, 1.0, 10.0 )); + BOOST_CHECK_EQUAL ( 10.0, ba::clamp ( 10.0, 1.0, 10.0 )); + BOOST_CHECK_EQUAL ( 10.0, ba::clamp ( 11.0, 1.0, 10.0 )); // Negative numbers - BOOST_CHECK_EQUAL ( -3.f, ba::clamp ( -10.f, -1.f, -3.f )); - BOOST_CHECK_EQUAL ( -1.f, ba::clamp ( -10.f, -1.f, -1.f )); - BOOST_CHECK_EQUAL ( -1.f, ba::clamp ( -10.f, -1.f, 0.f )); - BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -10.f, -1.f, -10.f )); - BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -10.f, -1.f, -11.f )); + BOOST_CHECK_EQUAL ( -3.f, ba::clamp ( -3.f, -10.f, -1.f )); + BOOST_CHECK_EQUAL ( -1.f, ba::clamp ( -1.f, -10.f, -1.f )); + BOOST_CHECK_EQUAL ( -1.f, ba::clamp ( 0.f, -10.f, -1.f )); + BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -10.f, -10.f, -1.f )); + BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -11.f, -10.f, -1.f )); // Mixed positive and negative numbers - BOOST_CHECK_EQUAL ( 5.f, ba::clamp ( -10.f, 10.f, 5.f )); - BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -10.f, 10.f, -10.f )); - BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -10.f, 10.f, -15.f )); - BOOST_CHECK_EQUAL ( 10.f, ba::clamp ( -10.f, 10.f, 10.f )); - BOOST_CHECK_EQUAL ( 10.f, ba::clamp ( -10.f, 10.f, 15.f )); + BOOST_CHECK_EQUAL ( 5.f, ba::clamp ( 5.f, -10.f, 10.f )); + BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -10.f, -10.f, 10.f )); + BOOST_CHECK_EQUAL ( -10.f, ba::clamp ( -15.f, -10.f, 10.f )); + BOOST_CHECK_EQUAL ( 10.f, ba::clamp ( 10.f, -10.f, 10.f )); + BOOST_CHECK_EQUAL ( 10.f, ba::clamp ( 15.f, -10.f, 10.f )); } @@ -79,9 +79,7 @@ public: custom & operator = ( const custom &rhs ) { v = rhs.v; return *this; } bool operator < ( const custom &rhs ) const { return v < rhs.v; } - bool operator == ( const custom &rhs ) const { return v == rhs.v; } - bool operator <= ( const custom &rhs ) const { return v <= rhs.v; } - bool operator >= ( const custom &rhs ) const { return v >= rhs.v; } + bool operator == ( const custom &rhs ) const { return v == rhs.v; } // need this for the test std::ostream & print ( std::ostream &os ) const { return os << v; } @@ -95,14 +93,14 @@ void test_custom() { // Inside the range, equal to the endpoints, and outside the endpoints. - BOOST_CHECK_EQUAL ( custom( 3), ba::clamp ( custom(1), custom(10), custom( 3))); - BOOST_CHECK_EQUAL ( custom( 1), ba::clamp ( custom(1), custom(10), custom( 1))); - BOOST_CHECK_EQUAL ( custom( 1), ba::clamp ( custom(1), custom(10), custom( 0))); - BOOST_CHECK_EQUAL ( custom(10), ba::clamp ( custom(1), custom(10), custom(10))); - BOOST_CHECK_EQUAL ( custom(10), ba::clamp ( custom(1), custom(10), custom(11))); + BOOST_CHECK_EQUAL ( custom( 3), ba::clamp ( custom( 3), custom(1), custom(10))); + BOOST_CHECK_EQUAL ( custom( 1), ba::clamp ( custom( 1), custom(1), custom(10))); + BOOST_CHECK_EQUAL ( custom( 1), ba::clamp ( custom( 0), custom(1), custom(10))); + BOOST_CHECK_EQUAL ( custom(10), ba::clamp ( custom(10), custom(1), custom(10))); + BOOST_CHECK_EQUAL ( custom(10), ba::clamp ( custom(11), custom(1), custom(10))); // Fail!! -// BOOST_CHECK_EQUAL ( custom(1), ba::clamp ( custom(1), custom(10), custom(11))); +// BOOST_CHECK_EQUAL ( custom(1), ba::clamp ( custom(11), custom(1), custom(10))); } int test_main( int , char* [] ) diff --git a/include/boost/algorithm/clamp.hpp b/include/boost/algorithm/clamp.hpp index 6e0cc93..e1386d2 100644 --- a/include/boost/algorithm/clamp.hpp +++ b/include/boost/algorithm/clamp.hpp @@ -20,23 +20,23 @@ namespace boost { namespace algorithm { -/// \fn clamp ( V lo, V hi, V val ) +/// \fn clamp ( V val, V lo, V hi ) /// \brief Returns the value "val" brought into the range [ lo, hi ] /// If the value is greater than "hi", return hi. If the value is /// less than "lo", return lo. Otherwise, return the original value. /// +/// \param val The value to be clamped /// \param lo The low point of the range to be clamped to /// \param hi The high point of the range to be clamped to -/// \param val The value to be clamped /// template - V clamp ( V lo, V hi, V val ) + V clamp ( V val, V lo, V hi ) { // return val >= hi ? hi : val <= lo ? lo : val; // Alternately, // return std::max ( std::min ( val, hi ), lo ); // Rewritten to only use operator < - return val < lo ? lo : val < hi ? val : hi; + return val < lo ? lo : hi < val ? hi : val; } }}