QHash Class

The QHash class is a template class that provides a hash-table-based dictionary.

All functions in this class are reentrant.

Article lu fois.

L'auteur

The Qt Company Ltd.

L'article

Publié le 26 janvier 2024 - Mis à jour le 26 janvier 2024

Liens sociaux

QHash Class▲

Header: QHash
CMake:

find_package(Qt6 REQUIRED COMPONENTS Core)

target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
Inherited By:
Group: QHash is part of tools, Implicitly Shared Classes

Detailed Description▲

QHash<Key, T> is one of Qt's generic container classes. It stores (key, value) pairs and provides very fast lookup of the value associated with a key.

QHash provides very similar functionality to QMap. The differences are:

QHash provides faster lookups than QMap. (See Algorithmic Complexity for details.)
When iterating over a QMap, the items are always sorted by key. With QHash, the items are arbitrarily ordered.
The key type of a QMap must provide operator<(). The key type of a QHash must provide operator==() and a global hash function called qHash() (see qHash).

Here's an example QHash with QString keys and int values:

Sélectionnez

QHash&lt;QString, int&gt; hash;

To insert a (key, value) pair into the hash, you can use operator[]():

Sélectionnez

hash["one"] = 1;
hash["three"] = 3;
hash["seven"] = 7;

This inserts the following three (key, value) pairs into the QHash: ("one", 1), ("three", 3), and ("seven", 7). Another way to insert items into the hash is to use insert():

Sélectionnez

hash.insert("twelve", 12);

To look up a value, use operator[]() or value():

Sélectionnez

int num1 = hash["thirteen"];
int num2 = hash.value("thirteen");

If there is no item with the specified key in the hash, these functions return a default-constructed value.

If you want to check whether the hash contains a particular key, use contains():

Sélectionnez

int timeout = 30;
if (hash.contains("TIMEOUT"))
    timeout = hash.value("TIMEOUT");

There is also a value() overload that uses its second argument as a default value if there is no item with the specified key:

Sélectionnez

int timeout = hash.value("TIMEOUT", 30);

In general, we recommend that you use contains() and value() rather than operator[]() for looking up a key in a hash. The reason is that operator[]() silently inserts an item into the hash if no item exists with the same key (unless the hash is const). For example, the following code snippet will create 1000 items in memory:

Sélectionnez

// WRONG
QHash&lt;int, QWidget *&gt; hash;
...
for (int i = 0; i &lt; 1000; ++i) {
    if (hash[i] == okButton)
        cout &lt;&lt; "Found button at index " &lt;&lt; i &lt;&lt; Qt::endl;
}

To avoid this problem, replace hash[i] with hash.value(i) in the code above.

Internally, QHash uses a hash table to perform lookups. This hash table automatically grows to provide fast lookups without wasting too much memory. You can still control the size of the hash table by calling reserve() if you already know approximately how many items the QHash will contain, but this isn't necessary to obtain good performance. You can also call capacity() to retrieve the hash table's size.

QHash will not shrink automatically if items are removed from the table. To minimize the memory used by the hash, call squeeze().

If you want to navigate through all the (key, value) pairs stored in a QHash, you can use an iterator. QHash provides both Java-style iterators (QHashIterator and QMutableHashIterator) and STL-style iterators (QHash::const_iterator and QHash::iterator). Here's how to iterate over a QHash<QString, int> using a Java-style iterator:

Sélectionnez

QHashIterator&lt;QString, int&gt; i(hash);
while (i.hasNext()) {
    i.next();
    cout &lt;&lt; i.key() &lt;&lt; ": " &lt;&lt; i.value() &lt;&lt; Qt::endl;
}

Here's the same code, but using an STL-style iterator:

Sélectionnez

QHash&lt;QString, int&gt;::const_iterator i = hash.constBegin();
while (i != hash.constEnd()) {
    cout &lt;&lt; i.key() &lt;&lt; ": " &lt;&lt; i.value() &lt;&lt; Qt::endl;
    ++i;
}

QHash is unordered, so an iterator's sequence cannot be assumed to be predictable. If ordering by key is required, use a QMap.

A QHash allows only one value per key. If you call insert() with a key that already exists in the QHash, the previous value is erased. For example:

Sélectionnez

hash.insert("plenty", 100);
hash.insert("plenty", 2000);
// hash.value("plenty") == 2000

If you need to store multiple entries for the same key in the hash table, use QMultiHash.

If you only need to extract the values from a hash (not the keys), you can also use foreach:

Sélectionnez

