RWTValSortedDlist<T,C,A>

Module:  Essential Tools Module   Group:  STL-based Collection Classes

Does not inherit

• Local Index
• Synopsis
• Description
• Persistence
• Example
• Related Classes
• Public Typedefs
• Public Constructors
• Public Member Operators
• Public Member Functions
• Related Global Operators

Members

apply() at() begin() clear() const_iterator const_reference container_type contains() end()

entries() find() first() index() insert() isEmpty() isSorted() iterator last()

merge() occurrencesOf() operator<() operator()() operator=() operator==() operator[]() reference remove()

removeAll() removeAt() removeFirst() removeLast() RWTValSortedDlist<T,C,A>() size_type std() value_type

Non-Members

operator>>()

operator<<()

#include <rw/tvsrtdli.h> 
RWTValSortedDlist<T,C,A> srtdlist;

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

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

Isomorphic

In this example, a sorted doubly-linked list of RWDates is exercised.

//
// 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 

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

Class std::list<T,A<T> > is the C++-standard collection that serves as the underlying implementation for this class.

typedef list<T,A<T> > container_type; 
typedef typename container_type::const_iterator iterator;
typedef typename container_type::const_iterator
  const_iterator;
typedef typename container_type::size_type  size_type;
typedef T value_type; 
typedef T& reference; 
typedef const T&  const_reference; 

RWTValSortedDlist<T,C,A>();

Constructs an empty doubly-linked list.

RWTValSortedDlist<T,C,A>(const list<T,A>& lst);

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

RWTValSortedDlist<T,C,A>(const RWTValSortedDlist<T,C,A>& rwlst);

Copy constructor.

RWTValSortedDlist<T,C,A>(size_type n, const T& val = T());

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

RWTValSortedDlist<T,C,A>(const T* first, const T* last);

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.

RWTValSortedDlist<T,C,A>&
operator=(const RWTValSortedDlist<T,C,A>& lst); 
RWTValSortedDlist<T,C,A>&
operator=(const list<T,A>& lst);

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

bool
operator<(const RWTValSortedDlist<T,C,A>& lst) const; 
bool
operator<(const list<T,A>& lst) const;

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).

bool
operator==(const RWTValSortedDlist<T,C,A>& lst) const; 
bool
operator==(const list<T>& lst) const;

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.

const_reference
operator()(size_type i) const; 

Returns a reference to the ith element of self. Index i should be between 0 and one less then the number of entries, otherwise the results are undefined -- no bounds checking is performed.

const_reference
operator[](size_type i) const; 

Returns a reference to the ith element of self. Index i must be between 0 and one less then the number of entries in self, otherwise the function throws an exception of type RWBoundsErr.

void
apply(void (*fn)(const_reference,void*), void* d) const; 

Applies the user-defined function pointed to by fn to every item in the collection. This function must have prototype:

void yourfun(const_reference a, void* d);

Client data may be passed through parameter d.

const_reference
at(size_type i) const; 

Returns a reference to the ith element of self. Index i must be between 0 and one less then the number of entries in self, otherwise the function throws an exception of type RWBoundsErr.

iterator
begin();
const_iterator
begin() const;

Returns an iterator positioned at the first element of self.

void
clear();

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

bool
contains(const_reference a) const; 

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

bool
contains(bool (*fn)(const_reference,void*), void* d) const;

Returns true if there exists an element t in self such that the expression ((*fn)(t,d)) is true, otherwise returns false. fn points to a user-defined tester function which must have prototype:

bool yourTester(const_reference a, void* d);

Client data may be passed through parameter d.

iterator
end();
const_iterator
end() const;

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

size_type
entries() const; 

Returns the number of items in self.

bool
find(const_reference a, value_type& k) const; 

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.

bool
find(bool (*fn)(const_reference,void*), void* d, 
value_type& k) const;

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. fn points to a user-defined tester function which must have prototype:

bool yourTester(const_reference a, void* d);

Client data may be passed through parameter d.

reference
first();
const_reference
first() const;

Returns a reference to the first element of self.

size_type
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.

size_type
index(bool (*fn)(const_reference,void*), void* d) const;

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. fn points to a user-defined tester function which must have prototype:

bool yourTester(const_reference a, void* d);

Client data may be passed through parameter d.

size_type
insert(const list<T,A<T> >& a); 

Adds the items from a to self in an order preserving manner. Returns the number of items inserted into self.

bool
insert(const_reference a); 

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

bool
isEmpty() const; 

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

bool
isSorted() const; 

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

const_reference
last() const; 

Returns a reference to the last item in the collection.

size_type
merge(const RWTValSortedDlist&<T,C> dl); 

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

size_type
occurrencesOf(const_reference) const; 

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

size_type
occurrencesOf(bool (*fn)(const_reference,void*),
              void* d) const;

Returns the number of elements t in self such that the expression((*fn)(t,d)) is true. fn points to a user-defined tester function which must have prototype:

bool yourTester(const_reference a, void* d);

Client data may be passed through parameter d.

bool
remove(const_reference a); 

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.

bool
remove(bool (*fn)(const_reference,void*), void* d); 

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. fn points to a user-defined tester function which must have prototype:

bool yourTester(const_reference a, void* d);

Client data may be passed through parameter d.

size_type
removeAll(const_reference a); 

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

size_type
removeAll(bool (*fn)(const_reference,void*), void* d);

Removes all elements t in self such that the expression ((*fn)(t,d))is true. Returns the number of items removed. fn points to a user-defined tester function which must have prototype:

bool yourTester(const_reference a, void* d);

Client data may be passed through parameter d.

T
removeAt(size_type i); 

Removes and returns the item at position i in self. This position must be between zero and one less then the number of entries in the collection, otherwise the function throws an exception of type RWBoundsErr.

T
removeFirst();

Removes and returns the first item in the collection.

T
removeLast();

Removes and returns the last item in the collection.

list<T,A<T> >&
std();
const list<T,A<T> >&
std() const;

Returns a reference to the underlying C++-standard collection that serves as the implementation for self. It is your responsibility not to violate the ordering of the elements within the collection.

RWvostream&
operator<<(RWvostream& strm, 
       const RWTValSortedDlist<T,C,A>& coll);
RWFile&
operator<<(RWFile& strm, 
           const RWTValSortedDlist<T,C,A>& coll);

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

RWvistream&
operator>>(RWvistream& strm, RWTValSortedDlist<T,C,A>& coll); 
RWFile&
operator>>(RWFile& strm, RWTValSortedDlist<T,C,A>& coll);

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

RWvistream&
operator>>(RWvistream& strm, RWTValSortedDlist<T,C,A>*& p);
RWFile&
operator>>(RWFile& strm, RWTValSortedDlist<T,C,A>*& p);

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 you are responsible for deleting it.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.