DPC++ Runtime
Runtime libraries for oneAPI DPC++
cl::sycl::ext::oneapi::sub_group Struct Reference

#include <sycl/ext/oneapi/sub_group.hpp>

Collaboration diagram for cl::sycl::ext::oneapi::sub_group:

Public Types

using id_type = id< 1 >
 
using range_type = range< 1 >
 
using linear_id_type = uint32_t
 
template<typename T >
using EnableIfIsScalarArithmetic = sycl::detail::enable_if_t< sycl::detail::is_scalar_arithmetic< T >::value, T >
 

Public Member Functions

id_type get_local_id () const
 
linear_id_type get_local_linear_id () const
 
range_type get_local_range () const
 
range_type get_max_local_range () const
 
id_type get_group_id () const
 
linear_id_type get_group_linear_id () const
 
range_type get_group_range () const
 
template<typename T >
T shuffle (T x, id_type local_id) const
 
template<typename T >
T shuffle_down (T x, uint32_t delta) const
 
template<typename T >
T shuffle_up (T x, uint32_t delta) const
 
template<typename T >
T shuffle_xor (T x, id_type value) const
 
template<typename CVT , typename T = std::remove_cv_t<CVT>>
T load (CVT *src) const
 
template<typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore< T, Space >::value, Tload (const multi_ptr< CVT, Space > cv_src) const
 
template<typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore< T, Space >::value, Tload (const multi_ptr< CVT, Space > cv_src) const
 
template<int N, typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore< T, Space >::value, vec< T, N > > load (const multi_ptr< CVT, Space > src) const
 
template<int N, typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore< T, Space >::value, vec< T, N > > load (const multi_ptr< CVT, Space > cv_src) const
 
template<typename T >
void store (T *dst, const T &x) const
 
template<typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore< T, Space >::value > store (multi_ptr< T, Space > dst, const T &x) const
 
template<typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore< T, Space >::value > store (multi_ptr< T, Space > dst, const T &x) const
 
template<int N, typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore< T, Space >::value > store (multi_ptr< T, Space > dst, const vec< T, N > &x) const
 
template<int N, typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore< T, Space >::value > store (multi_ptr< T, Space > dst, const vec< T, N > &x) const
 
void barrier () const
 
 sub_group ()=default
 

Static Public Attributes

static constexpr int dimensions = 1
 
static constexpr sycl::memory_scope fence_scope
 

Friends

sub_group experimental::this_sub_group ()
 

Detailed Description

Definition at line 108 of file sub_group.hpp.

Member Typedef Documentation

◆ EnableIfIsScalarArithmetic

◆ id_type

Definition at line 110 of file sub_group.hpp.

◆ linear_id_type

Definition at line 112 of file sub_group.hpp.

◆ range_type

Definition at line 111 of file sub_group.hpp.

Constructor & Destructor Documentation

◆ sub_group()

cl::sycl::ext::oneapi::sub_group::sub_group ( )
default

Member Function Documentation

◆ barrier()

◆ get_group_id()

id_type cl::sycl::ext::oneapi::sub_group::get_group_id ( ) const
inline

Definition at line 155 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ get_group_linear_id()

linear_id_type cl::sycl::ext::oneapi::sub_group::get_group_linear_id ( ) const
inline

Definition at line 164 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ get_group_range()

range_type cl::sycl::ext::oneapi::sub_group::get_group_range ( ) const
inline

Definition at line 173 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ get_local_id()

id_type cl::sycl::ext::oneapi::sub_group::get_local_id ( ) const
inline

◆ get_local_linear_id()

linear_id_type cl::sycl::ext::oneapi::sub_group::get_local_linear_id ( ) const
inline

Definition at line 128 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ get_local_range()

range_type cl::sycl::ext::oneapi::sub_group::get_local_range ( ) const
inline

◆ get_max_local_range()

range_type cl::sycl::ext::oneapi::sub_group::get_max_local_range ( ) const
inline

Definition at line 146 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ load() [1/5]

template<typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore<T, Space>::value, T> cl::sycl::ext::oneapi::sub_group::load ( const multi_ptr< CVT, Space >  cv_src) const
inline

◆ load() [2/5]

template<typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore<T, Space>::value, T> cl::sycl::ext::oneapi::sub_group::load ( const multi_ptr< CVT, Space >  cv_src) const
inline

◆ load() [3/5]

template<int N, typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore<T, Space>::value, vec<T, N> > cl::sycl::ext::oneapi::sub_group::load ( const multi_ptr< CVT, Space >  cv_src) const
inline

◆ load() [4/5]

template<int N, typename CVT , access::address_space Space, typename T = std::remove_cv_t<CVT>>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore<T, Space>::value, vec<T, N> > cl::sycl::ext::oneapi::sub_group::load ( const multi_ptr< CVT, Space >  src) const
inline

Definition at line 382 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ load() [5/5]

template<typename CVT , typename T = std::remove_cv_t<CVT>>
T cl::sycl::ext::oneapi::sub_group::load ( CVT *  src) const
inline

Definition at line 272 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ shuffle()

template<typename T >
T cl::sycl::ext::oneapi::sub_group::shuffle ( T  x,
id_type  local_id 
) const
inline

Definition at line 190 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ shuffle_down()

template<typename T >
T cl::sycl::ext::oneapi::sub_group::shuffle_down ( T  x,
uint32_t  delta 
) const
inline

Definition at line 201 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ shuffle_up()

template<typename T >
T cl::sycl::ext::oneapi::sub_group::shuffle_up ( T  x,
uint32_t  delta 
) const
inline

Definition at line 212 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ shuffle_xor()

template<typename T >
T cl::sycl::ext::oneapi::sub_group::shuffle_xor ( T  x,
id_type  value 
) const
inline

Definition at line 223 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ store() [1/5]

template<typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore<T, Space>::value> cl::sycl::ext::oneapi::sub_group::store ( multi_ptr< T, Space >  dst,
const T x 
) const
inline

◆ store() [2/5]

template<typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore<T, Space>::value> cl::sycl::ext::oneapi::sub_group::store ( multi_ptr< T, Space >  dst,
const T x 
) const
inline

◆ store() [3/5]

template<int N, typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForGlobalLoadStore<T, Space>::value> cl::sycl::ext::oneapi::sub_group::store ( multi_ptr< T, Space >  dst,
const vec< T, N > &  x 
) const
inline

Definition at line 538 of file sub_group.hpp.

References PI_INVALID_DEVICE.

◆ store() [4/5]

template<int N, typename T , access::address_space Space>
sycl::detail::enable_if_t< sycl::detail::sub_group::AcceptableForLocalLoadStore<T, Space>::value> cl::sycl::ext::oneapi::sub_group::store ( multi_ptr< T, Space >  dst,
const vec< T, N > &  x 
) const
inline

◆ store() [5/5]

template<typename T >
void cl::sycl::ext::oneapi::sub_group::store ( T dst,
const T x 
) const
inline

Definition at line 448 of file sub_group.hpp.

References PI_INVALID_DEVICE.

Friends And Related Function Documentation

◆ experimental::this_sub_group

Member Data Documentation

◆ dimensions

constexpr int cl::sycl::ext::oneapi::sub_group::dimensions = 1
staticconstexpr

Definition at line 113 of file sub_group.hpp.

◆ fence_scope

constexpr sycl::memory_scope cl::sycl::ext::oneapi::sub_group::fence_scope
staticconstexpr
Initial value:

Definition at line 114 of file sub_group.hpp.


The documentation for this struct was generated from the following file:
cl::sycl::memory_scope::sub_group
@ sub_group