AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
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
 
using TagType = StrideTag< IntType >
 
using IntType = decltype(V)
 

Public Member Functions

constexpr AXOM_HOST_DEVICE IntType stride () const
 
constexpr AXOM_HOST_DEVICE IntType shape () const
 
AXOM_HOST_DEVICE void setStride (IntType AXOM_DEBUG_PARAM(val))
 
constexpr AXOM_HOST_DEVICE IntType value () const
 
constexpr IntType operator() () const
 
constexpr 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
 
static constexpr IntType VALUE
 

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

◆ TagType

◆ IntType

using axom::slam::policies::CompileTimeValue< V, StrideTag< IntType > >::IntType = decltype(V)
inherited

Member Function Documentation

◆ DefaultSize()

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

◆ stride()

template<typename IntType , IntType INT_VAL>
constexpr AXOM_HOST_DEVICE IntType axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::stride ( ) const
inlineconstexpr

◆ shape()

template<typename IntType , IntType INT_VAL>
constexpr AXOM_HOST_DEVICE IntType axom::slam::policies::CompileTimeStride< IntType, INT_VAL >::shape ( ) const
inlineconstexpr

◆ 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.

◆ value()

constexpr AXOM_HOST_DEVICE IntType axom::slam::policies::CompileTimeValue< V, StrideTag< IntType > >::value ( ) const
inlineconstexprinherited

◆ operator()()

constexpr IntType axom::slam::policies::CompileTimeValue< V, StrideTag< IntType > >::operator() ( ) const
inlineconstexprinherited

◆ isValid()

constexpr bool axom::slam::policies::CompileTimeValue< V, StrideTag< IntType > >::isValid ( bool  ) const
inlineconstexprinherited

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

◆ VALUE

constexpr IntType axom::slam::policies::CompileTimeValue< V, StrideTag< IntType > >::VALUE
staticconstexprinherited

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