stencil::GenericID< T > Class Template Reference

A generic, two-dimensional index. More...

#include <GenericID.hpp>

Public Member Functions
	GenericID ()
	Create a new index with undefined contents.
	GenericID (T column, T row)
	Create a new index with the given column and row indices.
	GenericID (sycl::id< 2 > sycl_id)
	Convert the SYCL ID.
	GenericID (sycl::range< 2 > sycl_range)
	Convert the SYCl range.
bool	operator== (GenericID const &other) const
	Test if the other generic ID has equivalent coordinates to this ID.

Public Attributes
T	c
	The column index.
T	r
	The row index.

Detailed Description

template<typename T>
class stencil::GenericID< T >

A generic, two-dimensional index.

Template Parameters

The	index type. It can be anything as long as it can be constructed from a dimension of sycl::id and tested for equality.

Constructor & Destructor Documentation

GenericID() [1/4]

template<typename T >

stencil::GenericID< T >::GenericID ( )

inline

Create a new index with undefined contents.

GenericID() [2/4]

template<typename T >

stencil::GenericID< T >::GenericID ( T  column, T  row  )

inline

Create a new index with the given column and row indices.

GenericID() [3/4]

template<typename T >

stencil::GenericID< T >::GenericID ( sycl::id< 2 >  sycl_id )

inline

Convert the SYCL ID.

GenericID() [4/4]

template<typename T >

stencil::GenericID< T >::GenericID ( sycl::range< 2 >  sycl_range )

inline

Convert the SYCl range.

Member Function Documentation

operator==()

template<typename T >

bool stencil::GenericID< T >::operator== ( GenericID< T > const &  other ) const

inline

Test if the other generic ID has equivalent coordinates to this ID.

Member Data Documentation

c

template<typename T >

T stencil::GenericID< T >::c

The column index.

r

template<typename T >

T stencil::GenericID< T >::r

The row index.

---

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

• StencilStream/GenericID.hpp