Hermes
hermes::Index3< T > Struct Template Reference

Holds 3-dimensional index coordinates. More...

Public Member Functions

HERMES_DEVICE_CALLABLE Index3 (T v)
 
HERMES_DEVICE_CALLABLE Index3 (T i, T j, T k)
 Construct a new Index2 object. More...
 
HERMES_DEVICE_CALLABLEoperator[] (int _i) const
 
HERMES_DEVICE_CALLABLE T & operator[] (int _i)
 

Public Attributes

i {0}
 0-th coordinate value
 
j {0}
 1-th coordinate value
 
k {0}
 2-th coordinate value
 

Detailed Description

template<typename T>
struct hermes::Index3< T >

Holds 3-dimensional index coordinates.

Template Parameters
Tmust be an integer type

Constructor & Destructor Documentation

◆ Index3() [1/2]

template<typename T >
HERMES_DEVICE_CALLABLE hermes::Index3< T >::Index3 ( v)
inlineexplicit
Parameters
v

◆ Index3() [2/2]

template<typename T >
HERMES_DEVICE_CALLABLE hermes::Index3< T >::Index3 ( i,
j,
k 
)
inline

Construct a new Index2 object.

Parameters
i- i coordinate value
j- j coordinate value
k- k coordinate value

Member Function Documentation

◆ operator[]() [1/2]

template<typename T >
HERMES_DEVICE_CALLABLE T& hermes::Index3< T >::operator[] ( int  _i)
inline
Parameters
_i
Precondition
_i must be in [0, 2]
Warning
the value of _i is not checked
Returns

◆ operator[]() [2/2]

template<typename T >
HERMES_DEVICE_CALLABLE T hermes::Index3< T >::operator[] ( int  _i) const
inline
Parameters
_i
Precondition
_i must be in [0, 2]
Warning
the value of _i is not checked
Returns

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