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

A hash-based associative container of pointer types. More...

#include <rw/tphdict.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 rw_deref_compare< EQ, T >	container_eq
typedef rw_deref_hash< H, T >	container_hash
typedef rw_hashmap< 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 T *&	reference_data
typedef K *&	reference_key
typedef container_type::size_type	size_type
typedef container_type::value_type	value_type
typedef T *	value_type_data
typedef K *	value_type_key

Public Member Functions
	RWTPtrHashMap ()
	RWTPtrHashMap (const container_type &m)
	RWTPtrHashMap (const H &h, size_type sz=64)
	RWTPtrHashMap (const RWTPtrHashMap< K, T, H, EQ, A > &rws)
	RWTPtrHashMap (container_type &&map)
template<typename InputIterator >
	RWTPtrHashMap (InputIterator first, InputIterator last)
	RWTPtrHashMap (RWTPtrHashMap< K, T, H, EQ, A > &&map)
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
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 first, iterator last)
iterator	erase (iterator pos)
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, const T *&tr) const
const K *	findKeyAndValue (const K *key, mapped_type &tr)
mapped_type	findValue (const K *key)
const T *	findValue (const K *key) const
template<typename InputIterator >
void	insert (InputIterator first, InputIterator last)
iterator	insert (iterator hint, const value_type &val)
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 *key) const
RWTPtrHashMap< K, T, H, EQ, A > &	operator= (const container_type &rhs)
RWTPtrHashMap< K, T, H, EQ, A > &	operator= (const RWTPtrHashMap< K, T, H, EQ, A > &rhs)
RWTPtrHashMap< K, T, H, EQ, A > &	operator= (container_type &&rhs)
RWTPtrHashMap< K, T, H, EQ, A > &	operator= (RWTPtrHashMap< K, T, H, EQ, A > &&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 (RWTPtrHashMap< K, T, H, EQ, A > &rhs)

Related Symbols
(Note that these are not member symbols.)
template<class K , class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &file, const RWTPtrHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTPtrHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTPtrHashMap< K, T, H, EQ, A > *&p)
template<class K , class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrHashMap< K, T, H, EQ, A > &coll)
template<class K , class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrHashMap< 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 RWTPtrHashMap< K, T, H, EQ, A >

This class maintains a pointer-based collection of associations of type std::pair<K* const, T*>. These pairs are stored according to a hash object of type H. Class T is the type pointed to by the items in the collection. 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 RWTPtrHashMultiMap 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/tphdict.h>
RWTPtrHashMap<K, T, H, EQ, A> m;

See also

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

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

Persistence

Isomorphic

Example

//
// tphmap.cpp
//
#include <rw/cstring.h>
#include <rw/tphdict.h>
#include <functional>
#include <iostream>
 
struct simple_hash {
  unsigned long operator()(const RWCString& ref) const {
    size_t n = ref.length();
    return (unsigned long)(n ? n * size_t(ref[0]) : 0);
  }
};
 
int main() {
  RWCString snd = "Second";
 
  RWTPtrHashMap<RWCString, int, simple_hash, std::equal_to<RWCString> >
      contest;
 
  contest.insert(new RWCString("First"), new int(7));
  contest.insert(&snd, new int(3));
 
  // duplicate insertion rejected
  contest.insert(&snd, new int(6));
 
  contest.insert(new RWCString("Third"), new int(2));
 
  std::cout << "There was "
            << contest.occurrencesOf(new RWCString("Second"))
            << " second place winner." << std::endl;
 
  return 0;
}

Program Output:

There was 1 second place winner.

Member Typedef Documentation

allocator_type

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

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

A type representing the allocator type for the container.

const_iterator

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

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

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

const_pointer

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

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

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

const_reference

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

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

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

const_reference_data

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

typedef const T* const& RWTPtrHashMap< K, T, H, EQ, 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.

const_reference_key

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

typedef const K* const& RWTPtrHashMap< K, T, H, EQ, 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.

container_eq

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, T> RWTPtrHashMap< K, T, H, EQ, A >::container_eq

Deprecated

As of SourcePro 12.5, use key_equal instead.

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

container_hash

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, T> RWTPtrHashMap< K, T, H, EQ, A >::container_hash

Deprecated

As of SourcePro 12.5, use hasher instead.

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

container_type

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

typedef rw_hashmap<K*, T*, hasher, key_equal, A> RWTPtrHashMap< K, T, H, EQ, A >::container_type

A type representing the underlying implementation container.

difference_type

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

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

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

hasher

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

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

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

iterator

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

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

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

key_equal

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

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

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

key_type

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

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

A type representing the key of the container.

mapped_type

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

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

A type representing the mapped type of the container.

pointer

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

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

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

reference

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

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

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

reference_data

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

typedef T*& RWTPtrHashMap< K, T, H, EQ, 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.

reference_key

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

typedef K*& RWTPtrHashMap< K, T, H, EQ, 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.

size_type

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

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

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

value_type

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

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

A type representing the container's data type.

value_type_data

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

typedef T* RWTPtrHashMap< K, T, H, EQ, A >::value_type_data

Deprecated

As of SourcePro 12.5, use mapped_type instead.

Typedef for the type of value.

value_type_key

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

typedef K* RWTPtrHashMap< K, T, H, EQ, A >::value_type_key

Deprecated

As of SourcePro 12.5, use key_type instead.

Typedef for the type of key.

Constructor & Destructor Documentation

RWTPtrHashMap() [1/7]

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

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

inline

Constructs an empty hashmap.

