DPC++ Runtime
Runtime libraries for oneAPI DPC++
sycl::_V1::range< dimensions > Class Template Reference

Defines the iteration domain of either a single work-group in a parallel dispatch, or the overall dimensions of the dispatch. More...

#include <sycl/range.hpp>

Inheritance diagram for sycl::_V1::range< dimensions >:
Collaboration diagram for sycl::_V1::range< dimensions >:

Public Member Functions

template<int N = dimensions>
 range (typename std::enable_if_t<(N==1), size_t > dim0)
 
template<int N = dimensions>
 range (typename std::enable_if_t<(N==2), size_t > dim0, size_t dim1)
 
template<int N = dimensions>
 range (typename std::enable_if_t<(N==3), size_t > dim0, size_t dim1, size_t dim2)
 
size_t size () const
 
 range (const range< dimensions > &rhs)=default
 
 range (range< dimensions > &&rhs)=default
 
range< dimensions > & operator= (const range< dimensions > &rhs)=default
 
range< dimensions > & operator= (range< dimensions > &&rhs)=default
 
 range ()=delete
 
- Public Member Functions inherited from sycl::_V1::detail::array< 1 >
 array (typename std::enable_if_t<(N==1), size_t > dim0=0)
 
 array (typename std::enable_if_t<(N==2), size_t > dim0, size_t dim1)
 
 array ()
 
 array (typename std::enable_if_t<(N==3), size_t > dim0, size_t dim1, size_t dim2)
 
 array ()
 
 array (const array< dimensions > &rhs)=default
 
 array (array< dimensions > &&rhs)=default
 
 operator sycl::id< dimensions > () const
 
 operator sycl::range< dimensions > () const
 
size_t get (int dimension) const
 
size_t & operator[] (int dimension)
 
size_t operator[] (int dimension) const
 
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
 

Friends

class handler
 
class detail::Builder
 

Additional Inherited Members

- Protected Member Functions inherited from sycl::_V1::detail::array< 1 >
__SYCL_ALWAYS_INLINE void check_dimension (int dimension) const
 
- Protected Attributes inherited from sycl::_V1::detail::array< 1 >
size_t common_array [dimensions]
 

Detailed Description

template<int dimensions = 1>
class sycl::_V1::range< dimensions >

Defines the iteration domain of either a single work-group in a parallel dispatch, or the overall dimensions of the dispatch.

Definition at line 24 of file range.hpp.

Constructor & Destructor Documentation

◆ range() [1/6]

template<int dimensions = 1>
template<int N = dimensions>
sycl::_V1::range< dimensions >::range ( typename std::enable_if_t<(N==1), size_t >  dim0)
inline

Definition at line 35 of file range.hpp.

◆ range() [2/6]

template<int dimensions = 1>
template<int N = dimensions>
sycl::_V1::range< dimensions >::range ( typename std::enable_if_t<(N==2), size_t >  dim0,
size_t  dim1 
)
inline

Definition at line 40 of file range.hpp.

◆ range() [3/6]

template<int dimensions = 1>
template<int N = dimensions>
sycl::_V1::range< dimensions >::range ( typename std::enable_if_t<(N==3), size_t >  dim0,
size_t  dim1,
size_t  dim2 
)
inline

Definition at line 46 of file range.hpp.

◆ range() [4/6]

template<int dimensions = 1>
sycl::_V1::range< dimensions >::range ( const range< dimensions > &  rhs)
default

◆ range() [5/6]

template<int dimensions = 1>
sycl::_V1::range< dimensions >::range ( range< dimensions > &&  rhs)
default

◆ range() [6/6]

template<int dimensions = 1>
sycl::_V1::range< dimensions >::range ( )
delete

Member Function Documentation

◆ operator=() [1/2]

template<int dimensions = 1>
range<dimensions>& sycl::_V1::range< dimensions >::operator= ( const range< dimensions > &  rhs)
default

◆ operator=() [2/2]

template<int dimensions = 1>
range<dimensions>& sycl::_V1::range< dimensions >::operator= ( range< dimensions > &&  rhs)
default

◆ size()

template<int dimensions = 1>
size_t sycl::_V1::range< dimensions >::size ( ) const
inline

Friends And Related Function Documentation

◆ detail::Builder

template<int dimensions = 1>
friend class detail::Builder
friend

Definition at line 214 of file range.hpp.

◆ handler

template<int dimensions = 1>
friend class handler
friend

Definition at line 213 of file range.hpp.


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