SourcePro® 2021.1 |
SourcePro® API Reference Guide |
Product Documentation: SourcePro Documentation Home |
Deprecated. Provides an iterator for RWTPtrHashMultiMap. More...
#include <rw/tphmmap.h>
Public Member Functions | |
RWTPtrHashMultiMapIterator (RWTPtrHashMultiMap< K, T, H, EQ, A > &h) | |
RWTPtrHashMultiMap< K, T, H, EQ, A > * | container () const |
K * | key () const |
K * | operator() () |
bool | operator++ () |
void | reset () |
void | reset (RWTPtrHashMultiMap< K, T, H, EQ, A > &m) |
T * | value () const |
RWTPtrHashMultiMapIterator provides an iterator interface to the C++ Standard Library-based collection represented by RWTPtrHashMultiMap. (An STL iterator interface is provided through RWTPtrHashMultiMap::iterator.)
Iteration over an RWTPtrHashMultiMap is pseudo-random 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 that 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 pre-increment 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.
Program Output (not necessarily in this order):
|
inline |
Creates an iterator for the hashed multi-map h. The iterator begins in an undefined state and must be advanced before the first element is accessible.
|
inline |
Returns a pointer to the collection being iterated over.
|
inline |
Returns the key portion of the association currently referenced by self. The return value is undefined if self is not referencing a value within the multimap.
|
inline |
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 multimap, returns rwnil.
|
inline |
Advances self to the next element. If the iterator has been reset or just created, self references the first element. If used when self references the last association in the multimap, self references an undefined value and the method returns a value equivalent to false
. Otherwise, the method returns a value equivalent to true
.
|
inline |
Resets the iterator so that after being advanced it references the first element of the collection.
|
inline |
Resets the iterator so that after being advanced it references the first element of the collection m.
|
inline |
Returns the value portion of the association referenced by self. The return value is undefined if self is not referencing an association within the multimap.
Copyright © 2021 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |