ESyS-Particle  2.3.4
NTBlock_iter Class Reference

iterator for a NTBlock More...

#include <ntb_iter.h>

Collaboration diagram for NTBlock_iter:

Public Member Functions

 NTBlock_iter (NTBlock< T > *, int, int, int, int)
 
NTBlock_iteroperator++ ()
 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

iterator for a NTBlock

Constructor & Destructor Documentation

◆ NTBlock_iter()

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

Construct block iterator

Parameters
ntbthe block over which to iterate
ixthe index in the x-dimension
iythe index in the y-dimension
izthe index in the z-dimension
igthe index at the gridpoint

Member Function Documentation

◆ operator*()

T & NTBlock_iter::operator* ( )

dereference operator

Todo:
what happens if end() is dereferenced ?

◆ operator++() [1/2]

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

move ops

prefix increment operator

Warning
not impl.

◆ operator++() [2/2]

NTBlock_iter< T > NTBlock_iter::operator++ ( int  )

postfix increment operator

◆ operator->()

T * NTBlock_iter::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!=

bool operator!= ( const NTBlock_iter ,
const NTBlock_iter  
)
friend

◆ operator==

bool operator== ( const NTBlock_iter ,
const NTBlock_iter  
)
friend

Member Data Documentation

◆ m_block

NTBlock<T>* NTBlock_iter::m_block
private

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

◆ m_ig

int NTBlock_iter::m_ig
private

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

◆ m_ix

int NTBlock_iter::m_ix
private

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

◆ m_iy

int NTBlock_iter::m_iy
private

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

◆ m_iz

int NTBlock_iter::m_iz
private

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


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