SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A pointer-based collection of values implemented as an ordered vector. More...
#include <rw/tpordvec.h>
Inherits RW_PSeq< std::vector< T *,A >, RWTPtrOrderedVector< T,A >, T >.
Public Types | |
typedef std::vector< 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 a) |
void | apply (void(*fn)(reference, void *), void *d) |
void | apply (void(*fn)(value_type, void *), void *d) |
void | apply (void(*fn)(const T *, void *), void *d) const |
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 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 | 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 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 RWTPtrOrderedVector< T, A > &vec) const |
bool | operator== (const RWTPtrOrderedVector< T, A > &vec) const |
bool | operator!= (const RWTPtrOrderedVector< T, A > &vec) 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) |
T *const * | data () const |
T *& | last () |
T *const & | last () const |
size_type | length () const |
void | resize (size_t n) |
T * | removeLast () |
void | sort () |
RWTPtrOrderedVector< T,A > & | operator= (const RWTPtrOrderedVector< T, A > &rhs) |
RWTPtrOrderedVector< T,A > & | operator= (const container_type &rhs) |
RWTPtrOrderedVector< T,A > & | operator= (RWTPtrOrderedVector< T, A > &&rhs) |
RWTPtrOrderedVector< T,A > & | operator= (container_type &&rhs) |
RWTPtrOrderedVector () | |
RWTPtrOrderedVector (const container_type &vec) | |
RWTPtrOrderedVector (const RWTPtrOrderedVector< T, A > &vec) | |
RWTPtrOrderedVector (RWTPtrOrderedVector< T, A > &&vec) | |
RWTPtrOrderedVector (size_type n, T *a) | |
RWTPtrOrderedVector (T *const *first, T *const *last) | |
void | swap (RWTPtrOrderedVector< T, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrOrderedVector< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTPtrOrderedVector< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrOrderedVector< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrOrderedVector< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrOrderedVector< T, A > *&p) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrOrderedVector< T, A > *&p) |
This class maintains a pointer-based collection of values, implemented as a vector. 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/tpordvec.h> RWTPtrOrderedVector<T,A> ordvec;
Classes RWTPtrDeque<T,A>, RWTPtrSlist<T,A>, and RWTPtrDlist<T,A> also provide a Rogue Wave pointer-based interface to C++ Standard sequence collections.
Class vector<T*,A<T*> >
is the C++ Standard Library collection that serves as the underlying implementation for this class.
Isomorphic
// // tporddat.cpp // #include <iostream> #include <rw/tpordvec.h> #include <rw/tools/datetime.h> int main () { RWTPtrOrderedVector<RWDateTime> week(7); RWDateTime begin(RWDateTime::setCurrentTime); // Today's date for (size_t i = 0; i < 7; ++i) { week.insert(new RWDateTime(begin)); begin.incrementDay(1); } for (size_t i = 0; i < 7; ++i) { std::cout << week[i]->asString('x') << std::endl; } return 0; }
Program Output (if program is run on June 18, 2009):
06/18/09 06/19/09 06/20/09 06/21/09 06/22/09 06/23/09 06/24/09
typedef container_type::const_iterator RWTPtrOrderedVector< T, A >::const_iterator |
Typedef for the const
iterator.
typedef container_type::const_reference RWTPtrOrderedVector< T, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef std::vector<T* ,A > RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::difference_type |
Typedef for the type of difference between iterators.
typedef container_type::iterator RWTPtrOrderedVector< T, A >::iterator |
Typedef for the non-const
iterator.
typedef container_type::reference RWTPtrOrderedVector< T, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTPtrOrderedVector< T, A >::size_type |
Typedef for the type used to index into this container.
typedef container_type::value_type RWTPtrOrderedVector< T, A >::value_type |
Typedef for the type of elements in this container.
RWTPtrOrderedVector< T, A >::RWTPtrOrderedVector | ( | ) | [inline] |
Constructs an empty vector.
RWTPtrOrderedVector< T, A >::RWTPtrOrderedVector | ( | const container_type & | vec | ) | [inline] |
Constructs an ordered vector by copying all elements of vec.
RWTPtrOrderedVector< T, A >::RWTPtrOrderedVector | ( | const RWTPtrOrderedVector< T, A > & | vec | ) | [inline] |
Copy constructor.
RWTPtrOrderedVector< T, A >::RWTPtrOrderedVector | ( | RWTPtrOrderedVector< T, A > && | vec | ) | [inline] |
Move constructor. The constructed vector takes ownership of the data owned by vec.
RWTPtrOrderedVector< T, A >::RWTPtrOrderedVector | ( | size_type | n, | |
T * | a | |||
) | [inline] |
Constructs a vector with n elements, each initialized to a.
RWTPtrOrderedVector< T, A >::RWTPtrOrderedVector | ( | T *const * | first, | |
T *const * | last | |||
) | [inline] |
Constructs a vector 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 RWTPtrOrderedVector< T, A >::append | ( | value_type | a | ) | [inline] |
Adds the item a to the end of the collection.
void RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTPtrOrderedVector< T, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTPtrOrderedVector< T, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self. Does not call operator delete
on the individual items.
void RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 returns false
.
bool RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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.
T* const* RWTPtrOrderedVector< T, A >::data | ( | void | ) | const [inline] |
Returns a pointer to the first element of the vector.
const_iterator RWTPtrOrderedVector< T, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last element in self.
iterator RWTPtrOrderedVector< T, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last element in self.
size_type RWTPtrOrderedVector< T, A >::entries | ( | void | ) | const [inline] |
Returns the number of items in self.
value_type RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
reference RWTPtrOrderedVector< T, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
size_type RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::insert | ( | value_type | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true
.
void RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
T* const& RWTPtrOrderedVector< T, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
T*& RWTPtrOrderedVector< T, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
size_type RWTPtrOrderedVector< T, A >::length | ( | ) | const [inline] |
Returns the number of items in self.
const_reference RWTPtrOrderedVector< T, A >::maxElement | ( | ) | const [inline] |
Returns a reference to the maximum element in self.
reference RWTPtrOrderedVector< T, A >::maxElement | ( | ) | [inline] |
Returns a reference to the maximum element in self.
const_reference RWTPtrOrderedVector< T, A >::minElement | ( | ) | const [inline] |
Returns a reference to the minimum element in self.
reference RWTPtrOrderedVector< T, A >::minElement | ( | ) | [inline] |
Returns a reference to the minimum element in self.
size_type RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::operator!= | ( | const RWTPtrOrderedVector< T, A > & | vec | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::operator< | ( | const RWTPtrOrderedVector< T, A > & | vec | ) | const [inline] |
Returns true
if self compares lexicographically less than vec, otherwise returns false
. Items in each collection are dereferenced before being compared.
RWTPtrOrderedVector<T ,A >& RWTPtrOrderedVector< T, A >::operator= | ( | container_type && | rhs | ) | [inline] |
Move assignment. Self takes ownership of the data owned by rhs.
RWTPtrOrderedVector<T ,A >& RWTPtrOrderedVector< T, A >::operator= | ( | RWTPtrOrderedVector< T, A > && | rhs | ) | [inline] |
Move assignment. Self takes ownership of the data owned by rhs.
RWTPtrOrderedVector<T ,A >& RWTPtrOrderedVector< T, A >::operator= | ( | const container_type & | rhs | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of rhs.
RWTPtrOrderedVector<T ,A >& RWTPtrOrderedVector< T, A >::operator= | ( | const RWTPtrOrderedVector< T, A > & | rhs | ) | [inline] |
Clears all elements of self and replaces them by copying all elements of rhs.
bool RWTPtrOrderedVector< T, A >::operator== | ( | const RWTPtrOrderedVector< T, A > & | vec | ) | const [inline] |
Returns true
if self compares equal to vec, 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::prepend | ( | value_type | a | ) | [inline] |
Adds the item a to the beginning of the collection.
value_type RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
T* RWTPtrOrderedVector< T, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
size_type RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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 RWTPtrOrderedVector< T, A >::resize | ( | size_t | n | ) | [inline] |
Modifies the capacity of the vector to be at least as large as n. The function has no effect if the capacity is already as large as n.
void RWTPtrOrderedVector< T, A >::sort | ( | ) | [inline] |
Sorts the collection using the less-than operator to compare elements. Elements are dereferenced before being compared.
const container_type& RWTPtrOrderedVector< T, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
container_type& RWTPtrOrderedVector< T, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
void RWTPtrOrderedVector< T, A >::swap | ( | RWTPtrOrderedVector< T, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTPtrOrderedVector< 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 RWTPtrOrderedVector< 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, | |
RWTPtrOrderedVector< 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, | |
RWTPtrOrderedVector< 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, | |
RWTPtrOrderedVector< T, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrOrderedVector< 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.