SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A hash-based associative container of pointer types. More...
#include <rw/tphdict.h>
Inherits RW_PMapAssoc< rw_hashmap< K *, T *, rw_deref_hash< H, K >, rw_deref_compare< EQ, K >,A >, RWTPtrHashMap< K, T, H, EQ,A >, K, T, std::less< K > >.
Public Types | |
typedef rw_deref_hash< H, K > | container_hash |
typedef rw_deref_compare< EQ, K > | container_eq |
typedef rw_hashmap< K *, T *, rw_deref_hash< H, K > , rw_deref_compare< EQ, K >,A > | container_type |
typedef container_type::size_type | size_type |
typedef container_type::difference_type | difference_type |
typedef container_type::iterator | iterator |
typedef container_type::const_iterator | const_iterator |
typedef container_type::value_type | value_type |
typedef container_type::reference | reference |
typedef container_type::const_reference | const_reference |
typedef K * | value_type_key |
typedef T * | value_type_data |
typedef K *& | reference_key |
typedef T *& | reference_data |
typedef const K *const & | const_reference_key |
typedef const T *const & | const_reference_data |
Public Member Functions | |
container_type & | std () |
const container_type & | std () const |
void | apply (void(*fn)(const K *, const T *, void *), void *d) const |
void | apply (void(*fn)(const K *, T *&, void *), void *d) |
void | applyToKeyAndValue (void(*fn)(const K *, const T *, void *), void *d) const |
void | applyToKeyAndValue (void(*fn)(const K *, T *&, void *), void *d) |
iterator | begin () |
const_iterator | begin () const |
iterator | end () |
const_iterator | end () const |
bool | isEmpty () const |
size_type | entries () const |
bool | contains (bool(*fn)(value_type, void *), void *d) const |
bool | contains (const K *key) const |
value_type | find (bool(*fn)(value_type, void *), void *d) const |
const K * | find (const K *key) const |
T * | findValue (const K *key) |
const T * | findValue (const K *key) const |
const K * | findKeyAndValue (const K *key, T *&tr) |
const K * | findKeyAndValue (const K *key, const T *&tr) const |
const K * | minElement () const |
const K * | maxElement () const |
K * | removeKeyAndValue (const K *key, T *&retVal) |
size_type | occurrencesOf (bool(*fn)(value_type, void *), void *d) const |
size_type | occurrencesOf (const K *key) const |
K * | remove (bool(*fn)(value_type, void *), void *d) |
K * | remove (const K *key) |
size_type | removeAll (bool(*fn)(value_type, void *), void *d) |
size_type | removeAll (const K *key) |
void | clear () |
void | clearAndDestroy () |
bool | operator== (const RWTPtrHashMap< K, T, H, EQ, A > &m) const |
bool | operator!= (const RWTPtrHashMap< K, T, H, EQ, A > &m) const |
bool | insert (K *key, T *a) |
bool | insertKeyAndValue (K *key, T *a) |
T *& | operator[] (K *key) |
size_type | capacity () const |
float | fillRatio () const |
void | resize (size_type sz) |
RWTPtrHashMap< K, T, H, EQ,A > & | operator= (const RWTPtrHashMap< K, T, H, EQ, A > &rhs) |
RWTPtrHashMap< K, T, H, EQ,A > & | operator= (const container_type &rhs) |
RWTPtrHashMap< K, T, H, EQ,A > & | operator= (RWTPtrHashMap< K, T, H, EQ, A > &&rhs) |
RWTPtrHashMap () | |
RWTPtrHashMap (const container_type &m) | |
RWTPtrHashMap (const RWTPtrHashMap< K, T, H, EQ, A > &rws) | |
RWTPtrHashMap (RWTPtrHashMap< K, T, H, EQ, A > &&map) | |
RWTPtrHashMap (value_type *first, value_type *last) | |
RWTPtrHashMap (const H &h, size_type sz=64) | |
void | swap (RWTPtrHashMap< 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 RWTPtrHashMap< K, T, H, EQ, A > &coll) |
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 > | |
RWvistream & | operator>> (RWvistream &strm, 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 > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrHashMap< K, T, H, EQ, A > *&p) |
template<class K , class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &file, RWTPtrHashMap< K, T, H, EQ, A > *&p) |
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
hash function on elements of type K
via public member:
unsigned long operator()(const K& x) const;
Equivalent keys are detected based on an equality object of type EQ
, which detects equality through its public member
bool operator()(const K& x, const K& y) const;
which should return true
if x
and y
are equivalent. An attempt to insert a duplicate association fails, as described for the insert() method.
This class does not allow duplicate keys, that is, keys that are equivalent to a key already in the collection. Use the class RWTPtrHashMultiMap<K,T,H,EQ,A> 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.
#include <rw/tphdict.h> RWTPtrHashMap<K,T,H,EQ,A> m;
Class RWTPtrHashMultiMap<K,T,H,EQ,A> offers the same interface to a pointer-based collection that accepts multiple keys that compare equal to each other.
Class rw_hashmap<K*,T*,rw_deref_hash<H,K>,rw_deref_compare<C,K>,A> is the C++ Standard Library-style collection that serves as the underlying implementation for this collection.
Isomorphic
// // tphmap.cpp // #include<iostream> #include<functional> #include<rw/tphdict.h> #include<rw/cstring.h> 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.
typedef container_type::const_iterator RWTPtrHashMap< K, T, H, EQ, A >::const_iterator |
Typedef for the const
iterator.
typedef container_type::const_reference RWTPtrHashMap< K, T, H, EQ, A >::const_reference |
Typedef for a const
reference to a value in this container.
typedef const T* const& RWTPtrHashMap< K, T, H, EQ, A >::const_reference_data |
Typedef for a const
reference to the type of data in this container.
typedef const K* const& RWTPtrHashMap< K, T, H, EQ, A >::const_reference_key |
Typedef for a const
reference to a key in this container.
typedef rw_deref_compare<EQ,K> RWTPtrHashMap< K, T, H, EQ, A >::container_eq |
Typedef for the equality object.
typedef rw_deref_hash<H,K> RWTPtrHashMap< K, T, H, EQ, A >::container_hash |
Typedef for the hashing object.
typedef rw_hashmap<K*,T*,rw_deref_hash<H,K>,rw_deref_compare<EQ,K> ,A > RWTPtrHashMap< K, T, H, EQ, A >::container_type |
Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::difference_type RWTPtrHashMap< K, T, H, EQ, A >::difference_type |
Typedef for the type of difference between iterators.
typedef container_type::iterator RWTPtrHashMap< K, T, H, EQ, A >::iterator |
Typedef for the non-const
iterator.
typedef container_type::reference RWTPtrHashMap< K, T, H, EQ, A >::reference |
Typedef for a non-const
reference to a value in this container.
typedef T*& RWTPtrHashMap< K, T, H, EQ, A >::reference_data |
Typedef for a non-const
reference to the type of data in this container.
typedef K*& RWTPtrHashMap< K, T, H, EQ, A >::reference_key |
Typedef for a non-const
reference to a key in this container.
typedef container_type::size_type RWTPtrHashMap< K, T, H, EQ, A >::size_type |
Typedef for the type used to index into this container.
typedef container_type::value_type RWTPtrHashMap< K, T, H, EQ, A >::value_type |
Typedef for the type of elements in this container.
typedef T* RWTPtrHashMap< K, T, H, EQ, A >::value_type_data |
Typedef for the type of value.
typedef K* RWTPtrHashMap< K, T, H, EQ, A >::value_type_key |
Typedef for the type of key.
RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap | ( | ) | [inline] |
Constructs an empty hashmap.
RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap | ( | const container_type & | m | ) | [inline] |
Constructs a pointer-based hashmap by copying all associations from m.
RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap | ( | const RWTPtrHashMap< K, T, H, EQ, A > & | rws | ) | [inline] |
Copy constructor.
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.
RWTPtrHashMap< K, T, H, EQ, A >::RWTPtrHashMap | ( | value_type * | first, | |
value_type * | last | |||
) | [inline] |
Constructs a hashmap by copying associations from the array of associations pointed to by first, up to, but not including, the association pointed to by last.
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.
void RWTPtrHashMap< K, T, H, EQ, A >::apply | ( | void(*)(const K *, T *&, void *) | fn, | |
void * | d | |||
) | [inline] |
Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.
void RWTPtrHashMap< K, T, H, EQ, A >::apply | ( | void(*)(const K *, const T *, void *) | fn, | |
void * | d | |||
) | const [inline] |
Applies the user-defined function pointed to by fn to every association in the collection. Client data may be passed through parameter d.
void RWTPtrHashMap< K, T, H, EQ, A >::applyToKeyAndValue | ( | void(*)(const K *, T *&, void *) | fn, | |
void * | d | |||
) | [inline] |
void RWTPtrHashMap< K, T, H, EQ, A >::applyToKeyAndValue | ( | void(*)(const K *, const T *, void *) | fn, | |
void * | d | |||
) | const [inline] |
const_iterator RWTPtrHashMap< K, T, H, EQ, A >::begin | ( | ) | const [inline] |
Returns an iterator positioned at the first association in self.
iterator RWTPtrHashMap< K, T, H, EQ, A >::begin | ( | ) | [inline] |
Returns an iterator positioned at the first association in self.
size_type RWTPtrHashMap< K, T, H, EQ, A >::capacity | ( | ) | const [inline] |
Returns the number of buckets (slots) available in the underlying hash representation.
void RWTPtrHashMap< K, T, H, EQ, A >::clear | ( | void | ) | [inline] |
Clears the collection by removing all items from self.
void RWTPtrHashMap< 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 usiing this method when there are duplicates results in unpredictable behavior.
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
.
bool RWTPtrHashMap< 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.
const_iterator RWTPtrHashMap< K, T, H, EQ, A >::end | ( | ) | const [inline] |
Returns an iterator positioned "just past" the last association in self.
iterator RWTPtrHashMap< K, T, H, EQ, A >::end | ( | ) | [inline] |
Returns an iterator positioned "just past" the last association in self.
size_type RWTPtrHashMap< K, T, H, EQ, A >::entries | ( | void | ) | const [inline] |
Returns the number of associations in self.
float RWTPtrHashMap< K, T, H, EQ, A >::fillRatio | ( | ) | const [inline] |
Returns the ratio entries() / capacity().
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.
value_type RWTPtrHashMap< K, T, H, EQ, A >::find | ( | bool(*)(value_type, void *) | fn, | |
void * | d | |||
) | const [inline] |
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.
const K* RWTPtrHashMap< K, T, H, EQ, A >::findKeyAndValue | ( | const K * | key, | |
T *& | 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.
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.
T* 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.
bool RWTPtrHashMap< K, T, H, EQ, A >::insert | ( | K * | key, | |
T * | a | |||
) | [inline] |
Adds key with associated item a to the collection. Returns true
if the insertion is successful, otherwise returns false
. The function will return true
unless the collection already holds an association with the equivalent key.
bool RWTPtrHashMap< K, T, H, EQ, A >::insertKeyAndValue | ( | K * | key, | |
T * | a | |||
) | [inline] |
bool RWTPtrHashMap< K, T, H, EQ, A >::isEmpty | ( | ) | const [inline] |
Returns true
if there are no items in the collection, otherwise returns false
.
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).
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).
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
.
size_type RWTPtrHashMap< 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.
bool RWTPtrHashMap< K, T, H, EQ, A >::operator!= | ( | const RWTPtrHashMap< K, T, H, EQ, A > & | m | ) | const [inline] |
Returns the negation of operator==().
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.
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.
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.
bool RWTPtrHashMap< K, T, H, EQ, A >::operator== | ( | const RWTPtrHashMap< K, T, H, EQ, A > & | m | ) | const [inline] |
Returns true
if self compares equal to m, otherwise returns false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual keys that compare equal to each other. Keys are dereferenced before being compared.
T*& RWTPtrHashMap< K, T, H, EQ, A >::operator[] | ( | K * | 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 T*
. 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.
K* 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.
K* RWTPtrHashMap< 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.
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.
size_type RWTPtrHashMap< K, T, H, EQ, A >::removeAll | ( | bool(*)(value_type, void *) | fn, | |
void * | d | |||
) | [inline] |
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.
K* RWTPtrHashMap< K, T, H, EQ, A >::removeKeyAndValue | ( | const K * | key, | |
T *& | retVal | |||
) | [inline] |
If std::find(key)
would succeed, erases the pair associated with key, places the value part in retVal, and returns key. Otherwise, returns rwnil.
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.
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.
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.
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.
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.
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.
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.
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.
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.
RWvistream & operator>> | ( | RWvistream & | strm, | |
RWTPtrHashMap< K, T, H, EQ, A > & | coll | |||
) | [related] |
Restores the contents of the collection coll from the input stream strm.
© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.