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

Maintains a sorted collection of values implemented as a doubly-linked list. More...

#include <rw/tvsrtdli.h>

Inherits RW_VSrtSeq< std::list< T,A >, RWTValSortedDlist< T, C,A >, C >.

List of all members.

Public Types
typedef std::list< T,A >	container_type
typedef container_type::iterator	iterator
typedef container_type::const_iterator	const_iterator
typedef container_type::size_type	size_type
typedef container_type::value_type	value_type
typedef container_type::reference	reference
typedef container_type::const_reference	const_reference
Public Member Functions
container_type &	std ()
const container_type &	std () const
iterator	begin ()
const_iterator	begin () const
void	clear ()
bool	contains (bool(*fn)(const_reference, void *), void *d) const
bool	contains (const_reference a) const
iterator	end ()
const_iterator	end () const
size_type	entries () const
bool	find (bool(*fn)(const_reference, void *), void *d, reference k) const
bool	find (const_reference a, reference k) const
reference	first ()
const_reference	first () const
bool	insert (const_reference a)
bool	insert (value_type &&a)
size_type	insert (const container_type &a)
bool	isEmpty () const
bool	isSorted () const
size_type	occurrencesOf (bool(*fn)(const_reference, void *), void *d) const
size_type	occurrencesOf (const_reference a) const
bool	operator< (const container_type &lst) const
bool	operator< (const RWTValSortedDlist< T, C, A > &lst) const
bool	operator== (const container_type &lst) const
bool	operator== (const RWTValSortedDlist< T, C, A > &lst) const
bool	operator!= (const container_type &stdc) const
bool	operator!= (const RWTValSortedDlist< T, C, A > &rwc) const
bool	remove (bool(*fn)(const_reference, void *), void *d)
bool	remove (const_reference a)
size_type	removeAll (bool(*fn)(const_reference, void *), void *d)
size_type	removeAll (const_reference a)
value_type	removeAt (size_type i)
value_type	removeFirst ()
size_type	index (const_reference a) const
size_type	index (bool(*fn)(const_reference, void *), void *d) const
void	apply (void(*fn)(const_reference, void *), void *d) const
const_reference	operator[] (size_type i) const
const_reference	operator() (size_type i) const
const_reference	at (size_type i) const
const_reference	last () const
T	removeLast ()
size_type	merge (const RWTValSortedDlist< T, C, A > &coll)
RWTValSortedDlist< T, C,A > &	operator= (const RWTValSortedDlist< T, C, A > &lst)
RWTValSortedDlist< T, C,A > &	operator= (const container_type &lst)
	RWTValSortedDlist ()
	RWTValSortedDlist (const RWTValSortedDlist< T, C, A > &t)
	RWTValSortedDlist (const container_type &lst)
	RWTValSortedDlist (size_type n, const T &val=T())
	RWTValSortedDlist (const T *first, const T *last)
	RWTValSortedDlist (RWTValSortedDlist &&rhs)
RWTValSortedDlist &	operator= (RWTValSortedDlist &&rhs)
void	swap (RWTValSortedDlist &rhs)
Related Functions
(Note that these are not member functions.)
template<class T , class C , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTValSortedDlist< T, C, A > &coll)
template<class T , class C , class A >
RWFile &	operator<< (RWFile &strm, const RWTValSortedDlist< T, C, A > &coll)
template<class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValSortedDlist< T, C, A > &coll)
template<class T , class C , class A >
RWFile &	operator>> (RWFile &strm, RWTValSortedDlist< T, C, A > &coll)
template<class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValSortedDlist< T, C, A > *&p)
template<class T , class C , class A >
RWFile &	operator>> (RWFile &strm, RWTValSortedDlist< T, C, A > *&p)

---

Detailed Description

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

This class maintains an always-sorted collection of values, implemented as a doubly-linked list.

Class T is the type of items in the collection. Class A is an allocator of objects of class T. For more information about using custom allocators, please see the Essential Tools Module User's Guide.

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> srtdlist;

Related Classes

RWTValSortedVector<T> is an alternative always-sorted collections. RWTValDlist<T,A> is an unsorted doubly-linked list of values.

Class list<T,A<T> > is the C++ Standard Library collection that serves as the underlying implementation for this class.

Persistence

Isomorphic

