feat: norm() added to a cartesian_vector

Author: mpusz

src/core/include/mp-units/cartesian_vector.h

@@ -175,7 +175,7 @@ class cartesian_vector : public detail::cartesian_vector_iface {
     return *this;
   }
 
-  [[nodiscard]] constexpr T magnitude() const
+  [[nodiscard]] constexpr T norm() const
     requires treat_as_floating_point<T>
   {
     using namespace std;
@@ -186,10 +186,16 @@ class cartesian_vector : public detail::cartesian_vector_iface {
       return hypot(_coordinates_[0], _coordinates_[1], _coordinates_[2]);
   }
 
+  [[nodiscard]] constexpr T magnitude() const
+    requires treat_as_floating_point<T>
+  {
+    return norm();
+  }
+
   [[nodiscard]] constexpr cartesian_vector unit() const
     requires treat_as_floating_point<T>
   {
-    return *this / magnitude();
+    return *this / norm();
   }
 
   [[nodiscard]] constexpr T& operator[](std::size_t i) { return _coordinates_[i]; }
@@ -249,10 +255,16 @@ class cartesian_vector : public detail::cartesian_vector_iface {
     return *this;
   }
 
+  [[nodiscard]] friend constexpr T norm(const cartesian_vector& vec)
+    requires treat_as_floating_point<T>
+  {
+    return vec.norm();
+  }
+
   [[nodiscard]] friend constexpr T magnitude(const cartesian_vector& vec)
     requires treat_as_floating_point<T>
   {
-    return vec.magnitude();
+    return vec.norm();
   }
 
   [[nodiscard]] friend constexpr cartesian_vector unit_vector(const cartesian_vector& vec)

test/runtime/cartesian_vector_test.cpp

@@ -316,18 +316,31 @@ TEST_CASE("cartesian_vector operations", "[vector]")
     }
   }
 
+  SECTION("cartesian_vector norm")
+  {
+    cartesian_vector v1{3.0, 4.0, 0.0};
+    cartesian_vector v2{2.0, 3.0, 6.0};
+    REQUIRE(v1.norm() == 5.0);
+    REQUIRE(v2.norm() == 7.0);
+    REQUIRE(norm(v1) == 5.0);
+    REQUIRE(norm(v2) == 7.0);
+  }
+
   SECTION("cartesian_vector magnitude")
   {
     cartesian_vector v1{3.0, 4.0, 0.0};
     cartesian_vector v2{2.0, 3.0, 6.0};
     REQUIRE(v1.magnitude() == 5.0);
     REQUIRE(v2.magnitude() == 7.0);
+    REQUIRE(magnitude(v1) == 5.0);
+    REQUIRE(magnitude(v2) == 7.0);
   }
 
   SECTION("cartesian_vector unit vector")
   {
     cartesian_vector v{3.0, 4.0, 0.0};
     cartesian_vector unit_v = v.unit();
+    REQUIRE_THAT(unit_v.norm(), WithinULP(1.0, 1));
     REQUIRE_THAT(unit_v.magnitude(), WithinULP(1.0, 1));
   }