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

A pointer-based collection of associations ordered according to a comparison object. More...

#include <rw/tpmap.h>

Public Types
typedef container_type::allocator_type	allocator_type
typedef container_type::const_iterator	const_iterator
typedef container_type::const_pointer	const_pointer
typedef container_type::const_reference	const_reference
typedef const T *const &	const_reference_data
typedef const K *const &	const_reference_key
typedef container_type::const_reverse_iterator	const_reverse_iterator
typedef rw_deref_compare< C, K >	container_comp
typedef std::map< K *, T *, key_compare, A >	container_type
typedef container_type::difference_type	difference_type
typedef container_type::iterator	iterator
typedef rw_deref_compare< C, K >	key_compare
typedef container_type::key_type	key_type
typedef container_type::mapped_type	mapped_type
typedef container_type::pointer	pointer
typedef container_type::reference	reference
typedef T *&	reference_data
typedef K *&	reference_key
typedef container_type::reverse_iterator	reverse_iterator
typedef container_type::size_type	size_type
typedef container_type::value_compare	value_compare
typedef container_type::value_type	value_type
typedef T *	value_type_data
typedef K *	value_type_key

Public Member Functions
	RWTPtrMap (const key_compare &comp=key_compare())
	RWTPtrMap (const container_type &m)
	RWTPtrMap (const RWTPtrMap< K, T, C, A > &rws)
	RWTPtrMap (RWTPtrMap< K, T, C, A > &&map)
	RWTPtrMap (container_type &&map)
template<typename InputIterator >
	RWTPtrMap (InputIterator first, InputIterator last, const key_compare &cmp=key_compare())
void	apply (void(*fn)(const K *, const T *, void *), void *d) const
void	apply (void(*fn)(const K *, mapped_type &, void *), void *d)
void	applyToKeyAndValue (void(*fn)(const K *, const T *, void *), void *d) const
void	applyToKeyAndValue (void(*fn)(const K *, mapped_type &, void *), void *d)
iterator	begin ()
const_iterator	begin () const
const_iterator	cbegin () const
const_iterator	cend () const
void	clear ()
void	clearAndDestroy ()
bool	contains (bool(*fn)(value_type, void *), void *d) const
bool	contains (const K *key) const
const_reverse_iterator	crbegin () const
const_reverse_iterator	crend () const
iterator	end ()
const_iterator	end () const
size_type	entries () const
iterator	erase (iterator pos)
iterator	erase (iterator first, iterator last)
value_type	find (bool(*fn)(value_type, void *), void *d) const
const K *	find (const K *key) const
const K *	findKeyAndValue (const K *key, mapped_type &tr)
const K *	findKeyAndValue (const K *key, const T *&tr) const
mapped_type	findValue (const K *key)
const T *	findValue (const K *key) const
iterator	insert (iterator hint, const_reference val)
template<typename InputIterator >
void	insert (InputIterator first, InputIterator last)
bool	insert (key_type key, mapped_type a)
bool	insertKeyAndValue (key_type key, mapped_type a)
bool	isEmpty () const
const K *	maxElement () const
const K *	minElement () const
size_type	occurrencesOf (bool(*fn)(value_type, void *), void *d) const
size_type	occurrencesOf (const K *k) const
RWTPtrMap< K, T, C, A > &	operator= (const RWTPtrMap< K, T, C, A > &rhs)
RWTPtrMap< K, T, C, A > &	operator= (const container_type &rhs)
RWTPtrMap< K, T, C, A > &	operator= (RWTPtrMap< K, T, C, A > &&rhs)
RWTPtrMap< K, T, C, A > &	operator= (container_type &&rhs)
mapped_type &	operator[] (const K *key)
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
key_type	remove (bool(*fn)(value_type, void *), void *d)
key_type	remove (const K *key)
size_type	removeAll (bool(*fn)(value_type, void *), void *d)
size_type	removeAll (const K *key)
reverse_iterator	rend ()
const_reverse_iterator	rend () const
container_type &	std ()
const container_type &	std () const
void	swap (RWTPtrMap< K, T, C, A > &rhs)

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

This class maintains a pointer-based collection of associations of type std::pair<K* const, T*>. The first part of the association is a key of type K*, the second is its associated item of type T*. Class A is an allocator of objects of class T. For more information about using custom allocators, please see the Essential Tools Module User's Guide.

Order is determined by the key according to a comparison object of type C. C must induce a total ordering on elements of type K via a public member.

bool operator()(const K& x, const K& y)

which returns true if x and its partner should precede y and its partner within the collection. The structure std::less<T> from the C++ Standard Library header file <functional> is an example. Note that keys will be dereferenced before being compared.

