SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Maintains a sorted collection of values implemented as a doubly-linked list. More...
#include <rw/tvsrtdli.h>
Public Types | |
typedef container_type::allocator_type | allocator_type |
typedef container_type::const_iterator | const_iterator |
typedef container_type::const_pointer | const_pointer |
typedef container_type::const_reference | const_reference |
typedef container_type::const_reverse_iterator | const_reverse_iterator |
typedef std::list< T, A > | container_type |
typedef container_type::difference_type | difference_type |
typedef container_type::iterator | iterator |
typedef C | key_compare |
typedef container_type::pointer | pointer |
typedef container_type::reference | reference |
typedef container_type::reverse_iterator | reverse_iterator |
typedef container_type::size_type | size_type |
typedef C | value_compare |
typedef container_type::value_type | value_type |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class C , class A > | |
bool | operator!= (const RWTValSortedDlist< T, C, A > &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator!= (const RWTValSortedDlist< T, C, A > &lhs, const typename RWTValSortedDlist< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator!= (const typename RWTValSortedDlist< T, C, A >::container_type &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator< (const RWTValSortedDlist< T, C, A > &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator< (const RWTValSortedDlist< T, C, A > &lhs, const typename RWTValSortedDlist< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator< (const typename RWTValSortedDlist< T, C, A >::container_type &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTValSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
bool | operator<= (const RWTValSortedDlist< T, C, A > &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator<= (const RWTValSortedDlist< T, C, A > &lhs, const typename RWTValSortedDlist< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator<= (const typename RWTValSortedDlist< T, C, A >::container_type &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator== (const RWTValSortedDlist< T, C, A > &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator== (const RWTValSortedDlist< T, C, A > &lhs, const typename RWTValSortedDlist< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator== (const typename RWTValSortedDlist< T, C, A >::container_type &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator> (const RWTValSortedDlist< T, C, A > &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator> (const RWTValSortedDlist< T, C, A > &lhs, const typename RWTValSortedDlist< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator> (const typename RWTValSortedDlist< T, C, A >::container_type &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator>= (const RWTValSortedDlist< T, C, A > &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator>= (const RWTValSortedDlist< T, C, A > &lhs, const typename RWTValSortedDlist< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator>= (const typename RWTValSortedDlist< T, C, A >::container_type &lhs, const RWTValSortedDlist< T, C, A > &rhs) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValSortedDlist< T, C, A > &coll) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValSortedDlist< T, C, A > *&p) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValSortedDlist< T, C, A > *&p) |
This class maintains an always-sorted collection of values, implemented as a doubly-linked list.
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.
RWTValSortedVector is an alternative always-sorted collections. RWTValDlist is an unsorted doubly-linked list of values.
Class std::list<T,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.
Program Output:
typedef container_type::allocator_type RWTValSortedDlist< T, C, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTValSortedDlist< T, C, A >::const_iterator |
A type that provides a const
bidirectional iterator over the elements in the container.
typedef container_type::const_pointer RWTValSortedDlist< T, C, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTValSortedDlist< T, C, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef container_type::const_reverse_iterator RWTValSortedDlist< T, C, A >::const_reverse_iterator |
A type that provides a const
bidirectional, reverse-order iterator over the elements in the container.
typedef std::list<T, A> RWTValSortedDlist< T, C, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTValSortedDlist< T, C, A >::difference_type |
A signed integral type used to indicate the distance between two valid iterators on the same container.
typedef container_type::iterator RWTValSortedDlist< T, C, A >::iterator |
A type that provides a bidirectional iterator over the elements in the container.
typedef C RWTValSortedDlist< T, C, A >::key_compare |
A type representing the comparison function.
typedef container_type::pointer RWTValSortedDlist< T, C, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTValSortedDlist< T, C, A >::reference |
A type that provides a reference to an element in the container.
typedef container_type::reverse_iterator RWTValSortedDlist< T, C, A >::reverse_iterator |
A type that provides a bidirectional, reverse-order iterator over the elements in the container.
typedef container_type::size_type RWTValSortedDlist< T, C, A >::size_type |
An unsigned integral type used for counting the number of elements in the container.
typedef C RWTValSortedDlist< T, C, A >::value_compare |
A type representing the comparison function.
typedef container_type::value_type RWTValSortedDlist< T, C, A >::value_type |
A type representing the container's data type.
|
inline |
Constructs an empty doubly-linked list.
|
inline |
Copy constructor.
|
inline |
Constructs a doubly-linked list by copying and sorting all elements of lst.
|
inline |
Constructs a doubly-linked list with n elements, each initialized to val.
|
inline |
Constructs a doubly-linked list by copying elements from the range [first, last).
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Move constructor. The constructed instance takes ownership of the data owned by rhs.
|
inline |
Move constructor. The constructed instance sorts and takes ownership of the data owned by rhs.
|
inline |
Invokes the function pointer fn on each item in the collection. Client data may be passed through parameter d.
|
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. |
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns an iterator referring to the element after the last element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Clears the collection by removing all items from self. Each item has its destructor called.
|
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.
|
inline |
Returns true
if there exists an element t
in self such that the expression (t == a)
is true
, otherwise returns false
.
|
inline |
Returns an iterator referring to the last element in the container.
If the container is empty, returns rend().
|
inline |
Returns an iterator referring to the element before the first element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Returns an iterator referring to the element after the last element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Returns an iterator referring to the element after the last element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Returns the number of elements in self.
|
inline |
Removes the item pointed to by pos from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.
|
inline |
Removes the items in the range [first, last) from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.
|
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.
|
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.
|
inline |
Returns a reference to the first element of self.
Calling this function on an empty collection results in undefined behavior.
|
inline |
Returns a reference to the first element of self.
Calling this function on an empty collection results in undefined behavior.
size_type RWTValSortedDlist< T, C, A >::index | ( | const_reference | a | ) | const |
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 RWTValSortedDlist< T, C, A >::index | ( | bool(*)(const_reference, void *) | fn, |
void * | d | ||
) | const |
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.
|
inline |
Adds the item a to self. The collection remains sorted. Returns true
.
|
inline |
Inserts val into self. Returns an iterator to the new item.
The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value should be inserted at a different location according to the containers comparison object.
|
inline |
Inserts the elements in the range [first, last) into self.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Adds the item a to self. The collection remains sorted. Returns true
.
|
inline |
Inserts val into self. Returns an iterator to the new item.
The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value should be inserted at a different location according to the containers comparison object.
size_type RWTValSortedDlist< T, C, A >::insert | ( | const container_type & | a | ) |
Adds the items from a to self, preserving order. Returns the number of items inserted into self.
|
inline |
Returns true
if there are no items in the collection, otherwise false
.
|
inline |
Returns true
if the collection is sorted relative to the supplied comparator object, otherwise false
.
|
inline |
Returns a reference to the last item in the collection.
Calling this function on an empty collection results in undefined behavior.
size_type RWTValSortedDlist< T, C, A >::merge | ( | const RWTValSortedDlist< T, C, A > & | coll | ) |
Inserts all elements of dl into self, preserving sorted order.
|
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.
|
inline |
Returns the number of elements t
in self such that the expression (t == a)
is true
.
|
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.
|
inline |
Destroys all elements of self and replaces them by copying (and sorting, if necessary) all elements of rhs.
|
inline |
Destroys all elements of self and replaces them by copying (and sorting, if necessary) all elements of rhs.
|
inline |
Move assignment. Self takes ownership of the data owned by rhs.
|
inline |
Move assignment. Self sorts and takes ownership of the data owned by rhs.
|
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. |
|
inline |
Returns an iterator referring to the last element in the container.
If the container is empty, returns rend().
|
inline |
Returns an iterator referring to the last element in the container.
If the container is empty, returns rend().
|
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.
|
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.
|
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 RWTValSortedDlist< T, C, A >::removeAll | ( | const_reference | a | ) |
Removes all elements t
in self such that the expression (t == a)
is true
. Returns the number of items removed.
value_type RWTValSortedDlist< T, C, A >::removeAt | ( | size_type | i | ) |
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 the collection. |
|
inline |
Removes and returns the first item in the collection.
Calling this function on an empty collection results in undefined behavior.
|
inline |
Removes and returns the last item in the collection.
Calling this function on an empty collection results in undefined behavior.
|
inline |
Returns an iterator referring to the element before the first element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Returns an iterator referring to the element before the first element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
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.
|
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.
|
inline |
Swaps the data owned by self with the data owned by rhs.
|
related |
Equivalent to !(lhs == rhs)
.
|
related |
Equivalent to !(lhs == rhs)
.
|
related |
Equivalent to !(lhs == rhs)
.
|
related |
Returns true
if lhs is lexicographically less than rhs, otherwise false
. Assumes that type T
has well-defined less-than semantics.
|
related |
Returns true
if lhs is lexicographically less than rhs, otherwise false
. Assumes that type T
has well-defined less-than semantics.
|
related |
Returns true
if lhs is lexicographically less than rhs, otherwise false
. Assumes that type T
has well-defined less-than semantics.
|
related |
Saves the collection coll onto the output stream strm, or a reference to it if it has already been saved.
|
related |
Saves the collection coll onto the RWFile strm, or a reference to it if it has already been saved.
|
related |
Equivalent to !(rhs < lhs)
.
|
related |
Equivalent to !(rhs < lhs)
.
|
related |
Equivalent to !(rhs < lhs)
.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces individual elements that, in turn, compare equal to each other.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces individual elements that, in turn, compare equal to each other.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces individual elements that, in turn, compare equal to each other.
|
related |
Equivalent to (rhs < lhs)
.
|
related |
Equivalent to (rhs < lhs)
.
|
related |
Equivalent to (rhs < lhs)
.
|
related |
Equivalent to !(lhs < rhs)
.
|
related |
Equivalent to !(lhs < rhs)
.
|
related |
Equivalent to !(lhs < rhs)
.
|
related |
Restores the contents of the collection coll from the input stream strm.
|
related |
Restores the contents of the collection coll from the RWFile strm.
|
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.
|
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.
Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |