SAMRAI::pdat::ArrayDataIterator< DIM > Class Template Reference

#include <source/patchdata/array/ArrayDataIterator.h>

List of all members.

Public Member Functions
	ArrayDataIterator ()
	ArrayDataIterator (const hier::Box< DIM > &box)
	ArrayDataIterator (const ArrayDataIterator< DIM > &iterator)
ArrayDataIterator< DIM > &	operator= (const ArrayDataIterator< DIM > &iterator)
	~ArrayDataIterator ()
const hier::Index< DIM > &	operator * () const
const hier::Index< DIM > &	operator() () const
	operator bool () const
	operator const void * () const
bool	operator! () const
void	operator++ (int)
bool	operator== (const ArrayDataIterator< DIM > &iterator) const
bool	operator!= (const ArrayDataIterator< DIM > &iterator) const

---

Detailed Description

template<int DIM>
class SAMRAI::pdat::ArrayDataIterator< DIM >

Class ArrayDataIterator is an iterator that provides methods for stepping through the index space associated with a pdat object. The indices are enumerated in column-major (e.g., Fortran) order. The iterator should be used as follows:

   hier::Box<DIM> box;
   ...
   for (ArrayDataIterator<DIM> c(box); c; c++) {
      // use index c of the box
   }
   

Note that the array data iterator may not compile to efficient code, depending on your compiler. Many compilers are not smart enough to optimize the looping constructs and indexing operations.

See also:

pdat::ArrayData

hier::Index

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::pdat::ArrayDataIterator< DIM >::ArrayDataIterator (   )  [inline]

Default constructor for the array data iterator. The iterator must be initialized before it can be used to iterate over a box.

template<int DIM> SAMRAI::pdat::ArrayDataIterator< DIM >::ArrayDataIterator (  const hier::Box< DIM > &  box  )  [inline]

Constructor for the array data iterator. The iterator will enumerate the indices in the argument box.

template<int DIM> SAMRAI::pdat::ArrayDataIterator< DIM >::ArrayDataIterator (  const ArrayDataIterator< DIM > &  iterator  )  [inline]

Copy constructor for the array data iterator

template<int DIM> SAMRAI::pdat::ArrayDataIterator< DIM >::~ArrayDataIterator (   )  [inline]

Destructor for the array data iterator.

---

Member Function Documentation

template<int DIM> ArrayDataIterator< DIM > & SAMRAI::pdat::ArrayDataIterator< DIM >::operator= (  const ArrayDataIterator< DIM > &  iterator  )  [inline]

Assignment operator for the array data iterator.

template<int DIM> const hier::Index< DIM > & SAMRAI::pdat::ArrayDataIterator< DIM >::operator * (   )  const [inline]

Extract the index corresponding to the iterator position in the box.

template<int DIM> const hier::Index< DIM > & SAMRAI::pdat::ArrayDataIterator< DIM >::operator() (   )  const [inline]

Extract the index corresponding to the iterator position in the box.

template<int DIM> SAMRAI::pdat::ArrayDataIterator< DIM >::operator bool (   )  const [inline]

Return true if the iterator points to a valid index within the box.

template<int DIM> SAMRAI::pdat::ArrayDataIterator< DIM >::operator const void * (   )  const [inline]

Return a non-NULL if the iterator points to a valid index within the box.

template<int DIM> bool SAMRAI::pdat::ArrayDataIterator< DIM >::operator! (   )  const [inline]

Return whether the iterator points to a valid index within the box. This operator mimics the !p operation applied to a pointer p.

template<int DIM> void SAMRAI::pdat::ArrayDataIterator< DIM >::operator++ (  int   )  [inline]

Increment the iterator to point to the next index in the box.

template<int DIM> bool SAMRAI::pdat::ArrayDataIterator< DIM >::operator== (  const ArrayDataIterator< DIM > &  iterator  )  const [inline]

Test two iterators for equality (same index value).

template<int DIM> bool SAMRAI::pdat::ArrayDataIterator< DIM >::operator!= (  const ArrayDataIterator< DIM > &  iterator  )  const [inline]

Test two iterators for inequality (different index values).

---

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

• source/patchdata/array/ArrayDataIterator.h
• source/patchdata/array/ArrayDataIterator.I

---