hotfix

added AngleBetween method for Vector3 + tests

README.md

@@ -11,7 +11,7 @@
 
 Oranges's Math Library (omath) is a comprehensive, open-source library aimed at providing efficient, reliable, and versatile mathematical functions and algorithms. Developed primarily in C++, this library is designed to cater to a wide range of mathematical operations essential in scientific computing, engineering, and academic research.
 
-## Features
+## 👁‍🗨 Features
 - **Efficiency**: Optimized for performance, ensuring quick computations.
 - **Versatility**: Includes a wide array of mathematical functions and algorithms.
 - **Ease of Use**: Simplified interface for convenient integration into various projects.
@@ -20,7 +20,7 @@ Oranges's Math Library (omath) is a comprehensive, open-source library aimed at
 - **Collision Detection**: Production ready code to handle collision detection by using simple interfaces.
 - **No Additional Dependencies**: No additional dependencies need to use OMath except unit test execution
 
-## Getting Started
+## ⏬ Getting Started
 ### Prerequisites
 - C++ Compiler
 - CMake (for building the project)
@@ -54,7 +54,7 @@ For detailed commands on installing different versions and more information, ple
    cmake --build cmake-build/build/windows-release --target server -j 6
    ```
    Use **\<platform\>-\<build configuration\>** preset to build siutable version for yourself. Like **windows-release** or **linux-release**.
-## Usage
+## ❔ Usage
 Simple world to screen function
 ```c++
 TEST(UnitTestProjection, IsPointOnScreen)
@@ -76,11 +76,11 @@ With `omath/projection` module you can achieve simple ESP hack for powered by So
 
 </details>
 
-## Contributing
+## 🫵🏻 Contributing
 Contributions to `omath` are welcome! Please read `CONTRIBUTING.md` for details on our code of conduct and the process for submitting pull requests.
 
-## License
+## 📜 License
 This project is licensed under the MIT - see the `LICENSE` file for details.
 
-## Acknowledgments
+## 💘 Acknowledgments
 -  [All contributors](https://github.com/orange-cpp/omath/graphs/contributors)

include/omath/Matrix.hpp

@@ -38,10 +38,7 @@ namespace omath
 
 
         [[nodiscard]]
-        float& operator[](size_t row, size_t column)
-        {
-            return At(row, column);
-        }
+        float& operator[](size_t row, size_t column);
 
         [[nodiscard]]
         size_t ColumnsCount() const noexcept;

include/omath/Vector3.hpp

@@ -7,9 +7,18 @@
 #include <cstdint>
 #include <functional>
 #include "omath/Vector2.hpp"
+#include "omath/Angle.hpp"
+#include <expected>
+
 
 namespace omath
 {
+
+    enum class Vector3Error
+    {
+        IMPOSSIBLE_BETWEEN_ANGLE,
+    };
+
     class Vector3 : public Vector2
     {
     public:
@@ -208,6 +217,17 @@ namespace omath
             return Sum2D() + z;
         }
 
+        [[nodiscard]] std::expected<Angle<float, 0.f, 180.f, AngleFlags::Clamped>, Vector3Error>
+        AngleBetween(const Vector3& other) const
+        {
+            const auto bottom = Length() * other.Length();
+
+            if (bottom == 0.f)
+                return std::unexpected(Vector3Error::IMPOSSIBLE_BETWEEN_ANGLE);
+
+            return Angle<float, 0.f, 180.f, AngleFlags::Clamped>::FromRadians(std::acos(Dot(other) / bottom));
+        }
+
         [[nodiscard]] constexpr float Sum2D() const
         {
             return Vector2::Sum();

source/Matrix.cpp

@@ -74,6 +74,11 @@ namespace omath
     {
         return m_rows;
     }
+    
+    float& Matrix::operator[](const size_t row, const size_t column)
+    {
+        return At(row, column);
+    }
 
     Matrix::Matrix(Matrix&& other) noexcept
     {

tests/general/UnitTestVector3.cpp

@@ -387,6 +387,15 @@ TEST_F(UnitTestVector3, AsTuple)
     EXPECT_FLOAT_EQ(std::get<2>(tuple), v1.z);
 }
 
+// Test AsTuple method
+TEST_F(UnitTestVector3, AngleBeatween)
+{
+    EXPECT_EQ(Vector3(0.0f, 0.0f, 1.0f).AngleBetween({1, 0 ,0}).value().AsDegrees(), 90.0f);
+    EXPECT_EQ(Vector3(0.0f, 0.0f, 1.0f).AngleBetween({0.0f, 0.0f, 1.0f}).value().AsDegrees(), 0.0f);
+    EXPECT_FALSE(Vector3(0.0f, 0.0f, 0.0f).AngleBetween({0.0f, 0.0f, 1.0f}).has_value());
+}
+
+
 // Static assertions (compile-time checks)
 static_assert(Vector3(1.0f, 2.0f, 3.0f).LengthSqr() == 14.0f, "LengthSqr should be 14");
 static_assert(Vector3(1.0f, 2.0f, 3.0f).Dot(Vector3(4.0f, 5.0f, 6.0f)) == 32.0f, "Dot product should be 32");