casacore::VectorSTLIterator< T > Class Template Reference

Casacore Vector iterator. More...

#include <VectorSTLIterator.h>

List of all members.

Public Types
typedef T	value_type
typedef value_type *	pointer
typedef const value_type *	const_pointer
typedef VectorSTLIterator< T >	iterator
typedef const VectorSTLIterator< T >	const_iterator
typedef value_type &	reference
typedef const value_type &	const_reference
typedef std::size_t	size_type
typedef ptrdiff_t	difference_type
Public Member Functions
	VectorSTLIterator (const Vector< T > &c)
	Constructors.
	VectorSTLIterator ()
	VectorSTLIterator (const typename Array< T >::IteratorSTL &c)
	VectorSTLIterator (const VectorSTLIterator< T > &that)
	Copy constructor.
VectorSTLIterator< T > &	operator= (const VectorSTLIterator< T > &that)
	Assignment.
	~VectorSTLIterator ()
	Destructor.
reference	operator[] (uInt i)
	Access.
const_reference	operator[] (uInt i) const
reference	operator* ()
const_reference	operator* () const
pointer	pos () const
const iterator &	operator++ ()
	Manipulation.
iterator	operator++ (int)
iterator &	operator-- ()
iterator	operator-- (int)
iterator &	operator+= (difference_type i)
iterator &	operator-= (difference_type i)
iterator	operator+ (difference_type i) const
iterator	operator- (difference_type i) const
difference_type	operator- (const VectorSTLIterator< T > &x) const
	Size related.
Bool	operator== (const iterator &other) const
	Comparisons.
Bool	operator!= (const iterator other) const
Bool	operator< (const iterator &other) const
Bool	operator== (const_pointer const pos) const
Bool	operator!= (const_pointer const pos) const
Bool	operator< (const_pointer const pos) const
Protected Attributes
pointer const	start_p
	Start (for random indexing).
difference_type	step_p
	Distance between elements.
pointer	iter_p
	Current element pointer.

---

Detailed Description

template<class T>
class casacore::VectorSTLIterator< T >

Casacore Vector iterator.

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

Synopsis

This class creates a random access STL iterator for an Casacore Vector. All the STL functionality is present (or if something missing can be easily added).
The following comments hold:

• A VectorSTLIterator can be created from a Vector (non-STL) It is the same as using Vector.begin()
• No contiguous iterator is provided. Its construction is not necessary, since Vector.data() is a fully functional STL iterator already.
• This iterator is non-intrusive. Since it needs state (the 'step') nothing substantial is gained by having it included in the Vector class. The major gain would be to be able to use the standard nomenclature: Vector::iterator() rather than VectorSTLiterator
• It would be advisable, and easy to implement, to add a template argument to the Array classes: <class T, Bool isCont=True>. The default is contiguous, since creation is contiguous. In that case correct iterators for e.g. contiguous arrays are supplied automatically.
• needs probably some 'const' fine tuning; and the -> operator

Definition at line 66 of file VectorSTLIterator.h.

---

Member Typedef Documentation

template<class T>

typedef const VectorSTLIterator<T> casacore::VectorSTLIterator< T >::const_iterator

Definition at line 73 of file VectorSTLIterator.h.

template<class T>

typedef const value_type* casacore::VectorSTLIterator< T >::const_pointer

Definition at line 71 of file VectorSTLIterator.h.

template<class T>

typedef const value_type& casacore::VectorSTLIterator< T >::const_reference

Definition at line 75 of file VectorSTLIterator.h.

template<class T>

typedef ptrdiff_t casacore::VectorSTLIterator< T >::difference_type

Definition at line 77 of file VectorSTLIterator.h.

template<class T>

typedef VectorSTLIterator<T> casacore::VectorSTLIterator< T >::iterator

Definition at line 72 of file VectorSTLIterator.h.

template<class T>

typedef value_type* casacore::VectorSTLIterator< T >::pointer

Definition at line 70 of file VectorSTLIterator.h.

template<class T>

typedef value_type& casacore::VectorSTLIterator< T >::reference

Definition at line 74 of file VectorSTLIterator.h.

template<class T>

typedef std::size_t casacore::VectorSTLIterator< T >::size_type

Definition at line 76 of file VectorSTLIterator.h.

template<class T>

typedef T casacore::VectorSTLIterator< T >::value_type

Definition at line 69 of file VectorSTLIterator.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::VectorSTLIterator< T >::VectorSTLIterator

(

const Vector< T > &

c

)

[inline, explicit]

Constructors.

The iterator constructor from a Vector is the same as if created from Vector.begin(). Copy constructor and assignment can be the default ones.

Definition at line 82 of file VectorSTLIterator.h.

template<class T>

casacore::VectorSTLIterator< T >::VectorSTLIterator

(

)

[inline]

Definition at line 87 of file VectorSTLIterator.h.

template<class T>

casacore::VectorSTLIterator< T >::VectorSTLIterator

(

const typename Array< T >::IteratorSTL &

c

)

[inline]

Definition at line 89 of file VectorSTLIterator.h.

template<class T>

casacore::VectorSTLIterator< T >::VectorSTLIterator

(

const VectorSTLIterator< T > &

that

)

[inline]

Copy constructor.

Definition at line 96 of file VectorSTLIterator.h.

