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

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.6.0/src/axom/slam/policies/CardinalityPolicies.hpp>

Public Types

using BeginsSizePolicy = RuntimeSize< ElementType >
 
using BeginsOffsetPolicy = ZeroOffset< ElementType >
 
using BeginsStridePolicy = StridePolicy
 
using BeginsIndirectionPolicy = NoIndirection< ElementType, ElementType >
 
using BeginsSet = OrderedSet< ElementType, ElementType, BeginsSizePolicy, BeginsOffsetPolicy, BeginsStridePolicy >
 
using RelationalOperatorSizeType = typename StrideToSize< BeginsStridePolicy, ElementType, BeginsStridePolicy::DEFAULT_VALUE >::SizeType
 

Public Member Functions

 ConstantCardinality ()
 
 ConstantCardinality (BeginsSet begins)
 
 ConstantCardinality (ElementType fromSetSize)
 
 ConstantCardinality (ElementType fromSetSize, typename BeginsSet::SetBuilder &builder)
 
const ElementType size (ElementType AXOM_NOT_USED(fromPos)) const
 
const ElementType offset (ElementType fromPos) const
 
void bindBeginOffsets (ElementType fromSetSize, ElementType stride)
 
ElementType totalSize () const
 
template<typename FromSetType >
bool isValid (const FromSetType *fromSet, bool AXOM_NOT_USED(vertboseOutput)=false) const
 

Public Attributes

BeginsSet m_begins
 

Member Typedef Documentation

◆ BeginsSizePolicy

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
using axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::BeginsSizePolicy = RuntimeSize<ElementType>

◆ BeginsOffsetPolicy

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
using axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::BeginsOffsetPolicy = ZeroOffset<ElementType>

◆ BeginsStridePolicy

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
using axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::BeginsStridePolicy = StridePolicy

◆ BeginsIndirectionPolicy

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
using axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::BeginsIndirectionPolicy = NoIndirection<ElementType, ElementType>

◆ BeginsSet

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
using axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::BeginsSet = OrderedSet<ElementType, ElementType, BeginsSizePolicy, BeginsOffsetPolicy, BeginsStridePolicy>

◆ RelationalOperatorSizeType

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
using axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::RelationalOperatorSizeType = typename StrideToSize<BeginsStridePolicy, ElementType, BeginsStridePolicy::DEFAULT_VALUE>::SizeType

Constructor & Destructor Documentation

◆ ConstantCardinality() [1/4]

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::ConstantCardinality ( )
inline

◆ ConstantCardinality() [2/4]

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::ConstantCardinality ( BeginsSet  begins)
inline

◆ ConstantCardinality() [3/4]

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::ConstantCardinality ( ElementType  fromSetSize)
inline

◆ ConstantCardinality() [4/4]

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::ConstantCardinality ( ElementType  fromSetSize,
typename BeginsSet::SetBuilder &  builder 
)
inline

Member Function Documentation

◆ size()

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
const ElementType axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::size ( ElementType   AXOM_NOT_USEDfromPos) const
inline

◆ offset()

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
const ElementType axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::offset ( ElementType  fromPos) const
inline

◆ bindBeginOffsets()

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
void axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::bindBeginOffsets ( ElementType  fromSetSize,
ElementType  stride 
)
inline

◆ totalSize()

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
ElementType axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::totalSize ( ) const
inline

◆ isValid()

template<typename ElementType = int, typename StridePolicy = RuntimeStride<ElementType>>
template<typename FromSetType >
bool axom::slam::policies::ConstantCardinality< ElementType, StridePolicy >::isValid ( const FromSetType *  fromSet,
bool   AXOM_NOT_USEDvertboseOutput = false 
) const
inline

Member Data Documentation

◆ m_begins


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