Rogue Wave banner
Previous fileTop of documentContentsIndexNext file

RWTValHashMapIterator<K,T,H,EQ>

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

Synopsis

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

Please Note!


If you have the Standard C++ Library, use the interface described here. Otherwise, use the interface for RWTValHashDictionaryIterator described in Appendix A.


Description

RWTValHashMapIterator is supplied with Tools 7 to provide an iterator interface to RWTValHashMapIterator that has backward compatibility with the container iterators provided in Tools 6.

Iteration over an RWTValHashMap 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 an 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

Example

#include<rw/tvhdict.h>
#include<iostream.h>
#include<rw/cstring.h>
struct silly_h{
   unsigned long operator()(const RWCString& x) const
   { return x.length() * (long)x(0); }
};
int main(){
   RWTValHashMap
     <RWCString,int,silly_h,equal_to<RWCString> > age;
   RWTValHashMapIterator
     <RWCString, int, silly_h, equal_to<RWCString > > itr(age);
   age.insert(RWCString("John"), 30);
   age.insert(RWCString("Steve"),17);
   age.insert(RWCString("Mark"),24);
//Duplicate insertion rejected
   age.insert(RWCString("Steve"),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
Steve's age is 17
Mark's age is 24

Public Constructors

RWTValHashMapIterator<K,T,H,EQ>
(RWTValHashMap<K,T,H,EQ>&h); 

Public Member Operators

RWBoolean
operator()();
RWBoolean
operator++();

Public Member Functions

RWTValHashMap<K,T,H,EQ>*
container() const; 
K
key() const; 
void
reset();
void
reset(RWTValHashMap<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.