RWMathVec<T>::iterator

Data Type and Member Function Indexes
Synopsis
Description
Example
Public Constructors
Public Member Operators

Data Type and Member Function Indexes
(exclusive of constructors and destructors)

Member Functions
operator!=() operator>() operator>=() operator<()	operator<=() operator*() operator+() operator++()	operator+=() operator-() operator--() operator-=()	operator=() operator==() operator[]()

Synopsis

template <class T>
class RWMathVec<T>::iterator;

Description

Class RWMathVec<T>::iterator is the random access iterator for the RWMathVec<T> collection class. The iterator class behaves like a pointer to type T and is used to increment through elements of an RWMathVec<T>.

Example

#include <rw/math/mathvec.h>

main()
{
    RWMathVec<int> V(5,rwUninitialized);
    RWMathVec<int>::iterator i = V.begin();
    RWMathVec<int>::iterator stop = V.end();

    // Assign a unique int value to each element of V
    for (int j=0; i != stop; ++i, ++j) *i = j;
}

Public Constructors

RWMathVec<T>::iterator();

Constructs an iterator that is in an uninitialized state. The iterator must be initialized before it is dereferenced.

RWMathVec<T>::iterator(const iterator& i);

Constructs an iterator from another iterator. Initialized iterators can be obtained via the begin() and end() member functions of RWMathVec<T>.

Public Member Operators

RWMathVec<T>::iterator&    operator++();
RWMathVec<T>::iterator&    operator--();
RWMathVec<T>::iterator&    operator++(int);
RWMathVec<T>::iterator&    operator--(int);

Prefix or postfix increment or decrement operator. The iterator points to the next or previous element in the RWMathVec<T>. No error condition is set if the iterator goes past the bounds of the vector. Compare to RWMathVec<T>::begin() and RWMathVec<T>::end() to check that the iterator position is valid.

RWMathVec<T>::iterator&  operator+=(RWMathVec<T>::difference_type d);
RWMathVec<T>::iterator&  operator-=(RWMathVec<T>::difference_type d);

Moves the iterator forward or backward d elements in the RWMathVec<T>. No error condition is set if the iterator goes past the bounds of the vector. Incrementing by d and then decrementing by d returns the iterator to its original position, even if doing so takes it past the bounds of the vector.

RWMathVec<T>::iterator& 
operator=(const RWMathVec<T>::iterator& i) const;

Sets the iterator state to be the same state as i.

RWMathVec<T>::difference_type 
operator-(const RWMathVec<T>::iterator& i) const;

If the return value is positive, moves the iterator that many elements past the iterator i. If the return value is negative, moves the iterator that many elements before the iterator i.

RWMathVec<T>::iterator& 
operator+(RWMathVec<T>::difference_type d) const;
RWMathVec<T>::iterator& 
operator-(RWMathVec<T>::difference_type d) const;

Returns an iterator that is d elements past (or before) self.

T&    operator[]() const;

Returns a reference to the element n elements after self if n is positive, or n elements before self if n is negative.

T&    operator*() const;

Returns a reference to the element pointed to by self.

RWBoolean  operator==(const RWMathVec<T>::iterator& i) const;
RWBoolean  operator!=(const RWMathVec<T>::iterator& i) const;
RWBoolean  operator<(const RWMathVec<T>::iterator& i) const;
RWBoolean  operator>(const RWMathVec<T>::iterator& i) const;
RWBoolean  operator<=(const RWMathVec<T>::iterator& i) const;
RWBoolean  operator>=(const RWMathVec<T>::iterator& i) const;

Comparison operator. Determines the relative logical position between two iterators, not necessarily the relative memory location of the elements to which they point.