RWTValMap< K, T, C, A > Class Template Reference

Maintains a collection of keys, each with an associated item and ordered according to a comparison object. More...

#include <rw/tvmap.h>

Public Types
typedef container_type::allocator_type	allocator_type
typedef container_type::const_iterator	const_iterator
typedef container_type::const_pointer	const_pointer
typedef container_type::const_reference	const_reference
typedef container_type::const_reverse_iterator	const_reverse_iterator
typedef std::map< K, T, C, A >	container_type
typedef container_type::difference_type	difference_type
typedef container_type::iterator	iterator
typedef container_type::key_compare	key_compare
typedef container_type::key_type	key_type
typedef container_type::mapped_type	mapped_type
typedef container_type::pointer	pointer
typedef container_type::reference	reference
typedef container_type::reverse_iterator	reverse_iterator
typedef container_type::size_type	size_type
typedef container_type::value_compare	value_compare
typedef container_type::value_type	value_type

Public Member Functions
	RWTValMap (const container_type &m)
	RWTValMap (const key_compare &cmp=key_compare())
	RWTValMap (const RWTValMap< K, T, C, A > &rws)
	RWTValMap (container_type &&rws)
template<typename InputIterator >
	RWTValMap (InputIterator first, InputIterator last, const key_compare &cmp=key_compare())
	RWTValMap (RWTValMap< K, T, C, 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)
void	applyToKeyAndValue (void(*fn)(const key_type &, const mapped_type &, void *), void *d) const
void	applyToKeyAndValue (void(*fn)(const key_type &, mapped_type &, void *), void *d)
iterator	begin ()
const_iterator	begin () 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
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)
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
RWTValMap< K, T, C, A > &	operator= (const container_type &rhs)
RWTValMap< K, T, C, A > &	operator= (const RWTValMap< K, T, C, A > &rhs)
RWTValMap< K, T, C, A > &	operator= (container_type &&rhs)
RWTValMap< K, T, C, A > &	operator= (RWTValMap< K, T, C, A > &&rhs)
mapped_type &	operator[] (const key_type &key)
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
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)
reverse_iterator	rend ()
const_reverse_iterator	rend () const
container_type &	std ()
const container_type &	std () const
void	swap (RWTValMap< K, T, C, A > &other)