QHash&lt;QString, int&gt; hash;
...
foreach (int value, hash)
    cout &lt;&lt; value &lt;&lt; Qt::endl;

Items can be removed from the hash in several ways. One way is to call remove(); this will remove any item with the given key. Another way is to use QMutableHashIterator::remove(). In addition, you can clear the entire hash using clear().

QHash's key and value data types must be assignable data types. You cannot, for example, store a QWidget as a value; instead, store a QWidget *.

The hashing function▲

A QHash's key type has additional requirements other than being an assignable data type: it must provide operator==(), and there must also be a hashing function that returns a hash value for an argument of the key's type.

The hashing function computes a numeric value based on a key. It can use any algorithm imaginable, as long as it always returns the same value if given the same argument. In other words, if e1 == e2, then hash(e1) == hash(e2) must hold as well. However, to obtain good performance, the hashing function should attempt to return different hash values for different keys to the largest extent possible.

A hashing function for a key type K may be provided in two different ways.

The first way is by having an overload of qHash() in K's namespace. The qHash() function must have one of these signatures:

Sélectionnez

size_t qHash(K key);
size_t qHash(const K &amp;key);

size_t qHash(K key, size_t seed);
size_t qHash(const K &amp;key, size_t seed);

The two-arguments overloads take an unsigned integer that should be used to seed the calculation of the hash function. This seed is provided by QHash in order to prevent a family of algorithmic complexity attacks. If both a one-argument and a two-arguments overload are defined for a key type, the latter is used by QHash (note that you can simply define a two-arguments version, and use a default value for the seed parameter).

The second way to provide a hashing function is by specializing the std::hash class for the key type K, and providing a suitable function call operator for it:

Sélectionnez

namespace std {
template &lt;&gt; struct hash&lt;K&gt;
{
    // seed is optional
    size_t operator()(const K &amp;key, size_t seed = 0) const;
};
}

The seed argument has the same meaning as for qHash(), and may be left out.

This second way allows to reuse the same hash function between QHash and the C++ Standard Library unordered associative containers. If both a qHash() overload and a std::hash specializations are provided for a type, then the qHash() overload is preferred.

Here's a partial list of the C++ and Qt types that can serve as keys in a QHash: any integer type (char, unsigned long, etc.), any pointer type, QChar, QString, and QByteArray. For all of these, the <QHash> header defines a qHash() function that computes an adequate hash value. Many other Qt classes also declare a qHash overload for their type; please refer to the documentation of each class.

If you want to use other types as the key, make sure that you provide operator==() and a hash implementation.

The convenience qHashMulti() function can be used to implement qHash() for a custom type, where one usually wants to produce a hash value from multiple fields:

Example:

Sélectionnez

#ifndef EMPLOYEE_H
#define EMPLOYEE_H

class Employee
{
public:
    Employee() {}
    Employee(const QString &amp;name, QDate dateOfBirth);
    ...

private:
    QString myName;
    QDate myDateOfBirth;
};

inline bool operator==(const Employee &amp;e1, const Employee &amp;e2)
{
    return e1.name() == e2.name()
           &amp;&amp; e1.dateOfBirth() == e2.dateOfBirth();
}

inline size_t qHash(const Employee &amp;key, size_t seed)
{
    return qHashMulti(seed, key.name(), key.dateOfBirth());
}

#endif // EMPLOYEE_H

In the example above, we've relied on Qt's own implementation of qHash() for QString and QDate to give us a hash value for the employee's name and date of birth respectively.

Note that the implementation of the qHash() overloads offered by Qt may change at any time. You must not rely on the fact that qHash() will give the same results (for the same inputs) across different Qt versions.

Algorithmic complexity attacks▲

All hash tables are vulnerable to a particular class of denial of service attacks, in which the attacker carefully pre-computes a set of different keys that are going to be hashed in the same bucket of a hash table (or even have the very same hash value). The attack aims at getting the worst-case algorithmic behavior (O(n) instead of amortized O(1), see Algorithmic Complexity for the details) when the data is fed into the table.

In order to avoid this worst-case behavior, the calculation of the hash value done by qHash() can be salted by a random seed, that nullifies the attack's extent. This seed is automatically generated by QHash once per process, and then passed by QHash as the second argument of the two-arguments overload of the qHash() function.

This randomization of QHash is enabled by default. Even though programs should never depend on a particular QHash ordering, there may be situations where you temporarily need deterministic behavior, for example for debugging or regression testing. To disable the randomization, define the environment variable QT_HASH_SEED to have the value 0. Alternatively, you can call the QHashSeed::setDeterministicGlobalSeed() function.

Member Type Documentation▲

