STLdoc
STLdocumentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 > Class Template Reference

A tiled_index is a set of indices of 1 to 3 dimensions which have been subdivided into 1-, 2-, or 3-dimensional tiles in a tiled_extent. It has three specialized forms: tiled_index<_Dim0>, tiled_index<_Dim0, _Dim1>, and tiled_index<_Dim0, _Dim1, _Dim2>, where _Dim0-2 specify the length of the tile along the each dimension, with _Dim0 being the most-significant dimension and _Dim2 being the least-significant. More...

#include <amp.h>

Inheritance diagram for Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >:
Concurrency::_Tiled_index_base< 3 >

Public Member Functions

 tiled_index (const index< rank > &_Global, const index< rank > &_Local, const index< rank > &_Tile, const index< rank > &_Tile_origin, const tile_barrier &_Barrier) __GPU
 A Constructor that initializes data members using the given values. More...
 
 tiled_index (const tiled_index &_Other) __GPU
 Copy Constructor. More...
 
 __declspec (property(get=get_tile_extent)) extent< rank > tile_extent
 Returns an instance of an extent that captures the values of the tiled_index template arguments _Dim0, _Dim1, _Dim2 More...
 
extent< rankget_tile_extent () __GPU
 
- Public Member Functions inherited from Concurrency::_Tiled_index_base< 3 >
 _CPP_AMP_VERIFY_RANK (_Rank, tiled_index)
 
 _Tiled_index_base (const index< rank > &_Global, const index< rank > &_Local, const index< rank > &_Tile, const index< rank > &_Tile_origin, const tile_barrier &_Barrier) __GPU
 A Constructor that initializes data members using the given values. More...
 
 _Tiled_index_base (const _Tiled_index_base &_Other) __GPU
 Copy Constructor. More...
 
 operator const index< rank > () const __GPU
 Implicit conversion operator that converts a tiled_index into an index. The implicit conversion converts to the .global index member. More...
 

Static Public Attributes

static const int tile_dim0 = _Dim0
 These constants allow access to the template arguments of tiled_index. More...
 
static const int tile_dim1 = _Dim1
 
static const int tile_dim2 = _Dim2
 
- Static Public Attributes inherited from Concurrency::_Tiled_index_base< 3 >
static const int rank
 

Private Member Functions

tiled_indexoperator= (const tiled_index &) __GPU
 

Additional Inherited Members

- Public Attributes inherited from Concurrency::_Tiled_index_base< 3 >
const index< rankglobal
 An index that represents the global index within an extent. More...
 
const index< ranklocal
 An index that represents the relative index within the current tile of a tiled_extent. More...
 
const index< ranktile
 An index that represents the coordinates of the current tile of a tiled_extent. More...
 
const index< ranktile_origin
 An index that represents the global coordinates of the origin of the current tile within a tiled_extent. More...
 
const tile_barrier barrier
 An object which represents a barrier within the current tile of threads. More...
 

Detailed Description

template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
class Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >

A tiled_index is a set of indices of 1 to 3 dimensions which have been subdivided into 1-, 2-, or 3-dimensional tiles in a tiled_extent. It has three specialized forms: tiled_index<_Dim0>, tiled_index<_Dim0, _Dim1>, and tiled_index<_Dim0, _Dim1, _Dim2>, where _Dim0-2 specify the length of the tile along the each dimension, with _Dim0 being the most-significant dimension and _Dim2 being the least-significant.

Constructor & Destructor Documentation

template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::tiled_index ( const index< rank > &  _Global,
const index< rank > &  _Local,
const index< rank > &  _Tile,
const index< rank > &  _Tile_origin,
const tile_barrier _Barrier 
)
inline

A Constructor that initializes data members using the given values.

Parameters
_GlobalThe global index to be copied from
_LocalThe local index to be copied from
_TileThe tile index to be copied from
_Tile_originThe tile origin to be copied from
_BarrierThe barrier to be copied from
1097  : _Tiled_index_base(_Global, _Local, _Tile, _Tile_origin, _Barrier)
1098  {}
_Tiled_index_base(const index< rank > &_Global, const index< rank > &_Local, const index< rank > &_Tile, const index< rank > &_Tile_origin, const tile_barrier &_Barrier) __GPU
A Constructor that initializes data members using the given values.
Definition: amp.h:1028
template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::tiled_index ( const tiled_index< _Dim0, _Dim1, _Dim2 > &  _Other)
inline

Copy Constructor.

Parameters
_OtherThe tile_index instance to be copied from .
1107  : _Tiled_index_base(_Other)
1108  {}
_Tiled_index_base(const index< rank > &_Global, const index< rank > &_Local, const index< rank > &_Tile, const index< rank > &_Tile_origin, const tile_barrier &_Barrier) __GPU
A Constructor that initializes data members using the given values.
Definition: amp.h:1028

Member Function Documentation

template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::__declspec ( property(get=get_tile_extent )

Returns an instance of an extent that captures the values of the tiled_index template arguments _Dim0, _Dim1, _Dim2

template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
extent<rank> Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::get_tile_extent ( )
inline
1115 { return extent<rank>(_Dim0, _Dim1, _Dim2); }
template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
tiled_index& Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::operator= ( const tiled_index< _Dim0, _Dim1, _Dim2 > &  )
private

Member Data Documentation

template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
const int Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::tile_dim0 = _Dim0
static

These constants allow access to the template arguments of tiled_index.

template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
const int Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::tile_dim1 = _Dim1
static
template<int _Dim0, int _Dim1 = 0, int _Dim2 = 0>
const int Concurrency::tiled_index< _Dim0, _Dim1, _Dim2 >::tile_dim2 = _Dim2
static

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