Examples

 //
 // tvsdldat.cpp
 //
 #include <iostream>
 #include <functional>
 
 #include <rw/tvsrtdli.h>
 #include <rw/tools/datetime.h>
 
 int main ()
 {
     RWTValSortedDlist<RWDateTime, std::less<RWDateTime> > lst;
 
     lst.insert(RWDateTime("Aug 10, 1991", RWDateTime::setDate));
     lst.insert(RWDateTime("Aug 9, 1991", RWDateTime::setDate));
     lst.insert(RWDateTime("Sep 1, 1991", RWDateTime::setDate));
     lst.insert(RWDateTime("May 14, 1990", RWDateTime::setDate));
     lst.insert(RWDateTime("Sep 1, 1991", RWDateTime::setDate)); // Add a duplicate
     lst.insert(RWDateTime("June 2, 1991", RWDateTime::setDate));
 
     for (size_t i = 0; i < lst.entries (); ++i)
         std::cout << lst[i].asString('x') << " ";
 
     std::cout << "\n\n";
 
     return 0;
 }

Program Output:

     05/14/90 06/02/91 08/09/91 08/10/91 09/01/91 09/01/91 

---

Member Typedef Documentation

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

typedef container_type::const_iterator RWTValSortedDlist< T, C, A >::const_iterator

Typedef for the const iterator.

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

typedef container_type::const_reference RWTValSortedDlist< T, C, A >::const_reference

Typedef for a const reference to a value in this container.

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

typedef std::list<T ,A > RWTValSortedDlist< T, C, A >::container_type

Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.

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

typedef container_type::iterator RWTValSortedDlist< T, C, A >::iterator

Typedef for the non-const iterator.

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

typedef container_type::reference RWTValSortedDlist< T, C, A >::reference

Typedef for a non-const reference to a value in this container.

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

typedef container_type::size_type RWTValSortedDlist< T, C, A >::size_type

Typedef for the type used to index into this container.

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

typedef container_type::value_type RWTValSortedDlist< T, C, A >::value_type

Typedef for the type of elements in this container.

---

Constructor & Destructor Documentation

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

RWTValSortedDlist< T, C, A >::RWTValSortedDlist

(

)

[inline]

Constructs an empty doubly-linked list.

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

RWTValSortedDlist< T, C, A >::RWTValSortedDlist

(

const RWTValSortedDlist< T, C, A > &

t

)

[inline]

Copy constructor.

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

RWTValSortedDlist< T, C, A >::RWTValSortedDlist

(

const container_type &

lst

)

[inline]

Constructs a doubly-linked list by copying and sorting all elements of lst.

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

RWTValSortedDlist< T, C, A >::RWTValSortedDlist	(	size_type	n,
		const T &	val = T()
	)			[inline]

Constructs a doubly-linked list with n elements, each initialized to val.

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

RWTValSortedDlist< T, C, A >::RWTValSortedDlist	(	const T *	first,
		const T *	last
	)			[inline]

Constructs a doubly-linked list by copying and sorting elements from the array of Ts pointed to by first, up to, but not including, the element pointed to by last.

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

RWTValSortedDlist< T, C, A >::RWTValSortedDlist

(

RWTValSortedDlist< T, C, A > &&

rhs

)

[inline]

Move constructor. The constructed instance takes ownership of the data owned by rhs.

Condition:

This method is only available on platforms with rvalue reference support.

---

Member Function Documentation

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

void RWTValSortedDlist< T, C, A >::apply	(	void(*)(const_reference, void *)	fn,
		void *	d
	)			const [inline]

Applies the user-defined function pointed to by fn to every item in the collection. Client data may be passed through parameter d.

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

const_reference RWTValSortedDlist< T, C, A >::at

(

size_type

i

)

const [inline]

Returns a reference to the i ^th element of self.

Exceptions:

RWBoundsErr

Thrown if index i is not between 0 and one less than the number of entries in self.

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

const_iterator RWTValSortedDlist< T, C, A >::begin

(

)

const [inline]

Returns an iterator positioned at the first element of self.

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

iterator RWTValSortedDlist< T, C, A >::begin

(

)

[inline]

Returns an iterator positioned at the first element of self.

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

void RWTValSortedDlist< T, C, A >::clear

(

void

)

[inline]

Clears the collection by removing all items from self. Each item has its destructor called.

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

bool RWTValSortedDlist< T, C, A >::contains

(

const_reference

a

)

const [inline]

Returns true if there exists an element t in self such that the expression (t == a) is true, otherwise returns false.

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

bool RWTValSortedDlist< T, C, A >::contains	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			const [inline]

Returns true if there exists an element t in self such that the expression ((*fn)(t,d)) is true, otherwise returns false. Client data may be passed through parameter d.

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

