SourcePro® 2024.1 |
SourcePro® API Reference Guide |
A hash-based associative container of pointer types, which allows duplicate keys. More...
#include <rw/tphmmap.h>
Public Member Functions | |
RWTPtrHashMultiMap () | |
RWTPtrHashMultiMap (const container_type &m) | |
RWTPtrHashMultiMap (const H &h, size_type sz=64) | |
RWTPtrHashMultiMap (const RWTPtrHashMultiMap< K, T, H, EQ, A > &rws) | |
RWTPtrHashMultiMap (container_type &&map) | |
template<typename InputIterator > | |
RWTPtrHashMultiMap (InputIterator first, InputIterator last) | |
RWTPtrHashMultiMap (RWTPtrHashMultiMap< 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 |
RWTPtrHashMultiMap< K, T, H, EQ, A > & | operator= (const container_type &rhs) |
RWTPtrHashMultiMap< K, T, H, EQ, A > & | operator= (const RWTPtrHashMultiMap< K, T, H, EQ, A > &rhs) |
RWTPtrHashMultiMap< K, T, H, EQ, A > & | operator= (container_type &&rhs) |
RWTPtrHashMultiMap< K, T, H, EQ, A > & | operator= (RWTPtrHashMultiMap< K, T, H, EQ, A > &&rhs) |
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) |
void | resize (size_type sz) |
container_type & | std () |
const container_type & | std () const |
void | swap (RWTPtrHashMultiMap< 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 RWTPtrHashMultiMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrHashMultiMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &file, RWTPtrHashMultiMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &file, RWTPtrHashMultiMap< K, T, H, EQ, A > *&p) |
template<class K , class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrHashMultiMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrHashMultiMap< 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
function that takes a single argument convertible to type K
and returns a value of type size_t
.
Equivalent keys within the collection are grouped together based on an equality object of type EQ
. EQ
must ensure this grouping via a function that takes two arguments convertible to type K
and returns a value of type bool
.
This class allows multiple keys that are equivalent to each other. Use the class RWTPtrHashMap if you need a collection that does not accept duplicate keys. Equality is based on the comparison object and not on operator==().
The value type must have operator==() defined. This requirement is imposed by the C++ Standard Library.
Class RWTPtrHashMap offers the same interface to a pointer-based collection that does not accept multiple keys that compare equal to each other.
rw_hashmultimap<K*,T*,hasher,key_equal,A> is the C++ Standard Library-style collection that serves as the underlying implementation for this class.
Program Output:
typedef container_type::allocator_type RWTPtrHashMultiMap< K, T, H, EQ, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTPtrHashMultiMap< K, T, H, EQ, A >::const_iterator |
A type that provides a const
forward iterator over the elements in the container.
typedef container_type::const_pointer RWTPtrHashMultiMap< K, T, H, EQ, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTPtrHashMultiMap< K, T, H, EQ, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef const T* const& RWTPtrHashMultiMap< K, T, H, EQ, A >::const_reference_data |
const T* const&
instead.Typedef for a const
reference to the type of data in this container.
typedef const K* const& RWTPtrHashMultiMap< K, T, H, EQ, A >::const_reference_key |
const K* const&
instead.Typedef for a const
reference to a key in this container.
typedef rw_deref_compare<EQ, K> RWTPtrHashMultiMap< K, T, H, EQ, A >::container_eq |
A type representing an equality function that dereferences the arguments before comparing.
typedef rw_deref_hash<H, K> RWTPtrHashMultiMap< K, T, H, EQ, A >::container_hash |
A type representing a hash function that dereferences the arguments before comparing.
typedef rw_hashmultimap<K*, T*, hasher, key_equal, A> RWTPtrHashMultiMap< K, T, H, EQ, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTPtrHashMultiMap< K, T, H, EQ, A >::difference_type |
A signed integral type used to indicate the distance between two valid iterators on the same container.
typedef rw_deref_hash<H, K> RWTPtrHashMultiMap< K, T, H, EQ, A >::hasher |
A type representing a hash function that dereferences the arguments before comparing.
typedef container_type::iterator RWTPtrHashMultiMap< K, T, H, EQ, A >::iterator |
A type that provides a forward iterator over the elements in the container.
typedef rw_deref_compare<EQ, K> RWTPtrHashMultiMap< K, T, H, EQ, A >::key_equal |
A type representing an equality function that dereferences the arguments before comparing.
typedef container_type::key_type RWTPtrHashMultiMap< K, T, H, EQ, A >::key_type |
A type representing the key of the container.
typedef container_type::mapped_type RWTPtrHashMultiMap< K, T, H, EQ, A >::mapped_type |
A type representing the mapped type of the container.
typedef container_type::pointer RWTPtrHashMultiMap< K, T, H, EQ, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTPtrHashMultiMap< K, T, H, EQ, A >::reference |
A type that provides a reference to an element in the container.
typedef T*& RWTPtrHashMultiMap< K, T, H, EQ, A >::reference_data |
Typedef for a non-const
reference to the type of data in this container.
typedef K*& RWTPtrHashMultiMap< K, T, H, EQ, A >::reference_key |
Typedef for a non-const
reference to a key in this container.
typedef container_type::size_type RWTPtrHashMultiMap< K, T, H, EQ, A >::size_type |
An unsigned integral type used for counting the number of elements in the container.
typedef container_type::value_type RWTPtrHashMultiMap< K, T, H, EQ, A >::value_type |
A type representing the container's data type.
typedef T* RWTPtrHashMultiMap< K, T, H, EQ, A >::value_type_data |
Typedef for the type of value.
typedef K* RWTPtrHashMultiMap< K, T, H, EQ, A >::value_type_key |
Typedef for the type of key.
|
inline |
Constructs an empty map.
|
inline |
Constructs a multi-map by doing an element by element copy from the C++ Standard Library-style hashed multi-map m.
|
inline |
Copy constructor.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by map.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by map.
|
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.
|
inline |
Creates an empty hashed multi-map that uses the hash object h and has an initial capacity of sz.
void RWTPtrHashMultiMap< 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.
void RWTPtrHashMultiMap< 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.
|
inline |
|
inline |
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns the number of buckets (slots) available in the underlying hash representation.
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns 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.
|
inline |
Clears the collection by removing all associations from self.
void RWTPtrHashMultiMap< K, T, H, EQ, 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 it is possible that the container holds multiple pointers to the same object because the results are unpredictable.
|
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.
|
inline |
Returns true
if there exists a key j
in self that compares equal to *key
, otherwise returns false
.
|
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.
|
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.
|
inline |
Returns the number of associations in self.
|
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.
|
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.
|
inline |
Returns the ratio entries() / capacity().
|
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.
|
inline |
If there exists a key j
in self that compares equal to *key
, returns j
, otherwise returns rwnil.
|
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.
|
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.
|
inline |
If there exists a key j
in self that compares equal to *key
, returns the item associated with j
, otherwise returns rwnil.
|
inline |
If there exists a key j
in self that compares equal to *key
, returns the item associated with j
, otherwise returns rwnil.
|
inline |
Inserts the elements in the range [first, last) into self.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Inserts val into self. 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.
|
inline |
Adds key with associated item a to the collection. Returns true
.
|
inline |
|
inline |
Returns true
if there are no items in the collection, otherwise returns false
.
|
inline |
Returns a reference to the maximum key in the collection. Type K
must have well-defined less-than semantics (K::operator<(const K&)
or equivalent).
|
inline |
Returns a reference to the minimum key in the collection. Type K
must have well-defined less-than semantics (K::operator<(const K&)
or equivalent).
|
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.
|
inline |
Returns the number of keys j
in self that compare equal to *key
.
|
inline |
Destroys all associations in self and replaces them by copying all associations from rhs.
|
inline |
Destroys all associations in self and replaces them by copying all associations from rhs.
|
inline |
Move assignment. Self takes ownership of the data owned by rhs.
|
inline |
Move assignment. Self takes ownership of the data owned by rhs.
|
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.
|
inline |
Removes the first association with key j
in self that compares equal to *key
. Returns rwnil if there is no such association.
size_type RWTPtrHashMultiMap< 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 removed. Client data may be passed through parameter d.
|
inline |
Removes all associations with key j
in self that compare equal to *key
. Returns the number of associations removed.
|
inline |
Changes the capacity of self by creating a new hashed multi-map with a capacity of sz. The copies resize
every association in self into the new container and finally swaps the internal representation of the new container with self.
|
inline |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
|
inline |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
|
inline |
Swaps the data owned by self with the data owned by rhs.
|
related |
Streams the collection coll to the RWFile file, or a reference to it if it has already been saved.
|
related |
Saves the collection coll onto the output stream strm, or a reference to it if it has already been saved.
|
related |
Restores the contents of the collection coll by streaming from the RWFile file.
|
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.
|
related |
Restores the contents of the collection coll from the input stream strm.
|
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.
Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |