RWTPtrOrderedHashMap< K, T, H, EQ, A > Class Template Reference

Maintains a collection of key pointers, each with an associated item of pointer type stored according to both a hash object and the key insertion order. More...

#include <rw/tools/tpordhmap.h>

Public Types
typedef container_type::allocator_type	allocator_type
typedef container_type::const_iterator	const_iterator
typedef container_type::const_pointer	const_pointer
typedef container_type::const_reference	const_reference
typedef rw_orderedhashmap< K *, T *, hasher, key_equal, A >	container_type
typedef container_type::difference_type	difference_type
typedef rw_deref_hash< H, K >	hasher
typedef container_type::iterator	iterator
typedef rw_deref_compare< EQ, K >	key_equal
typedef container_type::key_type	key_type
typedef container_type::mapped_type	mapped_type
typedef container_type::pointer	pointer
typedef container_type::reference	reference
typedef container_type::size_type	size_type
typedef container_type::value_type	value_type

Public Member Functions
	RWTPtrOrderedHashMap ()
	RWTPtrOrderedHashMap (const container_type &m)
	RWTPtrOrderedHashMap (const RWTPtrOrderedHashMap< K, T, H, EQ, A > &rws)
	RWTPtrOrderedHashMap (RWTPtrOrderedHashMap< K, T, H, EQ, A > &&map)
	RWTPtrOrderedHashMap (container_type &&map)
template<typename InputIterator >
	RWTPtrOrderedHashMap (InputIterator first, InputIterator last)
	RWTPtrOrderedHashMap (const H &h, size_type sz=64)
void	apply (void(*fn)(const K *, const T *, void *), void *d) const
void	apply (void(*fn)(const K *, mapped_type &, void *), void *d)
iterator	begin ()
const_iterator	begin () const
size_type	capacity () const
const_iterator	cbegin () const
const_iterator	cend () const
void	clear ()
void	clearAndDestroy ()
bool	contains (bool(*fn)(value_type, void *), void *d) const
bool	contains (const K *key) const
iterator	end ()
const_iterator	end () const
size_type	entries () const
iterator	erase (iterator pos)
iterator	erase (iterator first, iterator last)
float	fillRatio () const
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	isEmpty () const
const K *	maxElement () const
const K *	minElement () const
size_type	occurrencesOf (bool(*fn)(value_type, void *), void *d) const
size_type	occurrencesOf (const K *key) const
RWTPtrOrderedHashMap< K, T, H, EQ, A > &	operator= (const RWTPtrOrderedHashMap< K, T, H, EQ, A > &rhs)
RWTPtrOrderedHashMap< K, T, H, EQ, A > &	operator= (const container_type &rhs)
RWTPtrOrderedHashMap< K, T, H, EQ, A > &	operator= (RWTPtrOrderedHashMap< K, T, H, EQ, A > &&rhs)
RWTPtrOrderedHashMap< K, T, H, EQ, A > &	operator= (container_type &&rhs)
mapped_type &	operator[] (key_type key)
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)
key_type	removeKeyAndValue (const K *key, mapped_type &retVal)
void	resize (size_type sz)
container_type &	std ()
const container_type &	std () const
void	swap (RWTPtrOrderedHashMap< K, T, H, EQ, A > &rhs)

Related Functions
(Note that these are not member functions.)
template<class K , class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrOrderedHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &file, const RWTPtrOrderedHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrOrderedHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTPtrOrderedHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrOrderedHashMap< K, T, H, EQ, A > *&p)
template<class K , class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTPtrOrderedHashMap< K, T, H, EQ, A > *&p)

Detailed Description

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

RWTPtrOrderedHashMap maintains a collection of K key pointers, each with an associated item that is a pointer of type T. These std::pair<K* const, T*> pairs are stored according to a hash object of type H. RWTPtrOrderedHashMap preserves key insertion order.

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.

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

Note

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

Key equality is determined by an equality function of type EQ, which takes two arguments convertible to type K and returns a value of type bool.

Note

Any two keys that are equivalent are disallowed for this container.

This class does not allow duplicate keys, that is, keys that are equivalent to a key already in the collection. Use the class RWTPtrOrderedHashMultiMap if you need multiple keys to be equivalent to each other. Equality is based on the comparison object, not on operator==().

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

Synopsis

#include <rw/tools/tpordhmap.h>
RWTPtrOrderedHashMap<K,T,H,EQ,A> m;

See also

Class RWTPtrOrderedHashMultiMap offers the same interface to a pointer-based collection that accepts multiple keys that compare equal to each other.

Class rw_orderedhashmap<K*,T*,hasher,key_equal,A> is the C++ Standard Library-style collection that serves as the underlying implementation for this class.

Persistence

Isomorphic

Member Typedef Documentation

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

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

A type representing the allocator type for the container.

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

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

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

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

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

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

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

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

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

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

typedef rw_orderedhashmap< K*, T*, hasher, key_equal, A> RWTPtrOrderedHashMap< K, T, H, EQ, A >::container_type

A type representing the underlying implementation container.

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

typedef container_type::difference_type RWTPtrOrderedHashMap< K, T, H, EQ, 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 H = RWTHash<K>, class EQ = std::equal_to<K>, class A = std::allocator<K*>>

typedef rw_deref_hash<H, K> RWTPtrOrderedHashMap< K, T, H, EQ, A >::hasher

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

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

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

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

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

typedef rw_deref_compare<EQ, K> RWTPtrOrderedHashMap< K, T, H, EQ, A >::key_equal

A type representing an equality function that dereferences the arguments before comparing.

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

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

A type representing the key of the container.

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

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

