DomainIterator< Dom > Class Template Reference

A simple iterator class to iterate through all of the points in a given domain of type Dom. More...

#include <DomainIterator.h>

List of all members.

Public Types
enum	{ dimensions = DomainTraits<Dom>::dimensions }
typedef DomainIterator< Dom >	This_t
typedef Dom	Domain_t
typedef Domain_t::AskDomain_t	Value_t
typedef std::input_iterator_tag	iterator_category
typedef Value_t	value_type
typedef ptrdiff_t	difference_type
typedef const Value_t *	pointer
typedef const Value_t &	reference
Public Member Functions
	DomainIterator (const Dom &d, int size=0)
	DomainIterator (const This_t &model)
	DomainIterator ()
const Value_t &	operator* () const
const Value_t *	operator-> () const
bool	operator== (const This_t &rhs) const
bool	operator!= (const This_t &rhs) const
bool	done () const
This_t &	operator= (const This_t &model)
This_t &	operator++ ()
This_t	operator++ (int)

---

Detailed Description

template<class Dom>
class DomainIterator< Dom >

A simple iterator class to iterate through all of the points in a given domain of type Dom.

The individual points are returned as Loc<Dim>s or Region<Dim,T>'s when the iterator is dereferenced.

This is an input-iterator, in the STL sense. It only defines deref, ->, and ++ operators.

---

Member Typedef Documentation

template<class Dom>

typedef DomainIterator<Dom> DomainIterator< Dom >::This_t

template<class Dom>

typedef Dom DomainIterator< Dom >::Domain_t

template<class Dom>

typedef Domain_t::AskDomain_t DomainIterator< Dom >::Value_t

template<class Dom>

typedef std::input_iterator_tag DomainIterator< Dom >::iterator_category

template<class Dom>

typedef Value_t DomainIterator< Dom >::value_type

template<class Dom>

typedef ptrdiff_t DomainIterator< Dom >::difference_type

template<class Dom>

typedef const Value_t* DomainIterator< Dom >::pointer

template<class Dom>

typedef const Value_t& DomainIterator< Dom >::reference

---

Member Enumeration Documentation

template<class Dom>

anonymous enum

Enumerator:

dimensions

---

Constructor & Destructor Documentation

template<class Dom>

DomainIterator< Dom >::DomainIterator	(	const Dom &	d,
		int	size = 0
	)		[inline]

References DomainIterator< Dom >::dimensions, and PAssert.

template<class Dom>

DomainIterator< Dom >::DomainIterator

(

const This_t &

model

)

[inline]

References DomainIterator< Dom >::dimensions, and PAssert.

template<class Dom>

DomainIterator< Dom >::DomainIterator

(

)

[inline]

References DomainIterator< Dom >::dimensions.

---

Member Function Documentation

template<class Dom>

const Value_t& DomainIterator< Dom >::operator*

(

)

const [inline]

References DomainIterator< Dom >::done(), and PAssert.

template<class Dom>

const Value_t* DomainIterator< Dom >::operator->

(

)

const [inline]

References DomainIterator< Dom >::done(), and PAssert.

template<class Dom>

bool DomainIterator< Dom >::operator==

(

const This_t &

rhs

)

const [inline]

template<class Dom>

bool DomainIterator< Dom >::operator!=

(

const This_t &

rhs

)

const [inline]

template<class Dom>

bool DomainIterator< Dom >::done

(

)

const [inline]

Referenced by DomainIterator< Dom >::operator*(), and DomainIterator< Dom >::operator->().

template<class Dom>

This_t& DomainIterator< Dom >::operator=

(

const This_t &

model

)

[inline]

References DomainIterator< Dom >::dimensions.

template<class Dom>

This_t& DomainIterator< Dom >::operator++

(

)

[inline]

template<class Dom>

This_t DomainIterator< Dom >::operator++

(

int

)

[inline]

---

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

• DomainIterator.h