DPC++ Runtime
Runtime libraries for oneAPI DPC++
Public Member Functions | Friends | List of all members
cl::sycl::range< dimensions > Class Template Reference
DPC++ User API

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

#include <CL/sycl/buffer.hpp>

Public Member Functions

template<int N = dimensions>
 range (typename detail::enable_if_t<(N==1), size_t > dim0)
 
template<int N = dimensions>
 range (typename detail::enable_if_t<(N==2), size_t > dim0, size_t dim1)
 
template<int N = dimensions>
 range (typename detail::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
 

Friends

class handler
 
class detail::Builder
 

Detailed Description

template<int dimensions = 1>
class cl::sycl::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 buffer.hpp.

Constructor & Destructor Documentation

◆ range() [1/6]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::range< dimensions >::range ( typename detail::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>
cl::sycl::range< dimensions >::range ( typename detail::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>
cl::sycl::range< dimensions >::range ( typename detail::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>
cl::sycl::range< dimensions >::range ( const range< dimensions > &  rhs)
default

◆ range() [5/6]

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

◆ range() [6/6]

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

Member Function Documentation

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ size()

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

Definition at line 50 of file range.hpp.

Referenced by cl::sycl::detail::doOverlap(), cl::sycl::detail::MemoryManager::fill(), cl::sycl::ext::oneapi::detail::reduCGFunc(), cl::sycl::ext::oneapi::detail::reductionLoop(), cl::sycl::buffer< char, 1 >::reinterpret(), cl::sycl::detail::SetKernelParamsAndLaunch(), and cl::sycl::detail::updateOffset().

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: