#ifndef RANGE_ITERATOR_H_
#define RANGE_ITERATOR_H_

#include <sarray/Index.h>
#include <sarray/Range.h>

/**
 * A RangeIterator is an Index that is bound to be inside a given
 * Range.  It has operators to allow traversing the Range in row- or
 * column order.  
 * @see Index Range
 */
class RangeIterator : public Index {
  const Range _range;
  bool _atend;
 public:
  /**
   * Constructor. The initial value of a RangeIterator is
   * the lower limit of the range argument.
   * @param range. Range to traverse
   */
  RangeIterator(Range const &range);
  virtual ~RangeIterator();
  /**
   * Assignment operator. A RangeIterator can be set to any value
   * inside the range.
   * @exception range_error
   */
  RangeIterator &operator=(Index const &index);
  /**
   * Test to see if the RangeIterator has gone past the upper limit of
   * the range. For use in for() loops
   */
  bool atEnd() const;
  /**
   * Goes to the next index in column-major order, i.e. moving the
   * left hand index fastest. If the RangeIterator is equal to the
   * upper limit of the Range, then it will return to the lower limit,
   * but atEnd() will subsequently return true.
   * 
   * @return reference to self after incrementation
   */
  RangeIterator &nextLeft();
  /**
   * Goes to the next index in column-minor order, i.e. moving the right
   * hand index fastest.
   * @return reference to self after incrementation
   * @see nextLeft
   */
  RangeIterator &nextRight();
};

#endif /* RANGE_ITERATOR_H_ */