Class TempLat::TranspositionMap

template <size_t NDim>

ClassList > TempLat > TranspositionMap

A class which maps between two orderings. More...

#include <transpositionmap.h>

Public Functions

Type	Name
	TranspositionMap () Default constructor: untransposed, both maps are a linear range.
DEVICE_INLINE_FUNCTION device::Idx	getForward (device::Idx index) const
DEVICE_INLINE_FUNCTION device::Idx	getInverse (device::Idx index) const
DEVICE_INLINE_FUNCTION bool	isTransposed () const
DEVICE_INLINE_FUNCTION bool	isUntransposed () const
void	setMap (const device::IdxArray< NDim > & input) Provide your forward mapping, which will be the new output of getForward.

Public Static Functions

Type	Name
constexpr size_t	size ()

Detailed Description

Unit test: ctest -R test-transpositionmap

Public Functions Documentation

function TranspositionMap

Default constructor: untransposed, both maps are a linear range.

inline TempLat::TranspositionMap::TranspositionMap ()

function getForward

inline DEVICE_INLINE_FUNCTION device::Idx TempLat::TranspositionMap::getForward (
    device::Idx index
) const

function getInverse

inline DEVICE_INLINE_FUNCTION device::Idx TempLat::TranspositionMap::getInverse (
    device::Idx index
) const

function isTransposed

inline DEVICE_INLINE_FUNCTION bool TempLat::TranspositionMap::isTransposed () const

function isUntransposed

inline DEVICE_INLINE_FUNCTION bool TempLat::TranspositionMap::isUntransposed () const

function setMap

Provide your forward mapping, which will be the new output of getForward.

inline void TempLat::TranspositionMap::setMap (
    const device::IdxArray< NDim > & input
)

Public Static Functions Documentation

function size

static inline constexpr size_t TempLat::TranspositionMap::size ()

Friends Documentation

friend operator<<

inline std::ostream & TempLat::TranspositionMap::operator<< (
    std::ostream & ostream,
    const TranspositionMap & a
)

friend operator==

inline bool TempLat::TranspositionMap::operator== (
    const TranspositionMap & a,
    const TranspositionMap & b
)

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/lattice/memory/memorylayouts/transpositionmap.h