ArrayIter.h

Classes

ArrayIterator -- Iterate an Array cursor through another Array. (full description)

ReadOnlyArrayIterator -- Iterate a const Array cursor through a const Array. (full description)

template<class T> class ArrayIterator : public ArrayPositionIterator

Interface

Public Members

explicit ArrayIterator(Array<T> &arr, uInt byDim=1)

ArrayIterator(Array<T> &arr, const IPosition &axes, Bool axesAreCursor = True)

virtual ~ArrayIterator()

virtual void next()

virtual void reset()

Array<T> &array()

Private Members

void init(Array<T> &)

void apSetPointer(Int stepDim)

ArrayIterator(const ArrayIterator<T> &)

ArrayIterator<T> &operator=(const ArrayIterator<T> &)

Description

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

ArrayIterator steps an array section (the "cursor") through an array. The cursor "refers" to storage in the array, so that changing the values in the cursor changes values in the original array. Like with ArrayPositionIterator, the cursor presently only moves through the array from bottom to top in the obvious way; however one may of course iterate through a slice ("array section"). This class is derived from ArrayPositionIterator since it also has a position (the blc of the cursor) which moves through the array volume.

The origin of the cursor, i.e. the subarray that moves through the larger array, is always zero.

    Array<Float> to, from;
    //... set to and from, check that they are conformant
    ArrayIterator toiter(to,1);
    ArrayIterator fromiter(from,1);
    while (! toiter.pastEnd() ) {
        toiter.array() = fromiter.array();  // copy vector by vector
        toiter.next(); fromiter.next();
    }
    
    

Member Description

explicit ArrayIterator(Array<T> &arr, uInt byDim=1)

ArrayIterator(Array<T> &arr, const IPosition &axes, Bool axesAreCursor = True)

Step through an array using the given axes. The axes can be given in two ways:

1. axesAreCursor=True means that the axes form the cursor axes. The remaining axes will form the iteration axes. This is the default.
2. axesAreCursor=False means the opposite. In this case the iteration axes can be given in any order.

virtual ~ArrayIterator()

virtual void next()

Move the cursor to the next position.

virtual void reset()

Reset the cursor to the beginning.

Array<T> &array()

Return the cursor. (Perhaps we should have a fn() that returns a reference to the original array as well?)

void init(Array<T> &)

void apSetPointer(Int stepDim)

ArrayIterator(const ArrayIterator<T> &)

ArrayIterator<T> &operator=(const ArrayIterator<T> &)

template<class T> class ReadOnlyArrayIterator

Interface

    void CopyArray(Array<Float> &to, const Array<Float> &from)
    {
        //... check that they are conformant
        ArrayIterator toiter(to,1);
        ReadOnlyArrayIterator fromiter(from,1);
        while (! toiter.pastEnd() ) {
            toiter.array() = fromiter.array();  // copy vector by vector
            toiter.next(); fromiter.next();
        }
    }