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

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

#include <rw/tphdict.h>

Public Member Functions
	RWTPtrHashMapConstIterator (const RWTPtrHashMap< K, T, H, EQ, A > &h)
	RWTPtrHashMapConstIterator (const RWTPtrHashMapIterator< K, T, H, EQ, A > &itr)
const RWTPtrHashMap< K, T, H, EQ, A > *	container () const
const K *	key () const
const K *	operator() ()
bool	operator++ ()
void	reset ()
void	reset (const RWTPtrHashMap< K, T, H, EQ, A > &m)
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 RWTPtrHashMapConstIterator< K, T, H, EQ, A >

Deprecated

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

RWTPtrHashMapConstIterator provides a const iterator interface to the C++ Standard Library-based container RWTPtrHashMap. This iterator prohibits any changes to the underlying collection.

Iteration over an RWTPtrHashMap is pseudo-random and dependent on the capacity of the underlying hash table and the hash function being used.

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. Once this state is reached, 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/tphdict.h>
template <class K, class T, class H, class EQ,
          class A = std::allocator<T*> >
class RWTPtrHashMapConstIterator

Persistence

None

Constructor & Destructor Documentation

RWTPtrHashMapConstIterator() [1/2]

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

RWTPtrHashMapConstIterator< K, T, H, EQ, A >::RWTPtrHashMapConstIterator ( const RWTPtrHashMap< 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 association is accessible.

RWTPtrHashMapConstIterator() [2/2]

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

RWTPtrHashMapConstIterator< K, T, H, EQ, A >::RWTPtrHashMapConstIterator ( const RWTPtrHashMapIterator< 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 association 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 RWTPtrHashMap< K, T, H, EQ, A > * RWTPtrHashMapConstIterator< 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 * RWTPtrHashMapConstIterator< K, T, H, EQ, A >::key ( ) const

inline

Returns the key portion of the association currently referenced by self. The return value is undefined if self is not referencing an association within the hashmap.

operator()()

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

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

inline

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

operator++()

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

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

inline

Advances 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 hashmap, self references an undefined value and the method returns a value equivalent to false. Otherwise, the method returns a value equivalent to true.

reset() [1/2]

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

void RWTPtrHashMapConstIterator< 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 RWTPtrHashMapConstIterator< K, T, H, EQ, A >::reset ( const RWTPtrHashMap< K, T, H, EQ, A > & m )

inline

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

value()

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

const T * RWTPtrHashMapConstIterator< K, T, H, EQ, A >::value ( ) const

inline

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