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

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

#include <rw/tphmmap.h>

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

Deprecated:

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

RWTPtrHashMultiMapIterator provides a const iterator interface to the C++ Standard Library-based container RWTPtrHashMultiMap. This iterator prohibits changes to the collection that is being iterated through.

Iteration over an RWTPtrHashMultiMap 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(). 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/tphmmap.h>
template <class K, class T, class H, class EQ,
          class A=std::allocator<T*> >
class RWTPtrHashMultiMapConstIterator

Persistence

None

Constructor & Destructor Documentation

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

RWTPtrHashMultiMapConstIterator< K, T, H, EQ, A >::RWTPtrHashMultiMapConstIterator ( const RWTPtrHashMultiMap< K, T, H, EQ, A > &  h )

inline

Creates a const iterator for the hashed multi-map 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 = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K*>>

RWTPtrHashMultiMapConstIterator< K, T, H, EQ, A >::RWTPtrHashMultiMapConstIterator ( const RWTPtrHashMultiMapIterator< 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 = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K*>>

const RWTPtrHashMultiMap<K, T, H, EQ, A>* RWTPtrHashMultiMapConstIterator< K, T, H, EQ, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

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

const K* RWTPtrHashMultiMapConstIterator< 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 multimap.

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

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

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.

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

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

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

void RWTPtrHashMultiMapConstIterator< 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 = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K*>>

void RWTPtrHashMultiMapConstIterator< K, T, H, EQ, A >::reset ( RWTPtrHashMultiMap< K, T, H, EQ, A > &  m )

inline

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

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

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

inline

Returns the value portion of the association referenced by self. The return value is undefined if self is not referencing an association within the multi-map.