SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A pointer-based collection of associations ordered according to a comparison object, and allowing duplicate keys. More...
#include <rw/tpmmap.h>
Inherits RW_PMapAssoc< std::multimap< K *, T *, rw_deref_compare< C, K >,A >, RWTPtrMultiMap< K, T, C,A >, K, T, C >.
Public Types | |
typedef rw_deref_compare< C, K > | container_comp |
typedef std::multimap< K *, T *, container_comp,A > | container_type |
typedef container_type::size_type | size_type |
typedef container_type::difference_type | difference_type |
typedef container_type::iterator | iterator |
typedef container_type::const_iterator | const_iterator |
typedef container_type::value_type | value_type |
typedef container_type::reference | reference |
typedef container_type::const_reference | const_reference |
typedef K * | value_type_key |
typedef T * | value_type_data |
typedef K *& | reference_key |
typedef T *& | reference_data |
typedef const K *const & | const_reference_key |
typedef const T *const & | const_reference_data |
Public Member Functions | |
container_type & | std () |
const container_type & | std () const |
void | apply (void(*fn)(const K *, const T *, void *), void *d) const |
void | apply (void(*fn)(const K *, T *&, void *), void *d) |
void | applyToKeyAndValue (void(*fn)(const K *, const T *, void *), void *d) const |
void | applyToKeyAndValue (void(*fn)(const K *, T *&, void *), void *d) |
iterator | begin () |
const_iterator | begin () const |
void | clearAndDestroy () |
iterator | end () |
const_iterator | end () const |
bool | isEmpty () const |
size_type | entries () const |
bool | operator== (const RWTPtrMultiMap< K, T, C, A > &m) const |
bool | operator< (const RWTPtrMultiMap< K, T, C, A > &m) const |
void | clear () |
bool | contains (bool(*fn)(value_type, void *), void *d) const |
bool | contains (const K *key) const |
value_type | find (bool(*fn)(value_type, void *), void *d) const |
const K * | find (const K *key) const |
T * | findValue (const K *key) |
const T * | findValue (const K *key) const |
const K * | findKeyAndValue (const K *key, T *&tr) |
const K * | findKeyAndValue (const K *key, const T *&tr) const |
const K * | minElement () const |
const K * | maxElement () const |
size_type | occurrencesOf (bool(*fn)(value_type, void *), void *d) const |
size_type | occurrencesOf (const K *key) const |
K * | remove (bool(*fn)(value_type, void *), void *d) |
K * | remove (const K *key) |
size_type | removeAll (bool(*fn)(value_type, void *), void *d) |
size_type | removeAll (const K *key) |
bool | insert (K *key, T *a) |
bool | insertKeyAndValue (K *key, T *a) |
RWTPtrMultiMap< K, T, C,A > & | operator= (const RWTPtrMultiMap< K, T, C, A > &rhs) |
RWTPtrMultiMap< K, T, C,A > & | operator= (const container_type &rhs) |
RWTPtrMultiMap< K, T, C,A > & | operator= (RWTPtrMultiMap< K, T, C, A > &&rhs) |
RWTPtrMultiMap (const container_comp &comp=container_comp()) | |
RWTPtrMultiMap (const container_type &m) | |
RWTPtrMultiMap (const RWTPtrMultiMap< K, T, C, A > &rws) | |
RWTPtrMultiMap (RWTPtrMultiMap< K, T, C, A > &&map) | |
RWTPtrMultiMap (value_type *first, value_type *last, const container_comp &cmp=container_comp()) | |
void | swap (RWTPtrMultiMap< K, T, C, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class K , class T , class C , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrMultiMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTPtrMultiMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrMultiMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrMultiMap< K, T, C, A > &coll) |
template<class K , class T , class C , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrMultiMap< K, T, C, A > *&p) |
template<class K , class T , class C , class A > | |
RWFile & | operator>> (RWFile &strm, RWTPtrMultiMap< K, T, C, A > *&p) |
This class maintains a pointer-based collection of associations of type 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
bool operator()(const K& x, const K& y)
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.
RWTPtrMultiMap<K,T,C,A> may contain multiple keys that compare equal to each other. (RWTPtrMap<K,T,C,A> will not accept a key that compares equal to any key already in the collection.) Equality is based on the comparison object and not on the ==
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.
#include <rw/tpmmap.h> RWTPtrMultiMap<K,T,C,A> m;
Class RWTPtrMap<K,T,C,A> offers the same interface to a pointer-based collection that will not accept multiple keys that compare equal to each other. RWTPtrMultiSet<T,C,A> maintains a pointer-based collection of keys without the associated values.
Class std::multimap<K*,T*,deref_compare<C,K,A> > is the C++ Standard Library collection that serves as the underlying implementation for this collection.
Isomorphic
// // tpmmap.cpp // #include <iostream> #include <functional> #include <rw/tpmmap.h> #include <rw/cstring.h> #include <rw/tools/datetime.h> int main () { typedef RWTPtrMultiMap<RWCString, RWDateTime, std::less<RWCString> > RWMMap; RWMMap birthdays; birthdays.insert(new RWCString("John"), new RWDateTime("April 12, 1975", RWDateTime::setDate)); birthdays.insert(new RWCString("Ivan"), new RWDateTime("Nov 2, 1980", RWDateTime::setDate)); birthdays.insert(new RWCString("Mary"), new RWDateTime("Oct 22, 1987", RWDateTime::setDate)); birthdays.insert(new RWCString("Ivan"), new RWDateTime("June 19, 1971", RWDateTime::setDate)); birthdays.insert(new RWCString("Sally"), new RWDateTime("March 15, 1976", RWDateTime::setDate)); birthdays.insert(new RWCString("Ivan"), new RWDateTime("July 6, 1950", RWDateTime::setDate)); // How many "Ivan"s? RWCString ivanstr("Ivan"); RWMMap::size_type n = birthdays.occurrencesOf(&ivanstr); RWMMap::size_type idx = 0; std::cout << "There are " << n << " Ivans:" << std::endl; RWMMap::const_iterator iter = birthdays.std().lower_bound(&ivanstr); while (++idx <= n) std::cout << idx << ". " << (*iter++).second->asString('x') << std::endl; return 0; }
Program Output:
There are 3 Ivans: 1. 11/02/80 2. 06/19/71 3. 07/06/50
typedef container_type::const_iterator RWTPtrMultiMap< K, T, C, A >::const_iterator |
Typedef for the const
iterator.
typedef container_type::const_reference RWTPtrMultiMap< K, T, C, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef const T* const& RWTPtrMultiMap< K, T, C, A >::const_reference_data |
Typedef for a const
reference to the type of data in this container.
typedef const K* const& RWTPtrMultiMap< K, T, C, A >::const_reference_key |
Typedef for a const
reference to a key in this container.
typedef rw_deref_compare<C,K> RWTPtrMultiMap< K, T, C, A >::container_comp |
Typedef for the comparison object.
typedef std::multimap<K*,T*,container_comp ,A > RWTPtrMultiMap< K, T, C, A >::container_type |
Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::difference_type RWTPtrMultiMap< K, T, C, A >::difference_type |
Typedef for the type of difference between iterators.
typedef container_type::iterator RWTPtrMultiMap< K, T, C, A >::iterator |
Typedef for the non-const
iterator.
typedef container_type::reference RWTPtrMultiMap< K, T, C, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef T*& RWTPtrMultiMap< K, T, C, A >::reference_data |
Typedef for a non-const
reference to the type of data in this container.
typedef K*& RWTPtrMultiMap< K, T, C, A >::reference_key |
Typedef for a non-const
reference to a key in this container.
typedef container_type::size_type RWTPtrMultiMap< K, T, C, A >::size_type |
Typedef for the type used to index into this container.
typedef container_type::value_type RWTPtrMultiMap< K, T, C, A >::value_type |
Typedef for the type of elements in this container.
typedef T* RWTPtrMultiMap< K, T, C, A >::value_type_data |
Typedef for the type of value.
typedef K* RWTPtrMultiMap< K, T, C, A >::value_type_key |
Typedef for the type of key.
RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap | ( | const container_comp & | comp = container_comp() |
) | [inline] |
Constructs an empty map with comparator comp.
RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap | ( | const container_type & | m | ) | [inline] |
Constructs a multimap by copying all elements from m.
RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap | ( | const RWTPtrMultiMap< K, T, C, A > & | rws | ) | [inline] |
Copy constructor.
RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap | ( | RWTPtrMultiMap< K, T, C, A > && | map | ) | [inline] |
Move constructor. The constructed list takes ownership of the data owned by map.
RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap | ( | value_type * | first, | |
value_type * | last, | |||
const container_comp & | cmp = container_comp() | |||
) | [inline] |
Constructs a multimap by copying elements from the array of pairs
pointed to by first, up to, but not including, the pair pointed to by last.
void RWTPtrMultiMap< K, T, C, A >::apply | ( | void(*)(const K *, T *&, void *) | fn, | |
void * | d | |||
) | [inline] |
Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.
void RWTPtrMultiMap< K, T, C, A >::apply | ( | void(*)(const K *, const T *, void *) | fn, | |
void * | d | |||
) | const [inline] |
Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.
void RWTPtrMultiMap< K, T, C, A >::applyToKeyAndValue | ( | void(*)(const K *, T *&, void *) | fn, | |
void * | d | |||
) | [inline] |
void RWTPtrMultiMap< K, T, C, A >::applyToKeyAndValue | ( | void(*)(const K *, const T *, void *) | fn, | |
void * | d | |||
) | const [inline] |
const_iterator RWTPtrMultiMap< K, T, C, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first pair in self.
iterator RWTPtrMultiMap< K, T, C, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first pair in self.
void RWTPtrMultiMap< K, T, C, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self.
void RWTPtrMultiMap< K, T, C, A >::clearAndDestroy | ( | void | ) | [inline] |
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.
bool RWTPtrMultiMap< K, T, C, A >::contains | ( | const K * | key | ) | const [inline] |
Returns true
if there exists a key j
in self that compares equal to *key
, otherwise returns false
.
bool RWTPtrMultiMap< K, T, C, A >::contains | ( | bool(*)(value_type, void *) | fn, | |
void * | d | |||
) | const [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.
const_iterator RWTPtrMultiMap< K, T, C, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last association in self.
iterator RWTPtrMultiMap< K, T, C, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last association in self.
size_type RWTPtrMultiMap< K, T, C, A >::entries | ( | void | ) | const [inline] |
Returns the number of associations in self.
const K* RWTPtrMultiMap< K, T, C, A >::find | ( | const K * | key | ) | const [inline] |
If there exists a key j
in self that compares equal to *key
, then returns j
. Otherwise, returns rwnil.
value_type RWTPtrMultiMap< K, T, C, A >::find | ( | bool(*)(value_type, void *) | fn, | |
void * | d | |||
) | const [inline] |
const K* RWTPtrMultiMap< K, T, C, A >::findKeyAndValue | ( | const K * | key, | |
const T *& | tr | |||
) | const [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.
const K* RWTPtrMultiMap< K, T, C, A >::findKeyAndValue | ( | const K * | key, | |
T *& | tr | |||
) | [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.
const T* RWTPtrMultiMap< K, T, C, A >::findValue | ( | const K * | key | ) | const [inline] |
If there exists a key j
in self such that the expression (*j == *key)
is true
, returns the item associated with j
. Otherwise, returns rwnil.
T* RWTPtrMultiMap< K, T, C, A >::findValue | ( | const K * | key | ) | [inline] |
If there exists a key j
in self such that the expression (*j == *key)
is true
, returns the item associated with j
. Otherwise, returns rwnil.
bool RWTPtrMultiMap< K, T, C, A >::insert | ( | K * | key, | |
T * | a | |||
) | [inline] |
Adds key with associated item a to the collection. Returns true
.
bool RWTPtrMultiMap< K, T, C, A >::insertKeyAndValue | ( | K * | key, | |
T * | a | |||
) | [inline] |
bool RWTPtrMultiMap< K, T, C, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise false
.
const K* RWTPtrMultiMap< K, T, C, A >::maxElement | ( | ) | const [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
.
const K* RWTPtrMultiMap< K, T, C, A >::minElement | ( | ) | const [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
.
size_type RWTPtrMultiMap< K, T, C, A >::occurrencesOf | ( | const K * | key | ) | const [inline] |
Returns the number of keys j
in self that compare equal to *key
.
size_type RWTPtrMultiMap< K, T, C, A >::occurrencesOf | ( | bool(*)(value_type, void *) | fn, | |
void * | d | |||
) | const [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.
bool RWTPtrMultiMap< K, T, C, A >::operator< | ( | const RWTPtrMultiMap< K, T, C, A > & | m | ) | const [inline] |
Returns true
if self compares lexicographically less than m, otherwise returns false
. Keys in each collection are dereferenced before being compared. Assumes that type K
has well-defined less-than semantics.
RWTPtrMultiMap<K,T,C ,A >& RWTPtrMultiMap< K, T, C, A >::operator= | ( | RWTPtrMultiMap< K, T, C, A > && | rhs | ) | [inline] |
Move assignment. Self takes ownership of the data owned by rhs.
RWTPtrMultiMap<K,T,C ,A >& RWTPtrMultiMap< K, T, C, A >::operator= | ( | const container_type & | rhs | ) | [inline] |
Destroys all associations in self and replaces them by copying all associations from rhs.
RWTPtrMultiMap<K,T,C ,A >& RWTPtrMultiMap< K, T, C, A >::operator= | ( | const RWTPtrMultiMap< K, T, C, A > & | rhs | ) | [inline] |
Destroys all associations in self and replaces them by copying all associations from rhs.
bool RWTPtrMultiMap< K, T, C, A >::operator== | ( | const RWTPtrMultiMap< K, T, C, A > & | m | ) | const [inline] |
Returns true
if self compares equal to m, otherwise returns false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual keys that compare equal to each other. Keys are dereferenced before being compared.
K* RWTPtrMultiMap< K, T, C, A >::remove | ( | const K * | key | ) | [inline] |
Removes the first association with key j
in self such that the expression (*j == *key)
is true
and returns j
. Returns rwnil if there is no such association.
K* RWTPtrMultiMap< K, T, C, A >::remove | ( | bool(*)(value_type, void *) | fn, | |
void * | d | |||
) | [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.
size_type RWTPtrMultiMap< K, T, C, A >::removeAll | ( | const K * | key | ) | [inline] |
Removes all associations with key j
in self that compare equal to *key
. Returns the number of associations removed.
size_type RWTPtrMultiMap< K, T, C, A >::removeAll | ( | bool(*)(value_type, void *) | fn, | |
void * | d | |||
) | [inline] |
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.
const container_type& RWTPtrMultiMap< K, T, C, A >::std | ( | ) | const [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
container_type& RWTPtrMultiMap< K, T, C, A >::std | ( | ) | [inline] |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
void RWTPtrMultiMap< K, T, C, A >::swap | ( | RWTPtrMultiMap< K, T, C, A > & | rhs | ) | [inline] |
Swaps the data owned by self with the data owned by rhs.
RWFile & operator<< | ( | RWFile & | strm, | |
const RWTPtrMultiMap< K, T, C, 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 RWTPtrMultiMap< K, T, C, 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, | |
RWTPtrMultiMap< K, T, C, 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, | |
RWTPtrMultiMap< K, T, C, 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, | |
RWTPtrMultiMap< K, T, C, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the RWFile strm.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrMultiMap< K, T, C, 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.