RWTPtrHashMap() [2/7]

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

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

inline

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

RWTPtrHashMap() [3/7]

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

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

inline

Copy constructor.

RWTPtrHashMap() [4/7]

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

RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap ( RWTPtrHashMap< 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.

RWTPtrHashMap() [5/7]

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

RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap ( 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.

RWTPtrHashMap() [6/7]

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

template<typename InputIterator >

RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap ( 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.

RWTPtrHashMap() [7/7]

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

RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap ( 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

apply() [1/2]

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

void RWTPtrHashMap< K, T, H, EQ, A >::apply	(	void(*	fn )(const K *, const T *, void *),
		void *	d ) const

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

apply() [2/2]

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

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

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

applyToKeyAndValue() [1/2]

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

void RWTPtrHashMap< K, T, H, EQ, A >::applyToKeyAndValue ( void(* fn )(const K *, const T *, void *), void * d ) const

inline

Deprecated

As of SourcePro 1, use apply() instead.

applyToKeyAndValue() [2/2]

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

void RWTPtrHashMap< K, T, H, EQ, A >::applyToKeyAndValue ( void(* fn )(const K *, mapped_type &, void *), void * d )

inline

Deprecated

As of SourcePro 1, use apply() instead.

begin() [1/2]

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

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

inline

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

If the container is empty, returns end().

begin() [2/2]

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

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

inline

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

If the container is empty, returns end().

capacity()

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

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

inline

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

See also

resize()

cbegin()

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

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

inline

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

If the container is empty, returns end().

cend()

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

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

inline

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

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

clear()

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

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

inline

Clears the collection by removing all items from self.

clearAndDestroy()

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

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

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.

contains() [1/2]

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

bool RWTPtrHashMap< K, T, H, EQ, A >::contains ( bool(* fn )(value_type, void *), void * d ) const

inline

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

contains() [2/2]

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

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

end() [1/2]

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

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

inline

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

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

end() [2/2]

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

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

inline

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

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

entries()

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

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

inline

Returns the number of associations in self.

erase() [1/2]

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

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

inline

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

erase() [2/2]

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

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

inline

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

fillRatio()

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

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

inline

Returns the ratio entries() / capacity().

find() [1/2]

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

value_type RWTPtrHashMap< K, T, H, EQ, A >::find ( bool(* fn )(value_type, void *), 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.

find() [2/2]

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

const K * RWTPtrHashMap< 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.

findKeyAndValue() [1/2]

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

const K * RWTPtrHashMap< 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.

findKeyAndValue() [2/2]

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

const K * RWTPtrHashMap< 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.

findValue() [1/2]

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

mapped_type RWTPtrHashMap< 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.

findValue() [2/2]

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

const T * RWTPtrHashMap< 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.

insert() [1/3]

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

template<typename InputIterator >

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

insert() [2/3]

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

iterator RWTPtrHashMap< K, T, H, EQ, A >::insert ( iterator hint, const value_type & val )

inline

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

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

insert() [3/3]

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

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

insertKeyAndValue()

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

bool RWTPtrHashMap< K, T, H, EQ, A >::insertKeyAndValue ( key_type key, mapped_type a )

inline

Deprecated

As of SourcePro 1, use insert() instead.

isEmpty()

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

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

inline

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

maxElement()

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

const K * RWTPtrHashMap< 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).

minElement()

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

const K * RWTPtrHashMap< 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).

occurrencesOf() [1/2]

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

size_type RWTPtrHashMap< K, T, H, EQ, A >::occurrencesOf ( bool(* fn )(value_type, void *), void * d ) const

inline

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

occurrencesOf() [2/2]

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

size_type RWTPtrHashMap< K, T, H, EQ, A >::occurrencesOf ( const K * key ) const

inline

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

operator=() [1/4]

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

RWTPtrHashMap< K, T, H, EQ, A > & RWTPtrHashMap< 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.

operator=() [2/4]

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

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

inline

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

operator=() [3/4]

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

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

inline

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

Condition:

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

operator=() [4/4]

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

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

operator[]()

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

mapped_type & RWTPtrHashMap< 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, is 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 only be used as an lvalue.

remove() [1/2]

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

key_type RWTPtrHashMap< K, T, H, EQ, A >::remove ( bool(* fn )(value_type, void *), 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.

remove() [2/2]

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

key_type RWTPtrHashMap< 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.

removeAll() [1/2]

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

size_type RWTPtrHashMap< K, T, H, EQ, A >::removeAll	(	bool(*	fn )(value_type, void *),
		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.

removeAll() [2/2]

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

size_type RWTPtrHashMap< 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.

removeKeyAndValue()

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

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

inline

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

resize()

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

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

std() [1/2]

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

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

inline

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

std() [2/2]

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

const container_type & RWTPtrHashMap< 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.

swap()

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

void RWTPtrHashMap< K, T, H, EQ, A >::swap ( RWTPtrHashMap< K, T, H, EQ, A > & rhs )

inline

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

Friends And Related Symbol Documentation

operator<<() [1/2]

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

RWFile & operator<< ( RWFile & file, const RWTPtrHashMap< 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.

operator<<() [2/2]

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

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

operator>>() [1/4]

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

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

related

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

operator>>() [2/4]

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

RWFile & operator>> ( RWFile & file, RWTPtrHashMap< 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.

operator>>() [3/4]

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

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

related

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

operator>>() [4/4]

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

RWvistream & operator>> ( RWvistream & strm, RWTPtrHashMap< 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.