astrotypes  0.0
Public Types | Public Member Functions | List of all members
pss::astrotypes::OverlaySliceIterator< IterableType, SliceIteratorType > Class Template Reference

Overlays an iterator from one data structure onto that of another. More...

#include <src/cpp/pss/astrotypes/multiarray/OverlaySliceIterator.h>

Public Types

typedef std::iterator_traits< parent_iterator >::value_type value_type
 
typedef std::iterator_traits< parent_iterator >::reference reference
 
typedef std::iterator_traits< parent_iterator >::pointer pointer
 

Public Member Functions

 OverlaySliceIterator (IterableType &data, SliceIteratorType const &slice_it)
 
reference operator* () const
 

Detailed Description

template<typename IterableType, typename SliceIteratorType>
class pss::astrotypes::OverlaySliceIterator< IterableType, SliceIteratorType >

Overlays an iterator from one data structure onto that of another.

allows a single iterator to be used to iterate through multiple objects saving computational costs

Definition at line 39 of file OverlaySliceIterator.h.

Member Typedef Documentation

template<typename IterableType, typename SliceIteratorType>
typedef std::iterator_traits<parent_iterator>::pointer pss::astrotypes::OverlaySliceIterator< IterableType, SliceIteratorType >::pointer

Definition at line 47 of file OverlaySliceIterator.h.

template<typename IterableType, typename SliceIteratorType>
typedef std::iterator_traits<parent_iterator>::reference pss::astrotypes::OverlaySliceIterator< IterableType, SliceIteratorType >::reference

Definition at line 46 of file OverlaySliceIterator.h.

template<typename IterableType, typename SliceIteratorType>
typedef std::iterator_traits<parent_iterator>::value_type pss::astrotypes::OverlaySliceIterator< IterableType, SliceIteratorType >::value_type

Definition at line 45 of file OverlaySliceIterator.h.

Constructor & Destructor Documentation

template<typename IterableType, typename SliceIteratorType>
pss::astrotypes::OverlaySliceIterator< IterableType, SliceIteratorType >::OverlaySliceIterator ( IterableType &  data,
SliceIteratorType const &  slice_it 
)

Definition at line 28 of file OverlaySliceIterator.cpp.

Member Function Documentation

template<typename IterableType , typename SliceIteratorType >
OverlaySliceIterator< IterableType, SliceIteratorType >::reference pss::astrotypes::OverlaySliceIterator< IterableType, SliceIteratorType >::operator* ( ) const
inline

Definition at line 34 of file OverlaySliceIterator.cpp.