RWTValMap< K, T, C, A > Class Template Reference
[STL-based Collections]

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

#include <rw/tvmap.h>

Inherits RW_VMapAssoc< std::map< K, T, C,A >, RWTValMap< K, T, C,A >, K, T, C >.

List of all members.

Public Types
typedef std::map< K, T, C,A >	container_type
typedef container_type::iterator	iterator
typedef container_type::const_iterator	const_iterator
typedef container_type::size_type	size_type
typedef container_type::value_type	value_type
typedef container_type::reference	reference
typedef container_type::const_reference	const_reference
Public Member Functions
container_type &	std ()
const container_type &	std () const
void	apply (void(*fn)(const K &, const T &, void *), void *d) const
void	apply (void(*fn)(const K &, T &, void *), void *d)
void	applyToKeyAndValue (void(*fn)(const K &, const T &, void *), void *d) const
void	applyToKeyAndValue (void(*fn)(const K &, T &, void *), void *d)
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
bool	isEmpty () const
size_type	entries () const
bool	operator== (const container_type &m) const
bool	operator== (const RWTValMap< K, T, C, A > &m) const
bool	operator!= (const container_type &stdc) const
bool	operator!= (const RWTValMap< K, T, C, A > &rwc) const
bool	operator< (const container_type &m) const
bool	operator< (const RWTValMap< K, T, C, A > &m) const
void	clear ()
bool	contains (bool(*fn)(const_reference, void *), void *d) const
bool	contains (const K &key) const
bool	find (bool(*fn)(const_reference, void *), void *d, std::pair< K, T > &r) const
bool	find (const K &key, K &r) const
bool	findValue (const K &key, T &r) const
bool	findKeyAndValue (const K &key, K &kr, T &tr) const
const K &	minElement () const
const K &	maxElement () const
size_type	occurrencesOf (bool(*fn)(const_reference, void *), void *d) const
size_type	occurrencesOf (const K &key) const
bool	remove (bool(*fn)(const_reference, void *), void *d)
bool	remove (const K &key)
size_type	removeAll (bool(*fn)(const_reference, void *), void *d)
size_type	removeAll (const K &key)
bool	insert (const K &key, const T &a)
bool	insert (K &&key, T &&a)
T &	operator[] (const K &key)
void	swap (RWTValMap< K, T, C, A > &other)
RWTValMap< K, T, C,A > &	operator= (const RWTValMap< K, T, C, A > &m)
RWTValMap< K, T, C,A > &	operator= (const container_type &m)
RWTValMap< K, T, C,A > &	operator= (RWTValMap< K, T, C, A > &&rhs)
	RWTValMap (const C &cmp=C())
	RWTValMap (const container_type &m)
	RWTValMap (const RWTValMap< K, T, C, A > &rws)
	RWTValMap (RWTValMap< K, T, C, A > &&rws)
	RWTValMap (const value_type *first, const value_type *last, const C &cmp=C())
Related Functions
(Note that these are not member functions.)
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 >
RWFile &	operator<< (RWFile &file, const RWTValMap< K, T, C, A > &coll)
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 >
RWFile &	operator>> (RWFile &file, 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)
template<class K , class T , class C , class A >
RWFile &	operator>> (RWFile &file, RWTValMap< K, T, C, A > *&p)

---

Detailed Description

template<class K, class T, class C, 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;

Related Classes

Class RWTValMultiMap<K,T,C,A> offers the same interface to a collection that accepts multiple keys that compare equal to each other. RWTValSet<T,C,A> maintains a collection of keys without the associated values.

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

Persistence

Isomorphic.

Examples

 #include <iostream>
 #include <functional>
 #include <rw/tvmap.h>
 #include <rw/cstring.h>
 #include <rw/tools/datetime.h>
 
 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

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

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

Typedef for the const iterator.

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

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

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

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

typedef std::map<K,T,C ,A > RWTValMap< K, T, C, A >::container_type

Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.

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

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

Typedef for the non-const iterator.

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

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

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

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

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

Typedef for the type used to index into this container.

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

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

Typedef for the type of elements in this container.

---

Constructor & Destructor Documentation

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

RWTValMap< K, T, C, A >::RWTValMap

(

const C &

cmp = C()

)

[inline]

Constructs an empty map with comparator cmp.

template<class K, class T, class C, 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.

template<class K, class T, class C, 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.

template<class K, class T, class C, 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 only available on platforms with rvalue reference support.

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

RWTValMap< K, T, C, A >::RWTValMap	(	const value_type *	first,
		const value_type *	last,
		const C &	cmp = C()
	)			[inline]

Constructs a map by copying elements from the array of value_type pairs pointed to by first, up to, but not including, the pair pointed to by last.

---

Member Function Documentation

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

void RWTValMap< K, T, C, A >::apply	(	void(*)(const K &, T &, void *)	fn,
		void *	d
	)			[inline]

Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.

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

