axom::slam::policies::detail::IndexedIndirection< BasePolicy > Class Template Reference

Provides a mixin class for a generic indexable indirection policy. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/slam/policies/IndirectionPolicies.hpp>

Inherits BasePolicy.

Public Types
using	PositionType = typename BasePolicy::PosType
using	ConstResultPtr = std::remove_reference_t< ConstIndirectionResult > *
using	ResultPtr = std::remove_reference_t< IndirectionResult > *

Public Member Functions
bool	isValid (PositionType size, PositionType offset, PositionType stride, bool verboseOutput=false) const
AXOM_HOST_DEVICE ConstIndirectionResult	indirection (PositionType pos) const
AXOM_HOST_DEVICE IndirectionResult	indirection (PositionType pos)
AXOM_HOST_DEVICE ConstIndirectionResult	operator() (PositionType pos) const
AXOM_HOST_DEVICE IndirectionResult	operator() (PositionType pos)

Static Public Member Functions
template<bool DeviceEnable = BasePolicy::DeviceAccessible>
static AXOM_HOST_DEVICE std::enable_if_t< DeviceEnable, ResultPtr >	getIndirection (IndirectionRefType buf, PositionType pos=0)
template<bool DeviceEnable = BasePolicy::DeviceAccessible>
static AXOM_HOST_DEVICE std::enable_if_t< DeviceEnable, ConstResultPtr >	getConstIndirection (IndirectionConstRefType buf, PositionType pos=0)
template<bool DeviceEnable = BasePolicy::DeviceAccessible>
static AXOM_HOST_DEVICE std::enable_if_t<!DeviceEnable, ResultPtr >	getIndirection (IndirectionRefType buf, PositionType pos=0)
template<bool DeviceEnable = BasePolicy::DeviceAccessible>
static AXOM_HOST_DEVICE std::enable_if_t<!DeviceEnable, ConstResultPtr >	getConstIndirection (IndirectionConstRefType buf, PositionType pos=0)

Detailed Description

template<typename BasePolicy>
class axom::slam::policies::detail::IndexedIndirection< BasePolicy >

Provides a mixin class for a generic indexable indirection policy.

Template Parameters

BasePolicy

the type of the derived indirection policy class

Precondition

BasePolicy must implement the following methods:

• data(): returns the underlying indirection buffer object
• size(): returns the size of the backing buffer
• checkIndirection(pos): checks whether the indirection and index is valid

Member Typedef Documentation

PositionType

template<typename BasePolicy >

using axom::slam::policies::detail::IndexedIndirection< BasePolicy >::PositionType = typename BasePolicy::PosType

ConstResultPtr

template<typename BasePolicy >

using axom::slam::policies::detail::IndexedIndirection< BasePolicy >::ConstResultPtr = std::remove_reference_t<ConstIndirectionResult>*

ResultPtr

template<typename BasePolicy >

using axom::slam::policies::detail::IndexedIndirection< BasePolicy >::ResultPtr = std::remove_reference_t<IndirectionResult>*

Member Function Documentation

isValid()

template<typename BasePolicy >

bool axom::slam::policies::detail::IndexedIndirection< BasePolicy >::isValid ( PositionType  size, PositionType  offset, PositionType  stride, bool  verboseOutput = false  ) const

inline

References AXOM_UNUSED_VAR, and SLIC_DEBUG_IF.

getIndirection() [1/2]

template<typename BasePolicy >

template<bool DeviceEnable = BasePolicy::DeviceAccessible>

static AXOM_HOST_DEVICE std::enable_if_t<DeviceEnable, ResultPtr> axom::slam::policies::detail::IndexedIndirection< BasePolicy >::getIndirection ( IndirectionRefType  buf, PositionType  pos = 0  )

inlinestatic

getConstIndirection() [1/2]

template<typename BasePolicy >

template<bool DeviceEnable = BasePolicy::DeviceAccessible>

static AXOM_HOST_DEVICE std::enable_if_t<DeviceEnable, ConstResultPtr> axom::slam::policies::detail::IndexedIndirection< BasePolicy >::getConstIndirection ( IndirectionConstRefType  buf, PositionType  pos = 0  )

inlinestatic

getIndirection() [2/2]

template<typename BasePolicy >

template<bool DeviceEnable = BasePolicy::DeviceAccessible>

static AXOM_HOST_DEVICE std::enable_if_t<!DeviceEnable, ResultPtr> axom::slam::policies::detail::IndexedIndirection< BasePolicy >::getIndirection ( IndirectionRefType  buf, PositionType  pos = 0  )

inlinestatic

References axom::slic::abort(), AXOM_UNUSED_VAR, and SLIC_ASSERT_MSG.

getConstIndirection() [2/2]

template<typename BasePolicy >

template<bool DeviceEnable = BasePolicy::DeviceAccessible>

static AXOM_HOST_DEVICE std::enable_if_t<!DeviceEnable, ConstResultPtr> axom::slam::policies::detail::IndexedIndirection< BasePolicy >::getConstIndirection ( IndirectionConstRefType  buf, PositionType  pos = 0  )

inlinestatic

References axom::slic::abort(), AXOM_UNUSED_VAR, and SLIC_ASSERT_MSG.

indirection() [1/2]

template<typename BasePolicy >

AXOM_HOST_DEVICE ConstIndirectionResult axom::slam::policies::detail::IndexedIndirection< BasePolicy >::indirection ( PositionType  pos ) const

inline

References axom::slam::policies::detail::IndexedIndirection< BasePolicy >::getConstIndirection().

indirection() [2/2]

template<typename BasePolicy >

AXOM_HOST_DEVICE IndirectionResult axom::slam::policies::detail::IndexedIndirection< BasePolicy >::indirection ( PositionType  pos )

inline

References axom::slam::policies::detail::IndexedIndirection< BasePolicy >::getIndirection().

operator()() [1/2]

template<typename BasePolicy >

AXOM_HOST_DEVICE ConstIndirectionResult axom::slam::policies::detail::IndexedIndirection< BasePolicy >::operator() ( PositionType  pos ) const

inline

References axom::slam::policies::detail::IndexedIndirection< BasePolicy >::indirection().

operator()() [2/2]

template<typename BasePolicy >

AXOM_HOST_DEVICE IndirectionResult axom::slam::policies::detail::IndexedIndirection< BasePolicy >::operator() ( PositionType  pos )

inline

References axom::slam::policies::detail::IndexedIndirection< BasePolicy >::indirection().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/slam/policies/IndirectionPolicies.hpp