RWTValSortedDlistIterator< T, C, A > Class Template Reference
[STL-based Collections]

Provides an iterator for RWTValSortedDlist. More...

#include <rw/tvsrtdli.h>

List of all members.

Public Member Functions
	RWTValSortedDlistIterator (RWTValSortedDlist< T, C, A > &s)
bool	operator++ ()
bool	operator-- ()
bool	operator+= (size_t n)
bool	operator-= (size_t n)
bool	operator() ()
RWTValSortedDlist< T, C,A > *	container () const
bool	findNext (const T &a)
bool	findNext (bool(*fn)(const T &, void *), void *d)
T	key () const
bool	remove ()
bool	removeNext (const T &a)
bool	removeNext (bool(*fn)(const T &, void *), void *d)
void	reset ()
void	reset (RWTValSortedDlist< T, C, A > &l)

---

Detailed Description

template<class T, class C, class A = std:: allocator < T >>
class RWTValSortedDlistIterator< T, C, A >

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

The order of iteration over an RWTValSortedDlist is dependent on the supplied comparator object supplied as applied to the values stored in the container.

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 false. Continued increments returns a value equivalent to false until reset() is called.

The value type must have operator== and operator< defined. This requirement is imposed by the C++ Standard Library.

Synopsis

 #include<rw/tvsrtdli.h>
 RWTValSortedDlist<T,C,A> dl;
 RWTValSortedDlistIterator<T,C,A> itr(dl);

Persistence

None

Examples

 #include <rw/tvsrtdli.h>
 #include <iostream>
 #include <rw/cstring.h>
 #include <functional>
 
 int main() {
    RWTValSortedDlist<RWCString, std::less<RWCString> > a;
    RWTValSortedDlistIterator<RWCString, std::less<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
     Mark
     Steve
     Steve

---

Constructor & Destructor Documentation

template<class T, class C, class A = std:: allocator < T >>

RWTValSortedDlistIterator< T, C, A >::RWTValSortedDlistIterator

(

RWTValSortedDlist< T, C, A > &

s

)

[inline]

Creates an iterator for the sorted dlist s. The iterator begins in an undefined state and must be advanced before the first element is accessible.

---

Member Function Documentation

template<class T, class C, class A = std:: allocator < T >>

RWTValSortedDlist<T,C ,A >* RWTValSortedDlistIterator< T, C, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::findNext	(	bool(*)(const T &, void *)	fn,
		void *	d
	)

Advances self to the first element t encountered by iterating forward, such that the expression ((*fn)(t,d)) is true. Returns true if such an element if found, otherwise false. Client data may be passed through parameter d.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::findNext

(

const T &

a

)

Advances self to the first element t encountered by iterating forward, such that the expression (t == a) is true. Returns true if such an element if found, otherwise false.

template<class T, class C, class A = std:: allocator < T >>

T RWTValSortedDlistIterator< T, C, A >::key

(

)

const [inline]

Returns the stored value referenced by self.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::operator()

(

void

)

[inline]

Advances self to the next element and returns true. If the iterator has advanced past the last element in the collection, returns false.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::operator++

(

)

Advances self to the next element. If the iterator has been reset or just created, self references the first element. If, before iteration, self referenced the last value in the list, self now points to an undefined value distinct from the reset value, and the operator returns false. Otherwise, returns true.

Note:

No post-increment operator is provided.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::operator+=

(

size_t

n

)

Behaves as if the operator++() member function had been applied n times.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::operator--

(

)

Moves self back to the immediately previous element. If the iterator has been reset or just created, returns false, otherwise returns true. If self references the first element, it is now in the reset state. If self has been iterated past the last value in the list, it now points to the last item in the list.

Note:

No post-decrement operator is provided.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::operator-=

(

size_t

n

)

Behaves as if the operator--() member function had been applied n times.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::remove

(

)

Removes the stored value referenced by self from the collection. Returns true if the value was successfully removed, otherwise false.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::removeNext	(	bool(*)(const T &, void *)	fn,
		void *	d
	)

Removes the first element t, encountered by iterating self forward such that the expression ((*fn)(t,d)) is true. Returns true if such an element is successfully removed, otherwise false. Client data may be passed through parameter d.

template<class T, class C, class A = std:: allocator < T >>

bool RWTValSortedDlistIterator< T, C, A >::removeNext

(

const T &

a

)

Removes the first element t, encountered by iterating self forward, such that the expression (t == a) is true. Returns true if such an element is successfully removed, otherwise false.

template<class T, class C, class A = std:: allocator < T >>

void RWTValSortedDlistIterator< T, C, A >::reset

(

RWTValSortedDlist< T, C, A > &

l

)

[inline]

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

template<class T, class C, class A = std:: allocator < T >>

void RWTValSortedDlistIterator< T, C, A >::reset

(

void

)

[inline]

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