SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Maintains a collection of values implemented as a doubly-linked list. More...
#include <rw/tvdlist.h>
Inherits RW_VSeq< std::list< T,A >, RWTValDlist< T,A > >.
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 |
void | append (const_reference a) |
void | append (value_type &&a) |
void | apply (void(*fn)(reference, void *), void *d) |
void | apply (void(*fn)(const_reference, void *), void *d) const |
reference | at (size_type i) |
const_reference | at (size_type i) 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, value_type &k) const |
bool | find (const_reference a, value_type &k) const |
reference | first () |
const_reference | first () const |
value_type | get () |
size_type | index (const_reference a) const |
size_type | index (bool(*fn)(const_reference, void *), void *d) const |
bool | insert (const_reference a) |
bool | insert (value_type &&a) |
void | insertAt (size_type i, const_reference a) |
void | insertAt (size_type i, value_type &&a) |
bool | isEmpty () const |
reference | minElement () |
const_reference | minElement () const |
reference | maxElement () |
const_reference | maxElement () const |
size_type | occurrencesOf (bool(*fn)(const_reference, void *), void *d) const |
size_type | occurrencesOf (const_reference a) const |
reference | operator() (size_type i) |
const_reference | operator() (size_type i) const |
bool | operator< (const container_type &stdc) const |
bool | operator< (const RWTValDlist< T, A > &rwc) const |
bool | operator== (const container_type &s) const |
bool | operator== (const RWTValDlist< T, A > &s) const |
bool | operator!= (const container_type &s) const |
bool | operator!= (const RWTValDlist< T, A > &s) const |
reference | operator[] (size_type n) |
const_reference | operator[] (size_type n) const |
void | prepend (const_reference a) |
void | prepend (value_type &&a) |
bool | remove (const_reference a) |
bool | remove (bool(*fn)(const_reference, void *), void *d) |
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 | replaceAll (bool(*fn)(const value_type &, void *), void *d, const value_type &newVal) |
size_type | replaceAll (const value_type &oldVal, const value_type &newVal) |
void | sort () |
T & | last () |
const T & | last () const |
T | removeLast () |
RWTValDlist< T,A > & | operator= (const RWTValDlist< T, A > &lst) |
RWTValDlist< T,A > & | operator= (RWTValDlist< T, A > &&lst) |
RWTValDlist< T,A > & | operator= (const container_type &lst) |
RWTValDlist () | |
RWTValDlist (const container_type &lst) | |
RWTValDlist (const RWTValDlist< T, A > &rwlst) | |
RWTValDlist (RWTValDlist< T, A > &&lst) | |
RWTValDlist (size_type n, const T &val=T()) | |
RWTValDlist (const T *first, const T *last) | |
void | swap (RWTValDlist< T, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValDlist< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTValDlist< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValDlist< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValDlist< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValDlist< T, A > *&p) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValDlist< T, A > *&p) |
This class maintains a 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.
#include <rw/tvdlist.h> RWTValDlist<T,A> dlist;
Classes RWTValDeque<T,A>, RWTValSlist<T,A>, and RWTValOrderedVector<T,A> also provide a Rogue Wave interface to C++ Standard sequence collections.
Class std::list<T,A<T*> > is the C++ Standard collection that serves as the underlying implementation for this class.
Isomorphic
// // tvdldog.cpp // #include <iostream> #include <cstring> #include <rw/tvdlist.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() { RWTValDlist<Dog> terriers; terriers.insert("Cairn Terrier"); // NB: type conversion occurs terriers.insert("Irish Terrier"); terriers.insert("Schnauzer"); std::cout << "The list " << (terriers.contains("Schnauzer") ? "does " : "does not ") << "contain a Schnauzer\n"; terriers.insertAt(terriers.index("Irish Terrier"), "Fox Terrier"); while (!terriers.isEmpty()) std::cout << terriers.get() << "\n"; return 0; }
Program Output:
The list does contain a Schnauzer Cairn Terrier Fox Terrier Irish Terrier Schnauzer
typedef container_type::const_iterator RWTValDlist< T, A >::const_iterator |
Typedef for the const
iterator.
typedef container_type::const_reference RWTValDlist< T, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef std::list<T ,A > RWTValDlist< T, A >::container_type |
Typedef for the C++ Standard collection that serves as the underlying implementation for this class.
typedef container_type::iterator RWTValDlist< T, A >::iterator |
Typedef for the non-const
iterator.
typedef container_type::reference RWTValDlist< T, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTValDlist< T, A >::size_type |
Typedef for the type used to index into this container.
typedef container_type::value_type RWTValDlist< T, A >::value_type |
Typedef for the type of elements in this container.
RWTValDlist< T, A >::RWTValDlist | ( | ) | [inline] |
Constructs an empty, doubly-linked list.
RWTValDlist< T, A >::RWTValDlist | ( | const container_type & | lst | ) | [inline] |
Constructs a doubly-linked list by copying all elements of lst.
RWTValDlist< T, A >::RWTValDlist | ( | const RWTValDlist< T, A > & | rwlst | ) | [inline] |
Copy constructor.
RWTValDlist< T, A >::RWTValDlist | ( | RWTValDlist< T, A > && | lst | ) | [inline] |
Move constructor. The constructed list takes ownership of the data owned by lst.
RWTValDlist< T, A >::RWTValDlist | ( | size_type | n, | |
const T & | val = T() | |||
) | [inline] |
Constructs a doubly-linked list with n elements, each initialized to val.
RWTValDlist< T, A >::RWTValDlist | ( | const T * | first, | |
const T * | last | |||
) | [inline] |
Constructs a doubly-linked list by copying elements from the array of T
s pointed to by first, up to, but not including, the element pointed to by last.
void RWTValDlist< T, A >::append | ( | value_type && | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTValDlist< T, A >::append | ( | const_reference | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTValDlist< T, 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.
void RWTValDlist< 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.
const_reference RWTValDlist< 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 RWTValDlist< 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 RWTValDlist< T, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTValDlist< T, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTValDlist< T, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self. Each item has its destructor called.
bool RWTValDlist< T, 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
.
bool RWTValDlist< T, 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.
const_iterator RWTValDlist< T, A >::end | ( | ) | const [inline] |
Returns a past-the-end valued iterator of self.
iterator RWTValDlist< T, A >::end | ( | ) | [inline] |
Returns a past-the-end valued iterator of self.
size_type RWTValDlist< T, A >::entries | ( | void | ) | const [inline] |
Returns the number of elements in self.
bool RWTValDlist< T, A >::find | ( | const_reference | a, | |
value_type & | 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.
bool RWTValDlist< T, A >::find | ( | bool(*)(const_reference, void *) | fn, | |
void * | d, | |||
value_type & | 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.
const_reference RWTValDlist< T, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
reference RWTValDlist< T, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
value_type RWTValDlist< T, A >::get | ( | void | ) | [inline] |
Removes and returns the first element in the collection. This method is identical to removeFirst() and is included for compatibility with previous versions.
RWBoundsErr | Thrown if the collection is empty. |
size_type RWTValDlist< T, 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.
size_type RWTValDlist< T, A >::index | ( | const_reference | 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 RWTValDlist< T, A >::insert | ( | value_type && | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
bool RWTValDlist< T, A >::insert | ( | const_reference | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
void RWTValDlist< 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 index i is not between 0 and the number of entries in the collection. |
void RWTValDlist< T, A >::insertAt | ( | size_type | i, | |
const_reference | a | |||
) | [inline] |
Inserts the item a in front of the item at position i in self.
RWBoundsErr | Thrown if index i is not between 0 and the number of entries in the collection. |
bool RWTValDlist< T, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
const T& RWTValDlist< T, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
T& RWTValDlist< T, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
const_reference RWTValDlist< T, A >::maxElement | ( | ) | const [inline] |
Returns a reference to the maximum element in the collection. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
reference RWTValDlist< T, A >::maxElement | ( | ) | [inline] |
Returns a reference to the maximum element in the collection. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
const_reference RWTValDlist< T, A >::minElement | ( | ) | const [inline] |
Returns a reference to the minimum element in the collection. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
reference RWTValDlist< T, A >::minElement | ( | ) | [inline] |
Returns a reference to the minimum element in the collection. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
size_type RWTValDlist< T, A >::occurrencesOf | ( | const_reference | a | ) | const [inline] |
Returns the number of elements t
in self such that the expression (t == a)
is true
.
size_type RWTValDlist< T, 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.
bool RWTValDlist< T, A >::operator!= | ( | const RWTValDlist< T, A > & | s | ) | const [inline] |
Returns the negation of operator==().
bool RWTValDlist< T, A >::operator!= | ( | const container_type & | s | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTValDlist< T, 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 RWTValDlist< T, 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 RWTValDlist< T, A >::operator< | ( | const RWTValDlist< T, A > & | rwc | ) | const [inline] |
Returns true
if self compares lexicographically less than lst, otherwise returns false
. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
bool RWTValDlist< T, A >::operator< | ( | const container_type & | stdc | ) | const [inline] |
Returns true
if self compares lexicographically less than lst, otherwise returns false
. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
RWTValDlist<T ,A >& RWTValDlist< T, A >::operator= | ( | const container_type & | lst | ) | [inline] |
Calls the destructor on all elements of self and replaces them by copying all elements of lst.
RWTValDlist<T ,A >& RWTValDlist< T, A >::operator= | ( | RWTValDlist< T, A > && | lst | ) | [inline] |
Move assignment. Self takes ownership of the data owned by lst.
RWTValDlist<T ,A >& RWTValDlist< T, A >::operator= | ( | const RWTValDlist< T, A > & | lst | ) | [inline] |
Calls the destructor on all elements of self and replaces them by copying all elements of lst.
bool RWTValDlist< T, A >::operator== | ( | const RWTValDlist< T, A > & | s | ) | const [inline] |
Returns true
if self compares equal to s, 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.
bool RWTValDlist< T, A >::operator== | ( | const container_type & | s | ) | const [inline] |
Returns true
if self compares equal to s, 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 RWTValDlist< T, A >::operator[] | ( | size_type | n | ) | 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 RWTValDlist< T, A >::operator[] | ( | size_type | n | ) | [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 RWTValDlist< T, A >::prepend | ( | value_type && | a | ) | [inline] |
Adds the item a to the beginning of the collection.
void RWTValDlist< T, A >::prepend | ( | const_reference | a | ) | [inline] |
Adds the item a to the beginning of the collection.
bool RWTValDlist< T, 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.
bool RWTValDlist< T, 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.
size_type RWTValDlist< T, 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.
size_type RWTValDlist< T, 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.
value_type RWTValDlist< T, A >::removeAt | ( | size_type | i | ) | [inline] |
Removes and returns the item at position i in self.
RWBoundsErr | Thrown if this position is not between 0 and one less than the number of entries in the collection. |
value_type RWTValDlist< T, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
T RWTValDlist< T, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
size_type RWTValDlist< T, A >::replaceAll | ( | const value_type & | oldVal, | |
const value_type & | newVal | |||
) | [inline] |
Replaces all elements t
in self such that the expression (t == oldVal)
is true
with newVal. Returns the number of items replaced.
size_type RWTValDlist< T, A >::replaceAll | ( | bool(*)(const value_type &, void *) | fn, | |
void * | d, | |||
const value_type & | newVal | |||
) | [inline] |
Replaces 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 RWTValDlist< T, A >::sort | ( | ) | [inline] |
Sorts the collection using the less-than operator to compare elements.
const container_type& RWTValDlist< T, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard interface as well as interoperability with other software components that make use of the C++ Standard collections.
container_type& RWTValDlist< T, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard interface as well as interoperability with other software components that make use of the C++ Standard collections.
void RWTValDlist< T, A >::swap | ( | RWTValDlist< T, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTValDlist< 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 RWTValDlist< 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, | |
RWTValDlist< 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, | |
RWTValDlist< 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, | |
RWTValDlist< T, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTValDlist< 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.