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

A policy class for a set with stride one (i.e. the default stride) More...

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

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

Public Member Functions

 StrideOne (IntType val=DEFAULT_VALUE)
 
const IntType stride () const
 
const IntType operator() () const
 
void setStride (IntType AXOM_DEBUG_PARAM(val))
 
bool isValid (bool) const
 

Static Public Attributes

OrderedSet_Stride_Policies

A few default policies for the stride of an OrderedSet

static const IntType DEFAULT_VALUE = IntType {1}
 

Detailed Description

template<typename IntType>
struct axom::slam::policies::StrideOne< IntType >

A policy class for a set with stride one (i.e. the default stride)

Constructor & Destructor Documentation

◆ StrideOne()

template<typename IntType>
axom::slam::policies::StrideOne< IntType >::StrideOne ( IntType  val = DEFAULT_VALUE)
inline

This constructor only exists to allow the derived class to not have to specialize for when the stride is known at compile time

Member Function Documentation

◆ stride()

template<typename IntType>
const IntType axom::slam::policies::StrideOne< IntType >::stride ( ) const
inline

◆ operator()()

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

◆ setStride()

template<typename IntType>
void axom::slam::policies::StrideOne< IntType >::setStride ( IntType   AXOM_DEBUG_PARAMval)
inline

◆ isValid()

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

Member Data Documentation

◆ DEFAULT_VALUE

template<typename IntType>
const IntType axom::slam::policies::StrideOne< IntType >::DEFAULT_VALUE = IntType {1}
static

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