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

Deprecated. Provides an iterator for RWTPtrHashSet. More...

#include <rw/tphset.h>

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

Detailed Description

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

Deprecated:

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

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

Iteration over an RWTPtrHashSet 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 will return a value equivalent to boolean false. Continued increments will 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/tphset.h>
RWTPtrHashSet<T,H,EQ,A> m;
RWTPtrHashSet<T,H,EQ,A> itr(m);

Persistence

None

Example

#include <rw/tphset.h>
#include <iostream>
#include <rw/cstring.h>

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

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

   for(;++itr;) {
     std::cout << *itr.key() << std::endl;
   }

   age.clearAndDestroy();
   return 0;
}

Program Output (not necessarily in this order):

John
Mark
Steve

Constructor & Destructor Documentation

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

RWTPtrHashSetIterator< T, H, EQ, A >::RWTPtrHashSetIterator ( RWTPtrHashSet< T, H, EQ, A > &  h )

inline

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

Member Function Documentation

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

RWTPtrHashSet<T, H, EQ, A>* RWTPtrHashSetIterator< 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* RWTPtrHashSetIterator< T, H, EQ, A >::key ( ) const

inline

Returns the element referenced by self. Undefined if self is not referencing a value within the set.

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

T* RWTPtrHashSetIterator< 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, rwnil will be returned.

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

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

inline

Advances self to the next element. If the iterator has been reset or just created, self will now reference the first element. If, before iteration, self referenced the last association in the multi-map, self will now point to an undefined value and a value equivalent to false will be returned. Otherwise, a value equivalent to true is returned.

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

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

inline

Resets the iterator so that after being advanced, it will reference 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 RWTPtrHashSetIterator< T, H, EQ, A >::reset ( RWTPtrHashSet< T, H, EQ, A > &  t )

inline

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