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

Deprecated. Provides an iterator for RWTValHashMultiMap. More...

#include <rw/tvhmmap.h>

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

Deprecated:

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

RWTValHashMultiMapIterator provides an iterator interface to the C++ Standard Library-based collection represented by RWTValHashMultiMap. (An STL iterator interface is provided through RWTValHashMultiMap::iterator.)

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;
RWTValHashMultiMapIterator<K,T,H,EQ,A> itr(m);

Persistence

None

Example

#include <rw/tvhmmap.h>
#include <rw/cstring.h>
#include <iostream>
#include <functional>

struct simple_hash
{
    unsigned long
    operator()(const RWCString& ref) const {
        size_t n = ref.length ();
        return (unsigned long)(n ? n * size_t (ref [0]) : 0);
    }
};

int main() {
   RWTValHashMultiMap
     <RWCString, int, simple_hash, std::equal_to<RWCString> >
       age;
   RWTValHashMultiMapIterator
     <RWCString, int, simple_hash, std::equal_to<RWCString > >
       itr(age);

   age.insert(RWCString("John"), 30);
   age.insert(RWCString("Steve"),17);
   age.insert(RWCString("Mark"),24);
   age.insert(RWCString("Steve"),24);

   while(itr()) {
     std::cout << itr.key()
               << "\'s age is "
               << itr.value()
               << std::endl;
   }

   return 0;
}

Program Output:

John's age is 30
Steve's age is 24
Steve's age is 17
Mark's age is 24

Constructor & Destructor Documentation

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

RWTValHashMultiMapIterator< K, T, H, EQ, A >::RWTValHashMultiMapIterator ( RWTValHashMultiMap< K, T, H, EQ, A > &  h )

inline

Creates an iterator for the hash multimap h. The 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>>

RWTValHashMultiMap<K, T, H, EQ, A>* RWTValHashMultiMapIterator< 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>>

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

bool RWTValHashMultiMapIterator< 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; otherwise returns true.

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

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

inline

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

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

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

inline

Resets the iterator so that after being advanced, it will reference 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 RWTValHashMultiMapIterator< K, T, H, EQ, A >::reset ( RWTValHashMultiMap< 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.

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

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

inline

Returns the value portion of the association referenced by self.