AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::slam::policies::CompileTimeOffset< IntType, INT_VAL > Struct Template Reference

A policy class for a compile-time known set offset. More...

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

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

Public Member Functions

AXOM_HOST_DEVICE CompileTimeOffset (IntType val=DEFAULT_VALUE)
 
AXOM_HOST_DEVICE IntType offset () const
 
IntType operator() () const
 
bool isValid (bool) const
 

Static Public Attributes

static constexpr IntType DEFAULT_VALUE = INT_VAL
 

Detailed Description

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

A policy class for a compile-time known set offset.

Constructor & Destructor Documentation

◆ CompileTimeOffset()

template<typename IntType , IntType INT_VAL>
AXOM_HOST_DEVICE axom::slam::policies::CompileTimeOffset< IntType, INT_VAL >::CompileTimeOffset ( IntType  val = DEFAULT_VALUE)
inline

References AXOM_UNUSED_VAR, and SLIC_ASSERT_MSG.

Member Function Documentation

◆ offset()

template<typename IntType , IntType INT_VAL>
AXOM_HOST_DEVICE IntType axom::slam::policies::CompileTimeOffset< IntType, INT_VAL >::offset ( ) const
inline

◆ operator()()

template<typename IntType , IntType INT_VAL>
IntType axom::slam::policies::CompileTimeOffset< IntType, INT_VAL >::operator() ( ) const
inline

◆ isValid()

template<typename IntType , IntType INT_VAL>
bool axom::slam::policies::CompileTimeOffset< IntType, INT_VAL >::isValid ( bool  ) const
inline

Member Data Documentation

◆ DEFAULT_VALUE

template<typename IntType , IntType INT_VAL>
constexpr IntType axom::slam::policies::CompileTimeOffset< IntType, INT_VAL >::DEFAULT_VALUE = INT_VAL
staticconstexpr

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