generic_type_lists.hpp

Go to the documentation of this file.

//==-------- generic_type_lists.hpp - SYCL Generic type lists --------------==//
//
// 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>    // for address_space
#include <sycl/detail/type_list.hpp> // for type_list, address_space_list
 
#include <cstddef>     // for byte, size_t
#include <type_traits> // for conditional_t, is_signed_v, is_...
 
// Generic type name description, which serves as a description for all valid
// types of parameters to kernel functions
 
// Forward declarations
namespace sycl {
inline namespace _V1 {
template <typename T, int N> class vec;
template <typename Type, std::size_t NumElements> class marray;
 
namespace detail {
namespace half_impl {
class half;
}
} // namespace detail
using half = detail::half_impl::half;
 
namespace ext::oneapi {
class bfloat16;
}
namespace detail {
namespace gtl {
// floating point types
using scalar_half_list = type_list<half>;
 
using vector_half_list = type_list<vec<half, 1>, vec<half, 2>, vec<half, 3>,
                                   vec<half, 4>, vec<half, 8>, vec<half, 16>>;
 
using marray_half_list =
    type_list<marray<half, 1>, marray<half, 2>, marray<half, 3>,
              marray<half, 4>, marray<half, 8>, marray<half, 16>>;
 
using scalar_vector_half_list = tl_append<scalar_half_list, vector_half_list>;
 
using half_list =
    tl_append<scalar_half_list, vector_half_list, marray_half_list>;
 
using scalar_bfloat16_list = type_list<sycl::ext::oneapi::bfloat16>;
 
using vector_bfloat16_list = type_list<
    vec<sycl::ext::oneapi::bfloat16, 1>, vec<sycl::ext::oneapi::bfloat16, 2>,
    vec<sycl::ext::oneapi::bfloat16, 3>, vec<sycl::ext::oneapi::bfloat16, 4>,
    vec<sycl::ext::oneapi::bfloat16, 8>, vec<sycl::ext::oneapi::bfloat16, 16>>;
 
using marray_bfloat16_list = type_list<marray<sycl::ext::oneapi::bfloat16, 1>,
                                       marray<sycl::ext::oneapi::bfloat16, 2>,
                                       marray<sycl::ext::oneapi::bfloat16, 3>,
                                       marray<sycl::ext::oneapi::bfloat16, 4>,
                                       marray<sycl::ext::oneapi::bfloat16, 8>,
                                       marray<sycl::ext::oneapi::bfloat16, 16>>;
 
using scalar_vector_bfloat16_list =
    tl_append<scalar_bfloat16_list, vector_bfloat16_list>;
 
using bfloat16_list =
    tl_append<scalar_bfloat16_list, vector_bfloat16_list, marray_bfloat16_list>;
 
using half_bfloat16_list = tl_append<scalar_half_list, scalar_bfloat16_list>;
 
using scalar_float_list = type_list<float>;
 
using vector_float_list =
    type_list<vec<float, 1>, vec<float, 2>, vec<float, 3>, vec<float, 4>,
              vec<float, 8>, vec<float, 16>>;
 
using marray_float_list =
    type_list<marray<float, 1>, marray<float, 2>, marray<float, 3>,
              marray<float, 4>, marray<float, 8>, marray<float, 16>>;
 
using scalar_vector_float_list =
    tl_append<scalar_float_list, vector_float_list>;
 
using float_list =
    tl_append<scalar_float_list, vector_float_list, marray_float_list>;
 
using scalar_double_list = type_list<double>;
 
using vector_double_list =
    type_list<vec<double, 1>, vec<double, 2>, vec<double, 3>, vec<double, 4>,
              vec<double, 8>, vec<double, 16>>;
 
using marray_double_list =
    type_list<marray<double, 1>, marray<double, 2>, marray<double, 3>,
              marray<double, 4>, marray<double, 8>, marray<double, 16>>;
 
using scalar_vector_double_list =
    tl_append<scalar_double_list, vector_double_list>;
 
using double_list =
    tl_append<scalar_double_list, vector_double_list, marray_double_list>;
 
using scalar_floating_list = tl_append<scalar_float_list, scalar_double_list,
                                       scalar_half_list, scalar_bfloat16_list>;
 
using vector_floating_list = tl_append<vector_float_list, vector_double_list,
                                       vector_half_list, vector_bfloat16_list>;
 
using marray_floating_list = tl_append<marray_float_list, marray_double_list,
                                       marray_half_list, marray_bfloat16_list>;
 
using scalar_vector_floating_list =
    tl_append<scalar_floating_list, vector_floating_list>;
 
using floating_list =
    tl_append<scalar_floating_list, vector_floating_list, marray_floating_list>;
 
// geometric floating point types
using scalar_geo_half_list = type_list<half>;
 
using scalar_geo_float_list = type_list<float>;
 
using scalar_geo_double_list = type_list<double>;
 
using vector_geo_half_list =
    type_list<vec<half, 1>, vec<half, 2>, vec<half, 3>, vec<half, 4>>;
 
using vector_geo_float_list =
    type_list<vec<float, 1>, vec<float, 2>, vec<float, 3>, vec<float, 4>>;
 
using vector_geo_double_list =
    type_list<vec<double, 1>, vec<double, 2>, vec<double, 3>, vec<double, 4>>;
 
using marray_geo_float_list =
    type_list<marray<float, 2>, marray<float, 3>, marray<float, 4>>;
 
using marray_geo_double_list =
    type_list<marray<double, 2>, marray<double, 3>, marray<double, 4>>;
 
using geo_half_list = tl_append<scalar_geo_half_list, vector_geo_half_list>;
 
using geo_float_list = tl_append<scalar_geo_float_list, vector_geo_float_list>;
 
using geo_double_list =
    tl_append<scalar_geo_double_list, vector_geo_double_list>;
 
using scalar_geo_list = tl_append<scalar_geo_half_list, scalar_geo_float_list,
                                  scalar_geo_double_list>;
 
using vector_geo_list = tl_append<vector_geo_half_list, vector_geo_float_list,
                                  vector_geo_double_list>;
 
using marray_geo_list =
    tl_append<marray_geo_float_list, marray_geo_double_list>;
 
using geo_list = tl_append<scalar_geo_list, vector_geo_list>;
 
// cross floating point types
using cross_half_list = type_list<vec<half, 3>, vec<half, 4>>;
 
using cross_float_list = type_list<vec<float, 3>, vec<float, 4>>;
 
using cross_double_list = type_list<vec<double, 3>, vec<double, 4>>;
 
using cross_floating_list =
    tl_append<cross_float_list, cross_double_list, cross_half_list>;
 
using cross_marray_list = type_list<marray<float, 3>, marray<float, 4>,
                                    marray<double, 3>, marray<double, 4>>;
 
using scalar_default_char_list = type_list<char>;
 
using vector_default_char_list =
    type_list<vec<char, 1>, vec<char, 2>, vec<char, 3>, vec<char, 4>,
              vec<char, 8>, vec<char, 16>>;
 
using marray_default_char_list =
    type_list<marray<char, 1>, marray<char, 2>, marray<char, 3>,
              marray<char, 4>, marray<char, 8>, marray<char, 16>>;
 
using default_char_list =
    tl_append<scalar_default_char_list, vector_default_char_list,
              marray_default_char_list>;
 
using scalar_signed_char_list = type_list<signed char>;
 
using vector_signed_char_list =
    type_list<vec<signed char, 1>, vec<signed char, 2>, vec<signed char, 3>,
              vec<signed char, 4>, vec<signed char, 8>, vec<signed char, 16>>;
 
using marray_signed_char_list =
    type_list<marray<signed char, 1>, marray<signed char, 2>,
              marray<signed char, 3>, marray<signed char, 4>,
              marray<signed char, 8>, marray<signed char, 16>>;
 
using signed_char_list =
    tl_append<scalar_signed_char_list, vector_signed_char_list,
              marray_signed_char_list>;
 
using scalar_unsigned_char_list = type_list<unsigned char>;
 
using vector_unsigned_char_list =
    type_list<vec<unsigned char, 1>, vec<unsigned char, 2>,
              vec<unsigned char, 3>, vec<unsigned char, 4>,
              vec<unsigned char, 8>, vec<unsigned char, 16>>;
 
using marray_unsigned_char_list =
    type_list<marray<unsigned char, 1>, marray<unsigned char, 2>,
              marray<unsigned char, 3>, marray<unsigned char, 4>,
              marray<unsigned char, 8>, marray<unsigned char, 16>>;
 
using unsigned_char_list =
    tl_append<scalar_unsigned_char_list, vector_unsigned_char_list,
              marray_unsigned_char_list>;
 
using scalar_char_list =
    tl_append<scalar_default_char_list, scalar_signed_char_list,
              scalar_unsigned_char_list>;
 
using vector_char_list =
    tl_append<vector_default_char_list, vector_signed_char_list,
              vector_unsigned_char_list>;
 
using marray_char_list =
    tl_append<marray_default_char_list, marray_signed_char_list,
              marray_unsigned_char_list>;
 
using char_list = tl_append<scalar_char_list, vector_char_list>;
 
// short int types
using scalar_signed_short_list = type_list<signed short>;
 
using vector_signed_short_list =
    type_list<vec<signed short, 1>, vec<signed short, 2>, vec<signed short, 3>,
              vec<signed short, 4>, vec<signed short, 8>,
              vec<signed short, 16>>;
 
using marray_signed_short_list =
    type_list<marray<signed short, 1>, marray<signed short, 2>,
              marray<signed short, 3>, marray<signed short, 4>,
              marray<signed short, 8>, marray<signed short, 16>>;
 
using signed_short_list =
    tl_append<scalar_signed_short_list, vector_signed_short_list,
              marray_signed_short_list>;
 
using scalar_unsigned_short_list = type_list<unsigned short>;
 
using vector_unsigned_short_list =
    type_list<vec<unsigned short, 1>, vec<unsigned short, 2>,
              vec<unsigned short, 3>, vec<unsigned short, 4>,
              vec<unsigned short, 8>, vec<unsigned short, 16>>;
 
using marray_unsigned_short_list =
    type_list<marray<unsigned short, 1>, marray<unsigned short, 2>,
              marray<unsigned short, 3>, marray<unsigned short, 4>,
              marray<unsigned short, 8>, marray<unsigned short, 16>>;
 
using unsigned_short_list =
    tl_append<scalar_unsigned_short_list, vector_unsigned_short_list,
              marray_unsigned_short_list>;
 
using scalar_short_list =
    tl_append<scalar_signed_short_list, scalar_unsigned_short_list>;
 
using vector_short_list =
    tl_append<vector_signed_short_list, vector_unsigned_short_list,
              marray_unsigned_short_list>;
 
using short_list = tl_append<scalar_short_list, vector_short_list>;
 
// int types
using scalar_signed_int_list = type_list<signed int>;
 
using vector_signed_int_list =
    type_list<vec<signed int, 1>, vec<signed int, 2>, vec<signed int, 3>,
              vec<signed int, 4>, vec<signed int, 8>, vec<signed int, 16>>;
 
using marray_signed_int_list =
    type_list<marray<signed int, 1>, marray<signed int, 2>,
              marray<signed int, 3>, marray<signed int, 4>,
              marray<signed int, 8>, marray<signed int, 16>>;
 
using signed_int_list =
    tl_append<scalar_signed_int_list, vector_signed_int_list,
              marray_signed_int_list>;
 
using scalar_unsigned_int_list = type_list<unsigned int>;
 
using vector_unsigned_int_list =
    type_list<vec<unsigned int, 1>, vec<unsigned int, 2>, vec<unsigned int, 3>,
              vec<unsigned int, 4>, vec<unsigned int, 8>,
              vec<unsigned int, 16>>;
 
using marray_unsigned_int_list =
    type_list<marray<unsigned int, 1>, marray<unsigned int, 2>,
              marray<unsigned int, 3>, marray<unsigned int, 4>,
              marray<unsigned int, 8>, marray<unsigned int, 16>>;
 
using unsigned_int_list =
    tl_append<scalar_unsigned_int_list, vector_unsigned_int_list,
              marray_unsigned_int_list>;
 
using scalar_int_list =
    tl_append<scalar_signed_int_list, scalar_unsigned_int_list>;
 
using vector_int_list =
    tl_append<vector_signed_int_list, vector_unsigned_int_list>;
 
using marray_int_list =
    tl_append<marray_signed_int_list, marray_unsigned_int_list>;
 
using int_list = tl_append<scalar_int_list, vector_int_list, marray_int_list>;
 
// long types
using scalar_signed_long_list = type_list<signed long>;
 
using vector_signed_long_list =
    type_list<vec<signed long, 1>, vec<signed long, 2>, vec<signed long, 3>,
              vec<signed long, 4>, vec<signed long, 8>, vec<signed long, 16>>;
 
using marray_signed_long_list =
    type_list<marray<signed long, 1>, marray<signed long, 2>,
              marray<signed long, 3>, marray<signed long, 4>,
              marray<signed long, 8>, marray<signed long, 16>>;
 
using signed_long_list =
    tl_append<scalar_signed_long_list, vector_signed_long_list,
              marray_signed_long_list>;
 
using scalar_unsigned_long_list = type_list<unsigned long>;
 
using vector_unsigned_long_list =
    type_list<vec<unsigned long, 1>, vec<unsigned long, 2>,
              vec<unsigned long, 3>, vec<unsigned long, 4>,
              vec<unsigned long, 8>, vec<unsigned long, 16>>;
 
using marray_unsigned_long_list =
    type_list<marray<unsigned long, 1>, marray<unsigned long, 2>,
              marray<unsigned long, 3>, marray<unsigned long, 4>,
              marray<unsigned long, 8>, marray<unsigned long, 16>>;
 
using unsigned_long_list =
    tl_append<scalar_unsigned_long_list, vector_unsigned_long_list,
              marray_unsigned_long_list>;
 
using scalar_long_list =
    tl_append<scalar_signed_long_list, scalar_unsigned_long_list>;
 
using vector_long_list =
    tl_append<vector_signed_long_list, vector_unsigned_long_list>;
 
using marray_long_list =
    tl_append<marray_signed_long_list, marray_unsigned_long_list>;
 
using long_list =
    tl_append<scalar_long_list, vector_long_list, marray_long_list>;
 
// long long types
using scalar_signed_longlong_list = type_list<signed long long>;
 
using vector_signed_longlong_list =
    type_list<vec<signed long long, 1>, vec<signed long long, 2>,
              vec<signed long long, 3>, vec<signed long long, 4>,
              vec<signed long long, 8>, vec<signed long long, 16>>;
 
using marray_signed_longlong_list =
    type_list<marray<signed long long, 1>, marray<signed long long, 2>,
              marray<signed long long, 3>, marray<signed long long, 4>,
              marray<signed long long, 8>, marray<signed long long, 16>>;
 
using signed_longlong_list =
    tl_append<scalar_signed_longlong_list, vector_signed_longlong_list,
              marray_signed_longlong_list>;
 
using scalar_unsigned_longlong_list = type_list<unsigned long long>;
 
using vector_unsigned_longlong_list =
    type_list<vec<unsigned long long, 1>, vec<unsigned long long, 2>,
              vec<unsigned long long, 3>, vec<unsigned long long, 4>,
              vec<unsigned long long, 8>, vec<unsigned long long, 16>>;
 
using marray_unsigned_longlong_list =
    type_list<marray<unsigned long long, 1>, marray<unsigned long long, 2>,
              marray<unsigned long long, 3>, marray<unsigned long long, 4>,
              marray<unsigned long long, 8>, marray<unsigned long long, 16>>;
 
using unsigned_longlong_list =
    tl_append<scalar_unsigned_longlong_list, vector_unsigned_longlong_list,
              marray_unsigned_longlong_list>;
 
using scalar_longlong_list =
    tl_append<scalar_signed_longlong_list, scalar_unsigned_longlong_list>;
 
using vector_longlong_list =
    tl_append<vector_signed_longlong_list, vector_unsigned_longlong_list>;
 
using marray_longlong_list =
    tl_append<marray_signed_longlong_list, marray_unsigned_longlong_list>;
 
using longlong_list =
    tl_append<scalar_longlong_list, vector_longlong_list, marray_longlong_list>;
 
// long integer types
using scalar_signed_long_integer_list =
    tl_append<scalar_signed_long_list, scalar_signed_longlong_list>;
 
using vector_signed_long_integer_list =
    tl_append<vector_signed_long_list, vector_signed_longlong_list>;
 
using marray_signed_long_integer_list =
    tl_append<marray_signed_long_list, marray_signed_longlong_list>;
 
using signed_long_integer_list =
    tl_append<scalar_signed_long_integer_list, vector_signed_long_integer_list,
              marray_signed_long_integer_list>;
 
using scalar_unsigned_long_integer_list =
    tl_append<scalar_unsigned_long_list, scalar_unsigned_longlong_list>;
 
using vector_unsigned_long_integer_list =
    tl_append<vector_unsigned_long_list, vector_unsigned_longlong_list>;
 
using marray_unsigned_long_integer_list =
    tl_append<marray_unsigned_long_list, marray_unsigned_longlong_list>;
 
using unsigned_long_integer_list = tl_append<scalar_unsigned_long_integer_list,
                                             vector_unsigned_long_integer_list,
                                             marray_unsigned_long_integer_list>;
 
using scalar_long_integer_list = tl_append<scalar_signed_long_integer_list,
                                           scalar_unsigned_long_integer_list>;
 
using vector_long_integer_list = tl_append<vector_signed_long_integer_list,
                                           vector_unsigned_long_integer_list>;
 
using marray_long_integer_list = tl_append<marray_signed_long_integer_list,
                                           marray_unsigned_long_integer_list>;
 
using long_integer_list =
    tl_append<scalar_long_integer_list, vector_long_integer_list,
              marray_long_integer_list>;
 
#if (!defined(_HAS_STD_BYTE) || _HAS_STD_BYTE != 0)
// std::byte
using scalar_byte_list = type_list<std::byte>;
 
using vector_byte_list =
    type_list<vec<std::byte, 1>, vec<std::byte, 2>, vec<std::byte, 3>,
              vec<std::byte, 4>, vec<std::byte, 8>, vec<std::byte, 16>>;
 
using marray_byte_list = type_list<marray<std::byte, 1>, marray<std::byte, 2>,
                                   marray<std::byte, 3>, marray<std::byte, 4>,
                                   marray<std::byte, 8>, marray<std::byte, 16>>;
#endif
 
// integer types
using scalar_signed_integer_list =
    tl_append<std::conditional_t<
                  std::is_signed_v<char>,
                  tl_append<scalar_default_char_list, scalar_signed_char_list>,
                  scalar_signed_char_list>,
              scalar_signed_short_list, scalar_signed_int_list,
              scalar_signed_long_list, scalar_signed_longlong_list>;
 
using vector_signed_integer_list =
    tl_append<std::conditional_t<
                  std::is_signed_v<char>,
                  tl_append<vector_default_char_list, vector_signed_char_list>,
                  vector_signed_char_list>,
              vector_signed_short_list, vector_signed_int_list,
              vector_signed_long_list, vector_signed_longlong_list>;
 
using marray_signed_integer_list =
    tl_append<std::conditional_t<
                  std::is_signed_v<char>,
                  tl_append<marray_default_char_list, marray_signed_char_list>,
                  marray_signed_char_list>,
              marray_signed_short_list, marray_signed_int_list,
              marray_signed_long_list, marray_signed_longlong_list>;
 
using signed_integer_list =
    tl_append<scalar_signed_integer_list, vector_signed_integer_list,
              marray_signed_integer_list>;
 
using scalar_unsigned_integer_list =
    tl_append<std::conditional_t<std::is_unsigned_v<char>,
                                 tl_append<scalar_default_char_list,
                                           scalar_unsigned_char_list>,
                                 scalar_unsigned_char_list>,
              scalar_unsigned_short_list, scalar_unsigned_int_list,
              scalar_unsigned_long_list, scalar_unsigned_longlong_list
#if (!defined(_HAS_STD_BYTE) || _HAS_STD_BYTE != 0)
              ,
              scalar_byte_list
#endif
              >;
 
using vector_unsigned_integer_list =
    tl_append<std::conditional_t<std::is_unsigned_v<char>,
                                 tl_append<vector_default_char_list,
                                           vector_unsigned_char_list>,
                                 vector_unsigned_char_list>,
              vector_unsigned_short_list, vector_unsigned_int_list,
              vector_unsigned_long_list, vector_unsigned_longlong_list
#if (!defined(_HAS_STD_BYTE) || _HAS_STD_BYTE != 0)
              ,
              vector_byte_list
#endif
              >;
 
using marray_unsigned_integer_list =
    tl_append<std::conditional_t<std::is_unsigned_v<char>,
                                 tl_append<marray_default_char_list,
                                           marray_unsigned_char_list>,
                                 marray_unsigned_char_list>,
              marray_unsigned_short_list, marray_unsigned_int_list,
              marray_unsigned_long_list, marray_unsigned_longlong_list
#if (!defined(_HAS_STD_BYTE) || _HAS_STD_BYTE != 0)
              ,
              marray_byte_list
#endif
              >;
 
using unsigned_integer_list =
    tl_append<scalar_unsigned_integer_list, vector_unsigned_integer_list,
              marray_unsigned_integer_list>;
 
using scalar_integer_list =
    tl_append<scalar_signed_integer_list, scalar_unsigned_integer_list>;
 
using vector_integer_list =
    tl_append<vector_signed_integer_list, vector_unsigned_integer_list>;
 
using marray_integer_list =
    tl_append<marray_signed_integer_list, marray_unsigned_integer_list>;
 
using integer_list =
    tl_append<scalar_integer_list, vector_integer_list, marray_integer_list>;
 
// bool types
 
using marray_bool_list =
    type_list<marray<bool, 1>, marray<bool, 2>, marray<bool, 3>,
              marray<bool, 4>, marray<bool, 8>, marray<bool, 16>>;
 
using scalar_bool_list = type_list<bool>;
 
using bool_list = tl_append<scalar_bool_list, marray_bool_list>;
 
using vector_bool_list = type_list<vec<bool, 1>, vec<bool, 2>, vec<bool, 3>,
                                   vec<bool, 4>, vec<bool, 8>, vec<bool, 16>>;
 
// basic types
using scalar_signed_basic_list =
    tl_append<scalar_floating_list, scalar_signed_integer_list>;
 
using vector_signed_basic_list =
    tl_append<vector_floating_list, vector_signed_integer_list>;
 
using marray_signed_basic_list =
    tl_append<marray_floating_list, marray_signed_integer_list>;
 
using signed_basic_list =
    tl_append<scalar_signed_basic_list, vector_signed_basic_list,
              marray_signed_basic_list>;
 
using scalar_unsigned_basic_list = tl_append<scalar_unsigned_integer_list>;
 
using vector_unsigned_basic_list = tl_append<vector_unsigned_integer_list>;
 
using marray_unsigned_basic_list = tl_append<marray_unsigned_integer_list>;
 
using unsigned_basic_list =
    tl_append<scalar_unsigned_basic_list, vector_unsigned_basic_list,
              marray_unsigned_basic_list>;
 
using scalar_basic_list =
    tl_append<scalar_signed_basic_list, scalar_unsigned_basic_list>;
 
using vector_basic_list =
    tl_append<vector_signed_basic_list, vector_unsigned_basic_list>;
 
using marray_basic_list =
    tl_append<marray_signed_basic_list, marray_unsigned_basic_list>;
 
using basic_list =
    tl_append<scalar_basic_list, vector_basic_list, marray_basic_list>;
 
// nan builtin types
using nan_list = tl_append<gtl::unsigned_short_list, gtl::unsigned_int_list,
                           gtl::unsigned_long_integer_list>;
} // namespace gtl
namespace gvl {
// address spaces
using nonconst_address_space_list = address_space_list<
    access::address_space::local_space, access::address_space::global_space,
    access::address_space::private_space, access::address_space::generic_space,
    access::address_space::ext_intel_global_device_space,
    access::address_space::ext_intel_global_host_space>;
 
} // namespace gvl
} // namespace detail
} // namespace _V1
} // namespace sycl