Merge pull request #36 from orange-cpp/u/orange-cpp/small-refactoring

U/orange cpp/small refactoring

.gitignore

@@ -1,3 +1,4 @@
 /cmake-build/
 /.idea
 /out
+*.DS_Store

CMakeLists.txt

@@ -12,13 +12,17 @@ option(OMATH_USE_AVX2 "Omath will use AVX2 to boost performance" ON)
 option(OMATH_IMGUI_INTEGRATION "Omath will define method to convert omath types to imgui types" OFF)
 option(OMATH_BUILD_EXAMPLES "Build example projects with you can learn & play" OFF)
 option(OMATH_STATIC_MSVC_RUNTIME_LIBRARY  "Force Omath to link static runtime" OFF)
+option(OMATH_SUPRESS_SAFETY_CHECKS "Supress some safety checks in release build to improve general performance" ON)
+
 
 if (OMATH_BUILD_AS_SHARED_LIBRARY)
-    add_library(omath SHARED source/Matrix.cpp)
+    add_library(omath SHARED source/matrix.cpp)
 else()
-    add_library(omath STATIC source/Matrix.cpp)
+    add_library(omath STATIC source/matrix.cpp
+            source/matrix.cpp)
 endif()
 
+message(STATUS "Building on ${CMAKE_HOST_SYSTEM_NAME}")
 add_library(omath::omath ALIAS omath)
 
 if (OMATH_IMGUI_INTEGRATION)
@@ -44,6 +48,10 @@ if (OMATH_USE_AVX2)
     target_compile_definitions(omath PUBLIC OMATH_USE_AVX2)
 endif()
 
+if (OMATH_SUPRESS_SAFETY_CHECKS)
+    target_compile_definitions(omath PUBLIC OMATH_SUPRESS_SAFETY_CHECKS)
+endif()
+
 set_target_properties(omath PROPERTIES
         ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/out/${CMAKE_BUILD_TYPE}"
         LIBRARY_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/out/${CMAKE_BUILD_TYPE}"

CMakePresets.json

@@ -64,6 +64,38 @@
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release"
       }
+    },
+    {
+      "name": "darwin-base",
+      "hidden": true,
+      "generator": "Ninja",
+      "binaryDir": "${sourceDir}/cmake-build/build/${presetName}",
+      "installDir": "${sourceDir}/cmake-build/install/${presetName}",
+      "cacheVariables": {
+        "CMAKE_C_COMPILER": "clang",
+        "CMAKE_CXX_COMPILER": "clang++"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Darwin"
+      }
+    },
+    {
+      "name": "darwin-debug",
+      "displayName": "Darwin Debug",
+      "inherits": "darwin-base",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug"
+      }
+    },
+    {
+      "name": "darwin-release",
+      "displayName": "Darwin Release",
+      "inherits": "darwin-debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release"
+      }
     }
   ]
 }

README.md

@@ -21,12 +21,21 @@ Oranges's Math Library (omath) is a comprehensive, open-source library aimed at
 - **No Additional Dependencies**: No additional dependencies need to use OMath except unit test execution
 - **Ready for meta-programming**: Omath use templates for common types like Vectors, Matrixes etc, to handle all types!
 
-|ENGINE  |SUPPORT|
-|--------|-------|
-|Source  |✅YES   |
-|Unity   |✅YES   |
-|IWEngine|✅YES   |
-|Unreal  |❌NO    |
+## Supported Render Pipelines
+| ENGINE   | SUPPORT |
+|----------|---------|
+| Source   | ✅YES    |
+| Unity    | ✅YES    |
+| IWEngine | ✅YES    |
+| Unreal   | ❌NO     |
+
+## Supported Operating Systems
+
+| OS             | SUPPORT |
+|----------------|---------|
+| Windows 10/11  | ✅YES    |
+| Linux          | ✅YES    |
+| Darwin (MacOS) | ✅YES    |
 
 ## ⏬ Getting Started
 ### Prerequisites
