X_index_type Class Reference

X-coordinate type - "dummy" class. More...

#include <coordinates.h>

Public Member Functions
int	coordinate (Direction d) const
	Returns dth dimension coordinate of X.
const CoordinateVector &	coordinates () const
	Returns coordinate of site at index X.
::Parity	parity () const
	Returns parity of site at index X.

Detailed Description

X-coordinate type - "dummy" class.

used only in loop index and is removed by code analysis. Generally empty except for method deceleration

Examples

/home/runner/work/HILA/HILA/libraries/plumbing/field.h.

Definition at line 622 of file coordinates.h.

Member Function Documentation

coordinate()

int X_index_type::coordinate

(

Direction

d

)

const

Returns dth dimension coordinate of X.

Parameters

d	direction to probe

Returns

int

coordinates()

const CoordinateVector & X_index_type::coordinates

(

)

const

Returns coordinate of site at index X.

Returns

const CoordinateVector&

parity()

::Parity X_index_type::parity

(

)

const

Returns parity of site at index X.

Returns

Parity

---

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

• coordinates.h