RWTPtrMap will not accept a key that compares equal to any key already in the collection. (RWTPtrMultiMap may contain multiple keys that compare equal to each other.) Equality is based on the comparison object and not on the equality operator. Given a comparison object comp, keys a and b are equal if !comp(a,b) && !comp(b,a).

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

Synopsis

#include <rw/tpmap.h>
RWTPtrMap<K,T,C,A> m;

See also

Class RWTPtrMultiMap offers the same interface to a pointer-based collection that accepts multiple keys that compare equal to each other. RWTPtrSet maintains a pointer-based collection of keys without the associated items.

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

Persistence

Isomorphic

Example

//
// tpmap.cpp
//
#include <iostream>
#include <functional>

#include <rw/tpmap.h>
#include <rw/cstring.h>
#include <rw/tools/datetime.h>

int main ()
{
    RWTPtrMap<RWCString, RWDateTime, std::less<RWCString> > birthdays;

    birthdays.insert (new RWCString("John"),
                      new RWDateTime("April 12, 1975", RWDateTime::setDate));

    birthdays.insert (new RWCString("Ivan"),
                      new RWDateTime("Nov 2, 1980", RWDateTime::setDate));

    // Alternative syntax:
    birthdays[new RWCString("Susan")] = new RWDateTime("June 30, 1955", RWDateTime::setDate);
    birthdays[new RWCString("Gene")] = new RWDateTime("Jan 5, 1981", RWDateTime::setDate);

    // Print a birthday:
    RWCString key("John");
    std::cout << birthdays[&key]->asString('x') << std::endl;

    return 0;
}

Program Output:

04/12/75

Member Typedef Documentation

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

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

A type representing the allocator type for the container.

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

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

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

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

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

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

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

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

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

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

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

Deprecated:

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

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

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

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

Deprecated:

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

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

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 RWTPtrMap< K, T, C, A >::const_reverse_iterator

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

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

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

Deprecated:

As of SourcePro 12.5, use key_compare instead.

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

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

typedef std::map< K*, T*, key_compare, A> RWTPtrMap< K, T, C, A >::container_type

A type representing the underlying implementation container.

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

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

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

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

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

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

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

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

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

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

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

A type representing the key of the container.

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

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

A type representing the mapped value of the container.

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

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

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

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

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

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

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

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

Deprecated:

As of SourcePro 12.5, use mapped_type& instead.

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

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

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

Deprecated:

As of SourcePro 12.5, use key_type& instead.

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

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

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

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

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

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

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

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

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

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

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

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

A type representing the container's data type.

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

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

Deprecated:

As of SourcePro 12.5, use mapped_type instead.

Typedef for the type of value.

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

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

Deprecated:

As of SourcePro 12.5, use key_type instead.

Typedef for the type of key.

Constructor & Destructor Documentation

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

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

inline

Constructs an empty map with comparator comp.

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

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

inline

Constructs a map by copying all elements from m.

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

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

inline

Copy constructor.

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

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

inline

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

Condition:

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

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

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

inline

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

Condition:

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

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

template<typename InputIterator >

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

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

void RWTPtrMap< K, T, C, A >::apply	(	void(*)(const K *, const T *, void *)	fn,
		void *	d
	)		const

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

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

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

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

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

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

inline

Deprecated:

As of SourcePro 1, use apply() instead.

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

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

inline

Deprecated:

As of SourcePro 1, use apply() instead.

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

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

inline

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

If the container is empty, returns end().

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

const_iterator RWTPtrMap< 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().

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

const_iterator RWTPtrMap< 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().

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

const_iterator RWTPtrMap< 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.

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

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

inline

Clears the collection by removing all items from self.

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

void RWTPtrMap< K, T, C, A >::clearAndDestroy

(

)

Removes all associations from the collection and uses operator delete to destroy the objects pointed to by the keys and their associated items. Do not use this method if multiple pointers to the same object are stored. (This could happen even if keys all compare different, since items are not considered during comparison.)

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

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

inline

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

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

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

const_reverse_iterator RWTPtrMap< 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().

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

const_reverse_iterator RWTPtrMap< 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.

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

iterator RWTPtrMap< 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.

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

const_iterator RWTPtrMap< 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.

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

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

inline

Returns the number of associations in self.

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

iterator RWTPtrMap< 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.

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

iterator RWTPtrMap< 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.

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

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

inline

If there exists an association a in self such that the expression ((*fn)(a,d)) is true, then returns a. Otherwise, returns value_type(rwnil,rwnil). Client data may be passed through parameter d.

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

const K* RWTPtrMap< K, T, C, A >::find ( const K *  key ) const

