RWTPtrHashMultiSetConstIterator< T, H, EQ, A > Class Template Reference
[STL Extension-based Collections]

Provides a const iterator for RWTPtrHashMultiSet. More...

#include <rw/tphasht.h>

List of all members.

Public Member Functions
	RWTPtrHashMultiSetConstIterator (const RWTPtrHashMultiSet< T, H, EQ, A > &h)
	RWTPtrHashMultiSetConstIterator (const RWTPtrHashMultiSetIterator< T, H, EQ, A > &itr)
bool	operator++ ()
const T *	operator() ()
const RWTPtrHashMultiSet< T, H, EQ,A > *	container () const
const T *	key () const
void	reset ()
void	reset (const RWTPtrHashMultiSet< T, H, EQ, A > &t)

---

Detailed Description

template<class T, class H, class EQ, class A = std:: allocator < T* >>
class RWTPtrHashMultiSetConstIterator< T, H, EQ, A >

RWTPtrHashMultiSetConstIterator provides a const iterator interface to the C++ Standard Library-based collection represented by RWTPtrHashMultiSet. This iterator prohibits changes to the collection that is being iterated through.

Iteration over an RWTPtrHashMultiSet is pseudo-random and dependent on the capacity of the underlying hash table and the hash function being used. The only usable relationship between consecutive elements is that elements which are defined to be equivalent by the equivalence object, EQ, will remain adjacent.

The current item referenced by this iterator is undefined after construction or after a call to reset() operation. The iterator becomes valid after being advanced with either a pre-increment or operator()().

For both operator++() and operator()(), iterating past the last element returns a value equivalent to boolean false. Continued increments return a value equivalent to false until reset() is called.

The value type must have operator==() defined. This requirement is imposed by the C++ Standard Library.

Synopsis

 #include <rw/tphasht.h>
 template <class T, class H, class EQ,
           class A=std::allocator<T*> >
 class  RWTPtrHashMultiSetConstIterator

Persistence

None

---

Constructor & Destructor Documentation

template<class T , class H , class EQ , class A = std:: allocator < T* >>

RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::RWTPtrHashMultiSetConstIterator

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

h

)

[inline]

Constructs a const iterator for the hashed multiset h. The iterator begins in an undefined state and must be advanced before the first element is accessible.

template<class T , class H , class EQ , class A = std:: allocator < T* >>

RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::RWTPtrHashMultiSetConstIterator

(

const RWTPtrHashMultiSetIterator< T, H, EQ, A > &

itr

)

[inline]

Constructs a const iterator from the iterator itr. The const iterator begins in an undefined state and must be advanced before the first element is accessible.

---

Member Function Documentation

template<class T , class H , class EQ , class A = std:: allocator < T* >>

const RWTPtrHashMultiSet<T,H,EQ ,A >* RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

template<class T , class H , class EQ , class A = std:: allocator < T* >>

const T* RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::key

(

)

const [inline]

Returns the value currently referenced by self. The return value is undefined if self is not referencing an association within the multiset.

template<class T , class H , class EQ , class A = std:: allocator < T* >>

const T* RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::operator()

(

void

)

[inline]

Advances self to the next element, dereferences the resulting iterator and returns its value. If the iterator has advanced past the last item in the container, returns rwnil.

template<class T , class H , class EQ , class A = std:: allocator < T* >>

bool RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::operator++

(

)

[inline]

Advanced self to the next element. If the iterator has been reset or just created, self references the first element. If used when self references the last association in the multi-set, self references an undefined value and the method returns a value equivalent to false. Otherwise, the method returns a value equivalent to true.

Note:

No post-increment operator is provided.

template<class T , class H , class EQ , class A = std:: allocator < T* >>

void RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::reset

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

t

)

[inline]

Resets the iterator so that after being advanced it references the first element of the collection t.

template<class T , class H , class EQ , class A = std:: allocator < T* >>

void RWTPtrHashMultiSetConstIterator< T, H, EQ, A >::reset

(

void

)

[inline]

Resets the iterator so that after being advanced it references the first element of the collection.