template<class T>

casacore::VectorSTLIterator< T >::~VectorSTLIterator

(

)

[inline]

Destructor.

Definition at line 115 of file VectorSTLIterator.h.

---

Member Function Documentation

template<class T>

Bool casacore::VectorSTLIterator< T >::operator!=

(

const_pointer const

pos

)

const [inline]

Definition at line 157 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

template<class T>

Bool casacore::VectorSTLIterator< T >::operator!=

(

const iterator

other

)

const [inline]

Definition at line 151 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

template<class T>

const_reference casacore::VectorSTLIterator< T >::operator*

(

)

const [inline]

Definition at line 122 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

template<class T>

reference casacore::VectorSTLIterator< T >::operator*

(

)

[inline]

Definition at line 121 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

template<class T>

iterator casacore::VectorSTLIterator< T >::operator+

(

difference_type

i

)

const [inline]

Definition at line 137 of file VectorSTLIterator.h.

template<class T>

iterator casacore::VectorSTLIterator< T >::operator++

(

int

)

[inline]

Definition at line 128 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

const iterator& casacore::VectorSTLIterator< T >::operator++

(

)

[inline]

Manipulation.

Definition at line 127 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

iterator& casacore::VectorSTLIterator< T >::operator+=

(

difference_type

i

)

[inline]

Definition at line 133 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

difference_type casacore::VectorSTLIterator< T >::operator-

(

const VectorSTLIterator< T > &

x

)

const [inline]

Size related.

Definition at line 144 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

iterator casacore::VectorSTLIterator< T >::operator-

(

difference_type

i

)

const [inline]

Definition at line 139 of file VectorSTLIterator.h.

template<class T>

iterator casacore::VectorSTLIterator< T >::operator--

(

int

)

[inline]

Definition at line 131 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

iterator& casacore::VectorSTLIterator< T >::operator--

(

)

[inline]

Definition at line 130 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

iterator& casacore::VectorSTLIterator< T >::operator-=

(

difference_type

i

)

[inline]

Definition at line 135 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

Bool casacore::VectorSTLIterator< T >::operator<

(

const_pointer const

pos

)

const [inline]

Definition at line 159 of file VectorSTLIterator.h.

template<class T>

Bool casacore::VectorSTLIterator< T >::operator<

(

const iterator &

other

)

const [inline]

Definition at line 153 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

template<class T>

VectorSTLIterator<T>& casacore::VectorSTLIterator< T >::operator=

(

const VectorSTLIterator< T > &

that

)

[inline]

Assignment.

Definition at line 103 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p, casacore::VectorSTLIterator< T >::start_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

Bool casacore::VectorSTLIterator< T >::operator==

(

const_pointer const

pos

)

const [inline]

Definition at line 155 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

template<class T>

Bool casacore::VectorSTLIterator< T >::operator==

(

const iterator &

other

)

const [inline]

Comparisons.

Definition at line 149 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

template<class T>

const_reference casacore::VectorSTLIterator< T >::operator[]

(

uInt

i

)

const [inline]

Definition at line 119 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::start_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

reference casacore::VectorSTLIterator< T >::operator[]

(

uInt

i

)

[inline]

Access.

Definition at line 118 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::start_p, and casacore::VectorSTLIterator< T >::step_p.

template<class T>

pointer casacore::VectorSTLIterator< T >::pos

(

)

const [inline]

Definition at line 123 of file VectorSTLIterator.h.

References casacore::VectorSTLIterator< T >::iter_p.

---

Member Data Documentation

template<class T>

pointer casacore::VectorSTLIterator< T >::iter_p [protected]

Current element pointer.

Definition at line 168 of file VectorSTLIterator.h.

Referenced by casacore::VectorSTLIterator< T >::operator!=(), casacore::VectorSTLIterator< T >::operator*(), casacore::VectorSTLIterator< T >::operator++(), casacore::VectorSTLIterator< T >::operator+=(), casacore::VectorSTLIterator< T >::operator-(), casacore::VectorSTLIterator< T >::operator--(), casacore::VectorSTLIterator< T >::operator-=(), casacore::VectorSTLIterator< T >::operator<(), casacore::VectorSTLIterator< T >::operator=(), casacore::VectorSTLIterator< T >::operator==(), and casacore::VectorSTLIterator< T >::pos().

template<class T>

pointer const casacore::VectorSTLIterator< T >::start_p [protected]

Start (for random indexing).

Definition at line 160 of file VectorSTLIterator.h.

Referenced by casacore::VectorSTLIterator< T >::operator=(), and casacore::VectorSTLIterator< T >::operator[]().

template<class T>

difference_type casacore::VectorSTLIterator< T >::step_p [protected]

Distance between elements.

Definition at line 166 of file VectorSTLIterator.h.

Referenced by casacore::VectorSTLIterator< T >::operator++(), casacore::VectorSTLIterator< T >::operator+=(), casacore::VectorSTLIterator< T >::operator-(), casacore::VectorSTLIterator< T >::operator--(), casacore::VectorSTLIterator< T >::operator-=(), casacore::VectorSTLIterator< T >::operator=(), and casacore::VectorSTLIterator< T >::operator[]().

---

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

• casacore/casa/Arrays/VectorSTLIterator.h