SourcePro C++ 12.0
SourcePro® C++ API Reference Guide
SourcePro C++
Documentation Home
SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Maintains a collection of values implemented as a singly-linked list. More...
#include <rw/tvslist.h>
Inherits RW_VSeq< rw_slist< T,A >, RWTValSlist< T,A > >.
This class maintains a collection of values, implemented as a singly-linked list. The value type must have operator== and operator< defined. This requirement is imposed by the C++ Standard Library.
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/tvslist.h> RWTValSlist<T,A> lst;
Classes RWTValDeque<T,A>, RWTValDlist<T,A>, and RWTValOrderedVector<T,A> also provide a Rogue Wave interface to C++ Standard Library sequence collections.
The Rogue Wave supplied, Standard Library-compliant class rw_slist<T,A> is the collection that serves as the underlying implementation for this class.
Isomorphic
// // tvslint.cpp // #include<iostream> #include<rw/tvslist.h> void div5 (int& x, void*) { x /= 5; } int main() { const int vec[10] = {45,10,5,15,25,30,35,20,40,50}; RWTValSlist<int> lst(vec, vec+10); RWTValSlistIterator<int> itr(lst); lst.apply(div5, 0); lst.sort(); for(;itr ();) std::cout << itr.key() << " "; std::cout << std::endl; return 0; }
Program Output:
1 2 3 4 5 6 7 8 9 10
| typedef container_type::const_iterator RWTValSlist< T, A >::const_iterator |
Typedef for the const iterator.
| typedef container_type::const_reference RWTValSlist< T, A >::const_reference |
Typedef for a const reference to a value in this container.
| typedef rw_slist<T ,A > RWTValSlist< T, A >::container_type |
Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.
| typedef container_type::iterator RWTValSlist< T, A >::iterator |
Typedef for the non-const iterator.
| typedef container_type::reference RWTValSlist< T, A >::reference |
Typedef for a non-const reference to a value in this container.
| typedef container_type::size_type RWTValSlist< T, A >::size_type |
Typedef for the type used to index into this container.
| typedef container_type::value_type RWTValSlist< T, A >::value_type |
Typedef for the type of elements in this container.
| RWTValSlist< T, A >::RWTValSlist | ( | ) | [inline] |
Constructs an empty, singly-linked list.
| RWTValSlist< T, A >::RWTValSlist | ( | const rw_slist< T, A > & | lst | ) | [inline] |
Constructs a singly-linked list by copying all elements of lst.
| RWTValSlist< T, A >::RWTValSlist | ( | const RWTValSlist< T, A > & | lst | ) | [inline] |
Copy constructor.
| RWTValSlist< T, A >::RWTValSlist | ( | RWTValSlist< T, A > && | lst | ) | [inline] |
Move constructor. The constructed list takes ownership of the data owned by lst.
| RWTValSlist< T, A >::RWTValSlist | ( | size_type | n, | |
| const T & | val = T() | |||
| ) | [inline] |
Constructs a singly-linked list with n elements, each initialized to val.
| RWTValSlist< T, A >::RWTValSlist | ( | const T * | first, | |
| const T * | last | |||
| ) | [inline] |
Constructs a singly-linked list by copying elements from the array of Ts pointed to by first, up to, but not including, the element pointed to by last.
| void RWTValSlist< T, A >::append | ( | value_type && | a | ) | [inline] |
Adds the item a to the end of the collection.
| void RWTValSlist< T, A >::append | ( | const_reference | a | ) | [inline] |
Adds the item a to the end of the collection.
| void RWTValSlist< T, A >::apply | ( | void(*)(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 RWTValSlist< 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.
| const_reference RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first element of self.
| iterator RWTValSlist< T, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first element of self.
| void RWTValSlist< T, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self. Each item has its destructor called.
| bool RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::end | ( | ) | const [inline] |
Returns a past-the-end valued iterator of self.
| iterator RWTValSlist< T, A >::end | ( | ) | [inline] |
Returns a past-the-end valued iterator of self.
| size_type RWTValSlist< T, A >::entries | ( | void | ) | const [inline] |
Returns the number of elements in self.
| bool RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::first | ( | void | ) | const [inline] |
Returns a reference to the first element of self.
| reference RWTValSlist< T, A >::first | ( | void | ) | [inline] |
Returns a reference to the first element of self.
| size_type RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::insert | ( | value_type && | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true.
| bool RWTValSlist< T, A >::insert | ( | const_reference | a | ) | [inline] |
Adds the item a to the end of the collection. Returns true.
| void RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::isEmpty | ( | ) | const [inline] |
Returns true if there are no items in the collection, false otherwise.
| const_reference RWTValSlist< T, A >::last | ( | void | ) | const [inline] |
Returns a reference to the last item in the collection.
| T& RWTValSlist< T, A >::last | ( | void | ) | [inline] |
Returns a reference to the last item in the collection.
| const_reference RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::operator!= | ( | const RWTValSlist< T, A > & | rwc | ) | const [inline] |
Returns the negation of operator==().
| bool RWTValSlist< T, A >::operator!= | ( | const container_type & | stdc | ) | const [inline] |
Returns the negation of operator==().
| const_reference RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::operator< | ( | const RWTValSlist< T, A > & | lst | ) | const [inline] |
Returns true if self compares lexicographically less than lst, otherwise returns false. Type T must have well-defined less-than semantics (T::operator<(const T&) or equivalent).
| bool RWTValSlist< T, A >::operator< | ( | const container_type & | lst | ) | const [inline] |
Returns true if self compares lexicographically less than lst, otherwise returns false. Type T must have well-defined less-than semantics (T::operator<(const T&) or equivalent).
| RWTValSlist<T ,A >& RWTValSlist< T, A >::operator= | ( | RWTValSlist< T, A > && | lst | ) | [inline] |
Move assignment. Self takes ownership of the data owned by lst.
| RWTValSlist<T ,A >& RWTValSlist< T, A >::operator= | ( | const rw_slist< T, A > & | lst | ) | [inline] |
Calls the destructor on all elements of self and replaces them by copying all elements of lst.
| RWTValSlist<T ,A >& RWTValSlist< T, A >::operator= | ( | const RWTValSlist< T, A > & | lst | ) | [inline] |
Calls the destructor on all elements of self and replaces them by copying all elements of lst.
| bool RWTValSlist< T, A >::operator== | ( | const RWTValSlist< T, A > & | lst | ) | const [inline] |
Returns true if self compares equal to lst, 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 RWTValSlist< T, A >::operator== | ( | const container_type & | lst | ) | const [inline] |
Returns true if self compares equal to lst, 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 RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::prepend | ( | value_type && | a | ) | [inline] |
Adds the item a to the beginning of the collection.
| void RWTValSlist< T, A >::prepend | ( | const_reference | a | ) | [inline] |
Adds the item a to the beginning of the collection.
| bool RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< 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 RWTValSlist< T, A >::removeAt | ( | size_type | i | ) | [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. |
| value_type RWTValSlist< T, A >::removeFirst | ( | ) | [inline] |
Removes and returns the first item in the collection.
| T RWTValSlist< T, A >::removeLast | ( | ) | [inline] |
Removes and returns the last item in the collection.
| size_type RWTValSlist< 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 RWTValSlist< 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 the value newVal. Returns the number of items replaced. Client data may be passed through parameter d.
| void RWTValSlist< T, A >::sort | ( | ) | [inline] |
Sorts the collection using the less-than operator to compare elements.
| const container_type& RWTValSlist< T, A >::std | ( | ) | const [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.
| container_type& RWTValSlist< T, A >::std | ( | ) | [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.
| void RWTValSlist< T, A >::swap | ( | RWTValSlist< T, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
| RWFile & operator<< | ( | RWFile & | strm, | |
| const RWTValSlist< 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 RWTValSlist< 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, | |
| RWTValSlist< 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, | |
| RWTValSlist< 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, | |
| RWTValSlist< T, A > & | coll | |||
| ) | [related] |
Restores the contents of the collection coll from the RWFile strm.
| RWvistream & operator>> | ( | RWvistream & | strm, | |
| RWTValSlist< 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.
