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>

Inheritance diagram for axom::slam::policies::RuntimeStride< IntType >:

Public Types
using	IndexType = IntType
using	ShapeType = IntType
using	TagType = StrideTag< IntType >
using	IntType = decltype(Tag::defaultValue())

Public Member Functions
constexpr AXOM_HOST_DEVICE IntType	stride () const
	Returns the stride between consecutive elements. More...
constexpr AXOM_HOST_DEVICE IntType &	stride ()
constexpr 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...
void	setStride (IntType str)
constexpr AXOM_HOST_DEVICE auto	value () const
constexpr AXOM_HOST_DEVICE auto &	value ()
constexpr auto	operator() () const
constexpr auto &	operator() ()
constexpr bool	isValid (bool) const

Static Public Member Functions
static constexpr IntType	DefaultSize ()

Static Public Attributes
static const bool	IS_COMPILE_TIME = false
constexpr static int	NumDims = 1
OrderedSet_Stride_Policies
A few default policies for the stride of an OrderedSet
static const IntType	DEFAULT_VALUE = StrideTag<IntType>::defaultValue()

Protected Attributes
IntType	m_value

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

TagType

using axom::slam::policies::RuntimeValue< StrideTag< IntType > >::TagType = StrideTag< IntType >

inherited

IntType

using axom::slam::policies::RuntimeValue< StrideTag< IntType > >::IntType = decltype(Tag::defaultValue())

inherited

Member Function Documentation

DefaultSize()

template<typename IntType >

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

inlinestaticconstexpr

References axom::slam::policies::StrideTag< IntType >::defaultValue().

stride() [1/2]

template<typename IntType >

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

inlineconstexpr

Returns the stride between consecutive elements.

References axom::slam::policies::RuntimeValue< StrideTag< IntType > >::value().

stride() [2/2]

template<typename IntType >

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

inlineconstexpr

References axom::slam::policies::RuntimeValue< StrideTag< IntType > >::value().

shape()

template<typename IntType >

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

inlineconstexpr

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

References axom::slam::policies::RuntimeValue< StrideTag< IntType > >::value().

setStride()

template<typename IntType >

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

inline

References axom::slam::policies::RuntimeValue< StrideTag< IntType > >::m_value.

value() [1/2]

constexpr AXOM_HOST_DEVICE auto axom::slam::policies::RuntimeValue< StrideTag< IntType > >::value ( ) const

inlineconstexprinherited

value() [2/2]

constexpr AXOM_HOST_DEVICE auto& axom::slam::policies::RuntimeValue< StrideTag< IntType > >::value ( )

inlineconstexprinherited

operator()() [1/2]

constexpr auto axom::slam::policies::RuntimeValue< StrideTag< IntType > >::operator() ( ) const

inlineconstexprinherited

operator()() [2/2]

constexpr auto& axom::slam::policies::RuntimeValue< StrideTag< IntType > >::operator() ( )

inlineconstexprinherited

isValid()

constexpr bool axom::slam::policies::RuntimeValue< StrideTag< IntType > >::isValid ( bool  ) const

inlineconstexprinherited

Member Data Documentation

DEFAULT_VALUE

template<typename IntType >

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

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

m_value

IntType axom::slam::policies::RuntimeValue< StrideTag< IntType > >::m_value

protectedinherited

---

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