QHash::ConstIterator▲

Qt-style synonym for QHash::const_iterator.

QHash::Iterator▲

Qt-style synonym for QHash::iterator.

[since 5.10] QHash::const_key_value_iterator▲

The QHash::const_key_value_iterator typedef provides an STL-style const iterator for QHash.

QHash::const_key_value_iterator is essentially the same as QHash::const_iterator with the difference that operator*() returns a key/value pair instead of a value.

This typedef was introduced in Qt 5.10.

[alias] QHash::difference_type▲

Typedef for ptrdiff_t. Provided for STL compatibility.

[alias] QHash::key_type▲

Typedef for Key. Provided for STL compatibility.

[since 5.10] QHash::key_value_iterator▲

The QHash::key_value_iterator typedef provides an STL-style iterator for QHash.

QHash::key_value_iterator is essentially the same as QHash::iterator with the difference that operator*() returns a key/value pair instead of a value.

This typedef was introduced in Qt 5.10.

[alias] QHash::mapped_type▲

Typedef for T. Provided for STL compatibility.

[alias] QHash::size_type▲

Typedef for int. Provided for STL compatibility.

Member Function Documentation▲

T QHash::value(const Key &key) const▲

T QHash::value(const Key &key, const T &defaultValue) const

This is an overloaded function.

Returns the value associated with the key.

If the hash contains no item with the key, the function returns defaultValue, or a default-constructed value if this parameter has not been supplied.

Key QHash::key(const T &value) const▲

Key QHash::key(const T &value, const Key &defaultKey) const

Returns the first key mapped to value. If the hash contains no item mapped to value, returns defaultKey, or a default-constructed key if this parameter has not been supplied.

This function can be slow (linear time), because QHash's internal data structure is optimized for fast lookup by key, not by value.

[since 6.4] auto QHash::asKeyValueRange() &▲

[since 6.4] auto QHash::asKeyValueRange() &&

[since 6.4] auto QHash::asKeyValueRange() const &

[since 6.4] auto QHash::asKeyValueRange() const &&

Returns a range object that allows iteration over this hash as key/value pairs. For instance, this range object can be used in a range-based for loop, in combination with a structured binding declaration:

Sélectionnez

QHash&lt;QString, int&gt; hash;
hash.insert("January", 1);
hash.insert("February", 2);
// ...
hash.insert("December", 12);

for (auto [key, value] : hash.asKeyValueRange()) {
    cout &lt;&lt; key &lt;&lt; ": " &lt;&lt; value &lt;&lt; Qt::endl;
    --value; // convert to JS month indexing
}

Note that both the key and the value obtained this way are references to the ones in the hash. Specifically, mutating the value will modify the hash itself.

This function was introduced in Qt 6.4.

QHash::iterator QHash::emplace(Key &&key, Args &&... args)▲

QHash::iterator QHash::emplace(const Key &key, Args &&... args)

Inserts a new element into the container. This new element is constructed in-place using args as the arguments for its construction.

Returns an iterator pointing to the new element.

QHash::QHash()▲

Constructs an empty hash.

[since 5.1] QHash::QHash(std::initializer_list<std::pair<Key, T>> list)▲

Constructs a hash with a copy of each of the elements in the initializer list list.

This function was introduced in Qt 5.1.

QHash::QHash(const QHash<Key, T> &other)▲

Constructs a copy of other.

This operation occurs in constant time, because QHash is implicitly shared. This makes returning a QHash from a function very fast. If a shared instance is modified, it will be copied (copy-on-write), and this takes linear time.

[since 5.2] QHash::QHash(QHash<Key, T> &&other)▲

Move-constructs a QHash instance, making it point at the same object that other was pointing to.

This function was introduced in Qt 5.2.

[since 5.14] QHash::QHash(InputIterator begin, InputIterator end)▲

Constructs a 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 QPair, std::pair, etc.) 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.

This function was introduced in Qt 5.14.

QHash::~QHash()▲

Destroys the hash. References to the values in the hash and all iterators of this hash become invalid.

QHash::iterator QHash::begin()▲

Returns an STL-style iterator pointing to the first item in the hash.

QHash::const_iterator QHash::begin() const▲

This is an overloaded function.

qsizetype QHash::capacity() const▲

Returns the number of buckets in the QHash's internal hash table.

The sole purpose of this function is to provide a means of fine tuning QHash's memory usage. In general, you will rarely ever need to call this function. If you want to know how many items are in the hash, call size().

[since 5.0] QHash::const_iterator QHash::cbegin() const▲

Returns a const STL-style iterator pointing to the first item in the hash.

This function was introduced in Qt 5.0.

[since 5.0] QHash::const_iterator QHash::cend() const▲

Returns a const STL-style iterator pointing to the imaginary item after the last item in the hash.

This function was introduced in Qt 5.0.

void QHash::clear()▲

Removes all items from the hash and frees up all memory used by it.

QHash::const_iterator QHash::constBegin() const▲

Returns a const STL-style iterator pointing to the first item in the hash.

QHash::const_iterator QHash::constEnd() const▲

Returns a const STL-style iterator pointing to the imaginary item after the last item in the hash.

QHash::const_iterator QHash::constFind(const Key &key) const▲

Returns an iterator pointing to the item with the key in the hash.

If the hash contains no item with the key, the function returns constEnd().

[since 5.10] QHash::const_key_value_iterator QHash::constKeyValueBegin() const▲

Returns a const STL-style iterator pointing to the first entry in the hash.

This function was introduced in Qt 5.10.

[since 5.10] QHash::const_key_value_iterator QHash::constKeyValueEnd() const▲

Returns a const STL-style iterator pointing to the imaginary entry after the last entry in the hash.

This function was introduced in Qt 5.10.

bool QHash::contains(const Key &key) const▲

Returns true if the hash contains an item with the key; otherwise returns false.

qsizetype QHash::count(const Key &key) const▲

Returns the number of items associated with the key.

qsizetype QHash::count() const▲

This is an overloaded function.

Same as size().

bool QHash::empty() const▲

This function is provided for STL compatibility. It is equivalent to isEmpty(), returning true if the hash is empty; otherwise returns false.

QHash::iterator QHash::end()▲

Returns an STL-style iterator pointing to the imaginary item after the last item in the hash.

QHash::const_iterator QHash::end() const▲

This is an overloaded function.

[since 5.7] QHash::iterator QHash::erase(QHash::const_iterator pos)▲

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 QHash 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:

Sélectionnez

QHash&lt;QObject *, int&gt; objectHash;
...
QHash&lt;QObject *, int&gt;::iterator i = objectHash.find(obj);
while (i != objectHash.end() &amp;&amp; i.key() == obj) {
    if (i.value() == 0) {
        i = objectHash.erase(i);
    } else {
        ++i;
    }
}

This function was introduced in Qt 5.7.

QHash::iterator QHash::find(const Key &key)▲

Returns an iterator pointing to the item with the key in the hash.

If the hash contains no item with the key, the function returns end().

If the hash contains multiple items with the key, this function returns an iterator that points to the most recently inserted value. The other values are accessible by incrementing the iterator. For example, here's some code that iterates over all the items with the same key:

Sélectionnez

QHash&lt;QString, int&gt; hash;
...
QHash&lt;QString, int&gt;::const_iterator i = hash.find("HDR");
while (i != hash.end() &amp;&amp; i.key() == "HDR") {
    cout &lt;&lt; i.value() &lt;&lt; Qt::endl;
    ++i;
}

QHash::const_iterator QHash::find(const Key &key) const▲

This is an overloaded function.

QHash::iterator QHash::insert(const Key &key, const T &value)▲

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.

[since 5.15] void QHash::insert(const QHash<Key, T> &other)▲

Inserts all the items in the other hash into this hash.

If a key is common to both hashes, its value will be replaced with the value stored in other.

This function was introduced in Qt 5.15.

bool QHash::isEmpty() const▲

Returns true if the hash contains no items; otherwise returns false.

[since 5.6] QHash::key_iterator QHash::keyBegin() const▲

Returns a const STL-style iterator pointing to the first key in the hash.

This function was introduced in Qt 5.6.

[since 5.6] QHash::key_iterator QHash::keyEnd() const▲

Returns a const STL-style iterator pointing to the imaginary item after the last key in the hash.

This function was introduced in Qt 5.6.

[since 5.10] QHash::key_value_iterator QHash::keyValueBegin()▲

Returns an STL-style iterator pointing to the first entry in the hash.

This function was introduced in Qt 5.10.

[since 5.10] QHash::const_key_value_iterator QHash::keyValueBegin() const▲

Returns a const STL-style iterator pointing to the first entry in the hash.

This function was introduced in Qt 5.10.

[since 5.10] QHash::key_value_iterator QHash::keyValueEnd()▲

Returns an STL-style iterator pointing to the imaginary entry after the last entry in the hash.

This function was introduced in Qt 5.10.

[since 5.10] QHash::const_key_value_iterator QHash::keyValueEnd() const▲

Returns a const STL-style iterator pointing to the imaginary entry after the last entry in the hash.