@@ -73,9 +82,9 @@ TEST(UnitTestProjection, IsPointOnScreen)
     EXPECT_TRUE(proj.has_value());
 }
 ```
-
+## Showcase
 <details>
-  <summary>OMATH for making cheats</summary>
+  <summary>OMATH for making cheats (click to open)</summary>
 
 With `omath/projection` module you can achieve simple ESP hack for powered by Source/Unreal/Unity engine games, like [Apex Legends](https://store.steampowered.com/app/1172470/Apex_Legends/).
 

include/omath/angle.hpp

@@ -5,6 +5,8 @@
 #pragma once
 #include "omath/angles.hpp"
 #include <algorithm>
+#include <utility>
+
 
 namespace omath
 {

include/omath/color.hpp

@@ -8,6 +8,15 @@
 #include "omath/vector3.hpp"
 #include "omath/vector4.hpp"
 
+#ifdef max
+#undef max
+#endif
+
+
+#ifdef min
+#undef min
+#endif
+
 namespace omath
 {
     struct HSV
@@ -118,7 +127,7 @@ namespace omath
         {
             Clamp(0.f, 1.f);
         }
-        consteval void SetHue(const float hue)
+        constexpr void SetHue(const float hue)
         {
             auto hsv = ToHSV();
             hsv.hue = hue;
@@ -126,7 +135,7 @@ namespace omath
             *this = FromHSV(hsv);
         }
 
-        consteval void SetSaturation(const float saturation)
+        constexpr void SetSaturation(const float saturation)
         {
             auto hsv = ToHSV();
             hsv.saturation = saturation;
@@ -134,7 +143,7 @@ namespace omath
             *this = FromHSV(hsv);
         }
 
-        consteval void SetValue(const float value)
+        constexpr void SetValue(const float value)
         {
             auto hsv = ToHSV();
             hsv.value = value;

include/omath/mat.hpp

@@ -9,6 +9,17 @@
 #include <stdexcept>
 #include <utility>
 #include "omath/vector3.hpp"
+#include <numeric>
+
+
+#ifdef near
+#undef near
+#endif
+
+
+#ifdef far
+#undef far
+#endif
 
 namespace omath
 {
@@ -81,6 +92,12 @@ namespace omath
             return At(row, col);
         }
 
+        [[nodiscard]]
+        constexpr Type& operator[](const size_t row, const size_t col) const
+        {
+            return At(row, col);
+        }
+        
         constexpr Mat(Mat&& other) noexcept
         {
             m_data = std::move(other.m_data);
@@ -107,9 +124,10 @@ namespace omath
         [[nodiscard]]
         constexpr const Type& At(const size_t rowIndex, const size_t columnIndex) const
         {
+#if !defined(NDEBUG) && defined(OMATH_SUPRESS_SAFETY_CHECKS)
             if (rowIndex >= Rows || columnIndex >= Columns)
                 throw std::out_of_range("Index out of range");
-
+#endif
             if constexpr (StoreType == MatStoreType::ROW_MAJOR)
                 return m_data[rowIndex * Columns + columnIndex];
 
@@ -131,12 +149,7 @@ namespace omath
         [[nodiscard]]
         constexpr Type Sum() const noexcept
         {
-            Type sum = 0;
-            for (size_t i = 0; i < Rows; ++i)
-                for (size_t j = 0; j < Columns; ++j)
-                    sum += At(i, j);
-
-            return sum;
+            return std::accumulate(m_data.begin(), m_data.end(), Type(0));
         }
 
         constexpr void Clear() noexcept
@@ -151,6 +164,7 @@ namespace omath
 
         // Operator overloading for multiplication with another Mat
         template<size_t OtherColumns>
+        [[nodiscard]]
         constexpr Mat<Rows, OtherColumns, Type, StoreType>
         operator*(const Mat<Columns, OtherColumns, Type, StoreType>& other) const
         {
@@ -169,9 +183,7 @@ namespace omath
 
         constexpr Mat& operator*=(const Type& f) noexcept
         {
-            for (size_t i = 0; i < Rows; ++i)
-                for (size_t j = 0; j < Columns; ++j)
-                    At(i, j) *= f;
+            std::ranges::for_each(m_data, [&f](auto& val) {val *= f;});
             return *this;
         }
 
@@ -183,47 +195,39 @@ namespace omath
         }
 
         [[nodiscard]]
-        constexpr Mat operator*(const Type& f) const noexcept
+        constexpr Mat operator*(const Type& value) const noexcept
         {
             Mat result(*this);
-            result *= f;
+            result *= value;
             return result;
         }
 
-        constexpr Mat& operator/=(const Type& f) noexcept
+        constexpr Mat& operator/=(const Type& value) noexcept
         {
-            for (size_t i = 0; i < Rows; ++i)
-                for (size_t j = 0; j < Columns; ++j)
-                    At(i, j) /= f;
+            std::ranges::for_each(m_data, [&value](auto& val) {val /= value;});
             return *this;
         }
 
         [[nodiscard]]
-        constexpr Mat operator/(const Type& f) const noexcept
+        constexpr Mat operator/(const Type& value) const noexcept
         {
             Mat result(*this);
-            result /= f;
+            result /= value;
             return result;
         }
 
         constexpr Mat& operator=(const Mat& other) noexcept
         {
-            if (this == &other)
-                return *this;
-            for (size_t i = 0; i < Rows; ++i)
-                for (size_t j = 0; j < Columns; ++j)
-                    At(i, j) = other.At(i, j);
+            if (this != &other)
+                m_data = other.m_data;
+
             return *this;
         }
 
         constexpr Mat& operator=(Mat&& other) noexcept
         {
-            if (this == &other)
-                return *this;
-
-            for (size_t i = 0; i < Rows; ++i)
-                for (size_t j = 0; j < Columns; ++j)
-                    At(i, j) = other.At(i, j);
+            if (this != &other)
+                m_data = std::move(other.m_data);
 
             return *this;
         }
@@ -247,7 +251,7 @@ namespace omath
             if constexpr (Rows == 1)
                 return At(0, 0);
 
-            else if constexpr (Rows == 2)
+            if constexpr (Rows == 2)
                 return At(0, 0) * At(1, 1) - At(0, 1) * At(1, 0);
             else
             {

include/omath/vector2.hpp

@@ -124,9 +124,9 @@ namespace omath
         }
 
 #ifndef _MSC_VER
-        [[nodiscard]] constexpr Type& Length() const
+        [[nodiscard]] constexpr Type Length() const
         {
-            return std::hypot(x, y);
+            return std::hypot(this->x, this->y);
         }
 
         [[nodiscard]] constexpr Vector2 Normalized() const

include/omath/vector3.hpp

@@ -121,12 +121,12 @@ namespace omath
 #ifndef _MSC_VER
         [[nodiscard]] constexpr Type Length() const
         {
-            return std::hypot(x, y, z);
+            return std::hypot(this->x, this->y, z);
         }
 
         [[nodiscard]] constexpr Type Length2D() const
         {
-            return Vector2::Length();
+            return Vector2<Type>::Length();
         }
         [[nodiscard]] Type DistTo(const Vector3& vOther) const
         {

source/projectile_prediction/proj_pred_engine_avx2.cpp

@@ -4,13 +4,19 @@
 #include "omath/projectile_prediction/proj_pred_engine_avx2.hpp"
 #include "source_location"
 
+
+#if defined(OMATH_USE_AVX2) && defined(__i386__) && defined(__x86_64__)
+#include <immintrin.h>
+#include <format>
+#endif
+
 namespace omath::projectile_prediction
 {
     std::optional<Vector3<float>>
     ProjPredEngineAVX2::MaybeCalculateAimPoint([[maybe_unused]] const Projectile& projectile,
                                                [[maybe_unused]] const Target& target) const
     {
-#ifdef OMATH_USE_AVX2
+#if defined(OMATH_USE_AVX2) && defined(__i386__) && defined(__x86_64__)
         const float bulletGravity = m_gravityConstant * projectile.m_gravityScale;
         const float v0 = projectile.m_launchSpeed;
         const float v0Sqr = v0 * v0;

tests/general/unit_test_mat.cpp

@@ -166,8 +166,10 @@ TEST_F(UnitTestMat, StaticMethod_ToScreenMat)
 // Test exception handling in At() method
 TEST_F(UnitTestMat, Method_At_OutOfRange)
 {
+#if !defined(NDEBUG) && defined(OMATH_SUPRESS_SAFETY_CHECKS)
     EXPECT_THROW(std::ignore = m2.At(2, 0), std::out_of_range);
     EXPECT_THROW(std::ignore = m2.At(0, 2), std::out_of_range);
+#endif
 }
 
 // Test Determinant for 3x3 matrix