Rogue Wave banner
Previous fileTop of documentContentsIndexNext file

RWTPtrHashMultiMapIterator<K,T,H,EQ>

Data Type and Member Function Indexes
(exclusive of constructors and destructors)

Synopsis

#include<rw/tphmmap.h>
RWTPtrHashMultiMap<K,T,H,EQ> m;
RWTPtrHashMultiMap<K,T,H,EQ> itr(m);
 

Standard C++ Library Dependent!


RWTPtrHashMultiMapIterator requires the Standard C++ Library.


Description

RWTPtrHashMultiMapIterator is supplied with Tools 7 to provide an iterator interface to the new Standard Library based collections that has backward compatibility with the container iterators provided in Tools 6.

Iteration over an RWTPtrHashMultiMap is pseudorandom and dependent on the capacity of the underlying hash table and the hash function being used. The only useable 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 preincrement or operator().

For both operator++ and operator(), iterating past the last element will return a value equivalent to boolean false. 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 Standard C++ Library.

Persistence

None

Examples

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

struct silly_h{
   unsigned long operator()(RWCString x) const
     { return x.length() * (long)x(0); }
};

int main(){
   RWTPtrHashMultiMap
     <RWCString,int,silly_h,equal_to<RWCString> > age;

   RWTPtrHashMultiMapIterator
     <RWCString,int,silly_h,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));
   age.insert(new RWCString("Steve"),new int(24));

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

   return 0;
}

Program Output (not necessarily in this order)
John's age is 30
Mark's age is 24
Steve's age is 24
Steve's age is 17

Public Constructors

RWTPtrHashMultiMapIterator<K,T,H,EQ>
(RWTPtrHashMultiMap<K,T,H,EQ>&h);

Public Member Operators

K*
operator()();
RWBoolean
operator++();

Public Member Functions

RWTPtrHashMultiMap<K,T,H,EQ>*
container() const; 
K*
key() const; 
void
reset();
void
reset(RWTPtrHashMultiMap<K,T,H,EQ>& h);
T*
value();


Previous fileTop of documentContentsIndexNext file
©Copyright 1999, Rogue Wave Software, Inc.
Send mail to report errors or comment on the documentation.