SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A pointer-based collection of values implemented as a singly-linked list. More...
#include <rw/tpslist.h>
Inherits RW_PSeq< rw_slist< T *,A >, RWTPtrSlist< T,A >, T >.
Public Types | |
typedef rw_slist< T *,A > | container_type |
typedef container_type::size_type | size_type |
typedef container_type::difference_type | difference_type |
typedef base_type::my_iter_ | iterator |
typedef base_type::const_my_iter_ | const_iterator |
typedef base_type::value_type | value_type |
typedef base_type::reference | reference |
typedef base_type::const_reference | const_reference |
Public Member Functions | |
container_type & | std () |
const container_type & | std () const |
void | append (value_type a) |
reference | at (size_type i) |
const_reference | at (size_type i) const |
iterator | begin () |
const_iterator | begin () const |
void | clear () |
void | clearAndDestroy () |
bool | contains (bool(*fn)(value_type, void *), void *d) const |
bool | contains (bool(*fn)(const_value, void *), void *d) const |
bool | contains (const_value a) const |
iterator | end () |
const_iterator | end () const |
size_type | entries () const |
value_type | find (bool(*fn)(value_type, void *), void *d) const |
value_type | find (bool(*fn)(const_value, void *), void *d) const |
value_type | find (const_value a) const |
reference | first () |
const_reference | first () const |
value_type | get () |
size_type | index (const_value a) const |
size_type | index (bool(*fn)(value_type, void *), void *d) const |
size_type | index (bool(*fn)(const_value, void *), void *d) const |
bool | insert (value_type 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)(value_type, void *), void *d) const |
size_type | occurrencesOf (bool(*fn)(const_value, void *), void *d) const |
size_type | occurrencesOf (const_value a) const |
reference | operator() (size_type i) |
const_reference | operator() (size_type i) const |
bool | operator< (const RWTPtrSlist< T, A > &lst) const |
bool | operator== (const RWTPtrSlist< T, A > &lst) const |
bool | operator!= (const RWTPtrSlist< T, A > &lst) const |
reference | operator[] (size_type i) |
const_reference | operator[] (size_type i) const |
void | prepend (value_type a) |
value_type | remove (const_value a) |
value_type | remove (bool(*fn)(value_type, void *), void *d) |
value_type | remove (bool(*fn)(const_value, void *), void *d) |
value_type | removeAt (size_type i) |
size_type | removeAll (bool(*fn)(T *, void *), void *d) |
size_type | removeAll (bool(*fn)(const T *, void *), void *d) |
size_type | removeAll (const T *a) |
value_type | removeFirst () |
size_type | replaceAll (bool(*fn)(value_type, void *), void *d, value_type newVal) |
size_type | replaceAll (bool(*fn)(const_value, void *), void *d, value_type newVal) |
size_type | replaceAll (const_value oldVal, value_type newVal) |
void | apply (void(*fn)(T *&, void *), void *d) const |
void | apply (void(*fn)(T *, void *), void *d) const |
void | apply (void(*fn)(const T *, void *), void *d) const |
T *& | last () |
T *const & | last () const |
T * | removeLast () |
void | sort () |
RWTPtrSlist< T,A > & | operator= (const RWTPtrSlist< T, A > &lst) |
RWTPtrSlist< T,A > & | operator= (const rw_slist< T *, A > &lst) |
RWTPtrSlist< T,A > & | operator= (RWTPtrSlist< T, A > &&lst) |
RWTPtrSlist< T,A > & | operator= (rw_slist< T *, A > &&lst) |
RWTPtrSlist () | |
RWTPtrSlist (const container_type &lst) | |
RWTPtrSlist (const RWTPtrSlist< T, A > &lst) | |
RWTPtrSlist (RWTPtrSlist< T, A > &&lst) | |
RWTPtrSlist (size_type n, T *a=0) | |
RWTPtrSlist (T *const *first, T *const *last) | |
void | swap (RWTPtrSlist< T, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrSlist< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTPtrSlist< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrSlist< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrSlist< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrSlist< T, A > *&p) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrSlist< T, A > *&p) |
This class maintains a pointer-based collection of values, implemented as a singly-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/tpslist.h> RWTPtrSlist<T,A> slist;
Classes RWTPtrDlist<T,A>, RWTPtrDeque<T,A>, and RWTPtrOrderedVector<T,A> also provide a Rogue Wave pointer-based interface to C++ Standard sequence collections.
Class rw_slist<T*,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.
Isomorphic
// // tpslist.cpp // #include <rw/tpslist.h> #include <rw/tools/datetime.h> int main () { RWTPtrSlist<RWDateTime> dates; dates.insert(new RWDateTime("June 2, 52", RWDateTime::setDate)); // 6/2/52 dates.insert(new RWDateTime("March 30, 46", RWDateTime::setDate)); // 3/30/46 dates.insert(new RWDateTime("April 1, 90", RWDateTime::setDate)); // 4/1/90 // Now look for one of the dates: RWDateTime key("June 2, 52", RWDateTime::setDate); RWDateTime* d = dates.find(&key); if (d) std::cout << "Found date is: " << d->asString('x') << std::endl; // Remove in reverse order: while (!dates.isEmpty()) { d = dates.removeLast(); std::cout << d->asString('x') << "\n"; delete d; } return 0; }
Program Output:
Found date is: 6/02/52 4/01/90 3/30/46 6/02/52
typedef base_type::const_my_iter_ RWTPtrSlist< T, A >::const_iterator |
Typedef for the const
iterator.
typedef base_type::const_reference RWTPtrSlist< T, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef rw_slist<T* ,A > RWTPtrSlist< 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 RWTPtrSlist< T, A >::difference_type |
Typedef for the type of difference between iterators.
typedef base_type::my_iter_ RWTPtrSlist< T, A >::iterator |
Typedef for the non-const
iterator.
typedef base_type::reference RWTPtrSlist< T, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTPtrSlist< T, A >::size_type |
Typedef for the type used to index into this container.
typedef base_type::value_type RWTPtrSlist< T, A >::value_type |
Typedef for the type of elements in this container.
RWTPtrSlist< T, A >::RWTPtrSlist | ( | ) | [inline] |
Constructs an empty, singly-linked list.
RWTPtrSlist< T, A >::RWTPtrSlist | ( | const container_type & | lst | ) | [inline] |
Constructs a singly-linked list by copying all elements of lst.
RWTPtrSlist< T, A >::RWTPtrSlist | ( | const RWTPtrSlist< T, A > & | lst | ) | [inline] |
Copy constructor.
RWTPtrSlist< T, A >::RWTPtrSlist | ( | RWTPtrSlist< T, A > && | lst | ) | [inline] |
Move constructor. The constructed list takes ownership of the data owned by lst.
RWTPtrSlist< T, A >::RWTPtrSlist | ( | size_type | n, | |
T * | a = 0 | |||
) | [inline] |
Constructs a singly-linked list with n elements, each initialized to a.
RWTPtrSlist< T, A >::RWTPtrSlist | ( | T *const * | first, | |
T *const * | last | |||
) | [inline] |
Constructs a singly-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 RWTPtrSlist< T, A >::append | ( | value_type | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTPtrSlist< 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.
void RWTPtrSlist< T, A >::apply | ( | void(*)(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.
void RWTPtrSlist< T, A >::apply | ( | void(*)(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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTPtrSlist< T, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTPtrSlist< T, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self.
void RWTPtrSlist< T, 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 RWTPtrSlist< T, 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 RWTPtrSlist< T, 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.
bool RWTPtrSlist< 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 returns false
. Client data may be passed through parameter d.
const_iterator RWTPtrSlist< T, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last element in self.
iterator RWTPtrSlist< T, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last element in self.
size_type RWTPtrSlist< T, A >::entries | ( | void | ) | const [inline] |
Returns the number of items in self.
value_type RWTPtrSlist< T, 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 RWTPtrSlist< T, 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.
value_type RWTPtrSlist< 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 RWTPtrSlist< T, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
reference RWTPtrSlist< T, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
value_type RWTPtrSlist< T, A >::get | ( | void | ) | [inline] |
Removes and returns the first element in the collection.
size_type RWTPtrSlist< T, 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::index | ( | const_value | 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 RWTPtrSlist< T, A >::insert | ( | value_type | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
void RWTPtrSlist< 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 RWTPtrSlist< T, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
T* const& RWTPtrSlist< T, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
T*& RWTPtrSlist< T, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
const_reference RWTPtrSlist< T, A >::maxElement | ( | ) | const [inline] |
Returns a reference to the maximum element in self.
reference RWTPtrSlist< T, A >::maxElement | ( | ) | [inline] |
Returns a reference to the maximum element in self.
const_reference RWTPtrSlist< T, A >::minElement | ( | ) | const [inline] |
Returns a reference to the minimum element in self.
reference RWTPtrSlist< T, A >::minElement | ( | ) | [inline] |
Returns a reference to the minimum element in self.
size_type RWTPtrSlist< T, 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 RWTPtrSlist< T, 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.
size_type RWTPtrSlist< 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 RWTPtrSlist< T, A >::operator!= | ( | const RWTPtrSlist< T, A > & | lst | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTPtrSlist< 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.
reference RWTPtrSlist< 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.
bool RWTPtrSlist< T, A >::operator< | ( | const RWTPtrSlist< T, 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.
RWTPtrSlist<T ,A >& RWTPtrSlist< T, A >::operator= | ( | rw_slist< T *, A > && | lst | ) | [inline] |
Move assignment. Self takes ownership of the data owned by lst.
RWTPtrSlist<T ,A >& RWTPtrSlist< T, A >::operator= | ( | RWTPtrSlist< T, A > && | lst | ) | [inline] |
Move assignment. Self takes ownership of the data owned by lst.
RWTPtrSlist<T ,A >& RWTPtrSlist< T, A >::operator= | ( | const rw_slist< T *, A > & | lst | ) | [inline] |
Empties self, then inserts all elements of lst.
RWTPtrSlist<T ,A >& RWTPtrSlist< T, A >::operator= | ( | const RWTPtrSlist< T, A > & | lst | ) | [inline] |
Empties self, then inserts all elements of lst.
bool RWTPtrSlist< T, A >::operator== | ( | const RWTPtrSlist< T, 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 RWTPtrSlist< 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::prepend | ( | value_type | a | ) | [inline] |
Adds the item a to the beginning of the collection.
value_type RWTPtrSlist< T, 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.
value_type RWTPtrSlist< 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 RWTPtrSlist< T, A >::remove | ( | const_value | 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 RWTPtrSlist< 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.
size_type RWTPtrSlist< 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 RWTPtrSlist< 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.
value_type RWTPtrSlist< 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 zero and one less than the number of entries in the collection. |
value_type RWTPtrSlist< T, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
T* RWTPtrSlist< T, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
size_type RWTPtrSlist< T, A >::replaceAll | ( | const_value | 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 RWTPtrSlist< T, A >::replaceAll | ( | bool(*)(const_value, 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 RWTPtrSlist< 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 RWTPtrSlist< T, A >::sort | ( | ) |
Sorts the collection using the greater-than operator to compare elements so that the elements are sorted from smallest to largest. Elements are dereferenced before being compared.
const container_type& RWTPtrSlist< T, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
container_type& RWTPtrSlist< T, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
void RWTPtrSlist< T, A >::swap | ( | RWTPtrSlist< T, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTPtrSlist< 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 RWTPtrSlist< 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, | |
RWTPtrSlist< 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, | |
RWTPtrSlist< 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, | |
RWTPtrSlist< T, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrSlist< 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.