Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

named access to Vec #2201

Merged
merged 1 commit into from
Dec 2, 2023
Merged

named access to Vec #2201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions include/alpaka/vec/Vec.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,60 @@ namespace alpaka
return m_data[Dim::value - 1];
}

//! access elements by name
//!
//! names: x,y,z,w
//! @{
template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 1, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) x() const
{
return m_data[Dim::value - 1];
}

template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 1, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) x()
{
return m_data[Dim::value - 1];
}

template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 2, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) y() const
{
return m_data[Dim::value - 2];
}

template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 2, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) y()
{
return m_data[Dim::value - 2];
}

template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 3, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) z() const
{
return m_data[Dim::value - 3];
}

template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 3, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) z()
{
return m_data[Dim::value - 3];
}

template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 4, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) w() const
{
return m_data[Dim::value - 4];
}

template<typename TDefer = Dim, std::enable_if_t<std::is_same_v<TDefer, Dim> && Dim::value >= 4, int> = 0>
ALPAKA_FN_HOST_ACC constexpr decltype(auto) w()
{
return m_data[Dim::value - 4];
}

//! @}

//! Value reference accessor at the given non-unsigned integer index.
//! \return A reference to the value at the given index.
ALPAKA_NO_HOST_ACC_WARNING
Expand Down
80 changes: 80 additions & 0 deletions test/unit/vec/src/VecTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,3 +388,83 @@ TEST_CASE("deductionGuide", "[vec]")
[[maybe_unused]] auto v3l = alpaka::Vec{1L, 2L, 3L};
STATIC_REQUIRE(std::is_same_v<decltype(v3l), alpaka::Vec<alpaka::DimInt<3>, long>>);
}

TEST_CASE("accessByName", "[vec]")
{
// dim == 1
auto v1 = alpaka::Vec{1};
CHECK(v1.x() == 1); // non-const overload
CHECK(std::as_const(v1).x() == 1); // const overload
v1.x() += 42;
CHECK(v1.x() == 43); // check if value is changes correctly

// dim == 2
auto v2 = alpaka::Vec{2, 1};
CHECK(v2.x() == 1); // non-const overload
CHECK(v2.y() == 2); // non-const overload
CHECK(std::as_const(v2).x() == 1); // const overload
CHECK(std::as_const(v2).y() == 2); // const overload
v2.x() += 42;
v2.y() += 43;
CHECK(v2.x() == 43); // check if value is changes correctly
CHECK(v2.y() == 45); // check if value is changes correctly

// dim == 3
auto v3 = alpaka::Vec{3, 2, 1};
CHECK(v3.x() == 1); // non-const overload
CHECK(v3.y() == 2); // non-const overload
CHECK(v3.z() == 3); // non-const overload
CHECK(std::as_const(v3).x() == 1); // const overload
CHECK(std::as_const(v3).y() == 2); // const overload
CHECK(std::as_const(v3).z() == 3); // const overload
v3.x() += 42;
v3.y() += 43;
v3.z() += 44;
CHECK(v3.x() == 43); // check if value is changes correctly
CHECK(v3.y() == 45); // check if value is changes correctly
CHECK(v3.z() == 47); // check if value is changes correctly

// dim == 4
auto v4 = alpaka::Vec{4, 3, 2, 1};
CHECK(v4.x() == 1); // non-const overload
CHECK(v4.y() == 2); // non-const overload
CHECK(v4.z() == 3); // non-const overload
CHECK(v4.w() == 4); // non-const overload
CHECK(std::as_const(v4).x() == 1); // const overload
CHECK(std::as_const(v4).y() == 2); // const overload
CHECK(std::as_const(v4).z() == 3); // const overload
CHECK(std::as_const(v4).w() == 4); // const overload
v4.x() += 42;
v4.y() += 43;
v4.z() += 44;
v4.w() += 45;
CHECK(v4.x() == 43); // check if value is changes correctly
CHECK(v4.y() == 45); // check if value is changes correctly
CHECK(v4.z() == 47); // check if value is changes correctly
CHECK(v4.w() == 49); // check if value is changes correctly
}

TEST_CASE("accessByNameConstexpr", "[vec]")
{
// dim == 1
constexpr auto v1 = alpaka::Vec{1};
STATIC_REQUIRE(v1.x() == 1);

// dim == 2
constexpr auto v2 = alpaka::Vec{2, 1};
STATIC_REQUIRE(v2.x() == 1);
STATIC_REQUIRE(v2.y() == 2);

// dim == 3
constexpr auto v3 = alpaka::Vec{3, 2, 1};
STATIC_REQUIRE(v3.x() == 1);
STATIC_REQUIRE(v3.y() == 2);
STATIC_REQUIRE(v3.z() == 3);

// dim == 4
constexpr auto v4 = alpaka::Vec{4, 3, 2, 1};
STATIC_REQUIRE(v4.x() == 1);
STATIC_REQUIRE(v4.y() == 2);
STATIC_REQUIRE(v4.z() == 3);
STATIC_REQUIRE(v4.w() == 4);
}