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

Deprecated. Provides a const iterator for RWTPtrHashSet. More...

#include <rw/tphset.h>

Public Member Functions
	RWTPtrHashSetConstIterator (const RWTPtrHashSet< T, H, EQ, A > &h)
	RWTPtrHashSetConstIterator (const RWTPtrHashSetIterator< T, H, EQ, A > &itr)
const RWTPtrHashSet< T, H, EQ, A > *	container () const
const T *	key () const
const T *	operator() ()
bool	operator++ ()
void	reset ()
void	reset (const 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 RWTPtrHashSetConstIterator< T, H, EQ, A >

Deprecated

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

RWTPtrHashSetConstIterator provides a const iterator interface to C++ Standard Library-based RWTPtrHashSet collections.

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 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/tphset.h>
template <class T, class H, class EQ, class A = std::allocator<T*> >
class RWTPtrHashSetConstIterator

Persistence

None

Constructor & Destructor Documentation

RWTPtrHashSetConstIterator() [1/2]

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

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

inline

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

RWTPtrHashSetConstIterator() [2/2]

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

RWTPtrHashSetConstIterator< T, H, EQ, A >::RWTPtrHashSetConstIterator ( const RWTPtrHashSetIterator< T, H, EQ, A > & itr )

inline

Creates a const iterator for the iterator itr. The const iterator begins in an undefined state and must be advanced before the first element is accessible.

Member Function Documentation

container()

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

const RWTPtrHashSet< T, H, EQ, A > * RWTPtrHashSetConstIterator< T, H, EQ, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

key()

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

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

inline

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

operator()()

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

const T * RWTPtrHashSetConstIterator< T, H, EQ, A >::operator() ( )

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.

operator++()

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

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

inline

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

reset() [1/2]

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

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

inline

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

reset() [2/2]

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

void RWTPtrHashSetConstIterator< T, H, EQ, A >::reset ( const 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.