[math] Remove Tolerance class in favor of function

Author: salkinium

src/modm/architecture/interface/peripheral.hpp

@@ -88,7 +88,7 @@ class PeripheralDriver
 	static void
 	assertBaudrateInTolerance()
 	{
-		static_assert(modm::Tolerance::isValueInTolerance(requested, available, tolerance),
+		static_assert(modm::isValueInTolerance(requested, available, tolerance),
 				"The closest available baudrate exceeds the tolerance of the requested baudrate!");
 	}
 };

src/modm/math/tolerance.hpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013-2015, 2018, Niklas Hauser
+ * Copyright (c) 2013-2015, 2018, 2024, Niklas Hauser
  *
  * This file is part of the modm project.
  *
@@ -9,60 +9,20 @@
  */
 // ----------------------------------------------------------------------------
 
-#ifndef MODM_MATH_TOLERANCE_HPP
-#define MODM_MATH_TOLERANCE_HPP
+#pragma once
 
-#include <stdint.h>
 #include <modm/math/units.hpp>
+#include <cmath>
 
 namespace modm
 {
 
-/**
- * This class checks if values are within a certain tolerance.
- *
- * This can be used to guarantee the quality of certain parameters,
- * mostly baudrate or datarate.
- *
- * @ingroup	modm_math
- */
-class
-Tolerance
+/// @ingroup modm_math
+template< typename T >
+constexpr bool
+isValueInTolerance(T reference, T actual, percent_t tolerance)
 {
-public:
-	static constexpr int64_t
-	absoluteError(uint32_t reference, uint32_t actual)
-	{
-		return (int64_t(reference) - actual);
-	}
-
-	static constexpr float
-	relativeError(uint32_t reference, uint32_t actual)
-	{
-		return (1.f - float(actual) / reference);
-	}
-
-	static constexpr bool
-	isErrorInTolerance(float error, percent_t tolerance)
-	{
-		return (error == 0) or (((error > 0) ? error : -error) <= pct2f(tolerance));
-	}
-
-	static constexpr bool
-	isValueInTolerance(uint32_t reference, uint32_t actual, percent_t tolerance)
-	{
-		return isErrorInTolerance(relativeError(reference, actual), tolerance);
-	}
-
-	template< uint32_t reference, uint32_t actual, percent_t tolerance >
-	static void
-	assertValueInTolerance()
-	{
-		static_assert(isValueInTolerance(reference, actual, tolerance),
-				"The actual value exceeds the tolerance of reference!");
-	}
-};
+	return std::abs(1.0 - double(actual) / double(reference)) <= std::abs(double(tolerance));
+}
 
 } // namespace modm
-
-#endif	// MODM_MATH_TOLERANCE_HPP

src/modm/platform/usb/sam/usb.hpp.in

@@ -30,7 +30,7 @@ public:
 	{
 %% if target["family"] == "g5x"
 		// only the USB device mode is supported for now
-		static_assert(modm::Tolerance::isValueInTolerance(48_MHz, SystemClock::Usb, 0.25_pct),
+		static_assert(modm::isValueInTolerance(48_MHz, SystemClock::Usb, 0.25_pct),
 				"The USB clock frequency must be within 0.25\% of 48MHz!");
 		// Select DM/DP function for PA21/22
 		MATRIX->CCFG_SYSIO &= ~(CCFG_SYSIO_SYSIO11 | CCFG_SYSIO_SYSIO10);

test/modm/ui/color/color_test.cpp

@@ -93,9 +93,9 @@ void ColorTest::testRgbHsvPingPongConvertion_8bit()
 
 	// Convertion can distort - allow some tolerance.
 	using namespace modm;
-	TEST_ASSERT_TRUE(modm::Tolerance::isValueInTolerance(rgb8.red, rgb8_b.red, 1_pct));
-	TEST_ASSERT_TRUE(modm::Tolerance::isValueInTolerance(rgb8.green, rgb8_b.green, 1_pct));
-	TEST_ASSERT_TRUE(modm::Tolerance::isValueInTolerance(rgb8.blue, rgb8_b.blue, 1_pct));
+	TEST_ASSERT_TRUE(modm::isValueInTolerance(rgb8.red, rgb8_b.red, 1_pct));
+	TEST_ASSERT_TRUE(modm::isValueInTolerance(rgb8.green, rgb8_b.green, 1_pct));
+	TEST_ASSERT_TRUE(modm::isValueInTolerance(rgb8.blue, rgb8_b.blue, 1_pct));
 }
 
 // TODO 16bit convertion not yet working
@@ -109,7 +109,7 @@ void ColorTest::testRgbHsvPingPongConvertion_8bit()
 
 // 	// Convertion can distort - allow some tolerance.
 // 	using namespace modm;
-// 	TEST_ASSERT_TRUE(modm::Tolerance::isValueInTolerance(rgb.red, rgb16_b.red, 1_pct));
-// 	TEST_ASSERT_TRUE(modm::Tolerance::isValueInTolerance(rgb.green, rgb16_b.green, 1_pct));
-// 	TEST_ASSERT_TRUE(modm::Tolerance::isValueInTolerance(rgb.blue, rgb16_b.blue, 1_pct));
-// }
+// 	TEST_ASSERT_TRUE(modm::isValueInTolerance(rgb.red, rgb16_b.red, 1_pct));
+// 	TEST_ASSERT_TRUE(modm::isValueInTolerance(rgb.green, rgb16_b.green, 1_pct));
+// 	TEST_ASSERT_TRUE(modm::isValueInTolerance(rgb.blue, rgb16_b.blue, 1_pct));
+// }