const_iterator RWTValSortedDlist< T, C, A >::end

(

)

const [inline]

Returns an iterator positioned "just past" the last element in self.

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

iterator RWTValSortedDlist< T, C, A >::end

(

)

[inline]

Returns an iterator positioned "just past" the last element in self.

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

size_type RWTValSortedDlist< T, C, A >::entries

(

void

)

const [inline]

Returns the number of items in self.

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

bool RWTValSortedDlist< T, C, A >::find	(	const_reference	a,
		reference	k
	)			const [inline]

If there exists an element t in self such that the expression (t == a) is true, assigns t to k and returns true. Otherwise, returns false and leaves the value of k unchanged.

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

bool RWTValSortedDlist< T, C, A >::find	(	bool(*)(const_reference, void *)	fn,
		void *	d,
		reference	k
	)			const [inline]

If there exists an element t in self such that the expression ((*fn)(t,d)) is true, assigns t to k and returns true. Otherwise, returns false and leaves the value of k unchanged. Client data may be passed through parameter d.

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

const_reference RWTValSortedDlist< T, C, A >::first

(

void

)

const [inline]

Returns a reference to the first element of self.

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

reference RWTValSortedDlist< T, C, A >::first

(

void

)

[inline]

Returns a reference to the first element of self.

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

size_type RWTValSortedDlist< T, C, A >::index	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			const [inline]

Returns the position of the first item t in self such that ((*fn)(t,d)) is true, or returns RW_NPOS if no such item exists. Client data may be passed through parameter d.

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

size_type RWTValSortedDlist< T, C, A >::index

(

const_reference

a

)

const

Returns the position of the first item t in self such that (t == a), or returns RW_NPOS if no such item exists.

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

size_type RWTValSortedDlist< T, C, A >::insert

(

const container_type &

a

)

[inline]

Adds the items from a to self, preserving order. Returns the number of items inserted into self.

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

bool RWTValSortedDlist< T, C, A >::insert

(

value_type &&

a

)

[inline]

Adds the item a to self. The collection remains sorted. Returns true.

Condition:

This method is only available on platforms with rvalue reference support.

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

bool RWTValSortedDlist< T, C, A >::insert

(

const_reference

a

)

[inline]

Adds the item a to self. The collection remains sorted. Returns true.

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

bool RWTValSortedDlist< T, C, A >::isEmpty

(

)

const [inline]

Returns true if there are no items in the collection, otherwise false.

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

bool RWTValSortedDlist< T, C, A >::isSorted

(

)

const [inline]

Returns true if the collection is sorted relative to the supplied comparator object, otherwise false.

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

const_reference RWTValSortedDlist< T, C, A >::last

(

void

)

const [inline]

Returns a reference to the last item in the collection.

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

size_type RWTValSortedDlist< T, C, A >::merge

(

const RWTValSortedDlist< T, C, A > &

coll

)

Inserts all elements of dl into self, preserving sorted order.

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

size_type RWTValSortedDlist< T, C, A >::occurrencesOf

(

const_reference

a

)

const [inline]

Returns the number of elements t in self such that the expression (t == a) is true.

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

size_type RWTValSortedDlist< T, C, A >::occurrencesOf	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			const [inline]

Returns the number of elements t in self such that the expression ((*fn)(t,d)) is true. Client data may be passed through parameter d.

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

bool RWTValSortedDlist< T, C, A >::operator!=

(

const RWTValSortedDlist< T, C, A > &

rwc

)

const [inline]

Returns the negation of operator==().

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

bool RWTValSortedDlist< T, C, A >::operator!=

(

const container_type &

stdc

)

const [inline]

Returns the negation of operator==().

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

const_reference RWTValSortedDlist< T, C, A >::operator()

(

size_type

i

)

const [inline]

Returns a reference to the i ^th element of self. Index i should be between 0 and one less than the number of entries, otherwise the results are undefined.

Note:

No bounds checking is performed.

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

bool RWTValSortedDlist< T, C, A >::operator<

(

const RWTValSortedDlist< T, C, A > &

lst

)

const [inline]

Returns true if self compares lexicographically less than lst, otherwise returns false. Assumes that type T has well-defined less-than semantics (T::operator<(const T&) or equivalent).

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

bool RWTValSortedDlist< T, C, A >::operator<

(

const container_type &

lst

)

const [inline]

Returns true if self compares lexicographically less than lst, otherwise returns false. Assumes that type T has well-defined less-than semantics (T::operator<(const T&) or equivalent).

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

