SourcePro® 2024.1 |
SourcePro® API Reference Guide |
A pointer-based collection of associations ordered according to a comparison object. More...
#include <rw/tpmap.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 const T *const & | const_reference_data |
typedef const K *const & | const_reference_key |
typedef container_type::const_reverse_iterator | const_reverse_iterator |
typedef rw_deref_compare< C, K > | container_comp |
typedef std::map< K *, T *, key_compare, A > | container_type |
typedef container_type::difference_type | difference_type |
typedef container_type::iterator | iterator |
typedef rw_deref_compare< C, K > | key_compare |
typedef container_type::key_type | key_type |
typedef container_type::mapped_type | mapped_type |
typedef container_type::pointer | pointer |
typedef container_type::reference | reference |
typedef T *& | reference_data |
typedef K *& | reference_key |
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 |
typedef T * | value_type_data |
typedef K * | value_type_key |
Public Member Functions | |
RWTPtrMap (const container_type &m) | |
RWTPtrMap (const key_compare &comp=key_compare()) | |
RWTPtrMap (const RWTPtrMap< K, T, C, A > &rws) | |
RWTPtrMap (container_type &&map) | |
template<typename InputIterator > | |
RWTPtrMap (InputIterator first, InputIterator last, const key_compare &cmp=key_compare()) | |
RWTPtrMap (RWTPtrMap< K, T, C, A > &&map) | |
void | apply (void(*fn)(const K *, const T *, void *), void *d) const |
void | apply (void(*fn)(const K *, mapped_type &, void *), void *d) |
void | applyToKeyAndValue (void(*fn)(const K *, const T *, void *), void *d) const |
void | applyToKeyAndValue (void(*fn)(const K *, mapped_type &, void *), void *d) |
iterator | begin () |
const_iterator | begin () const |
const_iterator | cbegin () const |
const_iterator | cend () const |
void | clear () |
void | clearAndDestroy () |
bool | contains (bool(*fn)(value_type, void *), void *d) const |
bool | contains (const K *key) const |
const_reverse_iterator | crbegin () const |
const_reverse_iterator | crend () const |
iterator | end () |
const_iterator | end () const |
size_type | entries () const |
iterator | erase (iterator first, iterator last) |
iterator | erase (iterator pos) |
value_type | find (bool(*fn)(value_type, void *), void *d) const |
const K * | find (const K *key) const |
const K * | findKeyAndValue (const K *key, const T *&tr) const |
const K * | findKeyAndValue (const K *key, mapped_type &tr) |
mapped_type | findValue (const K *key) |
const T * | findValue (const K *key) const |
template<typename InputIterator > | |
void | insert (InputIterator first, InputIterator last) |
iterator | insert (iterator hint, const value_type &val) |
bool | insert (key_type key, mapped_type a) |
bool | insertKeyAndValue (key_type key, mapped_type a) |
bool | isEmpty () const |
const K * | maxElement () const |
const K * | minElement () const |
size_type | occurrencesOf (bool(*fn)(value_type, void *), void *d) const |
size_type | occurrencesOf (const K *k) const |
RWTPtrMap< K, T, C, A > & | operator= (const container_type &rhs) |
RWTPtrMap< K, T, C, A > & | operator= (const RWTPtrMap< K, T, C, A > &rhs) |
RWTPtrMap< K, T, C, A > & | operator= (container_type &&rhs) |
RWTPtrMap< K, T, C, A > & | operator= (RWTPtrMap< K, T, C, A > &&rhs) |
mapped_type & | operator[] (const K *key) |
reverse_iterator | rbegin () |
const_reverse_iterator | rbegin () const |
key_type | remove (bool(*fn)(value_type, void *), void *d) |
key_type | remove (const K *key) |
size_type | removeAll (bool(*fn)(value_type, void *), void *d) |
size_type | removeAll (const K *key) |
reverse_iterator | rend () |
const_reverse_iterator | rend () const |
container_type & | std () |
const container_type & | std () const |
void | swap (RWTPtrMap< K, T, C, A > &rhs) |
Related Symbols | |
(Note that these are not member symbols.) | |
template<class K , class T , class C , class A > | |
bool | operator!= (const RWTPtrMap< K, T, C, A > &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator!= (const RWTPtrMap< K, T, C, A > &lhs, const typename RWTPtrMap< K, T, C, A >::container_type &rhs) |
template<class K , class T , class C , class A > | |
bool | operator!= (const typename RWTPtrMap< K, T, C, A >::container_type &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator< (const RWTPtrMap< K, T, C, A > &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator< (const RWTPtrMap< K, T, C, A > &lhs, const typename RWTPtrMap< K, T, C, A >::container_type &rhs) |
template<class K , class T , class C , class A > | |
bool | operator< (const typename RWTPtrMap< K, T, C, A >::container_type &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTPtrMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
bool | operator<= (const RWTPtrMap< K, T, C, A > &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator<= (const RWTPtrMap< K, T, C, A > &lhs, const typename RWTPtrMap< K, T, C, A >::container_type &rhs) |
template<class K , class T , class C , class A > | |
bool | operator<= (const typename RWTPtrMap< K, T, C, A >::container_type &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator== (const RWTPtrMap< K, T, C, A > &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator== (const RWTPtrMap< K, T, C, A > &lhs, const typename RWTPtrMap< K, T, C, A >::container_type &rhs) |
template<class K , class T , class C , class A > | |
bool | operator== (const typename RWTPtrMap< K, T, C, A >::container_type &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator> (const RWTPtrMap< K, T, C, A > &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator> (const RWTPtrMap< K, T, C, A > &lhs, const typename RWTPtrMap< K, T, C, A >::container_type &rhs) |
template<class K , class T , class C , class A > | |
bool | operator> (const typename RWTPtrMap< K, T, C, A >::container_type &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator>= (const RWTPtrMap< K, T, C, A > &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
bool | operator>= (const RWTPtrMap< K, T, C, A > &lhs, const typename RWTPtrMap< K, T, C, A >::container_type &rhs) |
template<class K , class T , class C , class A > | |
bool | operator>= (const typename RWTPtrMap< K, T, C, A >::container_type &lhs, const RWTPtrMap< K, T, C, A > &rhs) |
template<class K , class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrMap< K, T, C, A > *&p) |
template<class K , class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrMap< K, T, C, A > *&p) |
This class maintains a pointer-based collection of associations of type std::pair<K* const, T*>. The first part of the association is a key of type K*
, the second is its associated item of type T*
. 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.
Order is determined by the key according to a comparison object of type C
. C
must induce a total ordering on elements of type K
via a public member.
which returns true
if x
and its partner should precede y
and its partner within the collection. The structure std::less<T> from the C++ Standard Library header file <functional>
is an example. Note that keys will be dereferenced before being compared.
RWTPtrMap will not accept a key that compares equal to any key already in the collection. (RWTPtrMultiMap may contain multiple keys that compare equal to each other.) Equality is based on the comparison object and not on the equality operator. Given a comparison object comp
, keys 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 RWTPtrMultiMap offers the same interface to a pointer-based collection that accepts multiple keys that compare equal to each other. RWTPtrSet maintains a pointer-based collection of keys without the associated items.
Class std::map<K*,T*,deref_compare<C,K,A>> is the C++ Standard Library collection that serves as the underlying implementation for this class.
Program Output:
typedef container_type::allocator_type RWTPtrMap< K, T, C, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTPtrMap< K, T, C, A >::const_iterator |
A type that provides a const
bidirectional iterator over the elements in the container.
typedef container_type::const_pointer RWTPtrMap< K, T, C, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTPtrMap< K, T, C, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef const T* const& RWTPtrMap< K, T, C, A >::const_reference_data |
const T* const&
instead.Typedef for a const
reference to the type of data in this container.
typedef const K* const& RWTPtrMap< K, T, C, A >::const_reference_key |
const K* const&
instead.Typedef for a const
reference to a key in this container.
typedef container_type::const_reverse_iterator RWTPtrMap< K, T, C, A >::const_reverse_iterator |
A type that provides a const
bidirectional, reverse-order iterator over the elements in the container.
typedef rw_deref_compare<C, K> RWTPtrMap< K, T, C, A >::container_comp |
A type representing a comparison function that dereferences the arguments before comparing.
typedef std::map<K*, T*, key_compare, A> RWTPtrMap< K, T, C, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTPtrMap< K, 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 RWTPtrMap< K, T, C, A >::iterator |
A type that provides a bidirectional iterator over the elements in the container.
typedef rw_deref_compare<C, K> RWTPtrMap< K, T, C, A >::key_compare |
A type representing a comparison function for key_type that dereferences the arguments before comparing.
typedef container_type::key_type RWTPtrMap< K, T, C, A >::key_type |
A type representing the key of the container.
typedef container_type::mapped_type RWTPtrMap< K, T, C, A >::mapped_type |
A type representing the mapped value of the container.
typedef container_type::pointer RWTPtrMap< K, T, C, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTPtrMap< K, T, C, A >::reference |
A type that provides a reference to an element in the container.
typedef T*& RWTPtrMap< K, T, C, A >::reference_data |
Typedef for a non-const
reference to the type of data in this container.
typedef K*& RWTPtrMap< K, T, C, A >::reference_key |
Typedef for a non-const
reference to a key in this container.
typedef container_type::reverse_iterator RWTPtrMap< K, 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 RWTPtrMap< K, T, C, A >::size_type |
An unsigned integral type used for counting the number of elements in the container.
typedef container_type::value_compare RWTPtrMap< K, T, C, A >::value_compare |
A type representing a comparison function for value_type that dereferences the arguments before comparing.
typedef container_type::value_type RWTPtrMap< K, T, C, A >::value_type |
A type representing the container's data type.
typedef T* RWTPtrMap< K, T, C, A >::value_type_data |
Typedef for the type of value.
typedef K* RWTPtrMap< K, T, C, A >::value_type_key |
Typedef for the type of key.
|
inline |
Constructs an empty map with comparator comp.
|
inline |
Constructs a map by copying all elements from m.
|
inline |
Copy constructor.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by map.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by map.
|
inline |
Constructs a map 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.
void RWTPtrMap< K, T, C, A >::apply | ( | void(* | fn )(const K *, const T *, void *), |
void * | d ) const |
Invokes the function pointer fn on each association in the collection. Client data may be passed through parameter d.
void RWTPtrMap< K, T, C, A >::apply | ( | void(* | fn )(const K *, mapped_type &, void *), |
void * | d ) |
Invokes the function pointer fn on each association in the collection. Client data may be passed through parameter d.
|
inline |
|
inline |
|
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.
void RWTPtrMap< K, T, C, A >::clearAndDestroy | ( | ) |
Removes all associations from the collection and uses operator delete
to destroy the objects pointed to by the keys and their associated items. Do not use this method if multiple pointers to the same object are stored. (This could happen even if keys all compare different, since items are not considered during comparison.)
|
inline |
Returns true
if there exists an association a
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 a key j
in self that compares equal to *key
, 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 associations in self.
|
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 |
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 |
If there exists an association a
in self such that the expression ((*fn)(a,d))
is true
, then returns a
. Otherwise, returns value_type(rwnil,rwnil)
. Client data may be passed through parameter d.
|
inline |
If there exists a key j
in self that compares equal to *key
, then returns j
. Otherwise, returns rwnil.
|
inline |
If there exists a key j
in self that compares equal to *key
, assigns the item associated with j
to tr
, and returns j
. Otherwise, returns rwnil and leaves the value of tr unchanged.
|
inline |
If there exists a key j
in self that compares equal to *key
, assigns the item associated with j
to tr
, and returns j
. Otherwise, returns rwnil and leaves the value of tr unchanged.
|
inline |
If there exists a key j
in self that compares equal to *key
, returns the item associated with j
. Otherwise, returns rwnil.
|
inline |
If there exists a key j
in self that compares equal to *key
, returns the item associated with j
. Otherwise, returns rwnil.
|
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 |
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 |
Adds key with associated item a to the collection. Returns true
if the insertion is successful, otherwise returns false
. Insertion will fail if the collection already holds an association with an equivalent key.
|
inline |
|
inline |
Returns true
if there are no items in the collection, otherwise false
.
|
inline |
Returns a pointer to the maximum key in the collection. Order is determined according to the comparison object described by the template parameter C
.
|
inline |
Returns a pointer to the minimum key in the collection. Order is determined according to the comparison object described by the template parameter C
.
|
inline |
Returns the number of associations a
in self such that the expression ((*fn)(a,d))
is true
. Client data may be passed through parameter d.
|
inline |
Returns the number of keys j
in self that compare equal to *key
.
|
inline |
Destroys all associations in self and replaces them by copying all associations from rhs.
|
inline |
Destroys all associations in self and replaces them by copying all associations from 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 |
Looks up key and returns a reference to its associated item. If the key is not in the dictionary, then it will be added with an associated uninitialized pointer of type mapped_type. Because of this, if there is a possibility that a key will not be in the dictionary, then this operator should be used only as an lvalue.
|
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 association a
in self such that the expression ((*fn)(a,d))
is true
and returns its key. Returns rwnil if there is no such association. Client data may be passed through parameter d.
|
inline |
Removes the first association with key j
in self that compares equal to *key
and returns j
. Returns rwnil if there is no such association.
size_type RWTPtrMap< K, T, C, A >::removeAll | ( | bool(* | fn )(value_type, void *), |
void * | d ) |
Removes all associations a
in self such that the expression ((*fn)(a,d))
is true
. Returns the number removed. Client data may be passed through parameter d.
|
inline |
Removes all associations with key j
in self that compares equal to *key
. Returns the number of associations 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.
|
inline |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
|
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
. Items in each collection are dereferenced before being compared. Assumes that types K
and T
have well-defined less-than semantics.
|
related |
Returns true
if lhs is lexicographically less than rhs, otherwise false
. Items in each collection are dereferenced before being compared. Assumes that types K
and T
have well-defined less-than semantics.
|
related |
Returns true
if lhs is lexicographically less than rhs, otherwise false
. Items in each collection are dereferenced before being compared. Assumes that types K
and T
have well-defined less-than semantics.
|
related |
Saves the collection coll onto the RWFile strm, or a reference to it if it has already been saved.
|
related |
Saves the collection coll onto the output stream 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 if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container. Keys and values are dereferenced before being compared.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container. Keys and values are dereferenced before being compared.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container. Keys and values are dereferenced before being compared.
|
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 RWFile strm.
|
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.
|
related |
Restores the contents of the collection coll from the input stream 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.
Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |