A pointer-based collection of associations ordered according to a comparison object, and allowing duplicate keys. More...

#include <rw/tpmmap.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::multimap< 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
	RWTPtrMultiMap (const container_type &m)

	RWTPtrMultiMap (const key_compare &comp=key_compare())

	RWTPtrMultiMap (const RWTPtrMultiMap< K, T, C, A > &rws)

	RWTPtrMultiMap (container_type &&map)

template<typename InputIterator >
	RWTPtrMultiMap (InputIterator first, InputIterator last, const key_compare &cmp=key_compare())

	RWTPtrMultiMap (RWTPtrMultiMap< 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 *key) const

RWTPtrMultiMap< K, T, C, A > &	operator= (const container_type &rhs)

RWTPtrMultiMap< K, T, C, A > &	operator= (const RWTPtrMultiMap< K, T, C, A > &rhs)

RWTPtrMultiMap< K, T, C, A > &	operator= (container_type &&rhs)

RWTPtrMultiMap< K, T, C, A > &	operator= (RWTPtrMultiMap< K, T, C, A > &&rhs)

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 (RWTPtrMultiMap< 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 RWTPtrMultiMap< K, T, C, A > &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator!= (const RWTPtrMultiMap< K, T, C, A > &lhs, const typename RWTPtrMultiMap< K, T, C, A >::container_type &rhs)

template<class K , class T , class C , class A >
bool	operator!= (const typename RWTPtrMultiMap< K, T, C, A >::container_type &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator< (const RWTPtrMultiMap< K, T, C, A > &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator< (const RWTPtrMultiMap< K, T, C, A > &lhs, const typename RWTPtrMultiMap< K, T, C, A >::container_type &rhs)

template<class K , class T , class C , class A >
bool	operator< (const typename RWTPtrMultiMap< K, T, C, A >::container_type &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

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 >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrMultiMap< K, T, C, A > &coll)

template<class K , class T , class C , class A >
bool	operator<= (const RWTPtrMultiMap< K, T, C, A > &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator<= (const RWTPtrMultiMap< K, T, C, A > &lhs, const typename RWTPtrMultiMap< K, T, C, A >::container_type &rhs)

template<class K , class T , class C , class A >
bool	operator<= (const typename RWTPtrMultiMap< K, T, C, A >::container_type &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator== (const RWTPtrMultiMap< K, T, C, A > &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator== (const RWTPtrMultiMap< K, T, C, A > &lhs, const typename RWTPtrMultiMap< K, T, C, A >::container_type &rhs)

template<class K , class T , class C , class A >
bool	operator== (const typename RWTPtrMultiMap< K, T, C, A >::container_type &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator> (const RWTPtrMultiMap< K, T, C, A > &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator> (const RWTPtrMultiMap< K, T, C, A > &lhs, const typename RWTPtrMultiMap< K, T, C, A >::container_type &rhs)

template<class K , class T , class C , class A >
bool	operator> (const typename RWTPtrMultiMap< K, T, C, A >::container_type &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator>= (const RWTPtrMultiMap< K, T, C, A > &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

template<class K , class T , class C , class A >
bool	operator>= (const RWTPtrMultiMap< K, T, C, A > &lhs, const typename RWTPtrMultiMap< K, T, C, A >::container_type &rhs)

template<class K , class T , class C , class A >
bool	operator>= (const typename RWTPtrMultiMap< K, T, C, A >::container_type &lhs, const RWTPtrMultiMap< K, T, C, A > &rhs)

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 >
RWFile &	operator>> (RWFile &strm, RWTPtrMultiMap< K, T, C, A > *&p)

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 >
RWvistream &	operator>> (RWvistream &strm, RWTPtrMultiMap< K, T, C, A > *&p)

Detailed Description

template<class K, class T, class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>
class RWTPtrMultiMap< K, T, C, A >

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

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 may contain multiple keys that compare equal to each other. (RWTPtrMap 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 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.

Synopsis: #include <rw/tpmmap.h>

RWTPtrMultiMap<K, T, C, A> m;

RWTPtrMultiMap
A pointer-based collection of associations ordered according to a comparison object,...
Definition tpmmap.h:169

See also

Class RWTPtrMap offers the same interface to a pointer-based collection that will not accept multiple keys that compare equal to each other. RWTPtrMultiSet 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 class.

Persistence: Isomorphic

Example: //

// tpmmap.cpp

//

#include <functional>

#include <iostream>

#include <rw/cstring.h>

#include <rw/tools/datetime.h>

#include <rw/tpmmap.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;

}

RWCString
Offers powerful and convenient facilities for manipulating strings.
Definition stdcstring.h:826

RWDateTime
Represents a date and time stored in milliseconds.
Definition tools/datetime.h:219

RWDateTime::setDate
@ setDate
Definition tools/datetime.h:253

RWTPtrMultiMap::insert
iterator insert(iterator hint, const value_type &val)
Definition tpmmap.h:722

Program Output:

There are 3 Ivans:

1. 11/02/80

2. 06/19/71

3. 07/06/50

Member Typedef Documentation

◆ allocator_type

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::allocator_type RWTPtrMultiMap< K, T, C, A >::allocator_type

A type representing the allocator type for the container.

◆ const_iterator

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::const_iterator RWTPtrMultiMap< K, T, C, A >::const_iterator

A type that provides a const bidirectional iterator over the elements in the container.

◆ const_pointer

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::const_pointer RWTPtrMultiMap< K, T, C, A >::const_pointer

A type that provides a const pointer to an element in the container.

◆ const_reference

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::const_reference RWTPtrMultiMap< K, T, C, A >::const_reference

A type that provides a const reference to an element in the container.

◆ const_reference_data

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef const T* const& RWTPtrMultiMap< K, T, C, A >::const_reference_data

Deprecated: As of SourcePro 12.5, use const T* const& instead.

Typedef for a const reference to the type of data in this container.

◆ const_reference_key

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef const K* const& RWTPtrMultiMap< K, T, C, A >::const_reference_key

Deprecated: As of SourcePro 12.5, use const K* const& instead.

Typedef for a const reference to a key in this container.

◆ const_reverse_iterator

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::const_reverse_iterator RWTPtrMultiMap< K, T, C, A >::const_reverse_iterator

A type that provides a const bidirectional, reverse-order iterator over the elements in the container.

◆ container_comp

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef rw_deref_compare<C, K> RWTPtrMultiMap< K, T, C, A >::container_comp

Deprecated: As of SourcePro 12.5, use key_compare instead.

A type representing a comparison function that dereferences the arguments before comparing.

◆ container_type

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef std::multimap<K*, T*, key_compare, A> RWTPtrMultiMap< K, T, C, A >::container_type

A type representing the underlying implementation container.

◆ difference_type

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::difference_type RWTPtrMultiMap< K, T, C, A >::difference_type

A signed integral type used to indicate the distance between two valid iterators on the same container.

◆ iterator

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::iterator RWTPtrMultiMap< K, T, C, A >::iterator

A type that provides a bidirectional iterator over the elements in the container.

◆ key_compare

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef rw_deref_compare<C, K> RWTPtrMultiMap< K, T, C, A >::key_compare

A type representing a comparison function for key_type that dereferences the arguments before comparing.

◆ key_type

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::key_type RWTPtrMultiMap< K, T, C, A >::key_type

A type representing the key of the container.

◆ mapped_type

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::mapped_type RWTPtrMultiMap< K, T, C, A >::mapped_type

A type representing the mapped value of the container.

◆ pointer

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::pointer RWTPtrMultiMap< K, T, C, A >::pointer

A type that provides a pointer to an element in the container.

◆ reference

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::reference RWTPtrMultiMap< K, T, C, A >::reference

A type that provides a reference to an element in the container.

◆ reference_data

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef T*& RWTPtrMultiMap< K, T, C, A >::reference_data

Deprecated: As of SourcePro 12.5, use mapped_type& instead.

Typedef for a non-const reference to the type of data in this container.

◆ reference_key

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef K*& RWTPtrMultiMap< K, T, C, A >::reference_key

Deprecated: As of SourcePro 12.5, use key_type& instead.

Typedef for a non-const reference to a key in this container.

◆ reverse_iterator

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::reverse_iterator RWTPtrMultiMap< K, T, C, A >::reverse_iterator

A type that provides a bidirectional, reverse-order iterator over the elements in the container.

◆ size_type

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::size_type RWTPtrMultiMap< K, T, C, A >::size_type

An unsigned integral type used for counting the number of elements in the container.

◆ value_compare

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::value_compare RWTPtrMultiMap< K, T, C, A >::value_compare

A type representing a comparison function for value_type that dereferences the arguments before comparing.

◆ value_type

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef container_type::value_type RWTPtrMultiMap< K, T, C, A >::value_type

A type representing the container's data type.

◆ value_type_data

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef T* RWTPtrMultiMap< K, T, C, A >::value_type_data

Deprecated: As of SourcePro 12.5, use mapped_type instead.

Typedef for the type of value.

◆ value_type_key

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

typedef K* RWTPtrMultiMap< K, T, C, A >::value_type_key

Deprecated: As of SourcePro 12.5, use key_type instead.

Typedef for the type of key.

Constructor & Destructor Documentation

◆ RWTPtrMultiMap() [1/6]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap ( const key_compare & comp = key_compare() )

inline

Constructs an empty map with comparator comp.

◆ RWTPtrMultiMap() [2/6]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap ( const container_type & m )

inline

Constructs a multimap by copying all elements from m.

◆ RWTPtrMultiMap() [3/6]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap ( const RWTPtrMultiMap< K, T, C, A > & rws )

inline

Copy constructor.

◆ RWTPtrMultiMap() [4/6]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

Condition:: This method is available only on platforms with rvalue reference support.

◆ RWTPtrMultiMap() [5/6]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap ( container_type && map )

inline

Move constructor. The constructed list takes ownership of the data owned by map.

Condition:: This method is available only on platforms with rvalue reference support.

◆ RWTPtrMultiMap() [6/6]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

template<typename InputIterator >

RWTPtrMultiMap< K, T, C, A >::RWTPtrMultiMap	(	InputIterator	first,
		InputIterator	last,
		const key_compare &	cmp = key_compare() )

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.

Member Function Documentation

◆ apply() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

void RWTPtrMultiMap< 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.

◆ apply() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

void RWTPtrMultiMap< 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.

◆ applyToKeyAndValue() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

void RWTPtrMultiMap< K, T, C, A >::applyToKeyAndValue	(	void(*	fn )(const K , const T , void *),
		void *	d ) const

inline

Deprecated: As of SourcePro 1, use apply() instead.

◆ applyToKeyAndValue() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

void RWTPtrMultiMap< K, T, C, A >::applyToKeyAndValue	(	void(*	fn )(const K , mapped_type &, void ),
		void *	d )

inline

Deprecated: As of SourcePro 1, use apply() instead.

◆ begin() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

iterator RWTPtrMultiMap< K, T, C, A >::begin ( )

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

◆ begin() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_iterator RWTPtrMultiMap< K, T, C, A >::begin ( ) const

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

◆ cbegin()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_iterator RWTPtrMultiMap< K, T, C, A >::cbegin ( ) const

inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

◆ cend()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_iterator RWTPtrMultiMap< K, T, C, A >::cend ( ) const

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.

◆ clear()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

void RWTPtrMultiMap< K, T, C, A >::clear ( )

inline

Clears the collection by removing all items from self.

◆ clearAndDestroy()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

void RWTPtrMultiMap< 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.

◆ contains() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

bool RWTPtrMultiMap< K, T, C, A >::contains	(	bool(*	fn )(value_type, void *),
		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.

◆ contains() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ crbegin()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_reverse_iterator RWTPtrMultiMap< K, T, C, A >::crbegin ( ) const

inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

◆ crend()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_reverse_iterator RWTPtrMultiMap< K, T, C, A >::crend ( ) const

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.

◆ end() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

iterator RWTPtrMultiMap< K, T, C, A >::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.

◆ end() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_iterator RWTPtrMultiMap< K, T, C, A >::end ( ) const

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.

◆ entries()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

size_type RWTPtrMultiMap< K, T, C, A >::entries ( ) const

inline

Returns the number of associations in self.

◆ erase() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

iterator RWTPtrMultiMap< K, T, C, A >::erase	(	iterator	first,
		iterator	last )

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.

◆ erase() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

iterator RWTPtrMultiMap< K, T, C, A >::erase ( iterator pos )

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.

◆ find() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

value_type RWTPtrMultiMap< K, T, C, A >::find	(	bool(*	fn )(value_type, void *),
		void *	d ) const

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.

◆ find() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ findKeyAndValue() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ findKeyAndValue() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const K * RWTPtrMultiMap< K, T, C, A >::findKeyAndValue	(	const K *	key,
		mapped_type &	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.

◆ findValue() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

mapped_type 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.

◆ findValue() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ insert() [1/3]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

template<typename InputIterator >

void RWTPtrMultiMap< K, T, C, A >::insert	(	InputIterator	first,
		InputIterator	last )

inline

Inserts the elements in the range [first, last) into self.

InputIterator is an input iterator type that points to elements that are convertible to value_type objects.

◆ insert() [2/3]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

iterator RWTPtrMultiMap< K, T, C, A >::insert	(	iterator	hint,
		const value_type &	val )

inline

Inserts val into self. 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.

◆ insert() [3/3]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

bool RWTPtrMultiMap< K, T, C, A >::insert	(	key_type	key,
		mapped_type	a )

inline

Adds key with associated item a to the collection. Returns true.

◆ insertKeyAndValue()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

bool RWTPtrMultiMap< K, T, C, A >::insertKeyAndValue	(	key_type	key,
		mapped_type	a )

inline

Deprecated: As of SourcePro 12.5, use insert() instead.

◆ isEmpty()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

bool RWTPtrMultiMap< K, T, C, A >::isEmpty ( ) const

inline

Returns true if there are no items in the collection, otherwise false.

◆ maxElement()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ minElement()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ occurrencesOf() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

size_type RWTPtrMultiMap< K, T, C, A >::occurrencesOf	(	bool(*	fn )(value_type, void *),
		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.

◆ occurrencesOf() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ operator=() [1/4]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ operator=() [2/4]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ operator=() [3/4]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

RWTPtrMultiMap< K, T, C, A > & RWTPtrMultiMap< K, T, C, A >::operator= ( container_type && rhs )

inline

Move assignment. Self takes ownership of the data owned by rhs.

Condition:: This method is available only on platforms with rvalue reference support.

◆ operator=() [4/4]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

Condition:: This method is available only on platforms with rvalue reference support.

◆ rbegin() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

reverse_iterator RWTPtrMultiMap< K, T, C, A >::rbegin ( )

inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

◆ rbegin() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_reverse_iterator RWTPtrMultiMap< K, T, C, A >::rbegin ( ) const

inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

◆ remove() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

key_type RWTPtrMultiMap< K, T, C, A >::remove	(	bool(*	fn )(value_type, void *),
		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.

◆ remove() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

key_type 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.

◆ removeAll() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

size_type RWTPtrMultiMap< 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.

◆ removeAll() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ rend() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

reverse_iterator RWTPtrMultiMap< K, T, C, A >::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.

◆ rend() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

const_reverse_iterator RWTPtrMultiMap< K, T, C, A >::rend ( ) const

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.

◆ std() [1/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ std() [2/2]

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

◆ swap()

template<class K , class T , class C = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

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.

Friends And Related Symbol Documentation

◆ operator!=() [1/3]

template<class K , class T , class C , class A >

bool operator!=	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator!=() [2/3]

template<class K , class T , class C , class A >

bool operator!=	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const typename RWTPtrMultiMap< K, T, C, A >::container_type &	rhs )

◆ operator!=() [3/3]

template<class K , class T , class C , class A >

bool operator!=	(	const typename RWTPtrMultiMap< K, T, C, A >::container_type &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator<() [1/3]

template<class K , class T , class C , class A >

bool operator<	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

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.

◆ operator<() [2/3]

template<class K , class T , class C , class A >

bool operator<	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const typename RWTPtrMultiMap< K, T, C, A >::container_type &	rhs )

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.

◆ operator<() [3/3]

template<class K , class T , class C , class A >

bool operator<	(	const typename RWTPtrMultiMap< K, T, C, A >::container_type &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

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.

◆ operator<<() [1/2]

template<class K , class T , class C , class A >

RWFile & operator<<	(	RWFile &	strm,
		const RWTPtrMultiMap< K, T, C, A > &	coll )

◆ operator<<() [2/2]

template<class K , class T , class C , class A >

RWvostream & operator<<	(	RWvostream &	strm,
		const RWTPtrMultiMap< K, T, C, A > &	coll )

◆ operator<=() [1/3]

template<class K , class T , class C , class A >

bool operator<=	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator<=() [2/3]

template<class K , class T , class C , class A >

bool operator<=	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const typename RWTPtrMultiMap< K, T, C, A >::container_type &	rhs )

◆ operator<=() [3/3]

template<class K , class T , class C , class A >

bool operator<=	(	const typename RWTPtrMultiMap< K, T, C, A >::container_type &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator==() [1/3]

template<class K , class T , class C , class A >

bool operator==	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

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.

◆ operator==() [2/3]

template<class K , class T , class C , class A >

bool operator==	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const typename RWTPtrMultiMap< K, T, C, A >::container_type &	rhs )

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.

◆ operator==() [3/3]

template<class K , class T , class C , class A >

bool operator==	(	const typename RWTPtrMultiMap< K, T, C, A >::container_type &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

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.

◆ operator>() [1/3]

template<class K , class T , class C , class A >

bool operator>	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator>() [2/3]

template<class K , class T , class C , class A >

bool operator>	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const typename RWTPtrMultiMap< K, T, C, A >::container_type &	rhs )

◆ operator>() [3/3]

template<class K , class T , class C , class A >

bool operator>	(	const typename RWTPtrMultiMap< K, T, C, A >::container_type &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator>=() [1/3]

template<class K , class T , class C , class A >

bool operator>=	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator>=() [2/3]

template<class K , class T , class C , class A >

bool operator>=	(	const RWTPtrMultiMap< K, T, C, A > &	lhs,
		const typename RWTPtrMultiMap< K, T, C, A >::container_type &	rhs )

◆ operator>=() [3/3]

template<class K , class T , class C , class A >

bool operator>=	(	const typename RWTPtrMultiMap< K, T, C, A >::container_type &	lhs,
		const RWTPtrMultiMap< K, T, C, A > &	rhs )

◆ operator>>() [1/4]

template<class K , class T , class C , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTPtrMultiMap< K, T, C, A > &	coll )

◆ operator>>() [2/4]

template<class K , class T , class C , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTPtrMultiMap< K, T, C, A > *&	p )

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.

◆ operator>>() [3/4]

template<class K , class T , class C , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTPtrMultiMap< K, T, C, A > &	coll )

◆ operator>>() [4/4]

template<class K , class T , class C , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTPtrMultiMap< K, T, C, A > *&	p )

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.

SourcePro® API Reference Guide

Public Types

Public Member Functions

Related Symbols

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reference_data

◆ const_reference_key

◆ const_reverse_iterator

◆ container_comp

◆ container_type

◆ difference_type

◆ iterator

◆ key_compare

◆ key_type

◆ mapped_type

◆ pointer

◆ reference

◆ reference_data

◆ reference_key

◆ reverse_iterator

◆ size_type

◆ value_compare

◆ value_type

◆ value_type_data

◆ value_type_key

Constructor & Destructor Documentation

◆ RWTPtrMultiMap() [1/6]

◆ RWTPtrMultiMap() [2/6]

◆ RWTPtrMultiMap() [3/6]

◆ RWTPtrMultiMap() [4/6]

◆ RWTPtrMultiMap() [5/6]

◆ RWTPtrMultiMap() [6/6]

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyToKeyAndValue() [1/2]

◆ applyToKeyAndValue() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ clear()

◆ clearAndDestroy()

◆ contains() [1/2]

◆ contains() [2/2]

◆ crbegin()

◆ crend()

◆ end() [1/2]

◆ end() [2/2]

◆ entries()

◆ erase() [1/2]

◆ erase() [2/2]

◆ find() [1/2]

◆ find() [2/2]

◆ findKeyAndValue() [1/2]

◆ findKeyAndValue() [2/2]

◆ findValue() [1/2]

◆ findValue() [2/2]

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ insertKeyAndValue()

◆ isEmpty()

◆ maxElement()

◆ minElement()

◆ occurrencesOf() [1/2]

◆ occurrencesOf() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]