 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
\inmodule QtCore More...
#include <qhash.h>
Classes | |
| class | iterator |
| \inmodule QtCore More... | |
| class | const_iterator |
| \inmodule QtCore More... | |
| class | key_iterator |
| \inmodule QtCore More... | |
Public Types | |
| using | key_type = Key |
| using | mapped_type = T |
| using | value_type = T |
| using | size_type = qsizetype |
| using | difference_type = qsizetype |
| using | reference = T & |
| using | const_reference = const T & |
| typedef QKeyValueIterator< const Key &, const T &, const_iterator > | const_key_value_iterator |
| \inmodule QtCore | |
| typedef QKeyValueIterator< const Key &, T &, iterator > | key_value_iterator |
| \inmodule QtCore | |
| typedef iterator | Iterator |
| typedef const_iterator | ConstIterator |
Public Member Functions | |
| QMultiHash () noexcept=default | |
| Constructs an empty hash. | |
| QMultiHash (std::initializer_list< std::pair< Key, T > > list) | |
| template<typename InputIterator, QtPrivate::IfAssociativeIteratorHasKeyAndValue< InputIterator > = true> | |
| QMultiHash (InputIterator f, InputIterator l) | |
| template<typename InputIterator, QtPrivate::IfAssociativeIteratorHasFirstAndSecond< InputIterator > = true> | |
| QMultiHash (InputIterator f, InputIterator l) | |
| QMultiHash (const QMultiHash &other) noexcept | |
| ~QMultiHash () | |
| QMultiHash & | operator= (const QMultiHash &other) noexcept(std::is_nothrow_destructible< Node >::value) |
| QMultiHash (QMultiHash &&other) noexcept | |
| QMultiHash & | operator= (QMultiHash &&other) noexcept(std::is_nothrow_destructible< Node >::value) |
| QMultiHash (const QHash< Key, T > &other) | |
| Constructs a copy of other (which can be a QHash or a QMultiHash). | |
| QMultiHash (QHash< Key, T > &&other) | |
| void | swap (QMultiHash &other) noexcept |
| template<typename Predicate> | |
| qsizetype | removeIf (Predicate pred) |
| T | take (const Key &key) |
| Removes the item with the key from the hash and returns the value associated with it. | |
| bool | contains (const Key &key) const noexcept |
| Key | key (const T &value) const noexcept |
| Key | key (const T &value, const Key &defaultKey) const noexcept |
| T | value (const Key &key) const noexcept |
| T | value (const Key &key, const T &defaultValue) const noexcept |
| Returns the value associated with the key. | |
| T & | operator[] (const Key &key) |
| Returns the value associated with the key as a modifiable reference. | |
| const T | operator[] (const Key &key) const noexcept |
| QList< Key > | uniqueKeys () const |
| QList< Key > | keys () const |
| Returns a list containing all the keys in the hash, in an arbitrary order. | |
| QList< Key > | keys (const T &value) const |
| QList< T > | values () const |
| Returns a list containing all the values in the hash, in an arbitrary order. | |
| QList< T > | values (const Key &key) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns a list of all the values associated with the key, from the most recently inserted to the least recently inserted. | |
| iterator | begin () |
| Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in the hash. | |
| const_iterator | begin () const noexcept |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const_iterator | cbegin () const noexcept |
| const_iterator | constBegin () const noexcept |
| Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item in the hash. | |
| iterator | end () noexcept |
| Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the hash. | |
| const_iterator | end () const noexcept |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const_iterator | cend () const noexcept |
| const_iterator | constEnd () const noexcept |
| Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the hash. | |
| key_iterator | keyBegin () const noexcept |
| key_iterator | keyEnd () const noexcept |
| key_value_iterator | keyValueBegin () noexcept |
| key_value_iterator | keyValueEnd () noexcept |
| const_key_value_iterator | keyValueBegin () const noexcept |
| const_key_value_iterator | constKeyValueBegin () const noexcept |
| const_key_value_iterator | keyValueEnd () const noexcept |
| const_key_value_iterator | constKeyValueEnd () const noexcept |
| auto | asKeyValueRange () & |
| auto | asKeyValueRange () const & |
| auto | asKeyValueRange () && |
| auto | asKeyValueRange () const && |
| iterator | detach (const_iterator it) |
| iterator | erase (const_iterator it) |
| qsizetype | count () const noexcept |
| iterator | find (const Key &key) |
| const_iterator | constFind (const Key &key) const noexcept |
| const_iterator | find (const Key &key) const noexcept |
| iterator | insert (const Key &key, const T &value) |
| Inserts a new item with the key and a value of value. | |
| iterator | insert (const Key &key, T &&value) |
| iterator | insert (Key &&key, const T &value) |
| iterator | insert (Key &&key, T &&value) |
| template<typename ... Args> | |
| iterator | emplace (const Key &key, Args &&... args) |
| template<typename ... Args> | |
| iterator | emplace (Key &&key, Args &&... args) |
| Inserts a new element into the container. | |
| float | load_factor () const noexcept |
| size_t | bucket_count () const noexcept |
| bool | empty () const noexcept |
| iterator | replace (const Key &key, const T &value) |
| Inserts a new item with the key and a value of value. | |
| template<typename ... Args> | |
| iterator | emplaceReplace (const Key &key, Args &&... args) |
| template<typename ... Args> | |
| iterator | emplaceReplace (Key &&key, Args &&... args) |
| Inserts a new element into the container. | |
| QMultiHash & | operator+= (const QMultiHash &other) |
| Inserts all the items in the other hash into this hash and returns a reference to this hash. | |
| QMultiHash | operator+ (const QMultiHash &other) const |
| Returns a hash that contains all the items in this hash in addition to all the items in other. | |
| bool | contains (const Key &key, const T &value) const noexcept |
| qsizetype | remove (const Key &key, const T &value) |
| qsizetype | count (const Key &key) const noexcept |
| qsizetype | count (const Key &key, const T &value) const noexcept |
| iterator | find (const Key &key, const T &value) |
| const_iterator | constFind (const Key &key, const T &value) const noexcept |
| const_iterator | find (const Key &key, const T &value) const noexcept |
| QMultiHash & | unite (const QMultiHash &other) |
| QMultiHash & | unite (const QHash< Key, T > &other) |
| QMultiHash & | unite (QHash< Key, T > &&other) |
| std::pair< iterator, iterator > | equal_range (const Key &key) |
| std::pair< const_iterator, const_iterator > | equal_range (const Key &key) const noexcept |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| qsizetype | remove (const K &key) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| T | take (const K &key) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| bool | contains (const K &key) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| T | value (const K &key) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| T | value (const K &key, const T &defaultValue) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true, if_key_constructible_from< K > = true> | |
| T & | operator[] (const K &key) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| const T | operator[] (const K &key) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| QList< T > | values (const K &key) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| iterator | find (const K &key) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| const_iterator | constFind (const K &key) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| const_iterator | find (const K &key) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| bool | contains (const K &key, const T &value) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| qsizetype | remove (const K &key, const T &value) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| qsizetype | count (const K &key) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| qsizetype | count (const K &key, const T &value) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| iterator | find (const K &key, const T &value) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| const_iterator | constFind (const K &key, const T &value) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| const_iterator | find (const K &key, const T &value) const noexcept |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| std::pair< iterator, iterator > | equal_range (const K &key) |
| template<typename K, if_heterogeneously_searchable< K > = true> | |
| std::pair< const_iterator, const_iterator > | equal_range (const K &key) const noexcept |
Static Public Member Functions | |
| static float | max_load_factor () noexcept |
| static size_t | max_bucket_count () noexcept |
Friends | |
| class | iterator |
| class | const_iterator |
| template<typename AKey = Key, typename AT = T, QTypeTraits::compare_eq_result_container< QMultiHash, AKey, AT > = true> | |
| bool | comparesEqual (const QMultiHash &lhs, const QMultiHash &rhs) noexcept |
Related Symbols | |
(Note that these are not member symbols.) | |
| template< class Key, class T > QDataStream & | operator<< (QDataStream &out, const QMultiHash< Key, T > &hash) |
| Writes the hash hash to stream out. | |
| template< class Key, class T > QDataStream & | operator>> (QDataStream &in, QMultiHash< Key, T > &hash) |
| Reads a hash from stream in into hash. | |
| template< typename Key, typename T, typename Predicate > qsizetype | erase_if (QMultiHash< Key, T > &hash, Predicate pred) |
\inmodule QtCore
The QMultiHash class provides a multi-valued hash table. \compares equality
\reentrant
QMultiHash<Key, T> is one of Qt's generic \l{container classes}, where Key is the type used for lookup keys and T is the mapped value type. It provides a hash table that allows multiple values for the same key.
QMultiHash mostly mirrors QHash's API. For example, you can use isEmpty() to test whether the hash is empty, and you can traverse a QMultiHash using QHash's iterator classes (for example, QHashIterator). But opposed to QHash, it provides an insert() function that allows the insertion of multiple items with the same key. The replace() function corresponds to QHash::insert(). It also provides convenient operator+() and operator+=().
Unlike QMultiMap, QMultiHash does not provide ordering of the inserted items. The only guarantee is that items that share the same key will appear consecutively, from the most recently to the least recently inserted value.
Example:
Unlike QHash, QMultiHash provides no operator[]. Use value() or replace() if you want to access the most recently inserted item with a certain key.
If you want to retrieve all the values for a single key, you can use values(const Key &key), which returns a QList<T>:
The items that share the same key are available from most recently to least recently inserted.
A more efficient approach is to call find() to get the STL-style iterator for the first item with a key and iterate from there:
QMultiHash's key and value data types must be \l{assignable data types}. You cannot, for example, store a QWidget as a value; instead, store a QWidget *. In addition, QMultiHash's key type must provide operator==(), and there must also be a qHash() function in the type's namespace that returns a hash value for an argument of the key's type. See the QHash documentation for details.
| typedef QKeyValueIterator<const Key&, const T&, const_iterator> QMultiHash< Key, T >::const_key_value_iterator |
\inmodule QtCore
The QMultiHash::const_key_value_iterator typedef provides an STL-style const iterator for QMultiHash.
QMultiHash::const_key_value_iterator is essentially the same as QMultiHash::const_iterator with the difference that operator*() returns a key/value pair instead of a value.
| using QMultiHash< Key, T >::const_reference = const T & |
| typedef const_iterator QMultiHash< Key, T >::ConstIterator |
| using QMultiHash< Key, T >::difference_type = qsizetype |
| typedef iterator QMultiHash< Key, T >::Iterator |
| using QMultiHash< Key, T >::key_type = Key |
| typedef QKeyValueIterator<const Key&, T&, iterator> QMultiHash< Key, T >::key_value_iterator |
\inmodule QtCore
The QMultiHash::key_value_iterator typedef provides an STL-style iterator for QMultiHash.
QMultiHash::key_value_iterator is essentially the same as QMultiHash::iterator with the difference that operator*() returns a key/value pair instead of a value.
| using QMultiHash< Key, T >::mapped_type = T |
| using QMultiHash< Key, T >::reference = T & |
| using QMultiHash< Key, T >::size_type = qsizetype |
| using QMultiHash< Key, T >::value_type = T |
|
defaultnoexcept |
Constructs an empty hash.
|
inline |
|
inline |
Constructs a multi-hash with a copy of each of the elements in the iterator range [begin, end). Either the elements iterated by the range must be objects with {first} and {second} data members (like {std::pair}), convertible to Key and to T respectively; or the iterators must have {key()} and {value()} member functions, returning a key convertible to Key and a value convertible to T respectively.
|
inline |
|
inlinenoexcept |
|
inline |
|
inlinenoexcept |
|
inlineexplicit |
Constructs a copy of other (which can be a QHash or a QMultiHash).
|
inlineexplicit |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Returns an iterator pointing to the item with the key and the value in the hash.
If the hash contains no such item, the function returns constEnd().
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first entry in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary entry after the last entry in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inline |
|
inline |
|
inline |
Inserts a new element into the container.
This new element is constructed in-place using args as the arguments for its construction.
If there is already an item with the same key in the hash, this function will simply create a new one. (This behavior is different from replace(), which overwrites the value of an existing item.)
Returns an iterator pointing to the new element.
qhash-iterator-invalidation-func-desc
|
inline |
|
inline |
Inserts a new element into the container.
This new element is constructed in-place using args as the arguments for its construction.
If there is already an item with the same key in the hash, that item's value is replaced with a value constructed from args.
Returns an iterator pointing to the new element.
qhash-iterator-invalidation-func-desc
|
inlinenodiscardnoexcept |
|
inlinenoexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inlinenoexcept |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
|
inlinenoexcept |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
qhash-iterator-invalidation-func-desc
|
inline |
Removes the (key, value) pair associated with the iterator pos from the hash, and returns an iterator to the next item in the hash.
This function never causes QMultiHash to rehash its internal data structure. This means that it can safely be called while iterating, and won't affect the order of items in the hash. For example:
qhash-iterator-invalidation-func-desc
|
inline |
|
inlinenoexcept |
|
inline |
|
inlinenoexcept |
|
inline |
|
inlinenoexcept |
|
inline |
Returns an iterator pointing to the item with the key and value. If the hash contains no such item, the function returns end().
If the hash contains multiple items with the key and value, the iterator returned points to the most recently inserted item.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
qhash-iterator-invalidation-func-desc
|
inline |
Inserts a new item with the key and a value of value.
If there is already an item with the same key in the hash, this function will simply create a new one. (This behavior is different from replace(), which overwrites the value of an existing item.)
Returns an iterator pointing to the new element.
qhash-iterator-invalidation-func-desc
|
inline |
|
inline |
|
inline |
|
inlinenoexcept |
|
inlinenoexcept |
Returns the first key mapped to value. If the hash contains no item mapped to value, returns defaultKey, or a \l{default-constructed value}{default-constructed key} if this parameter has not been supplied.
This function can be slow (\l{linear time}), because QMultiHash's internal data structure is optimized for fast lookup by key, not by value.
|
inlinenoexcept |
|
inlinenoexcept |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last key in the hash.
qhash-iterator-invalidation-func-desc
|
inline |
Returns a list containing all the keys in the hash, in an arbitrary order.
Keys that occur multiple times in the hash also occur multiple times in the list.
The order is guaranteed to be the same as that used by values().
This function creates a new list, in \l {linear time}. The time and memory use that entails can be avoided by iterating from \l keyBegin() to \l keyEnd().
|
inline |
|
inlinenoexcept |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first entry in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first entry in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary entry after the last entry in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary entry after the last entry in the hash.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
|
inlinestaticnoexcept |
|
inlinestaticnoexcept |
|
inline |
Returns a hash that contains all the items in this hash in addition to all the items in other.
If a key is common to both hashes, the resulting hash will contain the key multiple times.
|
inline |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inline |
Returns the value associated with the key as a modifiable reference.
If the hash contains no item with the key, the function inserts a \l{default-constructed value} into the hash with the key, and returns a reference to it.
If the hash contains multiple items with the key, this function returns a reference to the most recently inserted value.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
|
inline |
|
inline |
|
inline |
|
inline |
Removes all elements for which the predicate pred returns true from the multi hash.
The function supports predicates which take either an argument of type {QMultiHash<Key, T>::iterator}, or an argument of type {std::pair<const Key &, T &>}.
Returns the number of elements removed, if any.
|
inline |
Inserts a new item with the key and a value of value.
If there is already an item with the key, that item's value is replaced with value.
If there are multiple items with the key, the most recently inserted item's value is replaced with value.
Returns an iterator pointing to the new/updated element.
qhash-iterator-invalidation-func-desc
|
inlinenoexcept |
|
inline |
|
inline |
Removes the item with the key from the hash and returns the value associated with it.
If the item does not exist in the hash, the function simply returns a \l{default-constructed value}. If there are multiple items for key in the hash, only the most recently inserted one is removed.
If you don't use the return value, remove() is more efficient.
|
inline |
|
inline |
|
inline |
|
inline |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Returns the value associated with the key.
If the hash contains no item with the key, the function returns defaultValue, or a \l{default-constructed value} if this parameter has not been supplied.
If there are multiple items for the key in the hash, the value of the most recently inserted one is returned.
|
inline |
Returns a list containing all the values in the hash, in an arbitrary order.
If a key is associated with multiple values, all of its values will be in the list, and not just the most recently inserted one.
The order is guaranteed to be the same as that used by keys().
This function creates a new list, in \l {linear time}. The time and memory use that entails can be avoided by iterating from \l keyValueBegin() to \l keyValueEnd().
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns a list of all the values associated with the key, from the most recently inserted to the least recently inserted.
|
friend |
|
friend |
|
Removes all elements for which the predicate pred returns true from the multi hash hash.
The function supports predicates which take either an argument of type {QMultiHash<Key, T>::iterator}, or an argument of type {std::pair<const Key &, T &>}.
Returns the number of elements removed, if any.
|
friend |
|
Writes the hash hash to stream out.
This function requires the key and value types to implement operator<<().
Definition at line 603 of file qdatastream.h.
|
Reads a hash from stream in into hash.
This function requires the key and value types to implement operator>>().
Definition at line 603 of file qdatastream.h.
1.16.1