SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Maintains a sorted collection of values implemented as a vector. More...
#include <rw/tvsrtvec.h>
Inherits RW_VSrtSeq< std::vector< T,A >, RWTValSortedVector< T, C,A >, C >.
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::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 |
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, reference k) const |
bool | find (const_reference a, reference k) const |
reference | first () |
const_reference | first () const |
size_type | index (bool(*fn)(const_reference, void *), void *d) const |
size_type | index (const_reference a) const |
bool | insert (const_reference a) |
bool | insert (value_type &&a) |
size_type | insert (const container_type &a) |
bool | isEmpty () const |
bool | isSorted () const |
size_type | occurrencesOf (bool(*fn)(const_reference, void *), void *d) const |
size_type | occurrencesOf (const_reference a) const |
bool | operator< (const container_type &vec) const |
bool | operator< (const RWTValSortedVector< T, C, A > &vec) const |
bool | operator== (const container_type &vec) const |
bool | operator== (const RWTValSortedVector< T, C, A > &vec) const |
bool | operator!= (const container_type &stdc) const |
bool | operator!= (const RWTValSortedVector< T, C, A > &rwc) const |
reference | operator[] (size_type i) |
const_reference | operator[] (size_type i) const |
reference | operator() (size_type i) |
const_reference | operator() (size_type i) const |
bool | remove (bool(*fn)(const_reference, void *), void *d) |
bool | remove (const_reference a) |
size_type | removeAll (bool(*fn)(const_reference, void *), void *d) |
size_type | removeAll (const_reference a) |
value_type | removeAt (size_type i) |
value_type | removeFirst () |
reference | at (size_type i) |
const_reference | at (size_type i) const |
RWSelectType< RWIsSameType < value_type, bool >::value, value_type, reference >::type | last () |
RWSelectType< RWIsSameType < value_type, bool >::value, value_type, const_reference > ::type | last () const |
void | apply (void(*fn)(const_reference, void *), void *d) const |
const T * | data () const |
size_type | merge (const RWTValSortedVector< T, C, A > &coll) |
value_type | removeLast () |
size_type | length () const |
void | resize (size_t n) |
void | swap (RWTValSortedVector< T, C, A > &rhs) |
RWTValSortedVector () | |
RWTValSortedVector (const RWTValSortedVector< T, C, A > &t) | |
RWTValSortedVector (const container_type &vec) | |
RWTValSortedVector (size_type n, const T &val) | |
RWTValSortedVector (const T *first, const T *last) | |
RWTValSortedVector (size_type n) | |
RWTValSortedVector & | operator= (const RWTValSortedVector &x) |
RWTValSortedVector (RWTValSortedVector &&rhs) | |
RWTValSortedVector & | operator= (RWTValSortedVector &&rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class C , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValSortedVector< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTValSortedVector< T, C, A > &coll) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValSortedVector< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValSortedVector< T, C, A > &coll) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValSortedVector< T, C, A > *&p) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValSortedVector< T, C, A > *&p) |
This class maintains an always-sorted collection of values, implemented as a vector.
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.
The value
type must have operator==
and operator<
defined. This requirement is imposed by the C++ Standard Library.
#include <rw/tvsrtvec.h> RWTValSortedVector<T,C,A> srtvec;
RWTValSortedDlist<T,C,A> is an alternative always-sorted collection. RWTValOrderedVector<T,A> is an unsorted vector of values.
Class vector<T,A> is the C++ Standard collection that serves as the underlying implementation for this class.
Isomorphic
// // tvsvcdat.cpp // #include <iostream> #include <functional> #include <rw/tvsrtvec.h> #include <rw/tools/datetime.h> int main () { RWTValSortedVector<RWDateTime, std::less<RWDateTime> > vec; vec.insert(RWDateTime("Aug 10, 1991", RWDateTime::setDate)); vec.insert(RWDateTime("Aug 9, 1991", RWDateTime::setDate)); vec.insert(RWDateTime("Sep 1, 1991", RWDateTime::setDate)); vec.insert(RWDateTime("May 14, 1990", RWDateTime::setDate)); vec.insert(RWDateTime("Sep 1, 1991", RWDateTime::setDate)); // Add a duplicate vec.insert(RWDateTime("June 2, 1991", RWDateTime::setDate)); for (size_t i = 0; i < vec.entries (); ++i) std::cout << vec[i].asString('x') << "\n"; return 0; }
Program Output:
05/14/90 06/02/91 08/09/91 08/10/91 09/01/91 09/01/91
typedef container_type::const_iterator RWTValSortedVector< T, C, A >::const_iterator |
Typedef for the const
iterator.
typedef container_type::const_reference RWTValSortedVector< T, C, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef std::vector<T ,A > RWTValSortedVector< T, C, A >::container_type |
Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::iterator RWTValSortedVector< T, C, A >::iterator |
Typedef for the non-const
iterator.
typedef container_type::reference RWTValSortedVector< T, C, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef container_type::size_type RWTValSortedVector< T, C, A >::size_type |
Typedef for the type used to index into this container.
typedef container_type::value_type RWTValSortedVector< T, C, A >::value_type |
Typedef for the type of elements in this container.
RWTValSortedVector< T, C, A >::RWTValSortedVector | ( | ) | [inline] |
Constructs an empty vector.
RWTValSortedVector< T, C, A >::RWTValSortedVector | ( | const RWTValSortedVector< T, C, A > & | t | ) | [inline] |
Copy constructor.
RWTValSortedVector< T, C, A >::RWTValSortedVector | ( | const container_type & | vec | ) | [inline] |
Constructs a vector by copying and sorting all elements of vec.
RWTValSortedVector< T, C, A >::RWTValSortedVector | ( | size_type | n, | |
const T & | val | |||
) | [inline] |
Constructs a vector with n elements, each initialized to val.
RWTValSortedVector< T, C, A >::RWTValSortedVector | ( | const T * | first, | |
const T * | last | |||
) |
Constructs a vector by copying and sorting elements from the array of T
s pointed to by first, up to, but not including, the element pointed to by last.
RWTValSortedVector< T, C, A >::RWTValSortedVector | ( | size_type | n | ) | [inline] |
Constructs an empty vector with a capacity of n elements.
RWTValSortedVector< T, C, A >::RWTValSortedVector | ( | RWTValSortedVector< T, C, A > && | rhs | ) | [inline] |
Move constructor. The constructed instance takes ownership of the data owned by rhs.
void RWTValSortedVector< T, C, 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.
const_reference RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
iterator RWTValSortedVector< T, C, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
void RWTValSortedVector< T, C, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self. Each item has its destructor called.
bool RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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 T* RWTValSortedVector< T, C, A >::data | ( | void | ) | const [inline] |
Returns a pointer to the first element of the vector.
const_iterator RWTValSortedVector< T, C, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last element in self.
iterator RWTValSortedVector< T, C, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last element in self.
size_type RWTValSortedVector< T, C, A >::entries | ( | void | ) | const [inline] |
Returns the number of items in self.
bool RWTValSortedVector< T, C, A >::find | ( | const_reference | a, | |
reference | 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 RWTValSortedVector< T, C, A >::find | ( | bool(*)(const_reference, void *) | fn, | |
void * | d, | |||
reference | 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 RWTValSortedVector< T, C, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
reference RWTValSortedVector< T, C, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
size_type RWTValSortedVector< T, C, 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.
size_type RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, A >::insert | ( | const container_type & | a | ) | [inline] |
Inserts all elements of a into self. The collection remains sorted. Returns the number of items inserted.
bool RWTValSortedVector< T, C, A >::insert | ( | value_type && | a | ) | [inline] |
Adds the item a to self. The collection remains sorted. Returns true
.
bool RWTValSortedVector< T, C, A >::insert | ( | const_reference | a | ) | [inline] |
Adds the item a to self. The collection remains sorted. Returns true
.
bool RWTValSortedVector< T, C, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
bool RWTValSortedVector< T, C, A >::isSorted | ( | ) | const [inline] |
Returns true
if the collection is sorted relative to the supplied comparator object, otherwise false
.
RWSelectType< RWIsSameType < value_type, bool >::value, value_type, const_reference >::type RWTValSortedVector< T, C, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
RWSelectType< RWIsSameType < value_type, bool >::value, value_type, reference >::type RWTValSortedVector< T, C, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
size_type RWTValSortedVector< T, C, A >::length | ( | ) | const [inline] |
Returns the maximum number of elements which can be stored in self without first resizing.
size_type RWTValSortedVector< T, C, A >::merge | ( | const RWTValSortedVector< T, C, A > & | coll | ) | [inline] |
Inserts all elements of dl into self, preserving sorted order.
size_type RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, A >::operator!= | ( | const RWTValSortedVector< T, C, A > & | rwc | ) | const [inline] |
Returns the negation of operator==().
bool RWTValSortedVector< T, C, A >::operator!= | ( | const container_type & | stdc | ) | const [inline] |
Returns the negation of operator==().
const_reference RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, A >::operator< | ( | const RWTValSortedVector< T, C, A > & | vec | ) | const [inline] |
Returns true
if self compares lexicographically less than vec, otherwise returns false
. Assumes that type T
has well-defined less-than semantics (T::operator<(const T&)
or equivalent).
bool RWTValSortedVector< T, C, A >::operator< | ( | const container_type & | vec | ) | const [inline] |
Returns true
if self compares lexicographically less than vec, otherwise returns false
. Assumes that type T
has well-defined less-than semantics (T::operator<(const T&)
or equivalent).
RWTValSortedVector& RWTValSortedVector< T, C, A >::operator= | ( | RWTValSortedVector< T, C, A > && | rhs | ) | [inline] |
Move assignment. Self takes ownership of the data owned by rhs.
RWTValSortedVector& RWTValSortedVector< T, C, A >::operator= | ( | const RWTValSortedVector< T, C, A > & | x | ) | [inline] |
Assignment operator.
bool RWTValSortedVector< T, C, A >::operator== | ( | const RWTValSortedVector< T, C, 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.
bool RWTValSortedVector< T, C, A >::operator== | ( | const container_type & | 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.
const_reference RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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.
bool RWTValSortedVector< T, C, 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.
size_type RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, A >::removeAt | ( | size_type | i | ) | [inline] |
Removes and returns the item at position i in self.
RWBoundsErr | Thrown if this position is not between 0 and one less than the number of entries in the collection. |
value_type RWTValSortedVector< T, C, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
value_type RWTValSortedVector< T, C, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
void RWTValSortedVector< T, C, A >::resize | ( | size_t | n | ) | [inline] |
Modify, if necessary, the capacity of the vector to be at least as large as n.
const container_type& RWTValSortedVector< T, C, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. It is the application's responsibility to not violate the ordering of the elements within the collection.
container_type& RWTValSortedVector< T, C, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self. It is the application's responsibility to not violate the ordering of the elements within the collection.
void RWTValSortedVector< T, C, A >::swap | ( | RWTValSortedVector< T, C, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTValSortedVector< T, C, 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 RWTValSortedVector< T, C, 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, | |
RWTValSortedVector< T, C, 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, | |
RWTValSortedVector< T, C, 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, | |
RWTValSortedVector< T, C, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTValSortedVector< T, C, 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.