RWTPtrHashMapIterator<K,T,H,EQ,A>

Module:  Essential Tools Module   Group:  STL Extension-based Collection Classes

Does not inherit

• Local Index
• Synopsis
• Description
• Persistence
• Example
• Public Constructors
• Public Member Operators
• Public Member Functions

Members

container() key()

operator()() operator++()

reset() RWTPtrHashMapIterator<K,T,H,EQ,A>()

value()

#include<rw/tphdict.h>
RWTPtrHashMap<K,T,H,EQ,A>m;
RWTPtrHashMapIterator<K,T,H,EQ,A>itr(m); 

RWTPtrHashMapIterator provides the traditional Tools.h++ iterator interface to the standard library-based collections. (An STL iterator interface is provided through RWTPtrHashMap::iterator.)

Iteration over an RWTPtrHashMap is pseudorandom 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 preincrement or operator().

For both operator++ and operator(), iterating past the last element will return a value equivalent to boolean false. Once this state is reached, continued increments will 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.

None

#include <rw/tphdict.h>
#include <iostream>
#include <rw/cstring.h>

int main() {
   RWTPtrHashMap
     <RWCString,int,RWTHasher<RWCString>,std::equal_to<RWCString> > 
       age(RWCString::hash);

   RWTPtrHashMapIterator
     <RWCString,int,RWTHasher<RWCString>,std::equal_to<RWCString> > 
       itr(age);

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

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

   age.clearAndDestroy();
   return 0;
}

Program Output (not necessarily in this order):

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

RWTPtrHashMapIterator<K,T,H,EQ,A>(RWTPtrHashMap<K,T,H,EQ,A>& h);

Creates an iterator for the hashed map h. The iterator begins in an undefined state and must be advanced before the first element will be accessible.

K*
operator()();

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, a nil pointer will be returned.

bool
operator++();

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 multi-map, self will now reference an undefined value and a value equivalent to false will be returned. Otherwise, a value equivalent to true is returned. Note: no post-increment operator is provided.

RWTPtrHashMap<K,T,H,EQ,A>*
container() const; 

Returns a pointer to the collection being iterated over.

K*
key() const; 

Returns the key portion of the association currently referenced by self. Undefined if self is not referencing a value within the map.

void
reset();
void
reset(RWTPtrHashMap<K,T,H,EQ,A>& h);

Resets the iterator so that after being advanced it will reference the first element of the collection. Using reset() with no argument will reset the iterator on the current container. Supplying a hashed map with reset() will reset the iterator on that container.

T*
value();

Returns the value portion of the association pointed to by self. The behavior is undefined if the map is empty.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.