NTBlock_iter< T > Class Template Reference

iterator for a NTBlock More...

#include <ntb_iter.h>

Public Member Functions
	NTBlock_iter (NTBlock< T > *, int, int, int, int)
NTBlock_iter &	operator++ ()
	move ops More...
NTBlock_iter	operator++ (int)
T *	operator-> ()
	access ops More...
T &	operator* ()

Private Attributes
NTBlock< T > *	m_block
int	m_ix
int	m_iy
int	m_iz
int	m_ig

Friends
bool	operator== (const NTBlock_iter &, const NTBlock_iter &)
bool	operator!= (const NTBlock_iter &, const NTBlock_iter &)

Detailed Description

template<typename T>
class NTBlock_iter< T >

iterator for a NTBlock

Constructor & Destructor Documentation

NTBlock_iter()

template<typename T >

NTBlock_iter< T >::NTBlock_iter	(	NTBlock< T > *	ntb,
		int	ix,
		int	iy,
		int	iz,
		int	ig
	)

Construct block iterator

Parameters

ntb	the block over which to iterate
ix	the index in the x-dimension
iy	the index in the y-dimension
iz	the index in the z-dimension
ig	the index at the gridpoint

Member Function Documentation

operator*()

template<typename T >

T & NTBlock_iter< T >::operator*

dereference operator

Todo:

what happens if end() is dereferenced ?

operator++() [1/2]

template<typename T >

NTBlock_iter< T > & NTBlock_iter< T >::operator++

move ops

prefix increment operator

Warning

not impl.

operator++() [2/2]

template<typename T >

NTBlock_iter< T > NTBlock_iter< T >::operator++

(

int

)

postfix increment operator

operator->()

template<typename T >

T * NTBlock_iter< T >::operator->

access ops

prefix decrement operator

Warning

not impl.

postfix decrement operator

access operator

Todo:

what happens if end() is dereferenced ?

Friends And Related Function Documentation

operator!=

template<typename T >

bool operator!= ( const NTBlock_iter< T > &  b1, const NTBlock_iter< T > &  b2  )

friend

inequality operator

operator==

template<typename T >

bool operator== ( const NTBlock_iter< T > &  b1, const NTBlock_iter< T > &  b2  )

friend

equality operator

Member Data Documentation

m_block

template<typename T >

NTBlock<T>* NTBlock_iter< T >::m_block

private

Referenced by operator!=(), and operator==().

m_ig

template<typename T >

int NTBlock_iter< T >::m_ig

private

Referenced by operator!=(), and operator==().

m_ix

template<typename T >

int NTBlock_iter< T >::m_ix

private

Referenced by operator!=(), and operator==().

m_iy

template<typename T >

int NTBlock_iter< T >::m_iy

private

Referenced by operator!=(), and operator==().

m_iz

template<typename T >

int NTBlock_iter< T >::m_iz

private

Referenced by operator!=(), and operator==().

---

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

• ntable/src/ntb_iter.h
• ntable/src/ntb_iter.hpp