From c1a0768e55604687e82243bf64acd88d97a37ba0 Mon Sep 17 00:00:00 2001
From: Mel <einebeere@gmail.com>
Date: Thu, 7 Dec 2023 01:16:11 +0100
Subject: Consolidate mathematical functions into single file and add more

---
 src/Math/Common.hpp    |  4 ++--
 src/Math/Functions.hpp | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 src/Math/Mod.hpp       | 12 ------------
 src/Math/Rotation.hpp  |  2 +-
 src/Math/Sigmoid.hpp   | 13 -------------
 src/Math/Trig.hpp      | 17 -----------------
 src/Math/Vector.hpp    |  3 ++-
 7 files changed, 51 insertions(+), 46 deletions(-)
 create mode 100644 src/Math/Functions.hpp
 delete mode 100644 src/Math/Mod.hpp
 delete mode 100644 src/Math/Sigmoid.hpp
 delete mode 100644 src/Math/Trig.hpp

(limited to 'src/Math')

diff --git a/src/Math/Common.hpp b/src/Math/Common.hpp
index cf5a2c7..6e4d8f3 100644
--- a/src/Math/Common.hpp
+++ b/src/Math/Common.hpp
@@ -2,8 +2,8 @@
 
 #include "../Common/Sizes.hpp"
 
+#include "Functions.hpp"
 #include "Vector.hpp"
 #include "Matrix.hpp"
 #include "Rotation.hpp"
-#include "Trig.hpp"
-#include "Constants.hpp"
\ No newline at end of file
+#include "Constants.hpp"
diff --git a/src/Math/Functions.hpp b/src/Math/Functions.hpp
new file mode 100644
index 0000000..fd99c6d
--- /dev/null
+++ b/src/Math/Functions.hpp
@@ -0,0 +1,46 @@
+#pragma once
+
+#include <cmath>
+#include "Constants.hpp"
+
+namespace Math {
+
+// I. Trigonometric functions.
+
+template<typename T>
+T radians(T degrees) {
+    return degrees * PI / 180.0f;
+}
+
+template<typename T>
+T degrees(T radians) {
+    return radians * 180.0f / PI;
+}
+
+// II. Mathematical functions.
+
+template <typename T>
+T sigmoid(T x) {
+    return 1 / (1 + std::pow(E, -x));
+}
+
+// Returns the least nonnegative remainder of a % b.
+// Euclidian definition of modulo.
+template <typename A, typename B>
+auto mod(A a, B b) -> decltype(a % b) {
+    return (a % b + b) % b;
+}
+
+template <typename T, typename R = T>
+R sign(T x) {
+    return x < 0 ? -1 : 1;
+}
+
+// III. Utility functions.
+
+template <typename T>
+Bool floats_equal(T a, T b, Real epsilon = 0.0001f) {
+    return std::abs(a - b) < epsilon;
+}
+
+}
\ No newline at end of file
diff --git a/src/Math/Mod.hpp b/src/Math/Mod.hpp
deleted file mode 100644
index d686ad9..0000000
--- a/src/Math/Mod.hpp
+++ /dev/null
@@ -1,12 +0,0 @@
-#pragma once
-
-namespace Math {
-
-// Returns the least nonnegative remainder of a % b.
-// Euclidian definition of modulo.
-template <typename A, typename B>
-auto mod(A a, B b) -> decltype(a % b) {
-    return (a % b + b) % b;
-}
-
-}
\ No newline at end of file
diff --git a/src/Math/Rotation.hpp b/src/Math/Rotation.hpp
index d5bc023..d12ac29 100644
--- a/src/Math/Rotation.hpp
+++ b/src/Math/Rotation.hpp
@@ -1,7 +1,7 @@
 #pragma once
 
 #include <cmath>
-#include "Trig.hpp"
+#include "Functions.hpp"
 #include "Vector.hpp"
 
 struct Rotation {
diff --git a/src/Math/Sigmoid.hpp b/src/Math/Sigmoid.hpp
deleted file mode 100644
index f2fa009..0000000
--- a/src/Math/Sigmoid.hpp
+++ /dev/null
@@ -1,13 +0,0 @@
-#pragma once
-
-#include <cmath>
-#include "Constants.hpp"
-
-namespace Math {
-
-template <typename T>
-T sigmoid(T x) {
-    return 1 / (1 + std::pow(E, -x));
-}
-
-}
diff --git a/src/Math/Trig.hpp b/src/Math/Trig.hpp
deleted file mode 100644
index 00489a9..0000000
--- a/src/Math/Trig.hpp
+++ /dev/null
@@ -1,17 +0,0 @@
-#pragma once
-
-#include "Constants.hpp"
-
-namespace Math {
-
-template<typename T>
-T radians(T degrees) {
-    return degrees * PI / 180.0f;
-}
-
-template<typename T>
-T degrees(T radians) {
-    return radians * 180.0f / PI;
-}
-
-}
\ No newline at end of file
diff --git a/src/Math/Vector.hpp b/src/Math/Vector.hpp
index a31afec..4506f0b 100644
--- a/src/Math/Vector.hpp
+++ b/src/Math/Vector.hpp
@@ -1,8 +1,9 @@
 #pragma once
 
-#include "../Common/Sizes.hpp"
 #include <sstream>
 #include <cmath>
+#include "../Common/Sizes.hpp"
+#include "Functions.hpp"
 
 template <uint S, typename T = Real>
 struct Vector {
-- 
cgit 1.4.1