SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A sorted pointer-based collection of values implemented as a doubly-linked list. More...
#include <rw/tpsrtdli.h>
Inherits RW_PSrtSeq< std::list< T *,A >, RWTPtrSortedDlist< T, C,A >, rw_deref_compare< C, T >, T >.
Public Types | |
typedef rw_deref_compare< C, T > | container_comp |
typedef std::list< T *,A > | container_type |
typedef container_type::size_type | size_type |
typedef container_type::difference_type | difference_type |
typedef base_type::value_type | value_type |
typedef base_type::reference | reference |
typedef base_type::const_reference | const_reference |
typedef base_type::const_iterator | const_iterator |
typedef base_type::iterator | iterator |
Public Member Functions | |
container_type & | std () |
const container_type & | std () const |
void | clear () |
void | clearAndDestroy () |
bool | contains (bool(*fn)(const_value, void *), void *d) const |
bool | contains (const_value a) const |
size_type | entries () const |
const_value | find (bool(*fn)(const_value, void *), void *d) const |
value_type | find (const_value a) |
const_value | find (const_value a) const |
reference | first () |
const_reference | first () const |
bool | insert (value_type a) |
size_type | insert (const container_type &a) |
bool | isEmpty () const |
bool | isSorted () const |
size_type | occurrencesOf (bool(*fn)(const_value, void *), void *d) const |
size_type | occurrencesOf (const_value a) const |
bool | operator< (const RWTPtrSortedDlist< T, C, A > &lst) const |
bool | operator== (const RWTPtrSortedDlist< T, C, A > &lst) const |
bool | operator!= (const RWTPtrSortedDlist< T, C, A > &rwc) const |
value_type | remove (bool(*fn)(const_value, void *), void *d) |
value_type | remove (const_value key) |
size_type | removeAll (bool(*fn)(const_value, void *), void *d) |
size_type | removeAll (const_value a) |
value_type | removeAt (size_type i) |
value_type | removeFirst () |
reference | operator[] (size_type i) |
const_reference | operator[] (size_type i) const |
reference | operator() (size_type i) |
const_reference | operator() (size_type i) const |
void | apply (void(*fn)(reference, void *), void *d) |
void | apply (void(*fn)(value_type, void *), void *d) |
void | apply (void(*fn)(const_value, void *), void *d) const |
reference | at (size_type i) |
const_reference | at (size_type i) const |
iterator | begin () |
const_iterator | begin () const |
iterator | end () |
const_iterator | end () const |
size_type | index (const_value a) const |
size_type | index (bool(*fn)(const_value, void *), void *d) const |
T *& | last () |
T *const & | last () const |
size_type | merge (const RWTPtrSortedDlist< T, C, A > &coll) |
T * | removeLast () |
RWTPtrSortedDlist< T, C,A > & | operator= (const RWTPtrSortedDlist< T, C, A > &lst) |
RWTPtrSortedDlist< T, C,A > & | operator= (const container_type &lst) |
RWTPtrSortedDlist< T, C,A > & | operator= (RWTPtrSortedDlist< T, C, A > &&lst) |
RWTPtrSortedDlist< T, C,A > & | operator= (container_type &&lst) |
RWTPtrSortedDlist () | |
RWTPtrSortedDlist (const RWTPtrSortedDlist< T, C, A > &t) | |
RWTPtrSortedDlist (const container_type &lst) | |
RWTPtrSortedDlist (size_type n, T *p) | |
RWTPtrSortedDlist (RWTPtrSortedDlist< T, C, A > &&lst) | |
RWTPtrSortedDlist (T *const *first, T *const *last) | |
void | swap (RWTPtrSortedDlist< T, C, A > &lst) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class C , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTPtrSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrSortedDlist< T, C, A > *&p) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrSortedDlist< T, C, A > *&p) |
This class maintains an always-sorted pointer-based collection of values, implemented as a doubly-linked list. Items are ordered according to a comparison object of type C
. Class T
is the type pointed to by the items in the collection. Class A
is an allocator of objects of type T
. For more information about using custom allocators, please see the Essential Tools Module User's Guide.
C
must induce a total ordering on elements of type T
via a public member bool operator()(const T& x, const T& y)
that returns true
if x
should precede y
within the collection. The structure std::less<T> from the C++ Standard Library header file <functional>
is an example. Note that items in the collection will be dereferenced before being compared.
The value
type must have operator==
and operator<
defined. This requirement is imposed by the C++ Standard Library.
#include <rw/tpsrtdli.h> RWTPtrSortedDlist<T,C,A> srtdlist;
Class RWTPtrSortedVector<T> is an alternative always-sorted pointer-based collection. RWTPtrDlist<T,A> is an unsorted pointer-based doubly-linked list.
Class std::list<T*,A<T*> > is the C++ Standard Library collection that serves as the underlying implementation for this class.
Isomorphic
// // tpsrtdli.cpp // #include <iostream> #include <functional> #include <rw/tpsrtdli.h> #include <rw/tools/datetime.h> int main () { RWTPtrSortedDlist<RWDateTime, std::greater<RWDateTime> > lst; lst.insert(new RWDateTime("Aug 10, 1991", RWDateTime::setDate)); lst.insert(new RWDateTime("Aug 9, 1991", RWDateTime::setDate)); lst.insert(new RWDateTime("Sep 1, 1991", RWDateTime::setDate)); lst.insert(new RWDateTime("May 14, 1990", RWDateTime::setDate)); lst.insert(new RWDateTime("Sep 1, 1991", RWDateTime::setDate)); // Add a duplicate lst.insert(new RWDateTime("June 2, 1991", RWDateTime::setDate)); for (size_t i = 0; i < lst.entries(); ++i) std::cout << lst[i]->asString('x') << std::endl; lst.clearAndDestroy(); return 0; }
Program Output:
09/01/91 09/01/91 08/10/91 08/09/91 06/02/91 05/14/90
typedef base_type::const_iterator RWTPtrSortedDlist< T, C, A >::const_iterator |
Typedef for the const
iterator.
typedef base_type::const_reference RWTPtrSortedDlist< T, C, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef rw_deref_compare<C,T> RWTPtrSortedDlist< T, C, A >::container_comp |
Typedef for the comparison object.
typedef std::list<T* ,A > RWTPtrSortedDlist< T, C, A >::container_type |
Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::difference_type RWTPtrSortedDlist< T, C, A >::difference_type |
Typedef for the type of difference between iterators.
typedef base_type::iterator RWTPtrSortedDlist< T, C, A >::iterator |
Typedef for the non-const
iterator.
typedef base_type::reference RWTPtrSortedDlist< T, C, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTPtrSortedDlist< T, C, A >::size_type |
Typedef for the type used to index into this container.
typedef base_type::value_type RWTPtrSortedDlist< T, C, A >::value_type |
Typedef for the type of elements in this container.
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist | ( | ) | [inline] |
Constructs an empty doubly-linked list.
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist | ( | const RWTPtrSortedDlist< T, C, A > & | t | ) | [inline] |
Copy constructor.
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist | ( | const container_type & | lst | ) | [inline] |
Constructs a doubly-linked list by iterating over all elements in lst and performing an order preserving insertion on self for each.
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist | ( | size_type | n, | |
T * | p | |||
) | [inline] |
Constructs a doubly-linked list with n elements, each initialized to p.
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist | ( | RWTPtrSortedDlist< T, C, A > && | lst | ) | [inline] |
Move constructor. The constructed list takes ownership of the data owned by lst.
RWTPtrSortedDlist< T, C, A >::RWTPtrSortedDlist | ( | T *const * | first, | |
T *const * | last | |||
) |
Constructs a doubly-linked list by copying and sorting elements from the array of T*
s pointed to by first, up to, but not including, the element pointed to by last.
void RWTPtrSortedDlist< T, C, A >::apply | ( | void(*)(const_value, 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.
void RWTPtrSortedDlist< T, C, A >::apply | ( | void(*)(value_type, void *) | fn, | |
void * | d | |||
) | [inline] |
Applies the user-defined function pointed to by fn to every item in the collection. Client data may be passed through parameter d.
void RWTPtrSortedDlist< T, C, A >::apply | ( | void(*)(reference, void *) | fn, | |
void * | d | |||
) | [inline] |
Applies the user-defined function pointed to by fn to every item in the collection. Client data may be passed through parameter d.
const_reference RWTPtrSortedDlist< T, C, A >::at | ( | size_type | i | ) | const [inline] |
Returns a reference to the i th element of self.
RWBoundsErr | Thrown if index i is not between 0 and one less than the number of entries in self. |
reference RWTPtrSortedDlist< T, C, A >::at | ( | size_type | i | ) | [inline] |
Returns a reference to the i th element of self.
RWBoundsErr | Thrown if index i is not between 0 and one less than the number of entries in self. |
const_iterator RWTPtrSortedDlist< T, C, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTPtrSortedDlist< T, C, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTPtrSortedDlist< T, C, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self.
void RWTPtrSortedDlist< T, C, A >::clearAndDestroy | ( | void | ) | [inline] |
Removes all items from the collection and uses operator delete
to destroy the objects pointed to by those items. Do not use this method if multiple pointers to the same object are stored.
bool RWTPtrSortedDlist< T, C, A >::contains | ( | const_value | a | ) | const [inline] |
Returns true
if there exists an element t
in self such that the expression (*t == *a)
is true
, otherwise returns false
.
bool RWTPtrSortedDlist< T, C, A >::contains | ( | bool(*)(const_value, 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.
const_iterator RWTPtrSortedDlist< T, C, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last element in self.
iterator RWTPtrSortedDlist< T, C, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last element in self.
size_type RWTPtrSortedDlist< T, C, A >::entries | ( | void | ) | const [inline] |
Returns the number of items in self.
const_value RWTPtrSortedDlist< T, C, A >::find | ( | const_value | a | ) | const [inline] |
If there exists an element t
in self such that the expression (*t == *a)
is true
, returns t
. Otherwise, returns rwnil.
value_type RWTPtrSortedDlist< T, C, A >::find | ( | const_value | a | ) | [inline] |
If there exists an element t
in self such that the expression (*t == *a)
is true
, returns t
. Otherwise, returns rwnil.
const_value RWTPtrSortedDlist< T, C, A >::find | ( | bool(*)(const_value, void *) | fn, | |
void * | d | |||
) | const [inline] |
If there exists an element t
in self such that the expression ((*fn)(t,d))
is true
, returns t
. Otherwise, returns rwnil. Client data may be passed through parameter d.
const_reference RWTPtrSortedDlist< T, C, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
reference RWTPtrSortedDlist< T, C, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
size_type RWTPtrSortedDlist< T, C, A >::index | ( | bool(*)(const_value, 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.
size_type RWTPtrSortedDlist< T, C, A >::index | ( | const_value | 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 RWTPtrSortedDlist< T, C, A >::insert | ( | const container_type & | a | ) | [inline] |
Adds the items from a to self in an order preserving way. Returns the number of items inserted.
bool RWTPtrSortedDlist< T, C, A >::insert | ( | value_type | a | ) | [inline] |
Adds the item a to self. The collection remains sorted. Returns true
.
bool RWTPtrSortedDlist< T, C, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
bool RWTPtrSortedDlist< T, C, A >::isSorted | ( | ) | const [inline] |
Returns true
if the collection is sorted relative to the supplied comparator object, otherwise false
.
T* const& RWTPtrSortedDlist< T, C, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
T*& RWTPtrSortedDlist< T, C, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
size_type RWTPtrSortedDlist< T, C, A >::merge | ( | const RWTPtrSortedDlist< T, C, A > & | coll | ) | [inline] |
Inserts all elements of coll into self, preserving sorted order. Returns the number of items inserted.
size_type RWTPtrSortedDlist< T, C, A >::occurrencesOf | ( | const_value | a | ) | const [inline] |
Returns the number of elements t
in self such that the expression (*t == *a)
is true
.
size_type RWTPtrSortedDlist< T, C, A >::occurrencesOf | ( | bool(*)(const_value, 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.
bool RWTPtrSortedDlist< T, C, A >::operator!= | ( | const RWTPtrSortedDlist< T, C, A > & | rwc | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTPtrSortedDlist< 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.
reference RWTPtrSortedDlist< T, C, A >::operator() | ( | size_type | i | ) | [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.
bool RWTPtrSortedDlist< T, C, A >::operator< | ( | const RWTPtrSortedDlist< T, C, A > & | lst | ) | const [inline] |
Returns true
if self compares lexicographically less than lst, otherwise returns false
. Items in each collection are dereferenced before being compared.
RWTPtrSortedDlist<T, C ,A >& RWTPtrSortedDlist< T, C, A >::operator= | ( | container_type && | lst | ) | [inline] |
Move assignment. Self takes ownership of the data owned by lst.
RWTPtrSortedDlist<T, C ,A >& RWTPtrSortedDlist< T, C, A >::operator= | ( | RWTPtrSortedDlist< T, C, A > && | lst | ) | [inline] |
Move assignment. Self takes ownership of the data owned by lst.
RWTPtrSortedDlist<T, C ,A >& RWTPtrSortedDlist< T, C, A >::operator= | ( | const container_type & | lst | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of lst.
RWTPtrSortedDlist<T, C ,A >& RWTPtrSortedDlist< T, C, A >::operator= | ( | const RWTPtrSortedDlist< T, C, A > & | lst | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of lst.
bool RWTPtrSortedDlist< T, C, A >::operator== | ( | const RWTPtrSortedDlist< 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. Elements are dereferenced before being compared.
const_reference RWTPtrSortedDlist< T, C, A >::operator[] | ( | size_type | i | ) | const [inline] |
Returns a reference to the i th element of self.
RWBoundsErr | Thrown if index i is not between 0 and one less than the number of entries in self. |
reference RWTPtrSortedDlist< T, C, A >::operator[] | ( | size_type | i | ) | [inline] |
Returns a reference to the i th element of self.
RWBoundsErr | Thrown if index i is not between 0 and one less than the number of entries in self. |
value_type RWTPtrSortedDlist< T, C, A >::remove | ( | const_value | key | ) | [inline] |
Removes and returns the first element t
in self such that the expression (*t == *a)
is true
. Returns rwnil if there is no such element.
value_type RWTPtrSortedDlist< T, C, A >::remove | ( | bool(*)(const_value, void *) | fn, | |
void * | d | |||
) | [inline] |
Removes and returns the first element t
in self such that the expression ((*fn)(t,d))
is true
. Returns rwnil if there is no such element. Client data may be passed through parameter d.
size_type RWTPtrSortedDlist< T, C, A >::removeAll | ( | const_value | a | ) | [inline] |
Removes all elements t
in self such that the expression (*t == *a)
is true
. Returns the number of items removed.
size_type RWTPtrSortedDlist< T, C, A >::removeAll | ( | bool(*)(const_value, 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.
value_type RWTPtrSortedDlist< T, C, A >::removeAt | ( | size_type | i | ) | [inline] |
Removes and returns the item at position i in self.
RWBoundsErr | Thrown if this position is not between zero and one less than the number of entries in the collection. |
value_type RWTPtrSortedDlist< T, C, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
T* RWTPtrSortedDlist< T, C, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
const container_type& RWTPtrSortedDlist< T, C, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
container_type& RWTPtrSortedDlist< T, C, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
void RWTPtrSortedDlist< T, C, A >::swap | ( | RWTPtrSortedDlist< T, C, A > & | lst | ) | [inline] |
Swaps the data owned by self with the data owned by lst.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTPtrSortedDlist< T, C, A > & | coll | |||
) | [related] |
Saves the collection coll onto the RWFile strm, or a reference to it if it has already been saved.
RWvostream & operator<< | ( | RWvostream & | strm, | |
const RWTPtrSortedDlist< 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.
RWFile & operator>> | ( | RWFile & | strm, | |
RWTPtrSortedDlist< 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.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrSortedDlist< 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.
RWFile & operator>> | ( | RWFile & | strm, | |
RWTPtrSortedDlist< T, C, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrSortedDlist< T, C, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the input stream strm.
© 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.