This function was introduced in Qt 5.10.

QList<Key> QHash::keys() const▲

Returns a list containing all the keys in the hash, in an arbitrary order.

The order is guaranteed to be the same as that used by values().

This function creates a new list, in linear time. The time and memory use that entails can be avoided by iterating from keyBegin() to keyEnd().

QList<Key> QHash::keys(const T &value) const▲

This is an overloaded function.

Returns a list containing all the keys associated with value value, in an arbitrary order.

This function can be slow (linear time), because QHash's internal data structure is optimized for fast lookup by key, not by value.

float QHash::load_factor() const▲

Returns the current load factor of the QHash's internal hash table. This is the same as capacity()/size(). The implementation used will aim to keep the load factor between 0.25 and 0.5. This avoids having too many hash table collisions that would degrade performance.

Even with a low load factor, the implementation of the hash table has a very low memory overhead.

This method purely exists for diagnostic purposes and you should rarely need to call it yourself.

bool QHash::remove(const Key &key)▲

Removes the item that has the key from the hash. Returns true if the key exists in the hash and the item has been removed, and false otherwise.

[since 6.1] qsizetype QHash::removeIf(Predicate pred)▲

Removes all elements for which the predicate pred returns true from the hash.

The function supports predicates which take either an argument of type QHash<Key, T>::iterator, or an argument of type std::pair<const Key &, T &>.

Returns the number of elements removed, if any.

This function was introduced in Qt 6.1.

void QHash::reserve(qsizetype size)▲

Ensures that the QHash's internal hash table has space to store at least size items without having to grow the hash table.

This implies that the hash table will contain at least 2 * size buckets to ensure good performance

This function is useful for code that needs to build a huge hash and wants to avoid repeated reallocation. For example:

Sélectionnez

QHash&lt;QString, int&gt; hash;
hash.reserve(20000);
for (int i = 0; i &lt; 20000; ++i)
    hash.insert(keys[i], values[i]);

Ideally, size should be the maximum number of items expected in the hash. QHash will then choose the smallest possible number of buckets that will allow storing size items in the table without having to grow the internal hash table. If size is an underestimate, the worst that will happen is that the QHash will be a bit slower.

In general, you will rarely ever need to call this function. QHash's internal hash table automatically grows to provide good performance without wasting too much memory.

qsizetype QHash::size() const▲

Returns the number of items in the hash.

void QHash::squeeze()▲

Reduces the size of the QHash's internal hash table to save memory.

The sole purpose of this function is to provide a means of fine tuning QHash's memory usage. In general, you will rarely ever need to call this function.

void QHash::swap(QHash<Key, T> &other)▲

Swaps hash other with this hash. This operation is very fast and never fails.

T QHash::take(const Key &key)▲

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 default-constructed value.

If you don't use the return value, remove() is more efficient.

QList<T> QHash::values() const▲

Returns a list containing all the values in the hash, in an arbitrary order.

The order is guaranteed to be the same as that used by keys().

This function creates a new list, in linear time. The time and memory use that entails can be avoided by iterating from keyValueBegin() to keyValueEnd().

bool QHash::operator!=(const QHash<Key, T> &other) const▲

Returns true if other is not equal to this hash; otherwise returns false.

Two hashes are considered equal if they contain the same (key, value) pairs.

This function requires the value type to implement operator==().

QHash<Key, T> &QHash::operator=(const QHash<Key, T> &other)▲

Assigns other to this hash and returns a reference to this hash.

[since 5.2] QHash<Key, T> &QHash::operator=(QHash<Key, T> &&other)▲

Move-assigns other to this QHash instance.

This function was introduced in Qt 5.2.

bool QHash::operator==(const QHash<Key, T> &other) const▲

Returns true if other is equal to this hash; otherwise returns false.

Two hashes are considered equal if they contain the same (key, value) pairs.

This function requires the value type to implement operator==().

T &QHash::operator[](const Key &key)▲

Returns the value associated with the key as a modifiable reference.

If the hash contains no item with the key, the function inserts a default-constructed value into the hash with the key, and returns a reference to it.

const T QHash::operator[](const Key &key) const▲

This is an overloaded function.

Same as value().

Related Non-Members▲

[since 6.1] qsizetype erase_if(QHash<Key, T> &hash, Predicate pred)▲

Removes all elements for which the predicate pred returns true from the hash hash.

The function supports predicates which take either an argument of type QHash<Key, T>::iterator, or an argument of type std::pair<const Key &, T &>.

Returns the number of elements removed, if any.

This function was introduced in Qt 6.1.