SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A pointer-based collection of values, implemented as a double-ended queue, or deque. More...
#include <rw/tpdeque.h>
Inherits RW_PSeq< std::deque< T *,A >, RWTPtrDeque< T,A >, T >.
Public Types | |
typedef std::deque< 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::difference_type | difference_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 (value_type item) |
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) |
reference | at (size_type i) |
const_reference | at (size_type i) const |
iterator | begin () |
const_iterator | begin () const |
void | clear () |
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 |
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 T *, void *), void *d) const |
value_type | find (const T *a) const |
reference | first () |
const_reference | first () 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 |
bool | insert (value_type a) |
void | insertAt (size_type i, value_type a) |
bool | isEmpty () const |
reference | maxElement () |
const_reference | maxElement () const |
reference | minElement () |
const_reference | minElement () 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 |
reference | operator() (size_type i) |
const_reference | operator() (size_type i) const |
bool | operator< (const RWTPtrDeque< T, A > &deq) const |
bool | operator== (const RWTPtrDeque< T, A > &deq) const |
bool | operator!= (const RWTPtrDeque< T, A > &deq) const |
reference | operator[] (size_type i) |
const_reference | operator[] (size_type i) 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) |
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 | 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) |
void | sort () |
void | clearAndDestroy () |
T *& | last () |
T *const & | last () const |
void | pushBack (T *t) |
void | pushFront (T *t) |
T * | removeLast () |
T * | popBack () |
T * | popFront () |
RWTPtrDeque< T,A > & | operator= (const RWTPtrDeque< T, A > &deq) |
RWTPtrDeque< T,A > & | operator= (const container_type &stddeq) |
RWTPtrDeque< T,A > & | operator= (RWTPtrDeque< T, A > &&deq) |
RWTPtrDeque () | |
RWTPtrDeque (const container_type &deq) | |
RWTPtrDeque (const RWTPtrDeque< T, A > &rwdeq) | |
RWTPtrDeque (RWTPtrDeque< T, A > &&deq) | |
RWTPtrDeque (size_type n, T *a) | |
RWTPtrDeque (T *const *first, T *const *last) | |
void | swap (RWTPtrDeque< T, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrDeque< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTPtrDeque< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrDeque< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrDeque< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrDeque< T, A > *&p) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrDeque< T, A > *&p) |
This class maintains a pointer-based collection of values, implemented as a double-ended queue, or deque. 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/tpdeque.h> RWTPtrDeque<T,A> deq;
Classes RWTPtrDlist<T,A>, RWTPtrSlist<T,A>, and RWTPtrOrderedVector<T,A> also provide a Rogue Wave pointer-based interface to standard sequence collections.
Class std::deque<T*,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.
Isomorphic
In this example, a double-ended queue of ints
is exercised.
// tpdeque.cpp #include <iostream> #include <rw/tpdeque.h> int main () { RWTPtrDeque<int> numbers; int n; std::cout << "Input an assortment of integers (EOF to end):" << std::endl; while (std::cin >> n) { if (n % 2 == 0) numbers.pushFront(new int(n)); else numbers.pushBack(new int(n)); } std::cout << "Numbers partitioned in even and odds: "; for (int i = 0; numbers.entries (); ++i) { if (i) std::cout << ", "; std::cout << *numbers.first (); delete numbers.popFront(); } std::cout << "\n\n"; return 0; }
Program Output (numbers in output depend on numbers entered):
Input an assortment of integers (EOF to end): Numbers partitioned in even and odds: 4, 2, 1, 5, 3, 7, 9, 1
typedef container_type::const_iterator RWTPtrDeque< T, A >::const_iterator |
Typedef for the const
iterator.
typedef container_type::const_reference RWTPtrDeque< T, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef std::deque<T* ,A > RWTPtrDeque< 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 RWTPtrDeque< T, A >::difference_type |
Typedef for the type of result when subtracting two iterators obtained from this container.
typedef container_type::iterator RWTPtrDeque< T, A >::iterator |
Typedef for the non-const
iterator.
typedef container_type::reference RWTPtrDeque< T, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTPtrDeque< T, A >::size_type |
Typedef for the type used to index into this container.
typedef container_type::value_type RWTPtrDeque< T, A >::value_type |
Typedef for the type of elements in this container.
RWTPtrDeque< T, A >::RWTPtrDeque | ( | ) | [inline] |
Constructs an empty, double-ended queue.
RWTPtrDeque< T, A >::RWTPtrDeque | ( | const container_type & | deq | ) | [inline] |
Constructs a double-ended queue by copying all elements of deq.
RWTPtrDeque< T, A >::RWTPtrDeque | ( | const RWTPtrDeque< T, A > & | rwdeq | ) | [inline] |
Copy constructor.
RWTPtrDeque< T, A >::RWTPtrDeque | ( | RWTPtrDeque< T, A > && | deq | ) | [inline] |
Move constructor. The constructed deque takes ownership of the data owned by deq.
RWTPtrDeque< T, A >::RWTPtrDeque | ( | size_type | n, | |
T * | a | |||
) | [inline] |
Constructs a double-ended queue with n elements, each initialized to a.
RWTPtrDeque< T, A >::RWTPtrDeque | ( | T *const * | first, | |
T *const * | last | |||
) | [inline] |
Constructs a double-ended queue 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 RWTPtrDeque< T, A >::append | ( | value_type | item | ) | [inline] |
Adds the item a to the end of the collection.
void RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< T, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTPtrDeque< T, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTPtrDeque< T, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self.
void RWTPtrDeque< 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 RWTPtrDeque< T, A >::contains | ( | const T * | a | ) | const [inline] |
If there exists an element t
in self such that the expression (*t == *a)
is true
, returns true
, otherwise false
.
bool RWTPtrDeque< 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 returns false
. Client data may be passed through parameter d.
bool RWTPtrDeque< 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 RWTPtrDeque< T, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last element in self.
iterator RWTPtrDeque< T, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last element in self.
size_type RWTPtrDeque< T, A >::entries | ( | void | ) | const [inline] |
Returns the number of items in self.
value_type RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< T, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
RWBoundsErr | Thrown if the collection is empty. |
reference RWTPtrDeque< T, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
RWBoundsErr | Thrown if the collection is empty. |
size_type RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< T, A >::insert | ( | value_type | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
void RWTPtrDeque< 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 RWTPtrDeque< T, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
T* const& RWTPtrDeque< T, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last element of self.
T*& RWTPtrDeque< T, A >::last | ( | void | ) | [inline] |
Returns a reference to the last element of self.
const_reference RWTPtrDeque< T, A >::maxElement | ( | ) | const [inline] |
Returns a reference to the maximum element in self.
reference RWTPtrDeque< T, A >::maxElement | ( | ) | [inline] |
Returns a reference to the maximum element in self.
const_reference RWTPtrDeque< T, A >::minElement | ( | ) | const [inline] |
Returns a reference to the minimum element in self.
reference RWTPtrDeque< T, A >::minElement | ( | ) | [inline] |
Returns a reference to the minimum element in self.
size_type RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< T, A >::operator!= | ( | const RWTPtrDeque< T, A > & | deq | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTPtrDeque< 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. Note that no bounds checking is performed.
reference RWTPtrDeque< 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. Note that no bounds checking is performed.
bool RWTPtrDeque< T, A >::operator< | ( | const RWTPtrDeque< T, A > & | deq | ) | const [inline] |
Returns true
if self compares lexicographically less than deq, otherwise false
. Items in each collection are dereferenced before being compared. Assumes that type T
has well-defined less-than semantics.
RWTPtrDeque<T ,A >& RWTPtrDeque< T, A >::operator= | ( | RWTPtrDeque< T, A > && | deq | ) | [inline] |
Move assignment. Self takes ownership of the data owned by deq.
RWTPtrDeque<T ,A >& RWTPtrDeque< T, A >::operator= | ( | const container_type & | stddeq | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of stddeq.
RWTPtrDeque<T ,A >& RWTPtrDeque< T, A >::operator= | ( | const RWTPtrDeque< T, A > & | deq | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of deq.
bool RWTPtrDeque< T, A >::operator== | ( | const RWTPtrDeque< T, A > & | deq | ) | const [inline] |
Returns true
if self compares equal to deq, 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 RWTPtrDeque< 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 RWTPtrDeque< 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. |
T* RWTPtrDeque< T, A >::popBack | ( | ) | [inline] |
Removes and returns the last item in the collection.
T* RWTPtrDeque< T, A >::popFront | ( | ) | [inline] |
Removes and returns the first item in the collection.
void RWTPtrDeque< T, A >::prepend | ( | value_type | a | ) | [inline] |
Adds the item a to the beginning of the collection.
void RWTPtrDeque< T, A >::pushBack | ( | T * | t | ) | [inline] |
Adds the item a to the end of the collection.
void RWTPtrDeque< T, A >::pushFront | ( | T * | t | ) | [inline] |
Removes and returns the first item in the collection.
value_type RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< T, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
T* RWTPtrDeque< T, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
size_type RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< 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 RWTPtrDeque< T, A >::sort | ( | ) | [inline] |
Sorts the collection using the less-than operator to compare elements. Elements are dereferenced before being compared.
const container_type& RWTPtrDeque< T, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
container_type& RWTPtrDeque< T, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
void RWTPtrDeque< T, A >::swap | ( | RWTPtrDeque< T, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTPtrDeque< T, A > & | coll | |||
) | [related] |
Saves the collection coll onto the RWFile strm.
RWvostream & operator<< | ( | RWvostream & | strm, | |
const RWTPtrDeque< T, A > & | coll | |||
) | [related] |
Saves the collection coll onto the output stream strm.
RWFile & operator>> | ( | RWFile & | strm, | |
RWTPtrDeque< 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, | |
RWTPtrDeque< 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, | |
RWTPtrDeque< T, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrDeque< 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.