rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWTValHashMultiSetIterator< T, H, EQ, A > Class Template Reference
[STL Extension-based Collections]

Provides an iterator for RWTValHashMultiSet. More...

#include <rw/tvhasht.h>

List of all members.

Public Member Functions

 RWTValHashMultiSetIterator (RWTValHashMultiSet< T, H, EQ, A > &h)
bool operator++ ()
bool operator() ()
RWTValHashMultiSet< T, H, EQ,A > * container () const
key () const
void reset ()
void reset (RWTValHashMultiSet< T, H, EQ, A > &h)

Detailed Description

template<class T, class H, class EQ, class A = std:: allocator < T >>
class RWTValHashMultiSetIterator< T, H, EQ, A >

RWTValHashMultiSetIterator provides an iterator interface to the C++ Standard Library-based collection represented by RWTValHashMultiSet. (An STL iterator interface is provided through RWTValHashMultiSet::iterator.)

Iteration over an RWTValHashMultiSet 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 defined to be equivalent by the equivalence object, EQ, will be 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.

Synopsis

 #include <rw/tvhasht.h>
 RWTValHashMultiSet<T,H,EQ,A> m;
 RWTValHashMultiSetIterator<T,H,EQ,A> itr(m);

Persistence

None

Examples

 #include <rw/tvmset.h>
 #include <iostream>
 #include <rw/cstring.h>
 #include <functional>
 
 int main()
 {
    RWTValMultiSet<RWCString, std::greater<RWCString> > a;
    RWTValMultiSetIterator<RWCString,
      std::greater<RWCString> > itr(a);
 
    a.insert("John");
    a.insert("Steve");
    a.insert("Mark");
    a.insert("Steve");
 
    while(itr()) {
      std::cout << itr.key() << std::endl;
    }
 
    return 0;
 }

Program Output:

 John
 Steve
 Mark
 Steve

Constructor & Destructor Documentation

template<class T, class H, class EQ, class A = std:: allocator < T >>
RWTValHashMultiSetIterator< T, H, EQ, A >::RWTValHashMultiSetIterator ( RWTValHashMultiSet< T, H, EQ, A > &  h  )  [inline]

Creates an iterator for the hashed multiset h. The iterator begins in an undefined state and must be advanced before the first element is accessible.


Member Function Documentation

template<class T, class H, class EQ, class A = std:: allocator < T >>
RWTValHashMultiSet<T,H,EQ ,A >* RWTValHashMultiSetIterator< T, H, EQ, A >::container (  )  const [inline]

Returns a pointer to the collection being iterated over.

template<class T, class H, class EQ, class A = std:: allocator < T >>
T RWTValHashMultiSetIterator< T, H, EQ, A >::key (  )  const [inline]

Returns the value currently referenced by self.

template<class T, class H, class EQ, class A = std:: allocator < T >>
bool RWTValHashMultiSetIterator< T, H, EQ, A >::operator() ( void   )  [inline]

Advances self to the next element. Returns false if the iterator has advanced past the last element in the container, otherwise returns true.

template<class T, class H, class EQ, class A = std:: allocator < T >>
bool RWTValHashMultiSetIterator< T, H, EQ, A >::operator++ (  )  [inline]

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 value in the multiset, self now references an undefined value and the operator returns false, Otherwise, it returns true.

Note:
No post-increment operator is provided.
template<class T, class H, class EQ, class A = std:: allocator < T >>
void RWTValHashMultiSetIterator< T, H, EQ, A >::reset ( RWTValHashMultiSet< T, H, EQ, A > &  h  )  [inline]

Resets the iterator so that after being advanced it will reference the first element of the collection h.

template<class T, class H, class EQ, class A = std:: allocator < T >>
void RWTValHashMultiSetIterator< T, H, EQ, A >::reset ( void   )  [inline]

Resets the iterator so that after being advanced it will reference the first element of the collection.

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

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