axom::slam::policies::RuntimeStride< IntType > Struct Template Reference

A policy class for the stride in a set. When using this class, the stride can be set at runtime. More...

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

Public Types
using	IndexType = IntType
using	ShapeType = IntType

Public Member Functions
AXOM_HOST_DEVICE	RuntimeStride (IntType stride=DEFAULT_VALUE)
AXOM_HOST_DEVICE IntType	stride () const
	Returns the stride between consecutive elements. More...
AXOM_HOST_DEVICE IntType	shape () const
	Returns the shape of the inner data for a given stride. This only has meaning when used with Map-based types. More...
AXOM_HOST_DEVICE IntType &	stride ()
void	setStride (IntType str)
IntType	operator() () const
IntType &	operator() ()
bool	isValid (bool) const

Static Public Member Functions
static constexpr IntType	DefaultSize ()

Static Public Attributes
static const IntType	DEFAULT_VALUE = IntType(1)
static const bool	IS_COMPILE_TIME = false
constexpr static int	NumDims = 1

Detailed Description

template<typename IntType>
struct axom::slam::policies::RuntimeStride< IntType >

A policy class for the stride in a set. When using this class, the stride can be set at runtime.

Member Typedef Documentation

IndexType

template<typename IntType >

using axom::slam::policies::RuntimeStride< IntType >::IndexType = IntType

ShapeType

template<typename IntType >

using axom::slam::policies::RuntimeStride< IntType >::ShapeType = IntType

Constructor & Destructor Documentation

RuntimeStride()

template<typename IntType >

AXOM_HOST_DEVICE axom::slam::policies::RuntimeStride< IntType >::RuntimeStride ( IntType  stride = DEFAULT_VALUE )

inline

Member Function Documentation

DefaultSize()

template<typename IntType >

static constexpr IntType axom::slam::policies::RuntimeStride< IntType >::DefaultSize ( )

inlinestaticconstexpr

References axom::slam::policies::RuntimeStride< IntType >::DEFAULT_VALUE.

stride() [1/2]

template<typename IntType >

AXOM_HOST_DEVICE IntType axom::slam::policies::RuntimeStride< IntType >::stride ( ) const

inline

Returns the stride between consecutive elements.

shape()

template<typename IntType >

AXOM_HOST_DEVICE IntType axom::slam::policies::RuntimeStride< IntType >::shape ( ) const

inline

Returns the shape of the inner data for a given stride. This only has meaning when used with Map-based types.

stride() [2/2]

template<typename IntType >

AXOM_HOST_DEVICE IntType& axom::slam::policies::RuntimeStride< IntType >::stride ( )

inline

setStride()

template<typename IntType >

void axom::slam::policies::RuntimeStride< IntType >::setStride ( IntType  str )

inline

operator()() [1/2]

template<typename IntType >

IntType axom::slam::policies::RuntimeStride< IntType >::operator() ( ) const

inline

References axom::slam::policies::RuntimeStride< IntType >::stride().

operator()() [2/2]

template<typename IntType >

IntType& axom::slam::policies::RuntimeStride< IntType >::operator() ( )

inline

References axom::slam::policies::RuntimeStride< IntType >::stride().

isValid()

template<typename IntType >

bool axom::slam::policies::RuntimeStride< IntType >::isValid ( bool  ) const

inline

All non-zero strides are valid

Member Data Documentation

DEFAULT_VALUE

template<typename IntType >

const IntType axom::slam::policies::RuntimeStride< IntType >::DEFAULT_VALUE = IntType(1)

static

IS_COMPILE_TIME

template<typename IntType >

const bool axom::slam::policies::RuntimeStride< IntType >::IS_COMPILE_TIME = false

static

NumDims

template<typename IntType >

constexpr static int axom::slam::policies::RuntimeStride< IntType >::NumDims = 1

staticconstexpr

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/slam/policies/StridePolicies.hpp