Maintains a collection of keys, each with an associated item stored according to both a hash object and the key insertion order. Allows duplicate keys. More...

#include <rw/tools/tvordhmmap.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 rw_orderedhashmultimap< K, T, H, EQ, A >	container_type

typedef container_type::difference_type	difference_type

typedef container_type::hasher	hasher

typedef container_type::iterator	iterator

typedef container_type::key_equal_type	key_equal

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 container_type::size_type	size_type

typedef container_type::value_type	value_type

Public Member Functions
	RWTValOrderedHashMultiMap ()

	RWTValOrderedHashMultiMap (const rw_orderedhashmultimap< K, T, H, EQ, A > &m)

	RWTValOrderedHashMultiMap (const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &rws)

	RWTValOrderedHashMultiMap (container_type &&rws)

template<typename InputIterator >
	RWTValOrderedHashMultiMap (InputIterator first, InputIterator last)

	RWTValOrderedHashMultiMap (RWTValOrderedHashMultiMap< K, T, H, EQ, A > &&rws)

void	apply (void(fn)(const key_type &, const mapped_type &, void ), void *d) const

void	apply (void(fn)(const key_type &, mapped_type &, void ), void *d)

iterator	begin ()

const_iterator	begin () const

size_type	capacity () const

const_iterator	cbegin () const

const_iterator	cend () const

void	clear ()

bool	contains (bool(fn)(const_reference, void ), void *d) const

bool	contains (const key_type &key) const

iterator	end ()

const_iterator	end () const

size_type	entries () const

iterator	erase (iterator first, iterator last)

iterator	erase (iterator pos)

float	fillRatio () const

bool	find (bool(fn)(const_reference, void ), void *d, std::pair< K, T > &r) const

bool	find (const key_type &key, key_type &r) const

bool	findKeyAndValue (const key_type &key, key_type &kr, mapped_type &tr) const

bool	findValue (const key_type &key, mapped_type &r) const

bool	insert (const key_type &key, const mapped_type &a)

template<typename InputIterator >
void	insert (InputIterator first, InputIterator last)

iterator	insert (iterator hint, const value_type &val)

template<typename P >
iterator	insert (iterator hint, P &&val)

bool	insert (K &&key, T &&a)

bool	isEmpty () const

const key_type &	maxElement () const

const key_type &	minElement () const

size_type	occurrencesOf (bool(fn)(const_reference, void ), void *d) const

size_type	occurrencesOf (const key_type &key) const

RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	operator= (const rw_orderedhashmultimap< K, T, H, EQ, A > &rhs)

RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	operator= (const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &rhs)

RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	operator= (container_type &&rhs)

RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	operator= (RWTValOrderedHashMultiMap< K, T, H, EQ, A > &&rhs)

bool	remove (bool(fn)(const_reference, void ), void *d)

bool	remove (const key_type &key)

size_type	removeAll (bool(fn)(const_reference, void ), void *d)

size_type	removeAll (const key_type &key)

void	resize (size_type sz)

container_type &	std ()

const container_type &	std () const

void	swap (RWTValOrderedHashMultiMap< K, T, H, EQ, A > &other)

Related Symbols
(Note that these are not member symbols.)
template<class K , class T , class H , class EQ , class A >
bool	operator!= (const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &lhs, const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &rhs)

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

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

template<class K , class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &strm, const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &coll)

template<class K , class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &coll)

template<class K , class T , class H , class EQ , class A >
bool	operator== (const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &lhs, const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &rhs)

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

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

template<class K , class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &strm, RWTValOrderedHashMultiMap< K, T, H, EQ, A > &coll)

template<class K , class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &strm, RWTValOrderedHashMultiMap< K, T, H, EQ, A > *&p)

template<class K , class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValOrderedHashMultiMap< K, T, H, EQ, A > &coll)

template<class K , class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValOrderedHashMultiMap< K, T, H, EQ, A > *&p)

Detailed Description

template<class K, class T, class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>
class RWTValOrderedHashMultiMap< K, T, H, EQ, A >

