DPC++ Runtime
Runtime libraries for oneAPI Data Parallel C++
cl::sycl::detail::array< dimensions > Class Template Reference

#include <CL/sycl/detail/array.hpp>

Collaboration diagram for cl::sycl::detail::array< dimensions >:

Public Member Functions

template<int N = dimensions>
 array (typename detail::enable_if_t<(N==1), size_t > dim0=0)
 
template<int N = dimensions>
 array (typename detail::enable_if_t<(N==2), size_t > dim0, size_t dim1)
 
template<int N = dimensions, detail::enable_if_t<(N==2), size_t > = 0>
 array ()
 
template<int N = dimensions>
 array (typename detail::enable_if_t<(N==3), size_t > dim0, size_t dim1, size_t dim2)
 
template<int N = dimensions, detail::enable_if_t<(N==3), size_t > = 0>
 array ()
 
 operator cl::sycl::id< dimensions > () const
 
 operator cl::sycl::range< dimensions > () const
 
size_t get (int dimension) const
 
size_t & operator[] (int dimension)
 
size_t operator[] (int dimension) const
 
 array (const array< dimensions > &rhs)=default
 
 array (array< dimensions > &&rhs)=default
 
array< dimensions > & operator= (const array< dimensions > &rhs)=default
 
array< dimensions > & operator= (array< dimensions > &&rhs)=default
 
bool operator== (const array< dimensions > &rhs) const
 
bool operator!= (const array< dimensions > &rhs) const
 

Protected Member Functions

__SYCL_ALWAYS_INLINE void check_dimension (int dimension) const
 

Protected Attributes

size_t common_array [dimensions]
 

Detailed Description

template<int dimensions = 1>
class cl::sycl::detail::array< dimensions >

Definition at line 21 of file array.hpp.

Constructor & Destructor Documentation

◆ array() [1/7]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::detail::array< dimensions >::array ( typename detail::enable_if_t<(N==1), size_t >  dim0 = 0)
inline

Definition at line 28 of file array.hpp.

◆ array() [2/7]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::detail::array< dimensions >::array ( typename detail::enable_if_t<(N==2), size_t >  dim0,
size_t  dim1 
)
inline

Definition at line 34 of file array.hpp.

◆ array() [3/7]

template<int dimensions = 1>
template<int N = dimensions, detail::enable_if_t<(N==2), size_t > = 0>
cl::sycl::detail::array< dimensions >::array ( )
inline

Definition at line 38 of file array.hpp.

◆ array() [4/7]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::detail::array< dimensions >::array ( typename detail::enable_if_t<(N==3), size_t >  dim0,
size_t  dim1,
size_t  dim2 
)
inline

Definition at line 43 of file array.hpp.

◆ array() [5/7]

template<int dimensions = 1>
template<int N = dimensions, detail::enable_if_t<(N==3), size_t > = 0>
cl::sycl::detail::array< dimensions >::array ( )
inline

Definition at line 48 of file array.hpp.

◆ array() [6/7]

template<int dimensions = 1>
cl::sycl::detail::array< dimensions >::array ( const array< dimensions > &  rhs)
default

◆ array() [7/7]

template<int dimensions = 1>
cl::sycl::detail::array< dimensions >::array ( array< dimensions > &&  rhs)
default

Member Function Documentation

◆ check_dimension()

template<int dimensions = 1>
__SYCL_ALWAYS_INLINE void cl::sycl::detail::array< dimensions >::check_dimension ( int  dimension) const
inlineprotected

Definition at line 111 of file array.hpp.

References PI_INVALID_VALUE.

◆ get()

template<int dimensions = 1>
size_t cl::sycl::detail::array< dimensions >::get ( int  dimension) const
inline

Definition at line 67 of file array.hpp.

◆ operator cl::sycl::id< dimensions >()

template<int dimensions = 1>
cl::sycl::detail::array< dimensions >::operator cl::sycl::id< dimensions > ( ) const
inline

Definition at line 51 of file array.hpp.

◆ operator cl::sycl::range< dimensions >()

template<int dimensions = 1>
cl::sycl::detail::array< dimensions >::operator cl::sycl::range< dimensions > ( ) const
inline

Definition at line 59 of file array.hpp.

◆ operator!=()

template<int dimensions = 1>
bool cl::sycl::detail::array< dimensions >::operator!= ( const array< dimensions > &  rhs) const
inline

Definition at line 100 of file array.hpp.

References cl::sycl::detail::array< dimensions >::common_array.

◆ operator=() [1/2]

template<int dimensions = 1>
array<dimensions>& cl::sycl::detail::array< dimensions >::operator= ( array< dimensions > &&  rhs)
default

◆ operator=() [2/2]

template<int dimensions = 1>
array<dimensions>& cl::sycl::detail::array< dimensions >::operator= ( const array< dimensions > &  rhs)
default

◆ operator==()

template<int dimensions = 1>
bool cl::sycl::detail::array< dimensions >::operator== ( const array< dimensions > &  rhs) const
inline

Definition at line 89 of file array.hpp.

References cl::sycl::detail::array< dimensions >::common_array.

◆ operator[]() [1/2]

template<int dimensions = 1>
size_t& cl::sycl::detail::array< dimensions >::operator[] ( int  dimension)
inline

Definition at line 72 of file array.hpp.

◆ operator[]() [2/2]

template<int dimensions = 1>
size_t cl::sycl::detail::array< dimensions >::operator[] ( int  dimension) const
inline

Definition at line 77 of file array.hpp.

Member Data Documentation

◆ common_array

template<int dimensions = 1>
size_t cl::sycl::detail::array< dimensions >::common_array[dimensions]
protected

The documentation for this class was generated from the following file: