AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
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/v0.5.0/src/axom/slam/policies/StridePolicies.hpp>

Public Member Functions

 RuntimeStride (IntType stride=DEFAULT_VALUE)
 
IntType stride () const
 
IntType & stride ()
 
void setStride (IntType str)
 
IntType operator() () const
 
IntType & operator() ()
 
bool isValid (bool) const
 

Static Public Attributes

static const IntType DEFAULT_VALUE = IntType(1)
 

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.

Constructor & Destructor Documentation

◆ RuntimeStride()

template<typename IntType >
axom::slam::policies::RuntimeStride< IntType >::RuntimeStride ( IntType  stride = DEFAULT_VALUE)
inline

Member Function Documentation

◆ stride() [1/2]

◆ stride() [2/2]

template<typename IntType >
IntType& axom::slam::policies::RuntimeStride< IntType >::stride ( )
inline

◆ setStride()

◆ operator()() [1/2]

template<typename IntType >
IntType axom::slam::policies::RuntimeStride< IntType >::operator() ( ) const
inline

◆ operator()() [2/2]

template<typename IntType >
IntType& axom::slam::policies::RuntimeStride< IntType >::operator() ( )
inline

◆ isValid()

template<typename IntType >
bool axom::slam::policies::RuntimeStride< IntType >::isValid ( bool  ) const
inline

All non-zero strides are valid

Member Data Documentation

◆ DEFAULT_VALUE

template<typename IntType >
const IntType axom::slam::policies::RuntimeStride< IntType >::DEFAULT_VALUE = IntType(1)
static

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