DPC++ Runtime
Runtime libraries for oneAPI DPC++
Public Member Functions | Static Public Attributes | Friends | List of all members
sycl::_V1::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 <sycl/buffer.hpp>

Collaboration diagram for sycl::_V1::range< Dimensions >:
Collaboration graph
[legend]

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 ()=default
 

Static Public Attributes

static constexpr int dimensions = Dimensions
 

Friends

class handler
 
class detail::Builder
 

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 51 of file buffer.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 41 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 46 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 52 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 ( )
default

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

Definition at line 56 of file range.hpp.

Referenced by sycl::_V1::detail::doOverlap(), sycl::_V1::detail::MemoryManager::fill(), syclcompat::accessor< T, Memory, 2 >::get_ptr(), sycl::_V1::ext::oneapi::experimental::radix_sorter< ValT, OrderT, BitsPerPass >::memory_required(), sycl::_V1::detail::reduction_parallel_for(), sycl::_V1::buffer< char, 1 >::reinterpret(), and sycl::_V1::range< Dims >::size().

Friends And Related Function Documentation

◆ detail::Builder

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

Definition at line 220 of file range.hpp.

◆ handler

template<int Dimensions = 1>
friend class handler
friend

Definition at line 219 of file range.hpp.

Member Data Documentation

◆ dimensions

template<int Dimensions = 1>
constexpr int sycl::_V1::range< Dimensions >::dimensions = Dimensions
staticconstexpr

Definition at line 28 of file range.hpp.

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