SourcePro C++ 13.0 |
SourcePro® C++ API Reference Guide |
Product Documentation: SourcePro C++ Documentation Home |
Maintains a collection of mappings between two types K and V, implemented as a hash table of std::pair<K,V> instances where multiple occurrences of the same A instance are allowed. More...
#include <rw/stdex/hashmmap.h>
Public Types | |
typedef A | allocator_type |
typedef impl_type::ConstIterator | const_iterator |
typedef impl_type::const_pointer | const_pointer |
typedef impl_type::const_reference | const_reference |
typedef impl_type::difference_type | difference_type |
typedef Hash | hasher |
typedef impl_type::Iterator | iterator |
typedef EQ | key_equal_type |
typedef Hash | key_hash_type |
typedef K | key_type |
typedef V | mapped_type |
typedef impl_type::pointer | pointer |
typedef impl_type::reference | reference |
typedef impl_type::size_type | size_type |
typedef std::pair< const K, V > | value_type |
Public Member Functions | |
rw_hashmultimap (size_type sz=64, const hasher &h=hasher(), const key_equal_type &eq=key_equal_type()) | |
rw_hashmultimap (const rw_hashmultimap< K, V, Hash, EQ, A > &mmap) | |
rw_hashmultimap (rw_hashmultimap< K, V, Hash, EQ, A > &&mmap) | |
template<typename InputIterator > | |
rw_hashmultimap (InputIterator first, InputIterator last, size_type sz=64, const hasher &h=hasher(), const key_equal_type &eq=key_equal_type()) | |
~rw_hashmultimap () | |
iterator | begin () |
const_iterator | begin () const |
More... | |
size_type | capacity () const |
const_iterator | cbegin () const |
More... | |
const_iterator | cend () const |
More... | |
void | clear () |
size_type | count (const key_type &key) const |
bool | empty () const |
iterator | end () |
const_iterator | end () const |
More... | |
bool | equal_by_keys (const rw_hashmultimap< K, V, Hash, EQ, A > &rhs) const |
std::pair< iterator, iterator > | equal_range (const key_type &key) |
std::pair< const_iterator, const_iterator > | equal_range (const key_type &key) const |
size_type | erase (const key_type &key) |
iterator | erase (iterator iter) |
iterator | erase (iterator first, iterator bound) |
float | fill_ratio () const |
const_iterator | find (const key_type &key) const |
iterator | find (const key_type &key) |
std::pair< iterator, bool > | insert (const value_type &val) |
iterator | insert (iterator, const value_type &val) |
std::pair< iterator, bool > | insert (value_type &&val) |
More... | |
iterator | insert (iterator, value_type &&val) |
More... | |
size_type | insert (const value_type *first, const value_type *bound) |
template<typename InputIterator > | |
size_type | insert (InputIterator first, InputIterator last) |
iterator | lower_bound (const key_type &key) |
const_iterator | lower_bound (const key_type &key) const |
More... | |
rw_hashmultimap< K, V, Hash, EQ, A > & | operator= (const rw_hashmultimap< K, V, Hash, EQ, A > &rhs) |
rw_hashmultimap< K, V, Hash, EQ, A > & | operator= (rw_hashmultimap< K, V, Hash, EQ, A > &&rhs) |
void | resize (size_t sz) |
size_type | size () const |
void | swap (rw_hashmultimap< K, V, Hash, EQ, A > &other) |
iterator | upper_bound (const key_type &key) |
const_iterator | upper_bound (const key_type &key) const |
More... | |
Related Functions | |
(Note that these are not member functions.) | |
template<class K , class V , class Hash , class EQ , class A > | |
bool | operator!= (const rw_hashmultimap< K, V, Hash, EQ, A > &lhs, const rw_hashmultimap< K, V, Hash, EQ, A > &rhs) |
template<class K , class V , class Hash , class EQ , class A > | |
bool | operator== (const rw_hashmultimap< K, V, Hash, EQ, A > &lhs, const rw_hashmultimap< K, V, Hash, EQ, A > &rhs) |
Class rw_hashmultimap<K,V,Hash,EQ,A> maintains a collection of mappings between K
and V
, implemented as a hash table of std::pair<const K,V> in which there may be many pairs with the same K
instance. Since this is a value-based collection, objects are copied into and out of the collection. As with all classes that meet the ANSI associative container specification, rw_hashmultimap<K,V,Hash,EQ,A> provides for iterators that reference its elements. Operations that alter the contents of rw_hashmultimap<K,V,Hash,EQ,A> may invalidate other iterators that reference the container. Since the contents of rw_hashmultimap<K,V,Hash,EQ,A> are in pseudo-random order, the only iterator ranges that will usually make sense are the results of calling equal_range(), and the entire range from begin() to end().
Hash
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
.
None
typedef A rw_hashmultimap< K, V, Hash, EQ, A >::allocator_type |
A type representing the allocator type for the container.
typedef impl_type::ConstIterator rw_hashmultimap< K, V, Hash, EQ, A >::const_iterator |
A type that provides a const
forward iterator over the elements in the container.
typedef impl_type::const_pointer rw_hashmultimap< K, V, Hash, EQ, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef impl_type::const_reference rw_hashmultimap< K, V, Hash, EQ, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef impl_type::difference_type rw_hashmultimap< K, V, Hash, EQ, A >::difference_type |
A signed integral type used to indicate the distance between two valid iterators on the same container.
typedef Hash rw_hashmultimap< K, V, Hash, EQ, A >::hasher |
A type representing the hash function.
typedef impl_type::Iterator rw_hashmultimap< K, V, Hash, EQ, A >::iterator |
A type that provides a forward iterator over the elements in the container.
typedef EQ rw_hashmultimap< K, V, Hash, EQ, A >::key_equal_type |
A type representing the equality function.
typedef Hash rw_hashmultimap< K, V, Hash, EQ, A >::key_hash_type |
hasher
instead.A type representing the hash function.
typedef K rw_hashmultimap< K, V, Hash, EQ, A >::key_type |
A type representing the key of the container.
typedef V rw_hashmultimap< K, V, Hash, EQ, A >::mapped_type |
A type representing the mapped value of the container.
typedef impl_type::pointer rw_hashmultimap< K, V, Hash, EQ, A >::pointer |
A type that provides a pointer to an element in the container.
typedef impl_type::reference rw_hashmultimap< K, V, Hash, EQ, A >::reference |
A type that provides a reference to an element in the container.
typedef impl_type::size_type rw_hashmultimap< K, V, Hash, EQ, A >::size_type |
An unsigned integral type used for counting the number of elements in the container.
typedef std::pair<const K,V> rw_hashmultimap< K, V, Hash, EQ, A >::value_type |
A type representing the container's data type.
|
inline |
Constructs an empty rw_hashmultimap<K,V,Hash,EQ,A> with sz slots, using h as the hash object, and eq as the equality comparator.
|
inline |
Constructs an rw_hashmultimap<K,V,Hash,EQ,A> which is a copy of mmap. Each element from mmap is copied into self.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by mmap.
rw_hashmultimap< K, V, Hash, EQ, A >::rw_hashmultimap | ( | InputIterator | first, |
InputIterator | last, | ||
size_type | sz = 64 , |
||
const hasher & | h = hasher() , |
||
const key_equal_type & | eq = key_equal_type() |
||
) |
Constructs an rw_hashmultimap<K,V,Hash,EQ,A> containing a copy of the pair elements in the range [first, last). The rw_hashmultimap instance has sz slots, uses h as its hash object, and eq as its equality comparator.
InputIterator
is an input iterator type where the iterator points to elements that are convertible to value_type objects.
|
inline |
Releases the memory used by the container's implementation.
|
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 slots in the hash table that self uses.
|
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 |
A synonym for erase(begin(),end()) .
|
inline |
Returns the number of pairs in self which have key EQ
to their first element.
mapped_type
to have a default constructor.
|
inline |
Returns true
if self is empty.
|
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 true
if self and rhs have the same size, and if for each distinct key_type
in self, self and rhs have the same number of pairs with first parts that tests EQ
to that instance. Note that this method does not compare the V
(second) part of the pair of the items, so it will run slightly faster than operator==().
|
inline |
Returns std::pair<iterator,iterator>(
lower_bound(), upper_bound())
. The methods, upper_bound() and lower_bound(), have special meaning for hash-based collections.
EQ
to each other are in consecutive iterator locations. Thus, while equal_range() is useful, no other range (except the entire range of the hash table) is likely to be meaningful.mapped_type
to have a default constructor.
|
inline |
Returns std::pair<const_iterator,const_iterator>(
lower_bound(), upper_bound())
. The methods, upper_bound() and lower_bound(), have special meaning for hash-based collections.
EQ
to each other are in consecutive iterator locations. Thus, while equal_range() is useful, no other range (except the entire range of the hash table) is likely to be meaningful.mapped_type
to have a default constructor.
|
inline |
Removes all pairs in self for which the first part is EQ
to key, and returns the number of removed elements.
mapped_type
to have a default constructor.
|
inline |
Removes the element referenced by iter and returns an iterator referencing the next element. If iter does not reference an item in self, the result is undefined.
|
inline |
Removes each element in the range which begins with first and is bounded by bound. Returns an iterator referencing bound. If first does not reference an item in self (and if first and bound are not equal), the effect is undefined.
|
inline |
Returns the result of calculating size() / capacity().
|
inline |
Returns a const_iterator
referencing some pair with key as its first element, if such a pair is contained in self, else returns end().
mapped_type
to have a default constructor.
|
inline |
Returns an iterator
referencing some pair with key as its first element, if such a pair is contained in self, else returns end().
mapped_type
to have a default constructor.
|
inline |
Inserts the pair val, and returns a pair with an iterator referencing the new element and true
.
|
inline |
Inserts the pair val, returning 1
. Note that the first argument is provided only for conformance with the ANSI associative container specification, and is ignored by the method since hash table look up can be done in constant time.
|
inline |
Inserts the pair val, and returns a pair with an iterator referencing the new element and true
.
|
inline |
Inserts the pair val, returning 1
. Note that the first argument is provided only for conformance with the ANSI associative container specification, and is ignored by the method since hash table look up can be done in constant time.
|
inline |
For each element in the range beginning with first and bounded by bound, the element is copied into self. Returns the number of elements inserted.
|
inline |
For each element in the range [first, last), inserts a copy of the element into self. Returns the number of elements inserted.
InputIterator
is an input iterator type where the iterator points to elements that are convertible to value_type objects.
|
inline |
Returns the lower bound of key in self. This has a special meaning for hash-based collections.
Since hash tables are intrinsically unordered, we have relaxed the meaning very slightly so that lower_bound() returns an iterator which points to one of the following:
EQ
to key.mapped_type
to have a default constructor.
|
inline |
Returns the lower bound of key in self. This has a special meaning for hash-based collections.
Since hash tables are intrinsically unordered, we have relaxed the meaning very slightly so that lower_bound() returns an iterator which points to one of the following:
EQ
to key.mapped_type
to have a default constructor.
|
inline |
Sets self to have the same capacity, Hash
and EQ
as rhs, removes all self's current contents, and replaces them with copies of the elements in rhs.
|
inline |
Move assignment. Self takes ownership of the data owned by rhs.
|
inline |
Resizes self's hash table to have sz slots; and re-hashes all self's elements into the new table. Can be very expensive if self holds many elements.
|
inline |
Returns the number of items currently held in self.
|
inline |
Exchanges the contents of self with other, including the Hash
and EQ
objects. This method does not copy or destroy any of the items exchanged but exchanges the underlying hash tables.
|
inline |
Returns the upper bound of key in self. This has a special meaning for hash-based collections.
Since hash tables are intrinsically unordered, we have relaxed the meaning very slightly so that upper_bound() returns an iterator which points to one of the following:
EQ
to key.mapped_type
to have a default constructor.
|
inline |
Returns the upper bound of key in self. This has a special meaning for hash-based collections.
Since hash tables are intrinsically unordered, we have relaxed the meaning very slightly so that upper_bound() returns an iterator which points to one of the following:
EQ
to key.mapped_type
to have a default constructor.
|
related |
Equivalent to !(lhs == rhs)
.
|
related |
Returns true
if lhs and rhs have the same number of elements, and for each value_type
in lhs, there is exactly one corresponding value_type
in rhs that has a first part for which the EQ
object in lhs returns true
, and a second part for which operator==() returns true
. The need to test both parts, and ensure that the matches are one-to-one, means that this operator may be significantly slower than the method equal_by_keys().
mapped_type
to have a default constructor. Copyright © 2014 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.
Provide feedback to Rogue Wave about its documentation.