Class RWTValOrderedHashMultiMap maintains a collection of type K keys, each with an associated type T item. These pairs are stored according to a hash object of type H. RWTValOrderedHashMultiMap preserves key insertion order. If the collection already contains items with the same key, the item will be inserted immediately after those items.

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.

H must provide a const function that takes a single argument convertible to type K and returns a value of type size_t.

Equivalent keys within the collection are grouped together based on an equality object of type EQ. EQ must ensure this grouping via a function that takes two arguments convertible to type K and returns a value of type bool.

Note: Any two keys that are equivalent must hash to the same value.

RWTValOrderedHashMultiMap may contain multiple keys that are equivalent to each other. (RWTValOrderedHashMap will not accept a key that is equivalent to any key already in the collection.) Equality is based on the comparison object and not on the equality operator.

The value type must have operator== defined. This requirement is imposed by the C++ Standard Library.

Synopsis: #include <rw/tvhmmap.h>

RWTValOrderedHashMultiMap<K, T, H, EQ, A> m;

RWTValOrderedHashMultiMap
Maintains a collection of keys, each with an associated item stored according to both a hash object a...
Definition tvordhmmap.h:81

See also

Class RWTValOrderedHashMap offers the same interface to a collection that will not accept multiple keys that compare equal to each other.

Class rw_orderedhashmultimap<K,T,H,EQ,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.

Persistence: Isomorphic.

Member Typedef Documentation

◆ allocator_type

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::allocator_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::allocator_type

A type representing the allocator type for the container.

◆ const_iterator

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::const_iterator RWTValOrderedHashMultiMap< K, T, H, EQ, A >::const_iterator

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

◆ const_pointer

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::const_pointer RWTValOrderedHashMultiMap< K, T, H, EQ, A >::const_pointer

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

◆ const_reference

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::const_reference RWTValOrderedHashMultiMap< K, T, H, EQ, A >::const_reference

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

◆ container_type

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef rw_orderedhashmultimap<K, T, H, EQ, A> RWTValOrderedHashMultiMap< K, T, H, EQ, A >::container_type

A type representing the underlying implementation container.

◆ difference_type

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::difference_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::difference_type

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

◆ hasher

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::hasher RWTValOrderedHashMultiMap< K, T, H, EQ, A >::hasher

A type representing the hash function.

◆ iterator

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::iterator RWTValOrderedHashMultiMap< K, T, H, EQ, A >::iterator

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

◆ key_equal

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::key_equal_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::key_equal

A type representing the equality function.

◆ key_type

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::key_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::key_type

A type representing the key of the container.

◆ mapped_type

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::mapped_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::mapped_type

A type representing the mapped value of the container.

◆ pointer

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::pointer RWTValOrderedHashMultiMap< K, T, H, EQ, A >::pointer

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

◆ reference

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::reference RWTValOrderedHashMultiMap< K, T, H, EQ, A >::reference

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

◆ size_type

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::size_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::size_type

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

◆ value_type

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

typedef container_type::value_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

◆ RWTValOrderedHashMultiMap() [1/6]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A >::RWTValOrderedHashMultiMap ( )

inline

Constructs an empty map.

◆ RWTValOrderedHashMultiMap() [2/6]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A >::RWTValOrderedHashMultiMap ( const rw_orderedhashmultimap< K, T, H, EQ, A > & m )

inline

Constructs a map by copying all elements of m.

◆ RWTValOrderedHashMultiMap() [3/6]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A >::RWTValOrderedHashMultiMap ( const RWTValOrderedHashMultiMap< K, T, H, EQ, A > & rws )

inline

Copy constructor.

◆ RWTValOrderedHashMultiMap() [4/6]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A >::RWTValOrderedHashMultiMap ( RWTValOrderedHashMultiMap< K, T, H, EQ, A > && rws )

inline

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

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

◆ RWTValOrderedHashMultiMap() [5/6]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A >::RWTValOrderedHashMultiMap ( container_type && rws )

