RWTValHashSetIterator< T, H, EQ, A > Class Template Reference

Deprecated. Provides an iterator for RWTValHashSet. More...

#include <rw/tvhset.h>

Public Member Functions
	RWTValHashSetIterator (RWTValHashSet< T, H, EQ, A > &h)
RWTValHashSet< T, H, EQ, A > *	container () const
T	key () const
bool	operator() ()
bool	operator++ ()
void	reset ()
void	reset (RWTValHashSet< T, H, EQ, A > &h)

Detailed Description

template<class T, class H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>
class RWTValHashSetIterator< T, H, EQ, A >

Deprecated:

As of SourcePro 12.5, use RWTValHashSet::iterator to iterate over the elements in this collection.

RWTValHashSetIterator provides an iterator interface to the C++ Standard Library collection represented by RWTValHashSet. (An STL iterator interface is provided through RWTValHashSet::iterator.)

Iteration over an RWTValHashSet 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 pre-increment or an 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/tvhset.h>
RWTValHashSet<T,H,EQ,A> m;
RWTValHashSetIterator<T,H,EQ,A> itr(m);

Persistence

None

Example

#include <rw/tvhset.h>
#include <rw/cstring.h>
#include <iostream>
#include <functional>

int main()
{
   RWTValHashSet
     <RWCString, RWTHasher<RWCString>, std::equal_to<RWCString> >
       age(RWCString::hash);
   RWTValHashSetIterator
     <RWCString, RWTHasher<RWCString>, std::equal_to<RWCString > >
       itr(age);

   age.insert("John");
   age.insert("Steve");
   age.insert("Mark");

   while(itr()) {
     std::cout << itr.key() << std::endl;
   }

   return 0;
}

Program Output:

John
Steve
Mark

Constructor & Destructor Documentation

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

RWTValHashSetIterator< T, H, EQ, A >::RWTValHashSetIterator ( RWTValHashSet< T, H, EQ, A > &  h )

inline

Creates an iterator for the hashset 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 = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T>>

RWTValHashSet<T, H, EQ, A>* RWTValHashSetIterator< T, H, EQ, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

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

T RWTValHashSetIterator< T, H, EQ, A >::key ( ) const

inline

Returns the value currently pointed to by self.

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

bool RWTValHashSetIterator< T, H, EQ, A >::operator() ( void  )

inline

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

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

bool RWTValHashSetIterator< T, H, EQ, A >::operator++ ( )

inline

Advances self to the next element. If the iterator has been reset or just created, self will reference the first element. If, before iteration, self referenced the last value in the multiset, self will reference an undefined value and will return false. Otherwise, it returns true.

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

void RWTValHashSetIterator< T, H, EQ, A >::reset ( void  )

inline

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

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

void RWTValHashSetIterator< T, H, EQ, A >::reset ( RWTValHashSet< T, H, EQ, A > &  h )

inline

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