SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Provides an iterator for RWTPtrHashMultiSet. More...
#include <rw/tphasht.h>
Public Member Functions | |
RWTPtrHashMultiSetIterator (RWTPtrHashMultiSet< T, H, EQ, A > &h) | |
bool | operator++ () |
T * | operator() () |
RWTPtrHashMultiSet< T, H, EQ,A > * | container () const |
T * | key () const |
void | reset () |
void | reset (RWTPtrHashMultiSet< T, H, EQ, A > &t) |
RWTPtrHashMultiSetIterator provides an iterator interface to the C++ Standard Library-based collectionrepresented by RWTPtrHashMultiSet. (An STL iterator interface is provided through RWTPtrHashMultiSet::iterator
.)
Iteration over an RWTPtrHashMultiSet 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 all 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() operation. 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.
#include<rw/tphasht.h> RWTPtrHashMultiSet<T,H,EQ,A> m; RWTPtrHashMultiSet<T,H,EQ,A> itr(m);
None
#include <rw/tphasht.h> #include <iostream> #include <rw/cstring.h> int main() { RWTPtrHashMultiSet<RWCString,RWTHasher<RWCString>, std::equal_to<RWCString> > age(RWCString::hash); RWTPtrHashMultiSetIterator <RWCString,RWTHasher<RWCString>,std::equal_to<RWCString> > itr(age); age.insert(new RWCString("John")); age.insert(new RWCString("Steve")); age.insert(new RWCString("Mark")); age.insert(new RWCString("Steve")); for(;++itr;) { std::cout << *itr.key() << std::endl; } age.clearAndDestroy(); return 0; }
Program Output (not necessarily in this order):
John Mark Steve Steve
RWTPtrHashMultiSetIterator< T, H, EQ, A >::RWTPtrHashMultiSetIterator | ( | RWTPtrHashMultiSet< T, H, EQ, A > & | h | ) | [inline] |
Creates an iterator for the hashed multi-set h. The iterator begins in an undefined state and must be advanced before the first element is accessible.
RWTPtrHashMultiSet<T,H,EQ ,A >* RWTPtrHashMultiSetIterator< T, H, EQ, A >::container | ( | ) | const [inline] |
Returns a pointer to the collection being iterated over.
T* RWTPtrHashMultiSetIterator< T, H, EQ, A >::key | ( | ) | const [inline] |
Returns the value currently referenced by self. The return value is undefined if self is not referencing an element within the multiset.
T* RWTPtrHashMultiSetIterator< T, H, EQ, A >::operator() | ( | void | ) | [inline] |
Advances self to the next element, dereferences the resulting iterator and returns its value. If the iterator has advanced past the last item in the container, returns rwnil.
bool RWTPtrHashMultiSetIterator< T, H, EQ, A >::operator++ | ( | ) | [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 multiset, self references an undefined value and the method returns a value equivalent to false
. Otherwise, the method returns a value equivalent to true
.
void RWTPtrHashMultiSetIterator< T, H, EQ, A >::reset | ( | RWTPtrHashMultiSet< T, H, EQ, A > & | t | ) | [inline] |
Resets the iterator so that after being advanced it references the first element of the collection t.
void RWTPtrHashMultiSetIterator< T, H, EQ, A >::reset | ( | void | ) | [inline] |
Resets the iterator so that after being advanced it references the first element of the collection.
© 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.