type_traits.hpp

Go to the documentation of this file.

//==----------------- type_traits.hpp - SYCL type traits -------------------==//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include <sycl/access/access.hpp>
#include <sycl/detail/generic_type_lists.hpp>
#include <sycl/detail/stl_type_traits.hpp>
#include <sycl/detail/type_list.hpp>
 
#include <array>
#include <tuple>
#include <type_traits>
 
namespace sycl {
__SYCL_INLINE_VER_NAMESPACE(_V1) {
template <int Dimensions> class group;
namespace ext {
namespace oneapi {
struct sub_group;
 
namespace experimental {
template <typename Group, std::size_t Extent> class group_with_scratchpad;
 
namespace detail {
template <typename T> struct is_group_helper : std::false_type {};
 
template <typename Group, std::size_t Extent>
struct is_group_helper<group_with_scratchpad<Group, Extent>> : std::true_type {
};
} // namespace detail
} // namespace experimental
} // namespace oneapi
} // namespace ext
 
namespace detail {
 
template <typename T> struct is_group : std::false_type {};
 
template <int Dimensions>
struct is_group<group<Dimensions>> : std::true_type {};
 
template <typename T> struct is_sub_group : std::false_type {};
 
template <> struct is_sub_group<ext::oneapi::sub_group> : std::true_type {};
 
template <typename T>
struct is_generic_group
    : std::integral_constant<bool,
                             is_group<T>::value || is_sub_group<T>::value> {};
 
namespace half_impl {
class half;
}
} // namespace detail
using half = detail::half_impl::half;
 
// Forward declaration
template <typename ElementType, access::address_space Space,
          access::decorated DecorateAddress>
class multi_ptr;
 
template <class T>
__SYCL_INLINE_CONSTEXPR bool is_group_v =
    detail::is_group<T>::value || detail::is_sub_group<T>::value;
 
namespace ext::oneapi::experimental {
template <class T>
__SYCL_INLINE_CONSTEXPR bool is_group_helper_v =
    detail::is_group_helper<std::decay_t<T>>::value;
} // namespace ext::oneapi::experimental
 
namespace detail {
// Type for Intel device UUID extension.
// For details about this extension, see
// sycl/doc/extensions/supported/sycl_ext_intel_device_info.md
using uuid_type = std::array<unsigned char, 16>;
 
template <typename T, typename R> struct copy_cv_qualifiers;
 
template <typename T, typename R>
using copy_cv_qualifiers_t = typename copy_cv_qualifiers<T, R>::type;
 
template <int V> using int_constant = std::integral_constant<int, V>;
 
// vector_size
// scalars are interpreted as a vector of 1 length.
template <typename T> struct vector_size_impl : int_constant<1> {};
template <typename T, int N>
struct vector_size_impl<vec<T, N>> : int_constant<N> {};
template <typename T>
struct vector_size : vector_size_impl<remove_cv_t<remove_reference_t<T>>> {};
 
// 4.10.2.6 Memory layout and alignment
template <typename T, int N>
struct vector_alignment_impl
    : conditional_t<N == 3, int_constant<sizeof(T) * 4>,
                    int_constant<sizeof(T) * N>> {};
 
template <typename T, int N>
struct vector_alignment
    : vector_alignment_impl<remove_cv_t<remove_reference_t<T>>, N> {};
 
// vector_element
template <typename T> struct vector_element_impl;
template <typename T>
using vector_element_impl_t = typename vector_element_impl<T>::type;
template <typename T> struct vector_element_impl {
  using type = T;
};
template <typename T, int N> struct vector_element_impl<vec<T, N>> {
  using type = T;
};
template <typename T> struct vector_element {
  using type = copy_cv_qualifiers_t<T, vector_element_impl_t<remove_cv_t<T>>>;
};
template <class T> using vector_element_t = typename vector_element<T>::type;
 
// change_base_type_t
template <typename T, typename B> struct change_base_type {
  using type = B;
};
 
template <typename T, int N, typename B> struct change_base_type<vec<T, N>, B> {
  using type = vec<B, N>;
};
 
template <typename T, typename B>
using change_base_type_t = typename change_base_type<T, B>::type;
 
// Applies the same the cv-qualifiers from T type to R type
template <typename T, typename R> struct copy_cv_qualifiers_impl {
  using type = R;
};
 
template <typename T, typename R> struct copy_cv_qualifiers_impl<const T, R> {
  using type = const R;
};
 
template <typename T, typename R>
struct copy_cv_qualifiers_impl<volatile T, R> {
  using type = volatile R;
};
 
template <typename T, typename R>
struct copy_cv_qualifiers_impl<const volatile T, R> {
  using type = const volatile R;
};
 
template <typename T, typename R> struct copy_cv_qualifiers {
  using type = typename copy_cv_qualifiers_impl<T, remove_cv_t<R>>::type;
};
 
// make_signed with support SYCL vec class
template <typename T, typename Enable = void> struct make_signed_impl;
 
template <typename T>
using make_signed_impl_t = typename make_signed_impl<T, T>::type;
 
template <typename T>
struct make_signed_impl<
    T, std::enable_if_t<is_contained<T, gtl::scalar_integer_list>::value, T>> {
  using type = typename std::make_signed<T>::type;
};
 
template <typename T>
struct make_signed_impl<
    T, std::enable_if_t<is_contained<T, gtl::vector_integer_list>::value, T>> {
  using base_type = make_signed_impl_t<vector_element_t<T>>;
  using type = change_base_type_t<T, base_type>;
};
 
// TODO Delete this specialization after solving the problems in the test
// infrastructure.
template <typename T>
struct make_signed_impl<
    T, std::enable_if_t<!is_contained<T, gtl::integer_list>::value, T>> {
  using type = T;
};
 
template <typename T> struct make_signed {
  using new_type_wo_cv_qualifiers = make_signed_impl_t<remove_cv_t<T>>;
  using type = copy_cv_qualifiers_t<T, new_type_wo_cv_qualifiers>;
};
 
template <typename T> using make_signed_t = typename make_signed<T>::type;
 
// make_unsigned with support SYCL vec class
template <typename T, typename Enable = void> struct make_unsigned_impl;
 
template <typename T>
using make_unsigned_impl_t = typename make_unsigned_impl<T, T>::type;
 
template <typename T>
struct make_unsigned_impl<
    T, std::enable_if_t<is_contained<T, gtl::scalar_integer_list>::value, T>> {
  using type = typename std::make_unsigned<T>::type;
};
 
template <typename T>
struct make_unsigned_impl<
    T, std::enable_if_t<is_contained<T, gtl::vector_integer_list>::value, T>> {
  using base_type = make_unsigned_impl_t<vector_element_t<T>>;
  using type = change_base_type_t<T, base_type>;
};
 
// TODO Delete this specialization after solving the problems in the test
// infrastructure.
template <typename T>
struct make_unsigned_impl<
    T, std::enable_if_t<!is_contained<T, gtl::integer_list>::value, T>> {
  using type = T;
};
 
template <typename T> struct make_unsigned {
  using new_type_wo_cv_qualifiers = make_unsigned_impl_t<remove_cv_t<T>>;
  using type = copy_cv_qualifiers_t<T, new_type_wo_cv_qualifiers>;
};
 
template <typename T> using make_unsigned_t = typename make_unsigned<T>::type;
 
// Checks that sizeof base type of T equal N and T satisfies S<T>::value
template <typename T, int N, template <typename> class S>
using is_gen_based_on_type_sizeof =
    bool_constant<S<T>::value && (sizeof(vector_element_t<T>) == N)>;
 
template <typename> struct is_vec : std::false_type {};
template <typename T, std::size_t N>
struct is_vec<sycl::vec<T, N>> : std::true_type {};
 
// is_integral
template <typename T>
struct is_integral : std::is_integral<vector_element_t<T>> {};
 
// is_floating_point
template <typename T>
struct is_floating_point_impl : std::is_floating_point<T> {};
 
template <> struct is_floating_point_impl<half> : std::true_type {};
 
template <typename T>
struct is_floating_point
    : is_floating_point_impl<remove_cv_t<vector_element_t<T>>> {};
 
// is_arithmetic
template <typename T>
struct is_arithmetic
    : bool_constant<is_integral<T>::value || is_floating_point<T>::value> {};
 
template <typename T>
struct is_scalar_arithmetic
    : bool_constant<!is_vec<T>::value && is_arithmetic<T>::value> {};
 
template <typename T>
struct is_vector_arithmetic
    : bool_constant<is_vec<T>::value && is_arithmetic<T>::value> {};
 
// is_bool
template <typename T>
struct is_scalar_bool
    : bool_constant<std::is_same<remove_cv_t<T>, bool>::value> {};
 
template <typename T>
struct is_vector_bool
    : bool_constant<is_vec<T>::value &&
                    is_scalar_bool<vector_element_t<T>>::value> {};
 
template <typename T>
struct is_bool : bool_constant<is_scalar_bool<vector_element_t<T>>::value> {};
 
// is_pointer
template <typename T> struct is_pointer_impl : std::false_type {};
 
template <typename T> struct is_pointer_impl<T *> : std::true_type {};
 
template <typename T, access::address_space Space,
          access::decorated DecorateAddress>
struct is_pointer_impl<multi_ptr<T, Space, DecorateAddress>> : std::true_type {
};
 
template <typename T> struct is_pointer : is_pointer_impl<remove_cv_t<T>> {};
 
// remove_pointer_t
template <typename T> struct remove_pointer_impl {
  using type = T;
};
 
template <typename T> struct remove_pointer_impl<T *> {
  using type = T;
};
 
template <typename T, access::address_space Space,
          access::decorated DecorateAddress>
struct remove_pointer_impl<multi_ptr<T, Space, DecorateAddress>> {
  using type = T;
};
 
template <typename T>
struct remove_pointer : remove_pointer_impl<remove_cv_t<T>> {};
 
template <typename T> using remove_pointer_t = typename remove_pointer<T>::type;
 
// is_address_space_compliant
template <typename T, typename SpaceList>
struct is_address_space_compliant_impl : std::false_type {};
 
template <typename T, typename SpaceList>
struct is_address_space_compliant_impl<T *, SpaceList> : std::true_type {};
 
template <typename T, typename SpaceList, access::address_space Space,
          access::decorated DecorateAddress>
struct is_address_space_compliant_impl<multi_ptr<T, Space, DecorateAddress>,
                                       SpaceList>
    : bool_constant<is_one_of_spaces<Space, SpaceList>::value> {};
 
template <typename T, typename SpaceList>
struct is_address_space_compliant
    : is_address_space_compliant_impl<remove_cv_t<T>, SpaceList> {};
 
// make_type_t
template <typename T, typename TL> struct make_type_impl {
  using type = find_same_size_type_t<TL, T>;
};
 
template <typename T, int N, typename TL> struct make_type_impl<vec<T, N>, TL> {
  using scalar_type = typename make_type_impl<T, TL>::type;
  using type = vec<scalar_type, N>;
};
 
template <typename T, typename TL>
using make_type_t = typename make_type_impl<T, TL>::type;
 
// make_larger_t
template <typename T, typename Enable = void> struct make_larger_impl;
template <typename T>
struct make_larger_impl<
    T, std::enable_if_t<is_contained<T, gtl::scalar_floating_list>::value, T>> {
  using type = find_twice_as_large_type_t<gtl::scalar_floating_list, T>;
};
 
template <typename T>
struct make_larger_impl<
    T, std::enable_if_t<is_contained<T, gtl::scalar_signed_integer_list>::value,
                        T>> {
  using type = find_twice_as_large_type_t<gtl::scalar_signed_integer_list, T>;
};
 
template <typename T>
struct make_larger_impl<
    T, std::enable_if_t<
           is_contained<T, gtl::scalar_unsigned_integer_list>::value, T>> {
  using type = find_twice_as_large_type_t<gtl::scalar_unsigned_integer_list, T>;
};
 
template <typename T, int N> struct make_larger_impl<vec<T, N>, vec<T, N>> {
  using base_type = vector_element_t<vec<T, N>>;
  using upper_type = typename make_larger_impl<base_type, base_type>::type;
  using new_type = vec<upper_type, N>;
  static constexpr bool found = !std::is_same<upper_type, void>::value;
  using type = conditional_t<found, new_type, void>;
};
 
template <typename T> struct make_larger {
  using type = typename make_larger_impl<T, T>::type;
};
 
template <typename T> using make_larger_t = typename make_larger<T>::type;
 
#if defined(RESTRICT_WRITE_ACCESS_TO_CONSTANT_PTR)
template <access::address_space AS, class DataT>
using const_if_const_AS =
    typename std::conditional<AS == access::address_space::constant_space,
                              const DataT, DataT>::type;
#else
template <access::address_space AS, class DataT>
using const_if_const_AS = DataT;
#endif
 
template <typename T> struct function_traits {};
 
template <typename Ret, typename... Args> struct function_traits<Ret(Args...)> {
  using ret_type = Ret;
  using args_type = std::tuple<Args...>;
};
 
} // namespace detail
} // __SYCL_INLINE_VER_NAMESPACE(_V1)
} // namespace sycl