Related Symbols
(Note that these are not member symbols.)
template<class K , class T , class C , class A >
bool	operator!= (const RWTValMap< K, T, C, A > &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator!= (const RWTValMap< K, T, C, A > &lhs, const typename RWTValMap< K, T, C, A >::container_type &rhs)
template<class K , class T , class C , class A >
bool	operator!= (const typename RWTValMap< K, T, C, A >::container_type &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator< (const RWTValMap< K, T, C, A > &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator< (const RWTValMap< K, T, C, A > &lhs, const typename RWTValMap< K, T, C, A >::container_type &rhs)
template<class K , class T , class C , class A >
bool	operator< (const typename RWTValMap< K, T, C, A >::container_type &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
RWFile &	operator<< (RWFile &file, const RWTValMap< K, T, C, A > &coll)
template<class K , class T , class C , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTValMap< K, T, C, A > &coll)
template<class K , class T , class C , class A >
bool	operator<= (const RWTValMap< K, T, C, A > &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator<= (const RWTValMap< K, T, C, A > &lhs, const typename RWTValMap< K, T, C, A >::container_type &rhs)
template<class K , class T , class C , class A >
bool	operator<= (const typename RWTValMap< K, T, C, A >::container_type &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator== (const RWTValMap< K, T, C, A > &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator== (const RWTValMap< K, T, C, A > &lhs, const typename RWTValMap< K, T, C, A >::container_type &rhs)
template<class K , class T , class C , class A >
bool	operator== (const typename RWTValMap< K, T, C, A >::container_type &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator> (const RWTValMap< K, T, C, A > &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator> (const RWTValMap< K, T, C, A > &lhs, const typename RWTValMap< K, T, C, A >::container_type &rhs)
template<class K , class T , class C , class A >
bool	operator> (const typename RWTValMap< K, T, C, A >::container_type &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator>= (const RWTValMap< K, T, C, A > &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
bool	operator>= (const RWTValMap< K, T, C, A > &lhs, const typename RWTValMap< K, T, C, A >::container_type &rhs)
template<class K , class T , class C , class A >
bool	operator>= (const typename RWTValMap< K, T, C, A >::container_type &lhs, const RWTValMap< K, T, C, A > &rhs)
template<class K , class T , class C , class A >
RWFile &	operator>> (RWFile &file, RWTValMap< K, T, C, A > &coll)
template<class K , class T , class C , class A >
RWFile &	operator>> (RWFile &file, RWTValMap< K, T, C, A > *&p)
template<class K , class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValMap< K, T, C, A > &coll)
template<class K , class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTValMap< 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 RWTValMap< K, T, C, A >

This class maintains a collection of keys, each with an 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) const

which returns true if x and its associated object should precede y and its associated object within the collection. The structure std::less<T> from the C++ Standard Library header file <functional> is an example of such a comparison object.

Equality is based on the comparison object and not on 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/tvmap.h>
RWTValMap<K, T, C, A> m;

See also

Class RWTValMultiMap offers the same interface to a collection that accepts multiple keys that compare equal to each other. RWTValSet maintains a collection of keys without the associated values.

Class std::map<K,T,C,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.

Persistence

Isomorphic.

Example

#include <rw/cstring.h>
#include <rw/tools/datetime.h>
#include <rw/tvmap.h>
#include <functional>
#include <iostream>
 
int main() {
  RWTValMap<RWCString, RWDateTime, std::less<RWCString> > birthdays;
 
  birthdays.insert("John",
                   RWDateTime("April 12, 1975", RWDateTime::setDate));
  birthdays.insert("Ivan",
                   RWDateTime("Nov 2, 1980", RWDateTime::setDate));
 
  // Alternative syntax:
  birthdays["Susan"] = RWDateTime("June 30, 1955", RWDateTime::setDate);
  birthdays["Gene"] = RWDateTime("Jan 5, 1981", RWDateTime::setDate);
 
  // Print a birthday:
  std::cout << birthdays["John"].asString('x') << std::endl;
 
  return 0;
}

Program Output:

04/12/75

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 RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< K, T, C, A >::const_reference

A type that provides a const reference to an element in the 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 RWTValMap< K, T, C, A >::const_reverse_iterator

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

container_type

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

typedef std::map<K, T, C, A> RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 container_type::key_compare RWTValMap< K, T, C, A >::key_compare

A type representing the comparison function for key_type.

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 RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< K, T, C, A >::reference

A type that provides a reference to an element in the 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< K, T, C, A >::value_compare

A type representing the comparison function for value_type.

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 RWTValMap< K, T, C, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

RWTValMap() [1/6]

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

RWTValMap< K, T, C, A >::RWTValMap ( const key_compare & cmp = key_compare() )

inline

Constructs an empty map with comparator cmp.

RWTValMap() [2/6]

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

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

inline

Constructs a map by copying all elements of m.

RWTValMap() [3/6]

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

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

inline

Copy constructor.

RWTValMap() [4/6]

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

RWTValMap< K, T, C, A >::RWTValMap ( RWTValMap< K, T, C, 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.

RWTValMap() [5/6]

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

RWTValMap< K, T, C, A >::RWTValMap ( 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.

RWTValMap() [6/6]

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

template<typename InputIterator >

RWTValMap< K, T, C, A >::RWTValMap ( 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 RWTValMap< K, T, C, 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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

void RWTValMap< K, T, C, 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.

applyToKeyAndValue() [1/2]

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

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

inline

Deprecated

As of SourcePro 11.1, use apply() instead.

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

applyToKeyAndValue() [2/2]

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

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

inline

Deprecated

As of SourcePro 11.1, use apply() instead.

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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

iterator RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< K, T, C, A >::clear ( )

inline

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

contains() [1/2]

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

bool RWTValMap< K, T, C, 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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

bool RWTValMap< K, T, C, 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.

crbegin()

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

const_reverse_iterator RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< 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 RWTValMap< 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> >>

bool RWTValMap< K, T, C, 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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

bool RWTValMap< K, T, C, 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.

findKeyAndValue()

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

bool RWTValMap< K, T, C, 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.

findValue()

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

bool RWTValMap< K, T, C, 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.

insert() [1/5]

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

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

inline

Adds key with associated item a to the collection. Returns true if the insertion is successful, otherwise returns false. The function returns true unless the collection already holds an association with the equivalent key.

insert() [2/5]

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

template<typename InputIterator >

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

inline

Inserts the elements in the range [first, last) into self. If the element is already present in the collection, it will be ignored.

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

insert() [3/5]

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

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

inline

Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and returns an iterator to the new item.

The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value should be inserted at a different location according to the container's comparison object.

insert() [4/5]

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

template<typename P >

iterator RWTValMap< K, T, C, A >::insert ( iterator hint, P && val )

inline

Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and returns an iterator to the new item.

The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value should be inserted at a different location according to the container's comparison object.

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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

bool RWTValMap< K, T, C, A >::insert ( K && key, T && a )

inline

Adds key with associated item a to the collection. Returns true if the insertion is successful, otherwise returns false. The function returns true unless the collection already holds an association with the equivalent key.

Condition:

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

isEmpty()

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

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

inline

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

maxElement()

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

const key_type & RWTValMap< K, T, C, A >::maxElement ( ) const

inline

Returns a reference to the maximum key in the collection. Order is determined according to the comparison object C.

minElement()

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

const key_type & RWTValMap< K, T, C, A >::minElement ( ) const

inline

Returns a reference to the minimum key in the collection. Order is determined according to the comparison object 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 RWTValMap< K, T, C, 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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

size_type RWTValMap< K, T, C, A >::occurrencesOf ( const key_type & 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> >>

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

inline

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

operator=() [2/4]

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

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

inline

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

operator=() [3/4]

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

RWTValMap< K, T, C, A > & RWTValMap< 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> >>

RWTValMap< K, T, C, A > & RWTValMap< K, T, C, A >::operator= ( RWTValMap< 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.

operator[]()

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

mapped_type & RWTValMap< K, T, C, A >::operator[] ( const key_type & key )

inline

Looks up key and returns a reference to its associated item. If the key is not in the collection, it is added with an associated item provided by the default constructor for type mapped_type.

rbegin() [1/2]

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

reverse_iterator RWTValMap< 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 RWTValMap< 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> >>

bool RWTValMap< K, T, C, 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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

bool RWTValMap< K, T, C, 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.

removeAll() [1/2]

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

size_type RWTValMap< K, T, C, 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 C = std::less<K>, class A = std::allocator< std::pair<K const, T> >>

size_type RWTValMap< K, T, C, A >::removeAll ( const key_type & key )

inline

Removes all associations with key j in self such that j compares equal to key. Returns the number of items 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 RWTValMap< 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 RWTValMap< 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 & RWTValMap< K, T, C, A >::std ( )

inline

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

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 & RWTValMap< K, T, C, A >::std ( ) const

inline

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

swap()

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

void RWTValMap< K, T, C, A >::swap ( RWTValMap< K, T, C, A > & other )

inline

Swaps the data held by self with the data held by other. This method does not copy or destroy any of the items swapped; rather, it swaps the underlying map.

Friends And Related Symbol Documentation

operator!=() [1/3]

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

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

related

Equivalent to !(lhs == rhs).

operator!=() [2/3]

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

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

related

Equivalent to !(lhs == rhs).

operator!=() [3/3]

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

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

related

Equivalent to !(lhs == rhs).

operator<() [1/3]

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

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Assumes that type mapped_type has well-defined less-than semantics.

operator<() [2/3]

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

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Assumes that type mapped_type has well-defined less-than semantics.

operator<() [3/3]

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

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Assumes that type mapped_type has well-defined less-than semantics.

operator<<() [1/2]

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

RWFile & operator<< ( RWFile & file, const RWTValMap< K, T, C, A > & coll )

related

Saves the collection coll to the RWFile file, or a reference to it if it has already been saved.

operator<<() [2/2]

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

RWvostream & operator<< ( RWvostream & strm, const RWTValMap< 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.

operator<=() [1/3]

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

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

related

Equivalent to !(rhs < lhs).

operator<=() [2/3]

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

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

related

Equivalent to !(rhs < lhs).

operator<=() [3/3]

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

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

related

Equivalent to !(rhs < lhs).

operator==() [1/3]

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

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

related

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container.

operator==() [2/3]

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

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

related

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container.

operator==() [3/3]

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

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

related

Returns true if lhs and rhs are equal, otherwise false. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container.

operator>() [1/3]

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

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

related

Equivalent to (rhs < lhs).

operator>() [2/3]

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

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

related

Equivalent to (rhs < lhs).

operator>() [3/3]

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

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

related

Equivalent to (rhs < lhs).

operator>=() [1/3]

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

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

related

Equivalent to !(lhs < rhs).

operator>=() [2/3]

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

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

related

Equivalent to !(lhs < rhs).

operator>=() [3/3]

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

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

related

Equivalent to !(lhs < rhs).

operator>>() [1/4]

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

RWFile & operator>> ( RWFile & file, RWTValMap< K, T, C, A > & coll )

related

Restores the contents of the collection coll from the RWFile file.

operator>>() [2/4]

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

RWFile & operator>> ( RWFile & file, RWTValMap< K, T, C, A > *& p )

related

Looks at the next object on the stream represented by RWFile file 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, the application is responsible for deleting it.

operator>>() [3/4]

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

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

related

Restores the contents of the collection coll from the input stream strm.

operator>>() [4/4]

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

RWvistream & operator>> ( RWvistream & strm, RWTValMap< 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, the application is responsible for deleting it.