SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Maintains a collection of some type T implemented as a singly-linked, forward-iteration-only list. More...
#include <rw/tools/tvfwdlist.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 rw_forward_list< T, A > | container_type |
typedef container_type::difference_type | difference_type |
typedef container_type::iterator | iterator |
typedef container_type::pointer | pointer |
typedef container_type::reference | reference |
typedef container_type::size_type | size_type |
typedef container_type::value_type | value_type |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class A > | |
bool | operator!= (const RWTValForwardList< T, A > &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator!= (const RWTValForwardList< T, A > &lhs, const typename RWTValForwardList< T, A >::container_type &rhs) |
template<class T , class A > | |
bool | operator!= (const typename RWTValForwardList< T, A >::container_type &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator< (const RWTValForwardList< T, A > &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator< (const RWTValForwardList< T, A > &lhs, const typename RWTValForwardList< T, A >::container_type &rhs) |
template<class T , class A > | |
bool | operator< (const typename RWTValForwardList< T, A >::container_type &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValForwardList< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTValForwardList< T, A > &coll) |
template<class T , class A > | |
bool | operator<= (const RWTValForwardList< T, A > &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator<= (const RWTValForwardList< T, A > &lhs, const typename RWTValForwardList< T, A >::container_type &rhs) |
template<class T , class A > | |
bool | operator<= (const typename RWTValForwardList< T, A >::container_type &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator== (const RWTValForwardList< T, A > &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator== (const RWTValForwardList< T, A > &lhs, const typename RWTValForwardList< T, A >::container_type &rhs) |
template<class T , class A > | |
bool | operator== (const typename RWTValForwardList< T, A >::container_type &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator> (const RWTValForwardList< T, A > &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator> (const RWTValForwardList< T, A > &lhs, const typename RWTValForwardList< T, A >::container_type &rhs) |
template<class T , class A > | |
bool | operator> (const typename RWTValForwardList< T, A >::container_type &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator>= (const RWTValForwardList< T, A > &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
bool | operator>= (const RWTValForwardList< T, A > &lhs, const typename RWTValForwardList< T, A >::container_type &rhs) |
template<class T , class A > | |
bool | operator>= (const typename RWTValForwardList< T, A >::container_type &lhs, const RWTValForwardList< T, A > &rhs) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValForwardList< T, A > &coll) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValForwardList< T, A > &coll) |
template<class T , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValForwardList< T, A > *&p) |
template<class T , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValForwardList< T, A > *&p) |
Class RWTValForwardList maintains a collection of T
, implemented as a singly-linked list. Since this is a value-based list, objects are copied into and out of the links that make up the 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.
Classes RWTValDeque, RWTValDlist, and RWTValOrderedVector also provide a Rogue Wave interface to C++ Standard Library sequence collections.
The Rogue Wave supplied, Standard Library-compliant class rw_forward_list is the collection that serves as the underlying implementation for this class.
typedef container_type::allocator_type RWTValForwardList< T, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTValForwardList< T, A >::const_iterator |
A type that provides a const
forward iterator over the elements in the container.
typedef container_type::const_pointer RWTValForwardList< T, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTValForwardList< T, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef rw_forward_list<T, A> RWTValForwardList< T, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTValForwardList< T, A >::difference_type |
A signed integral type used to indicate the distance between two valid iterators on the same container.
typedef container_type::iterator RWTValForwardList< T, A >::iterator |
A type that provides a forward iterator over the elements in the container.
typedef container_type::pointer RWTValForwardList< T, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTValForwardList< T, A >::reference |
A type that provides a reference to an element in the container.
typedef container_type::size_type RWTValForwardList< T, A >::size_type |
An unsigned integral type used for counting the number of elements in the container.
typedef container_type::value_type RWTValForwardList< T, A >::value_type |
A type representing the container's data type.
|
inline |
Constructs an empty, singly-linked list.
|
inline |
Constructs a singly-linked list by copying all elements of lst.
|
inline |
Copy constructor.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by lst.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by lst.
|
inline |
Constructs a singly-linked list with n elements, each initialized to val.
|
inline |
Constructs a double-ended queue 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 |
Invokes the function pointer fn on each item in the collection. Client data may be passed through parameter d.
|
inline |
Invokes the function pointer fn on each item in the collection. Client data may be passed through parameter d.
|
inline |
Copies each element in the range [first, last) into self, replacing any existing items.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
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 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 preceding the first element in the container. This iterator is intended for use with functions insertAfter() and eraseAfter(). Attempting to access this iterator results in undefined behavior. When the iterator returned by this function is incremented, it is equivalent to the iterator returned by begin().
|
inline |
Returns an iterator preceding the first element in the container. This iterator is intended for use with functions insertAfter() and eraseAfter(). Attempting to access this iterator results in undefined behavior. When the iterator returned by this function is incremented, it is equivalent to the iterator returned by begin().
|
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 preceding the first element in the container. This iterator is intended for use with functions insertAfter() and eraseAfter(). Dereferencing the iterator returned by this function results in undefined behavior. When the iterator returned by this function is incremented, it is equivalent to the iterator returned by cbegin().
|
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 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 |
Removes from self the element following position. If position does not reference an actual element contained in self, the behavior is undefined. Returns an iterator referencing the location just after the erased element.
|
inline |
Removes from self the elements referenced by the range following position and bounded by last. Returns an iterator referencing a position just after the last erased element. If position does not reference an element in self, the behavior is undefined.
|
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 item in the collection.
Calling this function on an empty collection results in undefined behavior.
|
inline |
Returns a reference to the first item in the collection.
Calling this function on an empty collection results in undefined behavior.
|
inline |
Returns the position of the first item t
in self such that (t
== a), or returns RW_NPOS if no such item exists.
|
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.
|
inline |
Inserts value after the element referenced by position. Returns an iterator referencing the newly inserted element.
|
inline |
Inserts a copy of each element in the range [first, last) into self after the element referenced by position. Returns an iterator referencing the last inserted element.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Inserts n copies of value into self after the element referenced by position. Returns an iterator to the last inserted element, or position if no items are inserted.
|
inline |
Inserts value after the element referenced by position. Returns an iterator referencing the newly inserted element.
|
inline |
Inserts n copies of value into self after the element referenced by position. Returns an iterator to the last inserted element, or position if no items are inserted.
|
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. |
|
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. |
|
inline |
Returns true
if there are no items in the collection, false
otherwise.
|
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).
|
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).
|
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).
|
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).
|
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 |
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 |
Calls the destructor on all elements of self and replaces them by copying all elements of rhs.
|
inline |
Calls the destructor on all elements of self and replaces them by copying all elements of rhs.
|
inline |
Move assignment. Self takes ownership of the data owned by rhs.
|
inline |
Move assignment. Self 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 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 |
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 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 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.
|
inline |
Removes all elements t
in self such that the expression (t == a)
is true
. Returns the number of items removed.
|
inline |
Removes and returns the item at position i in self.
RWBoundsErr | Thrown if the index i is not between 0 and one less than the number of entries in the collection. |
|
inline |
Replaces all elements t
in self such that the expression ((*fn)(t,d))
is true
with the value newVal. Returns the number of items replaced. Client data may be passed through parameter d.
|
inline |
Replaces all elements t
in self such that the expression (t == oldVal)
is true
with newVal. Returns the number of items replaced.
|
inline |
Sorts the collection using the less-than operator to compare elements.
|
inline |
Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library collections.
|
inline |
Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library collections.
|
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. |