SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A pointer-based collection of values, implemented as a doubly-linked list. More...
#include <rw/tpdlist.h>
Inherits RW_PSeq< std::list< T *,A >, RWTPtrDlist< T,A >, T >.
Public Types | |
typedef std::list< T *,A > | container_type |
typedef container_type::size_type | size_type |
typedef container_type::difference_type | difference_type |
typedef base1_type::my_iter_ | iterator |
typedef base1_type::const_my_iter_ | const_iterator |
typedef base1_type::value_type | value_type |
typedef base1_type::reference | reference |
typedef base1_type::const_reference | const_reference |
Public Member Functions | |
container_type & | std () |
const container_type & | std () 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 | entries () const |
reference | first () |
const_reference | first () const |
bool | isEmpty () const |
reference | operator() (size_type i) |
const_reference | operator() (size_type i) const |
reference | operator[] (size_type i) |
const_reference | operator[] (size_type i) const |
bool | operator< (const RWTPtrDlist< T, A > &lst) const |
bool | operator== (const RWTPtrDlist< T, A > &lst) const |
bool | operator!= (const RWTPtrDlist< T, A > &lst) const |
void | apply (void(*fn)(const T *, void *), void *d) const |
void | apply (void(*fn)(value_type, void *), void *d) |
void | apply (void(*fn)(reference, void *), void *d) |
bool | contains (bool(*fn)(value_type, void *), void *d) const |
bool | contains (bool(*fn)(const T *, void *), void *d) const |
bool | contains (const T *a) const |
value_type | find (bool(*fn)(value_type, void *), void *d) const |
value_type | find (bool(*fn)(const T *, void *), void *d) const |
value_type | find (const T *a) const |
size_type | index (const T *a) const |
size_type | index (bool(*fn)(value_type, void *), void *d) const |
size_type | index (bool(*fn)(const T *, void *), void *d) const |
size_type | occurrencesOf (bool(*fn)(value_type, void *), void *d) const |
size_type | occurrencesOf (bool(*fn)(const T *, void *), void *d) const |
size_type | occurrencesOf (const T *a) const |
void | append (value_type a) |
void | clear () |
value_type | get () |
bool | insert (value_type a) |
void | insertAt (size_type i, value_type a) |
reference | minElement () |
const_reference | minElement () const |
reference | maxElement () |
const_reference | maxElement () const |
void | prepend (value_type a) |
value_type | remove (const T *a) |
value_type | remove (bool(*fn)(value_type, void *), void *d) |
value_type | remove (bool(*fn)(const T *, void *), void *d) |
value_type | removeAt (size_type i) |
value_type | removeFirst () |
size_type | replaceAll (bool(*fn)(value_type, void *), void *d, value_type newVal) |
size_type | replaceAll (bool(*fn)(const T *, void *), void *d, value_type newVal) |
size_type | replaceAll (const T *oldVal, value_type newVal) |
size_type | removeAll (const T *a) |
size_type | removeAll (bool(*fn)(const T *, void *), void *d) |
size_type | removeAll (bool(*fn)(T *, void *), void *d) |
void | clearAndDestroy () |
T *& | last () |
T *const & | last () const |
T * | removeLast () |
void | sort () |
RWTPtrDlist< T,A > & | operator= (const RWTPtrDlist< T, A > &rwset) |
RWTPtrDlist< T,A > & | operator= (const container_type &stdset) |
RWTPtrDlist< T,A > & | operator= (RWTPtrDlist< T, A > &&lst) |
RWTPtrDlist () | |
RWTPtrDlist (const container_type &lst) | |
RWTPtrDlist (const RWTPtrDlist< T, A > &lst) | |
RWTPtrDlist (RWTPtrDlist< T, A > &&lst) | |
RWTPtrDlist (size_type n, T *a=0) | |
RWTPtrDlist (T *const *pfirst, T *const *plast) | |
void | swap (RWTPtrDlist< T, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrDlist< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTPtrDlist< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrDlist< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrDlist< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrDlist< T, A > *&p) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrDlist< T, A > *&p) |
This class maintains a pointer-based collection of values, implemented as a doubly-linked list. Class T
is the type pointed to by the 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.
#include <rw/tpdlist.h> RWTPtrDlist<T,A> dlist;
Classes RWTPtrDeque<T,A>, RWTPtrSlist<T,A>, and RWTPtrOrderedVector<T,A> also provide a Rogue Wave pointer-based interface to C++ Standard Library sequence collections.
Class list<T*,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.
Isomorphic
In this example, a pointer-based doubly-linked list of user type Dog
is exercised.
// // tpdlist.cpp // #include <rw/tpdlist.h> #include <iostream> #include <string.h> class Dog { RWCString name_; public: Dog( const char* s) : name_ (s) { } // Define a copy constructor: Dog(const Dog& ref) : name_ (ref.name_) { } // Define an assignment operator: Dog& operator= (const Dog& ref) { if (this == &ref) return *this; name_ = ref.name_; return *this; } // Define an equality test operator: bool operator== (const Dog& ref) const { return name_ == ref.name_; } // Order alphabetically by name: bool operator< (const Dog& ref) const { return name_ < ref.name_; } friend std::ostream& operator<< (std::ostream& s, const Dog& ref) { s << ref.name_; return s; } }; int main () { RWTPtrDlist<Dog> terriers; terriers.insert(new Dog("Cairn Terrier")); terriers.insert(new Dog("Irish Terrier")); terriers.insert(new Dog("Schnauzer")); Dog key1("Schnauzer"); std::cout << "The list " << (terriers.contains (&key1) ? "does " : "does not ") << "contain a Schnauzer\n"; Dog key2("Irish Terrier"); terriers.insertAt(terriers.index(&key2), new Dog("Fox Terrier")); Dog* d; while (!terriers.isEmpty()) { d = terriers.get(); std::cout << *d << std::endl; delete d; } return 0; }
Program Output:
The list does contain a Schnauzer Cairn Terrier Fox Terrier Irish Terrier Schnauzer
typedef base1_type::const_my_iter_ RWTPtrDlist< T, A >::const_iterator |
Typedef for the const
iterator.
typedef base1_type::const_reference RWTPtrDlist< T, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef std::list<T* ,A > RWTPtrDlist< T, A >::container_type |
Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::difference_type RWTPtrDlist< T, A >::difference_type |
Typedef for the type of difference between iterators.
typedef base1_type::my_iter_ RWTPtrDlist< T, A >::iterator |
Typedef for the non-const
iterator.
typedef base1_type::reference RWTPtrDlist< T, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTPtrDlist< T, A >::size_type |
Typedef for the type used to index into this container.
typedef base1_type::value_type RWTPtrDlist< T, A >::value_type |
Typedef for the type of elements in this container.
RWTPtrDlist< T, A >::RWTPtrDlist | ( | ) | [inline] |
Constructs an empty, doubly-linked list.
RWTPtrDlist< T, A >::RWTPtrDlist | ( | const container_type & | lst | ) | [inline] |
Constructs a pointer-based doubly linked list by copying all elements of lst.
RWTPtrDlist< T, A >::RWTPtrDlist | ( | const RWTPtrDlist< T, A > & | lst | ) | [inline] |
Copy constructor.
RWTPtrDlist< T, A >::RWTPtrDlist | ( | RWTPtrDlist< T, A > && | lst | ) | [inline] |
Move constructor. The constructed list takes ownership of the data owned by lst.
RWTPtrDlist< T, A >::RWTPtrDlist | ( | size_type | n, | |
T * | a = 0 | |||
) | [inline] |
Constructs a doubly-linked list with n elements, each initialized to a.
RWTPtrDlist< T, A >::RWTPtrDlist | ( | T *const * | pfirst, | |
T *const * | plast | |||
) | [inline] |
Constructs a doubly-linked list by copying elements from the array of T*s
pointed to by pfirst, up to, but not including, the element pointed to by plast.
void RWTPtrDlist< T, A >::append | ( | value_type | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTPtrDlist< T, 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.
void RWTPtrDlist< T, 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 RWTPtrDlist< T, A >::apply | ( | void(*)(const T *, 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.
const_reference RWTPtrDlist< T, 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 RWTPtrDlist< T, 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 RWTPtrDlist< T, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTPtrDlist< T, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTPtrDlist< T, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self.
void RWTPtrDlist< T, A >::clearAndDestroy | ( | ) |
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 RWTPtrDlist< T, A >::contains | ( | const T * | a | ) | const [inline] |
Returns true
if there exists an element t
in self such that the expression (*t == *a)
is true
, otherwise false
.
bool RWTPtrDlist< T, A >::contains | ( | bool(*)(const T *, 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 false
. Client data may be passed through parameter d.
bool RWTPtrDlist< T, A >::contains | ( | bool(*)(value_type, 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 false
. Client data may be passed through parameter d.
const_iterator RWTPtrDlist< T, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last element in self.
iterator RWTPtrDlist< T, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last element in self.
size_type RWTPtrDlist< T, A >::entries | ( | void | ) | const [inline] |
Returns the number of items in self.
value_type RWTPtrDlist< T, A >::find | ( | const T * | 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 RWTPtrDlist< T, A >::find | ( | bool(*)(const T *, 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.
value_type RWTPtrDlist< T, A >::find | ( | bool(*)(value_type, 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 RWTPtrDlist< T, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
reference RWTPtrDlist< T, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
value_type RWTPtrDlist< T, A >::get | ( | void | ) | [inline] |
Removes and returns the first element in the collection.
size_type RWTPtrDlist< T, A >::index | ( | bool(*)(const T *, 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 RWTPtrDlist< T, A >::index | ( | bool(*)(value_type, 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 RWTPtrDlist< T, A >::index | ( | const T * | a | ) | const [inline] |
Returns the position of the first item t
in self such that (*t == *a)
, or returns RW_NPOS if no such item exists.
bool RWTPtrDlist< T, A >::insert | ( | value_type | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
void RWTPtrDlist< T, A >::insertAt | ( | size_type | i, | |
value_type | a | |||
) | [inline] |
Inserts the item a in front of the item at position i in self.
RWBoundsErr | Thrown if this position is not between zero and the number of entries in the collection. |
bool RWTPtrDlist< T, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, false
otherwise.
T* const& RWTPtrDlist< T, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
T*& RWTPtrDlist< T, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
const_reference RWTPtrDlist< T, A >::maxElement | ( | ) | const [inline] |
Returns a reference to the maximum element in self.
reference RWTPtrDlist< T, A >::maxElement | ( | ) | [inline] |
Returns a reference to the maximum element in self.
const_reference RWTPtrDlist< T, A >::minElement | ( | ) | const [inline] |
Returns a reference to the minimum element in self.
reference RWTPtrDlist< T, A >::minElement | ( | ) | [inline] |
Returns a reference to the minimum element in self.
size_type RWTPtrDlist< T, A >::occurrencesOf | ( | const T * | a | ) | const [inline] |
Returns the number of elements t
in self such that the expression (*t == *a)
is true
.
size_type RWTPtrDlist< T, A >::occurrencesOf | ( | bool(*)(const T *, 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.
size_type RWTPtrDlist< T, A >::occurrencesOf | ( | bool(*)(value_type, 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 RWTPtrDlist< T, A >::operator!= | ( | const RWTPtrDlist< T, A > & | lst | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTPtrDlist< T, A >::operator() | ( | size_type | i | ) | const [inline] |
Returns a reference to the i th element of self. Index i must be between 0
and one less than the number of entries, otherwise the results are undefined. Note that no bounds checking is performed.
reference RWTPtrDlist< T, A >::operator() | ( | size_type | i | ) | [inline] |
Returns a reference to the i th element of self. Index i must be between 0
and one less than the number of entries, otherwise the results are undefined. Note that no bounds checking is performed.
bool RWTPtrDlist< T, A >::operator< | ( | const RWTPtrDlist< T, A > & | lst | ) | const [inline] |
Returns true
if self compares lexicographically less than lst, otherwise false
. Items in each collection are dereferenced before being compared. Assumes that type T
has well-defined less-than semantics.
RWTPtrDlist<T ,A >& RWTPtrDlist< T, A >::operator= | ( | RWTPtrDlist< T, A > && | lst | ) | [inline] |
Move assignment. Self takes ownership of the data owned by lst.
RWTPtrDlist<T ,A >& RWTPtrDlist< T, A >::operator= | ( | const container_type & | stdset | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of lst.
RWTPtrDlist<T ,A >& RWTPtrDlist< T, A >::operator= | ( | const RWTPtrDlist< T, A > & | rwset | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of lst.
bool RWTPtrDlist< T, A >::operator== | ( | const RWTPtrDlist< T, A > & | lst | ) | const [inline] |
Returns true
if self compares equal to lst, otherwise false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces individual elements that compare equal to each other. Elements are dereferenced before being compared.
const_reference RWTPtrDlist< T, 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 RWTPtrDlist< T, 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. |
void RWTPtrDlist< T, A >::prepend | ( | value_type | a | ) | [inline] |
Adds the item a to the beginning of the collection.
value_type RWTPtrDlist< T, A >::remove | ( | bool(*)(const T *, 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.
value_type RWTPtrDlist< T, A >::remove | ( | bool(*)(value_type, 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.
value_type RWTPtrDlist< T, A >::remove | ( | const T * | a | ) | [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.
size_type RWTPtrDlist< T, A >::removeAll | ( | bool(*)(T *, 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.
size_type RWTPtrDlist< T, A >::removeAll | ( | bool(*)(const T *, 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.
size_type RWTPtrDlist< T, A >::removeAll | ( | const T * | a | ) | [inline] |
Removes all elements t
in self such that the expression (*t == *a)
is true
. Returns the number of items removed.
value_type RWTPtrDlist< T, A >::removeAt | ( | size_type | i | ) | [inline] |
Removes and returns the item at position i in self.
RWBoundsError | Thrown if this position is not between zero and one less than the number of entries in the collection. |
value_type RWTPtrDlist< T, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
T* RWTPtrDlist< T, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
size_type RWTPtrDlist< T, A >::replaceAll | ( | const T * | oldVal, | |
value_type | newVal | |||
) | [inline] |
Replaces with newVal all elements t
in self such that the expression (*t == *oldVal)
is true
. Returns the number of items replaced.
size_type RWTPtrDlist< T, A >::replaceAll | ( | bool(*)(const T *, void *) | fn, | |
void * | d, | |||
value_type | newVal | |||
) | [inline] |
Replaces with newVal all elements t
in self such that the expression ((*fn)(t,d))
is true
. Returns the number of items replaced. Client data may be passed through parameter d.
size_type RWTPtrDlist< T, A >::replaceAll | ( | bool(*)(value_type, void *) | fn, | |
void * | d, | |||
value_type | newVal | |||
) | [inline] |
Replaces with newVal all elements t
in self such that the expression ((*fn)(t,d))
is true
. Returns the number of items replaced. Client data may be passed through parameter d.
void RWTPtrDlist< T, A >::sort | ( | ) |
Sorts the collection using the less-than operator to compare elements. Elements are dereferenced before being compared.
const container_type& RWTPtrDlist< T, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
container_type& RWTPtrDlist< T, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
void RWTPtrDlist< T, A >::swap | ( | RWTPtrDlist< T, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTPtrDlist< T, 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 RWTPtrDlist< T, 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, | |
RWTPtrDlist< T, 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, | |
RWTPtrDlist< T, 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, | |
RWTPtrDlist< T, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrDlist< T, 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.