SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Maintains a collection of values ordered according to a comparison object. More...
#include <rw/tvset.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::set< T, C, A > | container_type |
typedef container_type::difference_type | difference_type |
typedef container_type::iterator | iterator |
typedef container_type::key_compare | key_compare |
typedef container_type::key_type | key_type |
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 container_type::value_compare | 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 RWTValSet< T, C, A > &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator!= (const RWTValSet< T, C, A > &lhs, const typename RWTValSet< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator!= (const typename RWTValSet< T, C, A >::container_type &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator< (const RWTValSet< T, C, A > &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator< (const RWTValSet< T, C, A > &lhs, const typename RWTValSet< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator< (const typename RWTValSet< T, C, A >::container_type &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValSet< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTValSet< T, C, A > &coll) |
template<class T , class C , class A > | |
bool | operator<= (const RWTValSet< T, C, A > &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator<= (const RWTValSet< T, C, A > &lhs, const typename RWTValSet< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator<= (const typename RWTValSet< T, C, A >::container_type &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator== (const RWTValSet< T, C, A > &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator== (const RWTValSet< T, C, A > &lhs, const typename RWTValSet< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator== (const typename RWTValSet< T, C, A >::container_type &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator> (const RWTValSet< T, C, A > &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator> (const RWTValSet< T, C, A > &lhs, const typename RWTValSet< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator> (const typename RWTValSet< T, C, A >::container_type &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator>= (const RWTValSet< T, C, A > &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
bool | operator>= (const RWTValSet< T, C, A > &lhs, const typename RWTValSet< T, C, A >::container_type &rhs) |
template<class T , class C , class A > | |
bool | operator>= (const typename RWTValSet< T, C, A >::container_type &lhs, const RWTValSet< T, C, A > &rhs) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValSet< T, C, A > &coll) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValSet< T, C, A > &coll) |
template<class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValSet< T, C, A > *&p) |
template<class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValSet< T, C, A > *&p) |
This class maintains a collection of values, which are ordered according to a comparison object of type C
. 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.
C
must induce a total ordering on elements of type T
via a public member
which returns true
if x
should precede y
within the collection. The structure std::less<T>
from the C++ Standard Library header file <functional>
is an example.
RWTValSet will not accept an item that compares equal to an item already in the collection. (RWTValMultiSet may contain multiple items that compare equal to each other.) Equality is based on the comparison object and not on operator==
. Given a comparison object comp
, items a
and b
are equal if !comp(a,b) && !comp(b,a)
.
The value
type must have operator==
and operator<
defined. This requirement is imposed by the C++ Standard Library.
Class RWTValMultiSet offers the same interface to a collection that accepts multiple items that compare equal to each other. RWTValMap maintains a collection of key-value pairs.
Class std::set<T,C,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::allocator_type RWTValSet< T, C, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTValSet< T, C, A >::const_iterator |
A type that provides a const
bidirectional iterator over the elements in the container.
typedef container_type::const_pointer RWTValSet< T, C, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTValSet< T, C, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef container_type::const_reverse_iterator RWTValSet< T, C, A >::const_reverse_iterator |
A type that provides a const
bidirectional, reverse-order iterator over the elements in the container.
typedef std::set<T, C, A> RWTValSet< T, C, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTValSet< 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 RWTValSet< T, C, A >::iterator |
A type that provides a bidirectional iterator over the elements in the container.
typedef container_type::key_compare RWTValSet< T, C, A >::key_compare |
A type representing the comparison function.
typedef container_type::key_type RWTValSet< T, C, A >::key_type |
A type representing the key of the container.
typedef container_type::pointer RWTValSet< T, C, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTValSet< T, C, A >::reference |
A type that provides a reference to an element in the container.
typedef container_type::reverse_iterator RWTValSet< 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 RWTValSet< T, C, A >::size_type |
An unsigned integral type used for counting the number of elements in the container.
typedef container_type::value_compare RWTValSet< T, C, A >::value_compare |
A type representing the comparison function.
typedef container_type::value_type RWTValSet< T, C, A >::value_type |
A type representing the container's data type.
|
inline |
Constructs an empty set.
|
inline |
Constructs a set by copying all elements of s.
|
inline |
Copy constructor.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by rws.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by rws.
|
inline |
Constructs a set 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 |
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)(a, 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 that compares equal to a, 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 |
Sets self to the set-theoretic difference given by (self - s).
|
inline |
Sets self to the set-theoretic difference given by (self - s).
|
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)(a, 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 that compares equal to a, assigns t
to k and returns true
. Otherwise, returns false
and leaves the value of k unchanged.
|
inline |
Adds the item a to the collection. Returns true
if the insertion is successful, otherwise false
. Insertion will fail if the collection already holds an element with the equivalent key.
|
inline |
Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and 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 container's comparison object.
|
inline |
Inserts the elements in the range [first, last) into self. If the element is already present in the collection, it will be ignored.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Adds the item a to the collection. Returns true
if the insertion is successful, otherwise false
. Insertion will fail if the collection already holds an element with the equivalent key.
|
inline |
Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and 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 container's comparison object.
|
inline |
Sets self to the intersection of self and s.
|
inline |
Sets self to the intersection of self and s.
|
inline |
Returns true
if there are no items in the collection, otherwise false
.
|
inline |
Returns true
if self and s are identical, otherwise returns false
.
|
inline |
Returns true
if self is a proper subset of s, otherwise false
.
|
inline |
Returns true
if self is a subset of s, otherwise false
.
|
inline |
Returns the number of elements t
in self such that the expression ((*fn)(a, d))
is true
. Client data may be passed through parameter d.
|
inline |
Returns the number of elements t
in self that compare equal to a.
|
inline |
Destroys all elements of self and replaces them by copying all elements of rhs.
|
inline |
Destroys 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 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 that compares equal to a, and returns true
. Returns false
if there is no such element.
size_type RWTValSet< T, C, A >::removeAll | ( | bool(*)(const_reference, void *) | fn, |
void * | d | ||
) |
Removes all elements t
in self such that the expression ((*fn)(a, d))
is true
. Returns the number of items removed. Client data may be passed through parameter d.
|
inline |
Removes all elements t
in self that compare equal to a. Returns the number of items removed.
|
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. 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 C++ Standard Library 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 held by self with the data held by other, including the T
and EQ
objects. This method does not copy or destroy any of the items swapped; rather, it swaps the underlying hash tables.
|
inline |
Sets self to the symmetric difference of self and s.
|
inline |
Sets self to the symmetric difference of self and s.
|
inline |
Sets self to the union of self and s.
Union
avoids conflict with the C++ reserved word.
|
inline |
Sets self to the union of self and s.
Union
avoids conflict with the C++ reserved word.
|
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. |