void RWTValMap< K, T, C, A >::apply	(	void(*)(const K &, const T &, void *)	fn,
		void *	d
	)			const [inline]

Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.

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

void RWTValMap< K, T, C, A >::applyToKeyAndValue	(	void(*)(const K &, T &, void *)	fn,
		void *	d
	)			[inline]

Deprecated:

Use apply() instead.

Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.

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

void RWTValMap< K, T, C, A >::applyToKeyAndValue	(	void(*)(const K &, const T &, void *)	fn,
		void *	d
	)			const [inline]

Deprecated:

Use apply() instead.

Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.

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

const_iterator RWTValMap< K, T, C, A >::begin

(

)

const [inline]

Returns an iterator positioned at the first pair in self.

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

iterator RWTValMap< K, T, C, A >::begin

(

)

[inline]

Returns an iterator positioned at the first pair in self.

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

void RWTValMap< K, T, C, A >::clear

(

void

)

[inline]

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

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

bool RWTValMap< 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.

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

bool RWTValMap< K, T, C, A >::contains	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			const [inline]

Returns true if there exists an association a in self such that the expression ((*fn)(a,d)) is true, otherwise returns false. Client data may be passed through parameter d.

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

const_iterator RWTValMap< K, T, C, A >::end

(

)

const [inline]

Returns an iterator positioned "just past" the last association in self.

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

iterator RWTValMap< K, T, C, A >::end

(

)

[inline]

Returns an iterator positioned "just past" the last association in self.

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

size_type RWTValMap< K, T, C, A >::entries

(

void

)

const [inline]

Returns the number of associations in self.

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

bool RWTValMap< K, T, C, A >::find	(	const K &	key,
		K &	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.

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

bool RWTValMap< K, T, C, A >::find	(	bool(*)(const_reference, void *)	fn,
		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.

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

bool RWTValMap< K, T, C, A >::findKeyAndValue	(	const K &	key,
		K &	kr,
		T &	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.

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

bool RWTValMap< K, T, C, A >::findValue	(	const K &	key,
		T &	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.

template<class K, class T, class C, 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 only available on platforms with rvalue reference support.

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

bool RWTValMap< K, T, C, A >::insert	(	const K &	key,
		const 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.

template<class K, class T, class C, 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.

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

const K& 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.

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

const K& 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.

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

size_type RWTValMap< K, T, C, A >::occurrencesOf

(

const K &

key

)

const [inline]

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

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

size_type RWTValMap< K, T, C, A >::occurrencesOf	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			const [inline]

Returns the number of associations a in self such that the expression ((*fn)(a,d)) is true. Client data may be passed through parameter d.

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

bool RWTValMap< K, T, C, A >::operator!=

(

const RWTValMap< K, T, C, A > &

rwc

)

const [inline]

Returns the negation of operator==().

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

bool RWTValMap< K, T, C, A >::operator!=

(

const container_type &

stdc

)

const [inline]

Returns the negation of operator==().

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

bool RWTValMap< K, T, C, A >::operator<

(

const RWTValMap< K, T, C, A > &

m

)

const [inline]

Returns true if self compares lexicographically less than m, otherwise returns false. Assumes that type K has well-defined less-than semantics (T::operator<(const K&) or equivalent).

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

bool RWTValMap< K, T, C, A >::operator<

(

const container_type &

m

)

const [inline]

Returns true if self compares lexicographically less than m, otherwise returns false. Assumes that type K has well-defined less-than semantics (T::operator<(const K&) or equivalent).

template<class K, class T, class C, 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 only available on platforms with rvalue reference support.

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

RWTValMap<K,T,C ,A >& RWTValMap< K, T, C, A >::operator=

(

const container_type &

m

)

[inline]

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

template<class K, class T, class C, 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 > &

m

)

[inline]

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

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

bool RWTValMap< K, T, C, A >::operator==

(

const RWTValMap< K, T, C, A > &

m

)

const [inline]

Returns true if self compares equal to m, otherwise returns false. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual pairs that compare equal to each other.

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

bool RWTValMap< K, T, C, A >::operator==

(

const container_type &

m

)

const [inline]

Returns true if self compares equal to m, otherwise returns false. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual pairs that compare equal to each other.

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

T& RWTValMap< K, T, C, A >::operator[]

(

const K &

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

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

bool RWTValMap< K, T, C, A >::remove

(

const K &

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.

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

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

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

size_type RWTValMap< K, T, C, A >::removeAll

(

const K &

key

)

[inline]

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

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

size_type RWTValMap< K, T, C, A >::removeAll	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			[inline]

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.

template<class K, class T, class C, 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 C++ Standard Library collections.

template<class K, class T, class C, 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 C++ Standard Library collections.

template<class K, class T, class C, 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 Function Documentation

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.

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.

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.

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.

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.

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.