SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Collection of values implemented as a double-ended queue, or deque. More...
#include <rw/tvdeque.h>
Inherits RW_VSeq< std::deque< T,A >, RWTValDeque< T,A > >.
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::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 |
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 &deq) const |
bool | operator< (const RWTValDeque< T, A > &deq) const |
bool | operator== (const container_type &deq) const |
bool | operator== (const RWTValDeque< T, A > &deq) const |
bool | operator!= (const container_type &deq) const |
bool | operator!= (const RWTValDeque< T, A > &rwc) const |
reference | operator[] (size_type i) |
const_reference | operator[] (size_type i) 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 index) |
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) |
T & | last () |
const T & | last () const |
void | pushBack (const T &a) |
void | pushBack (value_type &&a) |
void | pushFront (const T &a) |
void | pushFront (value_type &&a) |
T | popBack () |
T | popFront () |
void | sort () |
value_type | removeLast () |
RWTValDeque< T,A > & | operator= (const RWTValDeque< T, A > &deq) |
RWTValDeque< T,A > & | operator= (const container_type &deq) |
RWTValDeque< T,A > & | operator= (RWTValDeque< T, A > &&deq) |
RWTValDeque () | |
RWTValDeque (const container_type &deq) | |
RWTValDeque (const RWTValDeque< T, A > &rwdeq) | |
RWTValDeque (RWTValDeque< T, A > &&deq) | |
RWTValDeque (size_type n, const T &val=T()) | |
RWTValDeque (const T *first, const T *last) | |
void | swap (RWTValDeque< T, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValDeque< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTValDeque< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValDeque< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValDeque< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValDeque< T, A > *&p) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValDeque< T, A > *&p) |
This class maintains a collection of values implemented as a double-ended queue, or deque. Order is determined externally and elements are accessible by index. Use this class when insertions and deletions usually occur at either the beginning or the end of the collection. 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/tvdeque.h> RWTValDeque<T,A> deq;
Classes RWTValSlist<T,A>, RWTValDlist<T,A>, RWTValSortedDlist<T>, and RWTValOrderedVector<T,A> also provide a Rogue Wave interface to C++ Standard sequence collections. The list classes should be considered for frequent insertions (or removals) in the interior of the collection. Vectors may be more efficient if most insertions and removals occur at the end of the collection.
Class std::deque<T, A<T*> > is the C++ Standard collection that serves as the underlying implementation for this class.
Isomorphic
// // tvdqint.cpp // #include <rw/tvdeque.h> #include <iostream> int main () { RWTValDeque<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(n); else numbers.pushBack(n); } std::cout << "Partitioned numbers are: "; for (int i = 0; numbers.entries(); ++i) { if (i) std::cout << ", "; std::cout << numbers.popFront(); } std::cout << "\n"; return 0; }
Program Input:
1 2 3 4 5 <eof>
Program Output:
Input an assortment of integers (EOF to end): Partitioned numbers are: 4, 2, 1, 3, 5
typedef container_type::const_iterator RWTValDeque< T, A >::const_iterator |
Typedef for the const
iterator.
typedef container_type::const_reference RWTValDeque< T, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef std::deque<T ,A > RWTValDeque< T, A >::container_type |
Typedef for the C++ Standard collection that serves as the underlying implementation for this class.
typedef container_type::iterator RWTValDeque< T, A >::iterator |
Typedef for the non-const
iterator.
typedef container_type::reference RWTValDeque< T, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTValDeque< T, A >::size_type |
Typedef for the type used to index into this container.
typedef container_type::value_type RWTValDeque< T, A >::value_type |
Typedef for the type of elements in this container.
RWTValDeque< T, A >::RWTValDeque | ( | ) | [inline] |
Constructs an empty, double-ended queue.
RWTValDeque< T, A >::RWTValDeque | ( | const container_type & | deq | ) | [inline] |
Constructs a double-ended queue by copying all elements of deq.
RWTValDeque< T, A >::RWTValDeque | ( | const RWTValDeque< T, A > & | rwdeq | ) | [inline] |
Copy constructor.
RWTValDeque< T, A >::RWTValDeque | ( | RWTValDeque< T, A > && | deq | ) | [inline] |
Move constructor. The constructed deque takes ownership of the data owned by deq.
RWTValDeque< T, A >::RWTValDeque | ( | size_type | n, | |
const T & | val = T() | |||
) | [inline] |
Constructs a double-ended queue with n elements, each initialized to val.
RWTValDeque< T, A >::RWTValDeque | ( | const T * | first, | |
const T * | 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 RWTValDeque< T, A >::append | ( | value_type && | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTValDeque< T, A >::append | ( | const_reference | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< T, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTValDeque< T, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTValDeque< T, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self. Each item will have its destructor called.
bool RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< T, A >::end | ( | ) | const [inline] |
Returns a past-the-end valued iterator of self.
iterator RWTValDeque< T, A >::end | ( | ) | [inline] |
Returns a past-the-end valued iterator of self.
size_type RWTValDeque< T, A >::entries | ( | void | ) | const [inline] |
Returns the number of elements in self.
bool RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< T, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
reference RWTValDeque< T, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
size_type RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< T, A >::insert | ( | value_type && | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
bool RWTValDeque< T, A >::insert | ( | const_reference | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
void RWTValDeque< 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 0 and the number of entries in the collection. |
void RWTValDeque< 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 this position is not between 0 and the number of entries in the collection. |
bool RWTValDeque< T, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
const T& RWTValDeque< T, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
T& RWTValDeque< T, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
const_reference RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< T, A >::operator!= | ( | const RWTValDeque< T, A > & | rwc | ) | const [inline] |
Returns the negation of operator==().
bool RWTValDeque< T, A >::operator!= | ( | const container_type & | deq | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTValDeque< 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 RWTValDeque< 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. |
bool RWTValDeque< T, A >::operator< | ( | const RWTValDeque< T, A > & | deq | ) | const [inline] |
Returns true
if self compares lexicographically less than deq, otherwise returns false
. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
bool RWTValDeque< T, A >::operator< | ( | const container_type & | deq | ) | const [inline] |
Returns true
if self compares lexicographically less than deq, otherwise returns false
. Type T
must have well-defined less-than semantics (T::operator<(const T&)
or equivalent).
RWTValDeque<T ,A >& RWTValDeque< T, A >::operator= | ( | RWTValDeque< T, A > && | deq | ) | [inline] |
Move assignment. Self takes ownership of the data owned by deq.
RWTValDeque<T ,A >& RWTValDeque< T, A >::operator= | ( | const container_type & | deq | ) | [inline] |
Calls the destructor on all elements of self and replaces them by copying all elements of deq.
RWTValDeque<T ,A >& RWTValDeque< T, A >::operator= | ( | const RWTValDeque< T, A > & | deq | ) | [inline] |
Calls the destructor on all elements of self and replaces them by copying all elements of deq.
bool RWTValDeque< T, A >::operator== | ( | const RWTValDeque< T, A > & | deq | ) | const [inline] |
Returns true
if self compares equal to deq, 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 RWTValDeque< T, A >::operator== | ( | const container_type & | deq | ) | const [inline] |
Returns true
if self compares equal to deq, 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< T, A >::popBack | ( | ) | [inline] |
Removes and returns the last item in the collection.
T RWTValDeque< T, A >::popFront | ( | ) | [inline] |
Removes and returns the first item in the collection.
void RWTValDeque< T, A >::prepend | ( | value_type && | a | ) | [inline] |
Adds the item a to the beginning of the collection.
void RWTValDeque< T, A >::prepend | ( | const_reference | a | ) | [inline] |
Adds the item a to the beginning of the collection.
void RWTValDeque< T, A >::pushBack | ( | value_type && | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTValDeque< T, A >::pushBack | ( | const T & | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTValDeque< T, A >::pushFront | ( | value_type && | a | ) | [inline] |
Adds the item a to the beginning of the collection.
void RWTValDeque< T, A >::pushFront | ( | const T & | a | ) | [inline] |
Adds the item a to the beginning of the collection.
bool RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< 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 RWTValDeque< T, A >::removeAt | ( | size_type | index | ) | [inline] |
Removes and returns the item at position i in self.
RWBoundsErr | Thrown if index i is not between 0 and one less than the number of entries in self. |
value_type RWTValDeque< T, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
value_type RWTValDeque< T, A >::removeLast | ( | ) |
Removes and returns the last item in the collection.
size_type RWTValDeque< 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 RWTValDeque< 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
with newVal. Returns the number of items replaced. Client data may be passed through parameter d.
void RWTValDeque< T, A >::sort | ( | ) | [inline] |
Sorts the collection using the less-than operator (<
) to compare elements.
const container_type& RWTValDeque< 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 C++ Standard collections.
container_type& RWTValDeque< 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 C++ Standard collections.
void RWTValDeque< T, A >::swap | ( | RWTValDeque< T, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTValDeque< 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 RWTValDeque< 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, | |
RWTValDeque< 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, | |
RWTValDeque< 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, | |
RWTValDeque< T, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTValDeque< 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.