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

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

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

Members

container() key()

operator()() operator++()

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

value()

#include <rw/tphmmap.h>
template <class K, class T, class H, class EQ, 
          class A=std::allocator<T*> >
class  RWTPtrHashMultiMapConstIterator

RWTPtrHashMultiMapIterator provides a const iterator interface to the standard library-based RWTPtrHashMultiMap collection.

Iteration over an RWTPtrHashMultiMap 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 preincrement 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.

None

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

Creates a const iterator for the hashed multi-map h. The iterator begins in an undefined state and must be advanced before the first element is accessible.

const 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 is a nil pointer equivalent to boolean false.

bool
operator++();

Advanced self to the next element. If the iterator has been reset or just created, self now references the first element. If, before iteration, self referenced the last association in the multimap, self now references an undefined value and a value equivalent to false is returned. Otherwise, a value equivalent to true is returned. Note: no post-increment operator is provided.

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

Returns a pointer to the collection being iterated over.

const 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,A>& h);

Resets the iterator so that after being advanced it references the first element of the collection. Using reset() with no argument resets the iterator on the current container. Supplying a RWTPtrHashMultiMap to reset() resets the iterator on that container.

const T*
value();

Returns the value portion of the association referenced by self. Undefined if self is not valid.

© 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.