1 files changed, 54 insertions, 0 deletions
diff --git a/libs/algorithm/example/clamp_example.cpp b/libs/algorithm/example/clamp_example.cpp
new file mode 100644
index 000000000..be61c84c0
--- /dev/null
+++ b/libs/algorithm/example/clamp_example.cpp
@@ -0,0 +1,54 @@
+/* 
+   Copyright (c) Marshall Clow 2010-2012.
+
+   Distributed under the Boost Software License, Version 1.0. (See accompanying
+   file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+    For more information, see http://www.boost.org
+*/
+
+#include <string>
+#include <iostream>     // for cout, etc
+
+#include <boost/algorithm/clamp.hpp>
+
+namespace ba = boost::algorithm;
+
+bool compare_string_lengths ( const std::string &one, const std::string &two )
+{
+    return one.length () < two.length ();
+}
+
+int main ( int /*argc*/, char * /*argv*/ [] ) {
+//  Clamp takes a value and two "fenceposts", and brings the value "between" the fenceposts.
+
+//  If the input value is "between" the fenceposts, then it is returned unchanged.
+    std::cout << "Clamping   5 to between [1, 10] -> " << ba::clamp ( 5, 1, 10 ) << std::endl;
+
+//  If the input value is out side the range of the fenceposts, it "brought into" range.
+    std::cout << "Clamping  15 to between [1, 10] -> " << ba::clamp (  15, 1, 10 ) << std::endl;
+    std::cout << "Clamping -15 to between [1, 10] -> " << ba::clamp ( -15, 1, 10 ) << std::endl;
+
+//  It doesn't just work for ints
+    std::cout << "Clamping 5.1 to between [1, 10] -> " << ba::clamp ( 5.1, 1.0, 10.0 ) << std::endl;
+
+    {
+        std::string one ( "Lower Bound" ), two ( "upper bound!" ), test1 ( "test#" ), test2 ( "#test" );
+        std::cout << "Clamping '" << test1 << "' between ['" << one << "' and '" << two << "'] -> '" << 
+            ba::clamp ( test1, one, two ) << "'" << std::endl;
+        std::cout << "Clamping '" << test2 << "' between ['" << one << "' and '" << two << "'] -> '" << 
+            ba::clamp ( test2, one, two ) << "'" << std::endl;
+    //  There is also a predicate based version, if you want to compare objects in your own way
+        std::cout << "Clamping '" << test1 << "' between ['" << one << "' and '" << two << "'] (comparing lengths) -> '" << 
+            ba::clamp ( test1, one, two, compare_string_lengths ) << "'" << std::endl;
+        std::cout << "Clamping '" << test2 << "' between ['" << one << "' and '" << two << "'] (comparing lengths) -> '" << 
+            ba::clamp ( test2, one, two, compare_string_lengths ) << "'" << std::endl;
+    
+    }
+
+//  Sometimes, though, you don't get quite what you expect
+//  This is because the two double arguments get converted to int
+    std::cout << "Somewhat unexpected: clamp ( 12, 14.7, 15.9 ) --> " << ba::clamp ( 12, 14.7, 15.9 ) << std::endl;
+    std::cout << "Expected:     clamp ((double)12, 14.7, 15.9 ) --> " << ba::clamp ((double) 12, 14.7, 15.9 ) << std::endl;
+    return 0;
+    }