inline

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

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

◆ RWTValOrderedHashMultiMap() [6/6]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

template<typename InputIterator >

RWTValOrderedHashMultiMap< K, T, H, EQ, A >::RWTValOrderedHashMultiMap	(	InputIterator	first,
		InputIterator	last )

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 H , class EQ , class A >

void RWTValOrderedHashMultiMap< K, T, H, EQ, A >::apply	(	void(*	fn )(const key_type &, const mapped_type &, 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 H , class EQ , class A >

void RWTValOrderedHashMultiMap< K, T, H, EQ, A >::apply	(	void(*	fn )(const key_type &, mapped_type &, void *),
		void *	d )

Invokes the function pointer fn on each association in the collection. Client data may be passed through parameter d.

◆ begin() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

const_iterator RWTValOrderedHashMultiMap< K, T, H, EQ, A >::begin ( ) const

inline

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

If the container is empty, returns end().

◆ capacity()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

size_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::capacity ( ) const

inline

Returns the number of buckets (slots) available in the underlying hash representation. See resize().

◆ cbegin()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

const_iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

const_iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

void RWTValOrderedHashMultiMap< K, T, H, EQ, A >::clear ( )

inline

Clears the collection by removing all items from self. Each key and its associated item will have its destructor called.

◆ contains() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::contains	(	bool(*	fn )(const_reference, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::contains ( const key_type & key ) const

inline

Returns true if there exists a key j in self that compares equal to key, otherwise returns false.

Note: This method requires the type mapped_type to have a default constructor.

◆ end() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

const_iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

size_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::entries ( ) const

inline

Returns the number of associations in self.

◆ erase() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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.

◆ fillRatio()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

float RWTValOrderedHashMultiMap< K, T, H, EQ, A >::fillRatio ( ) const

inline

Returns the ratio entries() / capacity().

◆ find() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::find	(	bool(*	fn )(const_reference, void *),
		void *	d,
		std::pair< K, T > &	r ) const

inline

If there exists an association a in self such that the expression ((*fn)(a,d)) is true, assigns a to r and returns true. Otherwise, returns false and leaves the value of r unchanged. Client data may be passed through parameter d.

◆ find() [2/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::find	(	const key_type &	key,
		key_type &	r ) const

inline

If there exists a key j in self that compares equal to key, assigns j to r and returns true. Otherwise, returns false and leaves the value of r unchanged.

Note: This method requires the type mapped_type to have a default constructor.

◆ findKeyAndValue()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::findKeyAndValue	(	const key_type &	key,
		key_type &	kr,
		mapped_type &	tr ) const

inline

If there exists a key j in self that compares equal to key, assigns j to kr, assigns the item associated with j to tr, and returns true. Otherwise, returns false and leaves the values of kr and tr unchanged.

Note: This method requires the type mapped_type to have a default constructor.

◆ findValue()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::findValue	(	const key_type &	key,
		mapped_type &	r ) const

inline

If there exists a key j in self that compares equal to key, assigns the item associated with j to r and returns true. Otherwise, returns false and leaves the value of r unchanged.

Note: This method requires the type mapped_type to have a default constructor.

◆ insert() [1/5]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::insert	(	const key_type &	key,
		const mapped_type &	a )

inline

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

Note: If the collection already contains items with the same key, key with associated item a will be inserted immediately after those items.

◆ insert() [2/5]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

template<typename InputIterator >

void RWTValOrderedHashMultiMap< K, T, H, EQ, 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.

Note: If the collection already contains items with the same key, a copy of the item will be inserted immediately after those items.

◆ insert() [3/5]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

iterator RWTValOrderedHashMultiMap< K, T, H, EQ, 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 is inserted at a different location according to the container's hash object.

Note: If the collection already contains items with the same key, val will be inserted immediately after those items.

◆ insert() [4/5]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

template<typename P >

iterator RWTValOrderedHashMultiMap< K, T, H, EQ, A >::insert	(	iterator	hint,
		P &&	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 is inserted at a different location according to the container's hash object.

Note: If the collection already contains items with the same key, val will be inserted immediately after those items.

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

P is a type that is convertible to value_type.

◆ insert() [5/5]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::insert	(	K &&	key,
		T &&	a )

inline

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

Note: If the collection already contains items with the same key, key with associated item a will be inserted immediately after those items.

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

◆ isEmpty()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::isEmpty ( ) const

inline

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

◆ maxElement()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

const key_type & RWTValOrderedHashMultiMap< K, T, H, EQ, A >::maxElement ( ) const

inline

Returns a reference to the maximum key in the collection. Type key_type must have well-defined less-than semantics (K::operator<(const &) or equivalent).

◆ minElement()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

const key_type & RWTValOrderedHashMultiMap< K, T, H, EQ, A >::minElement ( ) const

inline

Returns a reference to the minimum key in the collection. Type key_type must have well-defined less-than semantics (K::operator<(const K&) or equivalent).

◆ occurrencesOf() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

size_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::occurrencesOf	(	bool(*	fn )(const_reference, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

size_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::occurrencesOf ( const key_type & key ) const

inline

Returns the number of keys j in self that compares equal to key.

Note: This method requires the type mapped_type to have a default constructor.

◆ operator=() [1/4]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A > & RWTValOrderedHashMultiMap< K, T, H, EQ, A >::operator= ( const rw_orderedhashmultimap< K, T, H, EQ, A > & rhs )

inline

Destroys all elements of self and replaces them by copying all associations from rhs.

◆ operator=() [2/4]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A > & RWTValOrderedHashMultiMap< K, T, H, EQ, A >::operator= ( const RWTValOrderedHashMultiMap< K, T, H, EQ, A > & rhs )

inline

Destroys all elements of self and replaces them by copying all associations from rhs.

◆ operator=() [3/4]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A > & RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

RWTValOrderedHashMultiMap< K, T, H, EQ, A > & RWTValOrderedHashMultiMap< K, T, H, EQ, A >::operator= ( RWTValOrderedHashMultiMap< K, T, H, EQ, 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.

◆ remove() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::remove	(	bool(*	fn )(const_reference, void *),
		void *	d )

inline

Removes the first association a in self such that the expression ((*fn)(a,d)) is true, and returns true. Returns false if there is no such element. Client data may be passed through parameter d.

◆ remove() [2/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

bool RWTValOrderedHashMultiMap< K, T, H, EQ, A >::remove ( const key_type & key )

inline

Removes the first association with key j in self such that j compares equal to key and returns true. Returns false if there is no such association.

Note: This method requires the type mapped_type to have a default constructor.

◆ removeAll() [1/2]

template<class K , class T , class H , class EQ , class A >

RWTValOrderedHashMultiMap< K, T, H, EQ, A >::size_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::removeAll	(	bool(*	fn )(const_reference, void *),
		void *	d )

Removes all associations a 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.

◆ removeAll() [2/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

size_type RWTValOrderedHashMultiMap< K, T, H, EQ, A >::removeAll ( const key_type & key )

inline

Removes all associations with key j in self where j compares equal to key. Returns the number of items removed.

Note: This method requires the type mapped_type to have a default constructor.

◆ resize()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

void RWTValOrderedHashMultiMap< K, T, H, EQ, A >::resize ( size_type sz )

inline

Changes the capacity of self by creating a new multi-map with a capacity of sz. This method then copies every element of self into the new container and finally swaps the internal representation of the new container with self.

◆ std() [1/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

container_type & RWTValOrderedHashMultiMap< K, T, H, EQ, A >::std ( )

inline

Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing accessibility to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library collections.

◆ std() [2/2]

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

const container_type & RWTValOrderedHashMultiMap< K, T, H, EQ, A >::std ( ) const

inline

Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing accessibility to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library collections.

◆ swap()

template<class K , class T , class H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K>>

void RWTValOrderedHashMultiMap< K, T, H, EQ, A >::swap ( RWTValOrderedHashMultiMap< K, T, H, EQ, A > & other )

inline

Swaps the data held by self with the data held by other, including the H and EQ objects. This method does not copy or destroy any of the items swapped; rather, it swaps the underlying hash tables.

Friends And Related Symbol Documentation

◆ operator!=() [1/3]

template<class K , class T , class H , class EQ , class A >

bool operator!=	(	const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	lhs,
		const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	rhs )

◆ operator!=() [2/3]

template<class K , class T , class H , class EQ , class A >

bool operator!=	(	const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	lhs,
		const typename RWTValOrderedHashMultiMap< K, T, H, EQ, A >::container_type &	rhs )

◆ operator!=() [3/3]

template<class K , class T , class H , class EQ , class A >

bool operator!=	(	const typename RWTValOrderedHashMultiMap< K, T, H, EQ, A >::container_type &	lhs,
		const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	rhs )

◆ operator<<() [1/2]

template<class K , class T , class H , class EQ , class A >

RWFile & operator<<	(	RWFile &	strm,
		const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	coll )

◆ operator<<() [2/2]

template<class K , class T , class H , class EQ , class A >

RWvostream & operator<<	(	RWvostream &	strm,
		const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	coll )

◆ operator==() [1/3]

template<class K , class T , class H , class EQ , class A >

bool operator==	(	const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	lhs,
		const RWTValOrderedHashMultiMap< K, T, H, EQ, 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.

Note: This method requires the type mapped_type to have a default constructor.

◆ operator==() [2/3]

template<class K , class T , class H , class EQ , class A >

bool operator==	(	const RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	lhs,
		const typename RWTValOrderedHashMultiMap< K, T, H, EQ, 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.

Note: This method requires the type mapped_type to have a default constructor.

◆ operator==() [3/3]

template<class K , class T , class H , class EQ , class A >

bool operator==	(	const typename RWTValOrderedHashMultiMap< K, T, H, EQ, A >::container_type &	lhs,
		const RWTValOrderedHashMultiMap< K, T, H, EQ, 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.

Note: This method requires the type mapped_type to have a default constructor.

◆ operator>>() [1/4]

template<class K , class T , class H , class EQ , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	coll )

◆ operator>>() [2/4]

template<class K , class T , class H , class EQ , class A >

RWFile & operator>>	(	RWFile &	strm,
		RWTValOrderedHashMultiMap< K, T, H, EQ, 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 H , class EQ , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValOrderedHashMultiMap< K, T, H, EQ, A > &	coll )

◆ operator>>() [4/4]

template<class K , class T , class H , class EQ , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTValOrderedHashMultiMap< K, T, H, EQ, 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

◆ container_type

◆ difference_type

◆ hasher

◆ iterator

◆ key_equal

◆ key_type

◆ mapped_type

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ RWTValOrderedHashMultiMap() [1/6]

◆ RWTValOrderedHashMultiMap() [2/6]

◆ RWTValOrderedHashMultiMap() [3/6]

◆ RWTValOrderedHashMultiMap() [4/6]

◆ RWTValOrderedHashMultiMap() [5/6]

◆ RWTValOrderedHashMultiMap() [6/6]

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ cbegin()

◆ cend()

◆ clear()

◆ contains() [1/2]

◆ contains() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ entries()

◆ erase() [1/2]

◆ erase() [2/2]

◆ fillRatio()

◆ find() [1/2]

◆ find() [2/2]

◆ findKeyAndValue()

◆ findValue()

◆ insert() [1/5]

◆ insert() [2/5]

◆ insert() [3/5]

◆ insert() [4/5]

◆ insert() [5/5]

◆ isEmpty()

◆ maxElement()

◆ minElement()

◆ occurrencesOf() [1/2]

◆ occurrencesOf() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeAll() [1/2]

◆ removeAll() [2/2]

◆ resize()

◆ std() [1/2]

◆ std() [2/2]

◆ swap()

Friends And Related Symbol Documentation

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]