RWTPtrHashMultiMapIterator(3C++) RWTPtrHashMultiMapIterator(3C++)
Name
RWTPtrHashMultiMapIterator<K,T,H,EQ> - Rogue Wave library class
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.
DescriptionRWTPtrHashMultiMapIterator 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.
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
Page 1
RWTPtrHashMultiMapIterator(3C++) RWTPtrHashMultiMapIterator(3C++)
<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);
Creates an iterator for the hashed multi-map h. The iterator begins in
an undefined state and must be advanced before the first element will be
accessible.
Public Member Operators
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, the element returned will be a nil pointer equivalent to
boolean false.
RWBoolean
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.
Public Member Functions
RWTPtrHashMultiMap<K,T,H,EQ>*
container() const;
Returns a pointer to the collection being iterated over.
Page 2
RWTPtrHashMultiMapIterator(3C++) RWTPtrHashMultiMapIterator(3C++)
K*
key() const;
Returns the key portion of the association currently referenced by self.
Undefined if self is not referencing a value within the multimap.
void
reset();
void
reset(RWTPtrHashMultiMap<K,T,H,EQ>& 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
RWTPtrHashMultiMap to reset() will reset the iterator on that container.
T*
value();
Returns the value portion of the association referenced by self.
Undefined if self is not valid.
Page 3
