axom::slam::policies::CompileTimeStride< IntType, INT_VAL > Struct Template Reference

A policy class for a compile-time known stride. More...

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

Inheritance diagram for axom::slam::policies::CompileTimeStride< IntType, INT_VAL >:

Public Types
using	IndexType = IntType
using	ShapeType = IntType

Public Member Functions
AXOM_HOST_DEVICE	CompileTimeStride (IntType val=DEFAULT_VALUE)
AXOM_HOST_DEVICE IntType	stride () const
AXOM_HOST_DEVICE IntType	shape () const
IntType	operator() () const
AXOM_HOST_DEVICE void	setStride (IntType AXOM_DEBUG_PARAM(val))
bool	isValid (bool) const

Static Public Member Functions
static constexpr IntType	DefaultSize ()

Static Public Attributes
static const IntType	DEFAULT_VALUE = INT_VAL
static const bool	IS_COMPILE_TIME = true
constexpr static int	NumDims = 1

Detailed Description

template<typename IntType, IntType INT_VAL>
struct axom::slam::policies::CompileTimeStride< IntType, INT_VAL >

A policy class for a compile-time known stride.

Member Typedef Documentation

IndexType

template<typename IntType , IntType INT_VAL>

using axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::IndexType = IntType

ShapeType

template<typename IntType , IntType INT_VAL>

using axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::ShapeType = IntType

Constructor & Destructor Documentation

CompileTimeStride()

template<typename IntType , IntType INT_VAL>

AXOM_HOST_DEVICE axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::CompileTimeStride ( IntType  val = DEFAULT_VALUE )

inline

References axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::setStride().

Member Function Documentation

DefaultSize()

template<typename IntType , IntType INT_VAL>

static constexpr IntType axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::DefaultSize ( )

inlinestaticconstexpr

References axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::DEFAULT_VALUE.

stride()

template<typename IntType , IntType INT_VAL>

AXOM_HOST_DEVICE IntType axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::stride ( ) const

inline

shape()

template<typename IntType , IntType INT_VAL>

AXOM_HOST_DEVICE IntType axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::shape ( ) const

inline

operator()()

template<typename IntType , IntType INT_VAL>

IntType axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::operator() ( ) const

inline

References axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::stride().

setStride()

template<typename IntType , IntType INT_VAL>

AXOM_HOST_DEVICE void axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::setStride ( IntType   AXOM_DEBUG_PARAMval )

inline

References SLIC_ASSERT_MSG.

isValid()

template<typename IntType , IntType INT_VAL>

bool axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::isValid ( bool  ) const

inline

All non-zero strides are valid

Member Data Documentation

DEFAULT_VALUE

template<typename IntType , IntType INT_VAL>

const IntType axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::DEFAULT_VALUE = INT_VAL

static

IS_COMPILE_TIME

template<typename IntType , IntType INT_VAL>

const bool axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::IS_COMPILE_TIME = true

static

NumDims

template<typename IntType , IntType INT_VAL>

constexpr static int axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::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