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

Provides a const iterator for RWTValHashMultiMap. More...

#include <rw/tvhmmap.h>

List of all members.

Public Member Functions
	RWTValHashMultiMapConstIterator (const RWTValHashMultiMap< K, T, H, EQ, A > &h)
	RWTValHashMultiMapConstIterator (const RWTValHashMultiMapIterator< K, T, H, EQ, A > &itr)
bool	operator++ ()
bool	operator() ()
const RWTValHashMultiMap< K, T, H, EQ,A > *	container () const
const K &	key () const
void	reset ()
void	reset (const RWTValHashMultiMap< K, T, H, EQ, A > &h)
const T &	value () const

---

Detailed Description

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

RWTValHashMultiMapConstIterator provides a const iterator for RWTValHashMultiMap. A const iterator prohibits any changes to the collection it is iterating over.

Iteration over an RWTValHashMultiMap is pseudorandom 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(). 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/tvhmmap.h>
 RWTValHashMultiMap<K,T,H,EQ,A> m;
 RWTValHashMultiMapConstIterator<K,T,H,EQ,A> itr(m);

Persistence

None

---

Constructor & Destructor Documentation

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

RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::RWTValHashMultiMapConstIterator

(

const RWTValHashMultiMap< K, T, H, EQ, A > &

h

)

[inline]

Creates a const iterator for the hash multimap h. The iterator begins in an undefined state and must be advanced before the first element is accessible.

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

RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::RWTValHashMultiMapConstIterator

(

const RWTValHashMultiMapIterator< K, T, H, EQ, A > &

itr

)

[inline]

Creates 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 K, class T, class H, class EQ, class A = std:: allocator < K >>

const RWTValHashMultiMap<K,T,H,EQ ,A >* RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

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

const K& RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::key

(

)

const [inline]

Returns the key portion of the association currently referenced by self.

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

bool RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::operator()

(

void

)

[inline]

Advances self to the next element, dereferences the resulting iterator and returns false if the iterator has advanced past the last item in the container and true otherwise.

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

bool RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::operator++

(

)

[inline]

Advances self to the next element. If the iterator has been reset or just created self now references the first element. If, before iteration, self referenced the last association in the multimap, self now references an undefined value and false is returned. Otherwise, true is returned.

Note:

No post-increment operator is provided.

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

void RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::reset

(

const RWTValHashMultiMap< K, T, H, EQ, A > &

h

)

[inline]

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

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

void RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::reset

(

void

)

[inline]

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

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

const T& RWTValHashMultiMapConstIterator< K, T, H, EQ, A >::value

(

void

)

const [inline]

Returns the value portion of the association referenced by self.