Merge pull request #18 from ichiro-its/add-support-to-clamp-number

Add support to clamp number

Author: threeal

include/keisan/number.hpp

@@ -30,6 +30,8 @@ double scale_number(double value, double source, double target);
 double map_number(
   double value, double source_min, double source_max, double target_min, double target_max);
 
+double clamp_number(double value, double min, double max);
+
 }  // namespace keisan
 
 #endif  // KEISAN__NUMBER_HPP_

src/number.cpp

@@ -20,6 +20,7 @@
 
 #include <keisan/number.hpp>
 
+#include <algorithm>
 #include <cmath>
 
 namespace keisan
@@ -45,4 +46,9 @@ double map_number(
     value - source_min, source_max - source_min, target_max - target_min);
 }
 
+double clamp_number(double value, double min_value, double max_value)
+{
+  return std::max(std::min(value, max_value), min_value);
+}
+
 }  // namespace keisan

test/number_test.cpp

@@ -96,3 +96,19 @@ TEST(MapNumberTest, OutsideTest) {
     keisan::map_number(-9.3, -6.5, 4.75, -6.5 * 5.0, 4.75 * 5.0),
     -9.3 * 5.0);
 }
+
+TEST(ClampNumberTest, InsideTest) {
+  ASSERT_DOUBLE_EQ(
+    keisan::clamp_number(5.0, 1.0, 10.0),
+    5.0);
+}
+
+TEST(ClampNumberTest, OutsideTest) {
+  ASSERT_DOUBLE_EQ(
+    keisan::clamp_number(0.0, 1.0, 10.0),
+    1.0);
+
+  ASSERT_DOUBLE_EQ(
+    keisan::clamp_number(15.0, 1.0, 10.0),
+    10.0);
+}