tiled_index Class

Article
04/28/2015

Provides an index into a tiled_extent object. This class has properties to access elements relative to the local tile origin and relative to the global origin. For more information about tiled spaces, see Using Tiles.

template <
   int _Dim0,
   int _Dim1 = 0,
   int _Dim2 = 0
>
class tiled_index : public _Tiled_index_base<3>;

template <
   int _Dim0,
   int _Dim1
>
class tiled_index<_Dim0, _Dim1, 0> : public _Tiled_index_base<2>;

template <
   int _Dim0
>
class tiled_index<_Dim0, 0, 0> : public _Tiled_index_base<1>;

Parameters

_Dim0
The length of the most significant dimension.
_Dim1
The length of the next-to-most significant dimension.
_Dim2
The length of the least significant dimension.

Members

Public Constructors

Name	Description
tiled_index::tiled_index Constructor	Initializes a new instance of the tile_index class.

Public Methods

Name	Description
tiled_index::get_tile_extent Method	Returns an extent object that has the values of the tiled_index template arguments _Dim0, _Dim1, and _Dim2.

Public Constants

Name	Description
tiled_index::barrier Constant	Stores a tile_barrier object that represents a barrier in the current tile of threads.

tiled_index::global Constant	Stores an index object of rank 1, 2, or 3 that represents the global index in a grid object.
tiled_index::local Constant	Stores an index object of rank 1, 2, or 3 that represents the relative index in the current tile of a tiled_extent object.
tiled_index::rank Constant	Stores the rank of the tiled_index object.
tiled_index::tile Constant	Stores an index object of rank 1, 2, or 3 that represents the coordinates of the current tile of a tiled_extent object.
tiled_index::tile_dim0 Constant	Stores the length of the most significant dimension.
tiled_index::tile_dim1 Constant	Stores the length of the next-to-most significant dimension.
tiled_index::tile_dim2 Constant	Stores the length of the least significant dimension.
tiled_index::tile_origin Constant	Stores an index object of rank 1, 2, or 3 that represents the global coordinates of the origin of the current tile in a tiled_extent object.

Public Data Members

Name	Description
tiled_index::tile_extent Data Member	Gets an extent object that has the values of the tiled_index template arguments tiled_index template arguments _Dim0, _Dim1, and _Dim2.

Inheritance Hierarchy

_Tiled_index_base

tiled_index

Requirements

Header: amp.h

Namespace: Concurrency