add static function dim() to alpaka::Vec

- Easy way to get the dim of a alpaka::Vec.
alpaka-group · Nov 7, 2024 · 6140bce · 6140bce
1 parent 8fefd70
commit 6140bce
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/include/alpaka/vec/Vec.hpp b/include/alpaka/vec/Vec.hpp
@@ -368,6 +368,12 @@ namespace alpaka
             return (*this)[I];
         }
 
+        //! \return The number of dimensions of the vector.
+        [[nodiscard]] ALPAKA_FN_HOST_ACC static consteval auto dim() noexcept -> TVal
+        {
+            return TDim::value;
+        }
+
         //! \return The element-wise sum of two vectors.
         ALPAKA_NO_HOST_ACC_WARNING
         ALPAKA_FN_HOST_ACC friend constexpr auto operator+(Vec const& p, Vec const& q) -> Vec

diff --git a/test/unit/vec/src/VecTest.cpp b/test/unit/vec/src/VecTest.cpp
@@ -177,7 +177,14 @@ TEST_CASE("basicVecTraits", "[vec]")
     }
 
     {
-        constexpr alpaka::Vec<Dim, Idx> vec3(static_cast<Idx>(47u), static_cast<Idx>(8u), static_cast<Idx>(3u));
+        using Vec3 = alpaka::Vec<Dim, Idx>;
+        constexpr Vec3 vec3(static_cast<Idx>(47u), static_cast<Idx>(8u), static_cast<Idx>(3u));
+
+        // alpaka::Vec::dim
+        {
+            STATIC_REQUIRE(vec3.dim() == 3);
+            STATIC_REQUIRE(Vec3::dim() == 3);
+        }
 
         // alpaka::Vec operator +
         {