Large Restructure and Organization

include/J3ML/LinearAlgebra/Vector2.h

@@ -1,6 +1,7 @@
+#pragma clang diagnostic push
+#pragma ide diagnostic ignored "modernize-use-nodiscard"
 #pragma once
 #include <J3ML/J3ML.h>
-#include <J3ML/LinearAlgebra.h>
 #include <cstddef>
 
 namespace J3ML::LinearAlgebra {
@@ -9,11 +10,17 @@ namespace J3ML::LinearAlgebra {
     /// A 2D (x, y) ordered pair.
     class Vector2 {
     public:
+
+        enum {Dimensions = 2};
+
         /// Default Constructor - Initializes values to zero
         Vector2();
         /// Constructs a new Vector2 with the value (X, Y)
         Vector2(float X, float Y);
-        Vector2(float* xyPtr);
+        /// Constructs this float2 from a C array, to the value (data[0], data[1]).
+        explicit Vector2(const float* data);
+        // Constructs a new Vector2 with the value {scalar, scalar}
+        explicit Vector2(float scalar);
         Vector2(const Vector2& rhs);   // Copy Constructor
         //Vector2(Vector2&&) = default;   // Move Constructor
 
@@ -29,10 +36,26 @@ namespace J3ML::LinearAlgebra {
         void SetX(float newX);
         void SetY(float newY);
 
-        float* ptr()
-        {
-            return &x;
-        }
+        /// Casts this float2 to a C array.
+        /** This function does not allocate new memory or make a copy of this float2. This function simply
+		returns a C pointer view to this data structure. Use ptr()[0] to access the x component of this float2
+		and ptr()[1] to access the y component.
+		@note Since the returned pointer points to this class, do not dereference the pointer after this
+			float2 has been deleted. You should never store a copy of the returned pointer.
+		@note This function is provided for compatibility with other APIs which require raw C pointer access
+			to vectors. Avoid using this function in general, and instead always use the operator []
+			or the At() function to access the elements of this vector by index.
+		@return A pointer to the first float element of this class. The data is contiguous in memory.
+		@see operator [](), At(). */
+        float* ptr();
+        const float *ptr() const;
+
+        float operator[](std::size_t index) const;
+        float &operator[](std::size_t index);
+
+        const float At(std::size_t index) const;
+
+        float &At(std::size_t index);
 
         Vector2 Abs() const;
 
@@ -42,8 +65,7 @@ namespace J3ML::LinearAlgebra {
         bool IsZero(float epsilonSq = 1e-6f) const;
         bool IsPerpendicular(const Vector2& other, float epsilonSq=1e-5f) const;
 
-        float operator[](std::size_t index) const;
-        float &operator[](std::size_t index);
+
         bool operator == (const Vector2& rhs) const;
         bool operator != (const Vector2& rhs) const;
 
@@ -145,8 +167,9 @@ namespace J3ML::LinearAlgebra {
         Vector2 operator +() const; // TODO: Implement
         Vector2 operator -() const;
         /// Assigns a vector to another
-        Vector2& operator+=(const Vector2& rhs); // Adds a vector to this vector, in-place.
-        Vector2& operator-=(const Vector2& rhs); // Subtracts a vector from this vector, in-place
+        Vector2 &operator =(const Vector2 &rhs);
+        Vector2& operator+=(const Vector2& rhs);
+        Vector2& operator-=(const Vector2& rhs);
         Vector2& operator*=(float scalar);
         Vector2& operator/=(float scalar);
 
@@ -160,4 +183,5 @@ namespace J3ML::LinearAlgebra {
     {
         return rhs * lhs;
     }
-}
+}
+#pragma clang diagnostic pop