OpenMPCD
Public Member Functions | List of all members
OpenMPCD::StridedPointerIteratorRange< Pointee, stride > Class Template Reference

Represents a range of pointers that can be iterated over. More...

#include <StridedPointerIteratorRange.hpp>

Public Member Functions

 StridedPointerIteratorRange (Pointee *const start_, const std::size_t numberOfElements)
 The constructor. More...
 
StridedPointerIterator< Pointee, stride > begin () const
 Returns the first iterator in the range. More...
 
StridedPointerIterator< Pointee, stride > end () const
 Returns the past-the-end iterator. More...
 

Detailed Description

template<typename Pointee, unsigned int stride>
class OpenMPCD::StridedPointerIteratorRange< Pointee, stride >

Represents a range of pointers that can be iterated over.

Template Parameters
PointeeThe type the underlying pointer points at.
strideThe iteration stride, which must not be 0.

Definition at line 21 of file StridedPointerIteratorRange.hpp.

Constructor & Destructor Documentation

◆ StridedPointerIteratorRange()

template<typename Pointee , unsigned int stride>
OpenMPCD::StridedPointerIteratorRange< Pointee, stride >::StridedPointerIteratorRange ( Pointee *const  start_,
const std::size_t  numberOfElements 
)
inline

The constructor.

Parameters
[in]start_The first element to iterate over.
[in]numberOfElementsThe total number of elements in the array.

Definition at line 31 of file StridedPointerIteratorRange.hpp.

Member Function Documentation

◆ begin()

template<typename Pointee , unsigned int stride>
StridedPointerIterator<Pointee, stride> OpenMPCD::StridedPointerIteratorRange< Pointee, stride >::begin ( ) const
inline

Returns the first iterator in the range.

Definition at line 40 of file StridedPointerIteratorRange.hpp.

◆ end()

template<typename Pointee , unsigned int stride>
StridedPointerIterator<Pointee, stride> OpenMPCD::StridedPointerIteratorRange< Pointee, stride >::end ( ) const
inline

Returns the past-the-end iterator.

Definition at line 48 of file StridedPointerIteratorRange.hpp.


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