RWTValSortedDlist& RWTValSortedDlist< T, C, A >::operator=

(

RWTValSortedDlist< T, C, A > &&

rhs

)

[inline]

Move assignment. Self takes ownership of the data owned by rhs.

Condition:

This method is only available on platforms with rvalue reference support.

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

RWTValSortedDlist<T,C ,A >& RWTValSortedDlist< T, C, A >::operator=

(

const container_type &

lst

)

[inline]

Destroys all elements of self and replaces them by copying (and sorting, if necessary) all elements of lst.

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

RWTValSortedDlist<T,C ,A >& RWTValSortedDlist< T, C, A >::operator=

(

const RWTValSortedDlist< T, C, A > &

lst

)

[inline]

Destroys all elements of self and replaces them by copying (and sorting, if necessary) all elements of lst.

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

bool RWTValSortedDlist< T, C, A >::operator==

(

const RWTValSortedDlist< T, C, A > &

lst

)

const [inline]

Returns true if self compares equal to lst, otherwise returns false. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual elements that compare equal to each other.

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

bool RWTValSortedDlist< T, C, A >::operator==

(

const container_type &

lst

)

const [inline]

Returns true if self compares equal to lst, otherwise returns false. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual elements that compare equal to each other.

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

const_reference RWTValSortedDlist< T, C, A >::operator[]

(

size_type

i

)

const [inline]

Returns a reference to the i ^th element of self.

Exceptions:

RWBoundsErr

Thrown if index i is not between 0 and one less than the number of entries in self.

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

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

(

const_reference

a

)

[inline]

Removes the first element t in self such that the expression (t == a) is true and returns true. Returns false if there is no such element.

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

bool RWTValSortedDlist< T, C, A >::remove	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			[inline]

Removes the first element t in self such that the expression ((*fn)(t,d)) is true and returns true. Returns false if there is no such element. Client data may be passed through parameter d.

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

size_type RWTValSortedDlist< T, C, A >::removeAll

(

const_reference

a

)

[inline]

Removes all elements t in self such that the expression (t == a) is true. Returns the number of items removed.

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

size_type RWTValSortedDlist< T, C, A >::removeAll	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			[inline]

Removes all elements t in self such that the expression ((*fn)(t,d)) is true. Returns the number of items removed. Client data may be passed through parameter d.

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

value_type RWTValSortedDlist< T, C, A >::removeAt

(

size_type

i

)

[inline]

Removes and returns the item at position i in self.

Exceptions:

RWBoundsErr

Thrown if index i is not between 0 and one less than the number of entries in the collection.

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

value_type RWTValSortedDlist< T, C, A >::removeFirst

(

)

[inline]

Removes and returns the first item in the collection.

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

T RWTValSortedDlist< T, C, A >::removeLast

(

)

[inline]

Removes and returns the last item in the collection.

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

const container_type& RWTValSortedDlist< T, C, A >::std

(

)

const [inline]

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. It is the application's responsibility to not violate the ordering of the elements within the collection.

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

container_type& RWTValSortedDlist< T, C, A >::std

(

)

[inline]

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. It is the application's responsibility to not violate the ordering of the elements within the collection.

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

void RWTValSortedDlist< T, C, A >::swap

(

RWTValSortedDlist< T, C, A > &

rhs

)

[inline]

Swaps the data owned by self with the data owned by rhs.

---

Friends And Related Function Documentation

template<class T , class C , class A >

RWFile & operator<<	(	RWFile &	strm,
		const RWTValSortedDlist< T, C, A > &	coll
	)			[related]

Saves the collection coll onto the RWFile strm, or a reference to it if it has already been saved.

template<class T , class C , class A >

RWvostream & operator<<	(	RWvostream &	strm,
		const RWTValSortedDlist< T, C, A > &	coll
	)			[related]

Saves the collection coll onto the output stream strm, or a reference to it if it has already been saved.

template<class T , class C , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTValSortedDlist< T, C, A > *&	p
	)			[related]

Looks at the next object on the RWFile strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.

template<class T , class C , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValSortedDlist< T, C, A > *&	p
	)			[related]

Looks at the next object on the input stream strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.

template<class T , class C , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTValSortedDlist< T, C, A > &	coll
	)			[related]

Restores the contents of the collection coll from the RWFile strm.

template<class T , class C , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValSortedDlist< T, C, A > &	coll
	)			[related]

Restores the contents of the collection coll from the input stream strm.