QHash Class

QHash<QString, int> hash;

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

hash.insert("twelve", 12);

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

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

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

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

QHashIterator<QString, int> i(hash);
while (i.hasNext()) {
    i.next();
    cout << i.key() << ": " << i.value() << endl;
}

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

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

QList<int> values = hash.values("plenty");
for (int i = 0; i < values.size(); ++i)
    cout << values.at(i) << endl;

QHash<QString, int>::iterator i = hash.find("plenty");
while (i != hash.end() && i.key() == "plenty") {
    cout << i.value() << endl;
    ++i;
}

QHash<QString, int> hash;
...
foreach (int value, hash)
    cout << value << endl;

uint qHash(K key);
uint qHash(const K &key);

uint qHash(K key, uint seed);
uint qHash(const K &key, uint seed);

#ifndef EMPLOYEE_H
#define EMPLOYEE_H

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

private:
    QString myName;
    QDate myDateOfBirth;
};

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

inline uint qHash(const Employee &key, uint seed)
{
    return qHash(key.name(), seed) ^ key.dateOfBirth().day();
}

#endif // EMPLOYEE_H

Member Function Documentation

QHash::QHash()

Constructs an empty hash.

See also clear().

QHash::QHash(int)

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

This function is only available if the program is being compiled in C++11 mode.

This function was introduced in Qt 5.1.

QHash::QHash(const QHash<K, V> &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.

See also operator=().

QHash::QHash(QHash<K, V> &&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.

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.

See also constBegin() and end().

QHash::const_iterator QHash::begin() const

This is an overloaded function.

int 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().

See also reserve() and squeeze().

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.

See also begin() and cend().

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.

See also cbegin() and end().

void QHash::clear()

Removes all items from the hash.

See also remove().

QHash::const_iterator QHash::constBegin() const

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

See also begin() and constEnd().

QHash::const_iterator QHash::constEnd() const

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

See also constBegin() and end().

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().

This function was introduced in Qt 4.1.

See also find() and QMultiHash::constFind().

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.

See also keyValueBegin().

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.

See also constKeyValueBegin().

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

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

See also count() and QMultiHash::contains().

int QHash::count(const Key &key) const

Returns the number of items associated with the key.

See also contains() and insertMulti().

int 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.

See also begin() and constEnd().

QHash::const_iterator QHash::end() const

This is an overloaded function.

QPair<QHash::iterator, QHash::iterator> QHash::equal_range(const Key &key)

Returns a pair of iterators delimiting the range of values [first, second), that are stored under key. If the range is empty then both iterators will be equal to end().

This function was introduced in Qt 5.7.

QPair<QHash::const_iterator, QHash::const_iterator> QHash::equal_range(const Key &key) const

This is an overloaded function.

This function was introduced in Qt 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.

Unlike remove() and take(), 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:

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

This function was introduced in Qt 5.7.

See also remove(), take(), and find().

QHash::iterator QHash::erase(QHash::iterator pos)

This is an overloaded function.

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:

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

See also value(), values(), and QMultiHash::find().

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.

If there are multiple items with the key, the most recently inserted item's value is replaced with value.

See also insertMulti().

QHash::iterator QHash::insertMulti(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 same key in the hash, this function will simply create a new one. (This behavior is different from insert(), which overwrites the value of an existing item.)

See also insert() and values().

bool QHash::isEmpty() const

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

See also size().

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

Returns the first key mapped to value.

If the hash contains no item with the value, the function returns a default-constructed key.

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

See also value() and keys().

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

This is an overloaded function.

Returns the first key mapped to value, or defaultKey if the hash contains no item mapped to value.

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

This function was introduced in Qt 4.3.

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.

See also keyEnd().

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.

See also keyBegin().

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.

See also keyValueEnd().

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.

See also keyValueEnd().

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.

See also keyValueBegin().

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.

See also keyValueBegin().

QList<Key> QHash::keys() const

Returns a list containing all the keys in the hash, in an arbitrary order. Keys that occur multiple times in the hash (because items were inserted with insertMulti(), or unite() was used) also occur multiple times in the list.

To obtain a list of unique keys, where each key from the map only occurs once, use uniqueKeys().

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

See also uniqueKeys(), values(), and key().

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.

int QHash::remove(const Key &key)

Removes all the items that have the key from the hash. Returns the number of items removed which is usually 1 but will be 0 if the key isn't in the hash, or greater than 1 if insertMulti() has been used with the key.

See also clear(), take(), and QMultiHash::remove().

void QHash::reserve(int size)

Ensures that the QHash's internal hash table consists of at least size buckets.

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

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

Ideally, size should be slightly more than the maximum number of items expected in the hash. size doesn't have to be prime, because QHash will use a prime number internally anyway. 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 shrinks or grows to provide good performance without wasting too much memory.

See also squeeze() and capacity().

int QHash::size() const

Returns the number of items in the hash.

See also isEmpty() and count().

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.

See also reserve() and capacity().

void QHash::swap(QHash<K, V> &other)

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

This function was introduced in Qt 4.8.

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 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.

See also remove().

QList<Key> QHash::uniqueKeys() const

Returns a list containing all the keys in the map. Keys that occur multiple times in the map (because items were inserted with insertMulti(), or unite() was used) occur only once in the returned list.

This function was introduced in Qt 4.2.

See also keys() and values().

QHash<K, V> &QHash::unite(const QHash<K, V> &other)

Inserts all the items in the other hash into this hash. If a key is common to both hashes, the resulting hash will contain the key multiple times.

See also insertMulti().

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

Returns the value associated with the key.

If the hash contains no item with the key, the function returns a default-constructed value. If there are multiple items for the key in the hash, the value of the most recently inserted one is returned.

See also key(), values(), contains(), and operator[]().

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

This is an overloaded function.

If the hash contains no item with the given key, the function returns defaultValue.

QList<T> QHash::values() const

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().

See also keys() and value().

QList<T> QHash::values(const Key &key) const

This is an overloaded function.

Returns a list of all the values associated with the key, from the most recently inserted to the least recently inserted.

See also count() and insertMulti().

bool QHash::operator!=(const QHash<K, V> &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==().

See also operator==().

QHash<K, V> &QHash::operator=(const QHash<K, V> &other)

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

QHash<K, V> &QHash::operator=(QHash<K, V> &&other)

Move-assigns other to this QHash instance.

This function was introduced in Qt 5.2.

bool QHash::operator==(const QHash<K, V> &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==().

See also 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. If the hash contains multiple items with the key, this function returns a reference to the most recently inserted value.

See also insert() and value().

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

This is an overloaded function.

Same as value().

qHash(qMakePair(key.first, key.second), seed);

inline uint qHash(const std::vector<int> &key, uint seed = 0)
{
    if (key.empty())
        return seed;
    else
        return qHashBits(&key.front(), key.size() * sizeof(int), seed);
}

{0, 1, 2}

{1, 2, 0}

inline uint qHash(const std::vector<int> &key, uint seed = 0)
{
    return qHashRange(key.begin(), key.end(), seed);
}

{0, 1, 2}

{1, 2, 0}

inline uint qHash(const std::unordered_set<int> &key, uint seed = 0)
{
    return qHashRangeCommutative(key.begin(), key.end(), seed);
}