QDP++
QDP::NearestNeighborMapFunc Struct Reference

Function object used for constructing the default nearest neighbor map. More...

Inheritance diagram for QDP::NearestNeighborMapFunc:
QDP::ArrayMapFunc

Public Member Functions

 NearestNeighborMapFunc ()
virtual ~NearestNeighborMapFunc ()
virtual multi1d< int > operator() (const multi1d< int > &coord, int sign, int dir) const
 Maps a lattice coordinate under a map to a new lattice coordinate.
virtual int numArray () const
 Returns the array size - the number of directions which are to be used.
Public Member Functions inherited from QDP::ArrayMapFunc
virtual ~ArrayMapFunc ()
 Virtual destructor - no cleanup needed.

Detailed Description

Function object used for constructing the default nearest neighbor map.

Definition at line 17 of file qdp_map.cc.

Constructor & Destructor Documentation

◆ NearestNeighborMapFunc()

QDP::NearestNeighborMapFunc::NearestNeighborMapFunc ( )
inline

Definition at line 19 of file qdp_map.cc.

◆ ~NearestNeighborMapFunc()

virtual QDP::NearestNeighborMapFunc::~NearestNeighborMapFunc ( )
inlinevirtual

Definition at line 22 of file qdp_map.cc.

Member Function Documentation

◆ numArray()

virtual int QDP::NearestNeighborMapFunc::numArray ( ) const
inlinevirtual

Returns the array size - the number of directions which are to be used.

Implements QDP::ArrayMapFunc.

Definition at line 34 of file qdp_map.cc.

References QDP::Nd.

◆ operator()()

virtual multi1d< int > QDP::NearestNeighborMapFunc::operator() ( const multi1d< int > & coordinate,
int sign,
int dir ) const
inlinevirtual

Maps a lattice coordinate under a map to a new lattice coordinate.

sign > 0 for map, sign < 0 for the inverse map

Implements QDP::ArrayMapFunc.

Definition at line 24 of file qdp_map.cc.

References QDP::Layout::lattSize().


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