Skip to content

Add convenience macro for defining strong types (correctly) #451

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

Merged
sleeepyjack merged 2 commits into from
Apr 3, 2024
Merged

Add convenience macro for defining strong types (correctly) #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c855d33
Add convenience macro for defining strong type (correctly)
sleeepyjack Apr 2, 2024
7cd344c
Update sentinel docs
sleeepyjack Apr 2, 2024
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
23 changes: 22 additions & 1 deletion include/cuco/detail/utility/strong_type.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ namespace cuco::detail {
* @brief A strong type wrapper
*
* @tparam T Type of the value
*
*/
template <typename T>
template <class T>
struct strong_type {
/**
* @brief Constructs a strong type
Expand All @@ -42,3 +43,23 @@ struct strong_type {
};

} // namespace cuco::detail

/**
* @brief Convenience wrapper for defining a strong type
*/
#define CUCO_DEFINE_STRONG_TYPE(Name, Type) \
struct Name : public cuco::detail::strong_type<Type> { \
__host__ __device__ explicit constexpr Name(Type value) \
: cuco::detail::strong_type<Type>(value) \
{ \
} \
};

/**
* @brief Convenience wrapper for defining a templated strong type
*/
#define CUCO_DEFINE_TEMPLATE_STRONG_TYPE(Name) \
template <typename T> \
struct Name : public cuco::detail::strong_type<T> { \
__host__ __device__ explicit constexpr Name(T value) : cuco::detail::strong_type<T>(value) {} \
};
42 changes: 6 additions & 36 deletions include/cuco/sentinel.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,47 +20,17 @@

namespace cuco {
/**
* @brief A strong type wrapper used to denote the empty key sentinel.
*
* @tparam T Type of the key values
* @brief A strong type wrapper `cuco::empty_key<Key>` used to denote the empty key sentinel.
*/
template <typename T>
struct empty_key : public cuco::detail::strong_type<T> {
/**
* @brief Constructs an empty key sentinel with the given `v`.
*
* @param v The empty key sentinel value
*/
__host__ __device__ explicit constexpr empty_key(T v) : cuco::detail::strong_type<T>(v) {}
};
CUCO_DEFINE_TEMPLATE_STRONG_TYPE(empty_key);

/**
* @brief A strong type wrapper used to denote the empty value sentinel.
*
* @tparam T Type of the mapped values
* @brief A strong type wrapper `cuco::empty_value<T>` used to denote the empty value sentinel.
*/
template <typename T>
struct empty_value : public cuco::detail::strong_type<T> {
/**
* @brief Constructs an empty value sentinel with the given `v`.
*
* @param v The empty value sentinel value
*/
__host__ __device__ explicit constexpr empty_value(T v) : cuco::detail::strong_type<T>(v) {}
};
CUCO_DEFINE_TEMPLATE_STRONG_TYPE(empty_value);

/**
* @brief A strong type wrapper used to denote the erased key sentinel.
*
* @tparam T Type of the key values
* @brief A strong type wrapper `cuco::erased_key<Key>` used to denote the erased key sentinel.
*/
template <typename T>
struct erased_key : public cuco::detail::strong_type<T> {
/**
* @brief Constructs an erased key sentinel with the given `v`.
*
* @param v The erased key sentinel value
*/
__host__ __device__ explicit constexpr erased_key(T v) : cuco::detail::strong_type<T>(v) {}
};
CUCO_DEFINE_TEMPLATE_STRONG_TYPE(erased_key);
} // namespace cuco