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

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

#include <rw/tvhasht.h>

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

Deprecated

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

RWTValHashMultiSetConstIterator provides a const iterator interface to the C++ Standard Library-based collection represented by RWTValHashMultiSet. A const iterator prohibits any changes to the underlying collection.

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;
RWTValHashMultiSetConstIterator<T, H, EQ, A> itr(m);

Persistence

None

Constructor & Destructor Documentation

RWTValHashMultiSetConstIterator() [1/2]

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

RWTValHashMultiSetConstIterator< T, H, EQ, A >::RWTValHashMultiSetConstIterator ( const RWTValHashMultiSet< T, H, EQ, A > & h )

inline

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

RWTValHashMultiSetConstIterator() [2/2]

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

RWTValHashMultiSetConstIterator< T, H, EQ, A >::RWTValHashMultiSetConstIterator ( const RWTValHashMultiSetIterator< T, H, EQ, A > & itr )

inline

Creates a const iterator from 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 RWTValHashMultiSet< T, H, EQ, A > * RWTValHashMultiSetConstIterator< 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 & RWTValHashMultiSetConstIterator< T, H, EQ, A >::key ( ) const

inline

Returns the value currently referenced by self.

operator()()

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

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

inline

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

operator++()

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

bool RWTValHashMultiSetConstIterator< 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 returns false, otherwise, returns true.

reset() [1/2]

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

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