RWTValHashMapConstIterator< K, T, H, EQ, A > Class Template Reference

Deprecated. Provides a const iterator for RWTValHashMap. More...

#include <rw/tvhdict.h>

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

Detailed Description

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

Deprecated

As of SourcePro 12.5, use RWTValHashMap::const_iterator to iterate over the elements in this collection.

RWTValHashMapConstIterator provides a const iterator for RWTValHashMap. The const iterator prohibits changes to the underlying collection.

Iteration over an RWTValHashMap 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 an 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/tvhdict.h>
RWTValHashMap<K, T, H, EQ, A> m;
RWTValHashMapConstIterator<K, T, H, EQ, A> itr(m);

Persistence

None

Constructor & Destructor Documentation

RWTValHashMapConstIterator() [1/2]

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

RWTValHashMapConstIterator< K, T, H, EQ, A >::RWTValHashMapConstIterator ( const RWTValHashMap< K, T, H, EQ, A > & h )

inline

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

RWTValHashMapConstIterator() [2/2]

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

RWTValHashMapConstIterator< K, T, H, EQ, A >::RWTValHashMapConstIterator ( const RWTValHashMapIterator< 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

container()

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

const RWTValHashMap< K, T, H, EQ, A > * RWTValHashMapConstIterator< K, T, H, EQ, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

key()

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

const K & RWTValHashMapConstIterator< K, T, H, EQ, A >::key ( ) const

inline

Returns the key portion of the association currently pointed to by self.

operator()()

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

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

inline

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

operator++()

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

bool RWTValHashMapConstIterator< 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.

reset() [1/2]

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

void RWTValHashMapConstIterator< K, T, H, EQ, A >::reset ( )

inline

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

reset() [2/2]

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

void RWTValHashMapConstIterator< K, T, H, EQ, A >::reset ( const RWTValHashMap< K, T, H, EQ, A > & h )

inline

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

value()

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

const T & RWTValHashMapConstIterator< K, T, H, EQ, A >::value ( ) const

inline

Returns the value portion of the association referenced by self.