inline

If there exists a key j in self that compares equal to *key, then returns j. Otherwise, returns rwnil.

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

const K* RWTPtrMap< K, T, C, A >::findKeyAndValue ( const K *  key, mapped_type &  tr  )

inline

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

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

const K* RWTPtrMap< K, T, C, A >::findKeyAndValue ( const K *  key, const T *&  tr  ) const

inline

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

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

mapped_type RWTPtrMap< K, T, C, A >::findValue ( const K *  key )

inline

If there exists a key j in self that compares equal to *key, returns the item associated with j. Otherwise, returns rwnil.

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

const T* RWTPtrMap< K, T, C, A >::findValue ( const K *  key ) const

inline

If there exists a key j in self that compares equal to *key, returns the item associated with j. Otherwise, returns rwnil.

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

iterator RWTPtrMap< K, T, C, A >::insert ( iterator  hint, const_reference  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.

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

template<typename InputIterator >

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

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

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

inline

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

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

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

inline

Deprecated:

As of SourcePro 1, use insert() instead.

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

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

inline

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

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

const K* RWTPtrMap< K, T, C, A >::maxElement ( ) const

inline

Returns a pointer to the maximum key in the collection. Order is determined according to the comparison object described by the template parameter C.

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

const K* RWTPtrMap< K, T, C, A >::minElement ( ) const

inline

Returns a pointer to the minimum key in the collection. Order is determined according to the comparison object described by the template parameter C.

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

size_type RWTPtrMap< K, T, C, A >::occurrencesOf ( bool(*)(value_type, void *)  fn, void *  d  ) const

inline

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

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

size_type RWTPtrMap< K, T, C, A >::occurrencesOf ( const K *  k ) const

inline

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

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

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

inline

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

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

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

inline

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

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

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

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

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

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

mapped_type& RWTPtrMap< 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 dictionary, then it will be added with an associated uninitialized pointer of type mapped_type. Because of this, if there is a possibility that a key will not be in the dictionary, then this operator should be used only as an lvalue.

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

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

inline

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

If the container is empty, returns rend().

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

const_reverse_iterator RWTPtrMap< 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().

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

key_type RWTPtrMap< K, T, C, A >::remove ( bool(*)(value_type, void *)  fn, void *  d  )

inline

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

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

key_type RWTPtrMap< K, T, C, A >::remove ( const K *  key )

inline

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

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

size_type RWTPtrMap< K, T, C, A >::removeAll	(	bool(*)(value_type, void *)	fn,
		void *	d
	)

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

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

size_type RWTPtrMap< K, T, C, A >::removeAll ( const K *  key )

inline

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

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

reverse_iterator RWTPtrMap< 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.

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

const_reverse_iterator RWTPtrMap< 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.

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

container_type& RWTPtrMap< K, T, C, A >::std ( )

inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.

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

const container_type& RWTPtrMap< K, T, C, A >::std ( ) const

inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.

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

void RWTPtrMap< K, T, C, A >::swap ( RWTPtrMap< K, T, C, A > &  rhs )

inline

Swaps the data owned by self with the data owned by rhs.

Friends And Related Function Documentation

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

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

related

Equivalent to !(lhs == rhs).

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

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

related

Equivalent to !(lhs == rhs).

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

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

related

Equivalent to !(lhs == rhs).

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

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that types K and T have well-defined less-than semantics.

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

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that types K and T have well-defined less-than semantics.

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

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

related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that types K and T have well-defined less-than semantics.

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

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

related

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

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

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

related

Equivalent to !(rhs < lhs).

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

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

related

Equivalent to !(rhs < lhs).

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

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

related

Equivalent to !(rhs < lhs).

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

bool operator== ( const RWTPtrMap< K, T, C, A > &  lhs, const RWTPtrMap< 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. Keys and values are dereferenced before being compared.

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

bool operator== ( const RWTPtrMap< K, T, C, A > &  lhs, const typename RWTPtrMap< 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. Keys and values are dereferenced before being compared.

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

bool operator== ( const typename RWTPtrMap< K, T, C, A >::container_type &  lhs, const RWTPtrMap< 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. Keys and values are dereferenced before being compared.

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

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

related

Equivalent to (rhs < lhs).

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

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

related

Equivalent to (rhs < lhs).

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

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

related

Equivalent to (rhs < lhs).

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

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

related

Equivalent to !(lhs < rhs).

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

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

related

Equivalent to !(lhs < rhs).

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

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

related

Equivalent to !(lhs < rhs).

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

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

related

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

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

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

related

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

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

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

related

Looks at the next object on the input stream strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.

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

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

related

Looks at the next object on the RWFile strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.