r_MiterArea Class Reference

r_MiterArea is used for iterating r_Mintervals through larger r_Mintervals. More...

#include <mitera.hh>

Classes
struct	incArrElem

Public Member Functions
	r_MiterArea (const r_Minterval *newIterDom, const r_Minterval *newImgDom)
	The pointers are stored, do not delete the objects as long as the iterator is used! More...
	~r_MiterArea ()
void	reset ()
	resets iterator to beginning. More...
r_Minterval	nextArea ()
	returns current cell and sets iterator to next cell. More...
bool	isDone ()
	returns TRUE if iteration is finished. More...

Protected Attributes
r_Minterval	retVal
	This is used for the return value in nextArea() More...
const r_Minterval *	iterDom {NULL}
	area to be iterated through More...
const r_Minterval *	imgDom {NULL}
	area of tile. More...
incArrElem *	incArrIter {NULL}
	array with increments More...
bool	done {false}
	flag set if iteration is finished. More...

Detailed Description

r_MiterArea is used for iterating r_Mintervals through larger r_Mintervals.

It is given the domain to be iterated through and an Minterval specifying the shape of area to be iterated with.

Going to the next area is done with nextArea() which returns an r_Minterval. Test for the end is done with isDone(). The iterator can be reset with reset(). Iteration starts at the lowest border in all dimensions. Note that if the shape of r_Minterval iterated does not completely fit into the r_Minterval iterated through the results at the border may have a different (smaller) shape.

Constructor & Destructor Documentation

r_MiterArea()

r_MiterArea::r_MiterArea	(	const r_Minterval *	newIterDom,
		const r_Minterval *	newImgDom
	)

The pointers are stored, do not delete the objects as long as the iterator is used!

Exceptions

if	newIterDom and newImgDom have different dimension

~r_MiterArea()

r_MiterArea::~r_MiterArea

(

)

Member Function Documentation

isDone()

bool r_MiterArea::isDone

(

)

returns TRUE if iteration is finished.

nextArea()

r_Minterval r_MiterArea::nextArea

(

)

returns current cell and sets iterator to next cell.

reset()

void r_MiterArea::reset

(

)

resets iterator to beginning.

Member Data Documentation

done

bool r_MiterArea::done {false}

protected

flag set if iteration is finished.

imgDom

const r_Minterval* r_MiterArea::imgDom {NULL}

protected

area of tile.

incArrIter

incArrElem* r_MiterArea::incArrIter {NULL}

protected

array with increments

iterDom

const r_Minterval* r_MiterArea::iterDom {NULL}

protected

area to be iterated through

retVal

r_Minterval r_MiterArea::retVal

protected

This is used for the return value in nextArea()

---

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

• mitera.hh