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

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

Does not inherit

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

Members

container() key()

operator()() operator++()

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

value()

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

RWTPtrHashMapConstIterator provides a const iterator interface to the standard library-based RWTPtrHashMap. This iterator prohibits any changes to the underlying collection.

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 returns a value equivalent to boolean false. Once this state is reached, 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

RWTPtrHashMapConstIterator<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 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++();

Advances 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 multi-map, 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 RWTPtrHashMap<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 map.

void
reset();
void
reset(const RWTPtrHashMap<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 hashed map with reset() resets the iterator on that container.

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