AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
Public Types | Public Member Functions | List of all members
axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType > Class Template Reference

Predeclare the BlockIterator type. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/spin/OctreeLevel.hpp>

Public Types

using GridPt = typename OctreeLevel::GridPt
 
using iter = BlockIterator< OctreeLevel, IterHelper, DataType >
 
using value_type = DataType
 
using difference_type = std::ptrdiff_t
 
using pointer = DataType *
 
using reference = DataType &
 
using iterator_category = std::forward_iterator_tag
 

Public Member Functions

 BlockIterator (OctreeLevel *octLevel, bool begin=false)
 
 ~BlockIterator ()
 
DataType & operator* () const
 A const dereference function to access the data. More...
 
DataType * operator-> () const
 A const pointer dereference function to access the data. More...
 
GridPt pt () const
 Const accessor for the iterator's current grid point. More...
 
bool operator== (const iter &other) const
 Equality test against another iterator. More...
 
bool operator!= (const iter &other) const
 Inequality test against another iterator. More...
 
iter & operator++ ()
 Increment the iterator to the next point. More...
 
iter operator++ (int)
 Increment the iterator to the next point. More...
 

Detailed Description

template<int DIM, typename BlockDataType>
template<typename OctreeLevel, typename IterHelper, typename DataType>
class axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >

Predeclare the BlockIterator type.

Member Typedef Documentation

◆ GridPt

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
using axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::GridPt = typename OctreeLevel::GridPt

◆ iter

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
using axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::iter = BlockIterator<OctreeLevel, IterHelper, DataType>

◆ value_type

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
using axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::value_type = DataType

◆ difference_type

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
using axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::difference_type = std::ptrdiff_t

◆ pointer

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
using axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::pointer = DataType*

◆ reference

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
using axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::reference = DataType&

◆ iterator_category

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
using axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::iterator_category = std::forward_iterator_tag

Constructor & Destructor Documentation

◆ BlockIterator()

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::BlockIterator ( OctreeLevel *  octLevel,
bool  begin = false 
)
inline

References axom::spin::OctreeLevel< DIM, BlockDataType >::begin(), axom::spin::OctreeLevel< DIM, BlockDataType >::getIteratorHelper(), and SLIC_ASSERT.

◆ ~BlockIterator()

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::~BlockIterator ( )
inline

Member Function Documentation

◆ operator*()

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
DataType& axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator* ( ) const
inline

A const dereference function to access the data.

◆ operator->()

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
DataType* axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator-> ( ) const
inline

A const pointer dereference function to access the data.

◆ pt()

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
GridPt axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::pt ( ) const
inline

Const accessor for the iterator's current grid point.

◆ operator==()

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
bool axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator== ( const iter &  other) const
inline

Equality test against another iterator.

◆ operator!=()

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
bool axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator!= ( const iter &  other) const
inline

Inequality test against another iterator.

References axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator==().

◆ operator++() [1/2]

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
iter& axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator++ ( )
inline

Increment the iterator to the next point.

◆ operator++() [2/2]

template<int DIM, typename BlockDataType >
template<typename OctreeLevel , typename IterHelper , typename DataType >
iter axom::spin::OctreeLevel< DIM, BlockDataType >::BlockIterator< OctreeLevel, IterHelper, DataType >::operator++ ( int  )
inline

Increment the iterator to the next point.

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