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

Deprecated. Provides an iterator for RWTValHashMultiSet. More...

#include <rw/tvhasht.h>

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

Deprecated

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

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

Example

#include <rw/cstring.h>
#include <rw/tvmset.h>
#include <functional>
#include <iostream>
 
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

RWTValHashMultiSetIterator()

template<class T , class H = RWTHash<T>, class EQ = std::equal_to<T>, 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

container()

template<class T , class H = RWTHash<T>, class EQ = std::equal_to<T>, 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.

key()

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

T RWTValHashMultiSetIterator< 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 RWTValHashMultiSetIterator< T, H, EQ, A >::operator() ( )

inline

Advances self to the next element. Returns false if the iterator has advanced past the last element 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 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.

reset() [1/2]

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

void RWTValHashMultiSetIterator< 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 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.