A type representing the mapped type of the container.

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

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

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

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

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

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

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

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

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

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

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

A type representing the container's data type.

Constructor & Destructor Documentation

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

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

inline

Constructs an empty hashmap.

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

RWTPtrOrderedHashMap< K, T, H, EQ, A >::RWTPtrOrderedHashMap ( const container_type &  m )

inline

Constructs a pointer-based hashmap by copying all associations from m.

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

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

inline

Copy constructor.

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

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

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

template<typename InputIterator >

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

inline

Constructs a map by copying elements from the range [first, last).

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

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

RWTPtrOrderedHashMap< K, T, H, EQ, A >::RWTPtrOrderedHashMap ( const H &  h, size_type  sz = 64  )

inline

Creates an empty hashmap that uses the hash object h and has an initial capacity of sz.

Member Function Documentation

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

void RWTPtrOrderedHashMap< K, T, H, EQ, 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 H , class EQ , class A >

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

iterator RWTPtrOrderedHashMap< K, T, H, EQ, A >::begin ( )

inline

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

If the container is empty, returns end().

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

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

inline

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

If the container is empty, returns end().

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

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

inline

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

See also

resize()

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

const_iterator RWTPtrOrderedHashMap< K, T, H, EQ, A >::cbegin ( ) const

inline

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

If the container is empty, returns end().

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

const_iterator RWTPtrOrderedHashMap< K, T, H, EQ, A >::cend ( ) const

inline

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

Dereferencing the iterator returned by this function results in undefined behavior.

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

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

inline

Clears the collection by removing all items from self.

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

void RWTPtrOrderedHashMap< K, T, H, EQ, A >::clearAndDestroy ( void  )

inline

Removes all associations from the collection and uses operator delete to destroy the objects pointed to by the keys and their associated items. It is important that the equality object associated with this container successfully exclude duplicate entries, since using this method when there are duplicates results in unpredictable behavior.

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

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

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

iterator RWTPtrOrderedHashMap< K, T, H, EQ, A >::end ( )

inline

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

Dereferencing the iterator returned by this function results in undefined behavior.

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

const_iterator RWTPtrOrderedHashMap< K, T, H, EQ, A >::end ( ) const

inline

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

Dereferencing the iterator returned by this function results in undefined behavior.

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

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

inline

Returns the number of associations in self.

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

iterator RWTPtrOrderedHashMap< K, T, H, EQ, A >::erase ( iterator  pos )

inline

Removes the item pointed to by pos from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.

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

iterator RWTPtrOrderedHashMap< K, T, H, EQ, A >::erase ( iterator  first, iterator  last  )

inline

Removes the items in the range [first, last) from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.

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

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

inline

Returns the ratio entries() / capacity().

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

value_type RWTPtrOrderedHashMap< K, T, H, EQ, 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, returns a, otherwise returns value_type(rwnil,rwnil). Client data may be passed through parameter d.

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

const K* RWTPtrOrderedHashMap< K, T, H, EQ, A >::find ( const K *  key ) const

inline

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

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

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

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

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

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

iterator RWTPtrOrderedHashMap< K, T, H, EQ, 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 hash object.

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

template<typename InputIterator >

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

bool RWTPtrOrderedHashMap< K, T, H, EQ, 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. The function will return true unless the collection already holds an association with the equivalent key.

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

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

inline

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

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

const K* RWTPtrOrderedHashMap< K, T, H, EQ, A >::maxElement ( ) const

inline

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

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

const K* RWTPtrOrderedHashMap< K, T, H, EQ, A >::minElement ( ) const

inline

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

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

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

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

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

inline

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

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

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

inline

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

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

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

inline

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

Condition:

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

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

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

inline

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

Condition:

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

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

mapped_type& RWTPtrOrderedHashMap< K, T, H, EQ, A >::operator[] ( key_type  key )

inline

Looks up key and returns a reference to its associated item. If the key is not in the dictionary, it is 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, this operator should be used only as an lvalue.

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

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

key_type RWTPtrOrderedHashMap< K, T, H, EQ, 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 H , class EQ , class A >

RWTPtrOrderedHashMap< K, T, H, EQ, A >::size_type RWTPtrOrderedHashMap< K, T, H, EQ, 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 of associations removed. Client data may be passed through parameter d.

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

size_type RWTPtrOrderedHashMap< K, T, H, EQ, A >::removeAll ( const K *  key )

inline

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

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

key_type RWTPtrOrderedHashMap< K, T, H, EQ, A >::removeKeyAndValue ( const K *  key, mapped_type &  retVal  )

inline

If find(key) succeeds, erases the pair associated with key, places the value part in retVal, and returns key. Otherwise, returns rwnil.

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

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

inline

Changes the capacity of self by creating a new hashmap with a capacity of sz. Then copies every association in self into the new container and finally swaps the internal representation of the new container with the internal representation of self.

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

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

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

void RWTPtrOrderedHashMap< K, T, H, EQ, A >::swap ( RWTPtrOrderedHashMap< K, T, H, EQ, 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 H , class EQ , class A >

RWvostream & operator<< ( RWvostream &  strm, const RWTPtrOrderedHashMap< K, T, H, EQ, 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 H , class EQ , class A >

RWFile & operator<< ( RWFile &  file, const RWTPtrOrderedHashMap< K, T, H, EQ, A > &  coll  )

related

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

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

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

related

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

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

RWFile & operator>> ( RWFile &  file, RWTPtrOrderedHashMap< K, T, H, EQ, A > &  coll  )

related

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

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

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

RWFile & operator>> ( RWFile &  file, RWTPtrOrderedHashMap< K, T, H, EQ, A > *&  p  )

related

Looks at the next object from the streamed 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.