QHash 类

The QHash 类是提供基于哈希表的字典的模板类。 更多...

头: #include <QHash>
继承者: QMultiHash

注意: 此类的所有函数 可重入 .

公共类型

class const_iterator
class iterator
typedef ConstIterator
typedef Iterator
typedef difference_type
typedef key_type
typedef mapped_type
typedef size_type

公共函数

QHash ()
QHash (const QHash<Key, T> & other )
~QHash ()
iterator begin ()
const_iterator begin () const
int capacity () const
void clear ()
const_iterator constBegin () const
const_iterator constEnd () const
const_iterator constFind (const Key & key ) const
bool contains (const Key & key ) const
int count (const Key & key ) const
int count () const
bool empty () const
iterator end ()
const_iterator end () const
iterator erase (iterator pos )
iterator find (const Key & key )
const_iterator find (const Key & key ) const
iterator insert (const Key & key , const T & value )
iterator insertMulti (const Key & key , const T & value )
bool isEmpty () const
const Key key (const T & value ) const
const Key key (const T & value , const Key & defaultKey ) const
QList<Key> keys () const
QList<Key> keys (const T & value ) const
int remove (const Key & key )
void reserve (int size )
int size () const
void squeeze ()
void swap (QHash<Key, T> & other )
T take (const Key & key )
QList<Key> uniqueKeys () const
QHash<Key, T> & unite (const QHash<Key, T> & other )
const T value (const Key & key ) const
const T value (const Key & key , const T & defaultValue ) const
QList<T> values () const
QList<T> values (const Key & key ) const
bool operator!= (const QHash<Key, T> & other ) const
QHash<Key, T> & operator= (const QHash<Key, T> & other )
QHash<Key, T> & operator= (QHash<Key, T> && other )
bool operator== (const QHash<Key, T> & other ) const
T & operator[] (const Key & key )
const T operator[] (const Key & key ) const
uint qHash (const QXmlNodeModelIndex & index )
uint qHash (char key )
uint qHash (uchar key )
uint qHash (signed char key )
uint qHash (ushort key )
uint qHash (short key )
uint qHash (uint key )
uint qHash (int key )
uint qHash (ulong key )
uint qHash (long key )
uint qHash (quint64 key )
uint qHash (qint64 key )
uint qHash (QChar key )
uint qHash (const QByteArray & key )
uint qHash (const QString & key )
uint qHash (const QBitArray & key )
uint qHash (const T * key )
uint qHash (const QPair<T1, T2> & key )
QDataStream & operator<< (QDataStream & out , const QHash<Key, T> & hash )
QDataStream & operator>> (QDataStream & in , QHash<Key, T> & hash )

详细描述

The QHash 类是提供基于哈希表的字典的模板类。

QHash <Key, T> 是一种 Qt 一般 容器类 。它存储 (键,值) 对,并提供键关联值的非常快速查找。

QHash 提供的功能非常类似于 QMap 。差异:

  • QHash 提供更快的查找相比 QMap 。(见 算法的复杂性 了解细节。)
  • 当遍历 QMap ,项始终按键排序。采用 QHash ,项是任意次序。
  • Key 类型对于 QMap must provide operator<(). The key type of a QHash must provide operator==() and a global hash function called qHash () (see the related non-member functions).

这里是范例 QHash with QString 键和 int 值:

QHash<QString, int> hash;
					

要将 (键,值) 对插入哈希,可以使用 operator[]():

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

hash.insert("twelve", 12);
					

要查找值,使用 operator[]() 或 value ():

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

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:

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

In general, we recommend that you use contains () 和 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:

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

要避免此问题,替换 hash[i] with hash.value(i) 在以上代码中。

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

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

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

QHash<QString, int>::const_iterator i = hash.constBegin();
while (i != hash.constEnd()) {
    cout << i.key() << ": " << i.value() << 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 .

Normally, 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:

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

However, you can store multiple values per key by using insertMulti () 而不是 insert () (or using the convenience subclass QMultiHash ). If you want to retrieve all the values for a single key, you can use values(const Key &key), which returns a QList <T>:

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

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 iterator for the first item with a key and iterate from there:

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

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

QHash<QString, int> hash;
...
foreach (int value, hash)
    cout << value << 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 可赋值数据类型 。例如,无法存储 QWidget 作为值;取而代之,存储 QWidget *. In addition, QHash 's key type must provide operator==(), and there must also be a global qHash () function that returns a hash value for an argument of the key's type.

Here's a 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 ,和 QByteArray . For all of these, the <QHash> header defines a qHash () function that computes an adequate hash value. If you want to use other types as the key, make sure that you provide operator==() and a qHash () 实现。

范例:

#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)
{
    return qHash(key.name()) ^ key.dateOfBirth().day();
}
#endif // EMPLOYEE_H
					

The qHash () 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 ,那么 qHash(e1) == qHash(e2) must hold as well. However, to obtain good performance, the qHash () function should attempt to return different hash values for different keys to the largest extent possible.

In the example above, we've relied on Qt's global qHash (const QString &) to give us a hash value for the employee's name, and XOR'ed this with the day they were born to help produce unique hashes for people with the same name.

在内部, QHash uses a hash table to perform lookups. Unlike Qt 3's QDict class, which needed to be initialized with a prime number, QHash 's hash table automatically grows and shrinks 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.

另请参阅 QHashIterator , QMutableHashIterator , QMap ,和 QSet .

成员类型文档编制

typedef QHash:: ConstIterator

Qt 样式同义词 QHash::const_iterator .

typedef QHash:: Iterator

Qt 样式同义词 QHash::iterator .

typedef QHash:: difference_type

typedef 对于 ptrdiff_t。为兼容 STL 提供。

typedef QHash:: key_type

typedef 对于 Key。为兼容 STL 提供。

typedef QHash:: mapped_type

typedef 对于 T。为兼容 STL 提供。

typedef QHash:: size_type

typedef 对于 int。为兼容 STL 提供。

成员函数文档编制

QHash:: QHash ()

构造空哈希。

另请参阅 clear ().

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

构造副本为 other .

This operation occurs in 常量时间 ,因为 QHash is 隐式共享 . 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 线性时间 .

另请参阅 operator= ().

QHash:: ~QHash ()

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

iterator QHash:: begin ()

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

另请参阅 constBegin () 和 end ().

const_iterator QHash:: begin () const

这是重载函数。

int QHash:: capacity () const

Returns the number of buckets in the QHash 的内部哈希表。

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

另请参阅 reserve () 和 squeeze ().

void QHash:: clear ()

从哈希移除所有项。

另请参阅 remove ().

const_iterator QHash:: constBegin () const

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

另请参阅 begin () 和 constEnd ().

const_iterator QHash:: constEnd () const

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

另请参阅 constBegin () 和 end ().

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

返回迭代器指向的项具有 key 在哈希中。

若哈希包含的项不具有 key ,函数返回 constEnd ().

该函数在 Qt 4.1 引入。

另请参阅 find () 和 QMultiHash::constFind ().

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

Returns true if the hash contains an item with the key ;否则返回 false。

另请参阅 count () 和 QMultiHash::contains ().

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

返回项数关联 key .

另请参阅 contains () 和 insertMulti ().

int QHash:: count () const

这是重载函数。

如同 size ().

bool QHash:: empty () const

此函数为兼容 STL (标准模板库) 提供。它相当于 isEmpty (), returning true if the hash is empty; otherwise returns false.

iterator QHash:: end ()

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

另请参阅 begin () 和 constEnd ().

const_iterator QHash:: end () const

这是重载函数。

iterator QHash:: erase ( 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.

不像 remove () 和 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;
    }
}
					

另请参阅 remove (), take (),和 find ().

iterator QHash:: find (const Key & key )

返回迭代器指向的项具有 key 在哈希中。

若哈希包含的项不具有 key ,函数返回 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;
}
					

另请参阅 value (), values (),和 QMultiHash::find ().

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

这是重载函数。

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

插入新项具有 key 和值 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 .

另请参阅 insertMulti ().

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

插入新项具有 key 和值 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.)

另请参阅 insert () 和 values ().

bool QHash:: isEmpty () const

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

另请参阅 size ().

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

Returns the first key mapped to value .

若哈希包含的项不具有 value , the function returns a default-constructed key.

此函数可能很慢 ( 线性时间 ),因为 QHash 's internal data structure is optimized for fast lookup by key, not by value.

另请参阅 value () 和 keys ().

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

这是重载函数。

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

此函数可能很慢 ( 线性时间 ),因为 QHash 's internal data structure is optimized for fast lookup by key, not by value.

该函数在 Qt 4.3 引入。

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

另请参阅 uniqueKeys (), values (),和 key ().

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

这是重载函数。

Returns a list containing all the keys associated with value value ,按任意次序。

此函数可能很慢 ( 线性时间 ),因为 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 .

另请参阅 clear (), take (),和 QMultiHash::remove ().

void QHash:: reserve ( int size )

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

另请参阅 squeeze () 和 capacity ().

int QHash:: size () const

返回哈希中的项数。

另请参阅 isEmpty () 和 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.

另请参阅 reserve () 和 capacity ().

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

交换哈希 other with this hash. This operation is very fast and never fails.

该函数在 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.

若不使用返回值, remove () 效率更高。

另请参阅 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 (),或 unite () was used) occur only once in the returned list.

该函数在 Qt 4.2 引入。

另请参阅 keys () 和 values ().

QHash < Key , T > & QHash:: unite (const QHash < Key , T > & 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.

另请参阅 insertMulti ().

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

返回值关联 key .

若哈希包含的项不具有 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.

另请参阅 key (), values (), contains (),和 operator[] ().

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

这是重载函数。

If the hash contains no item with the given key ,函数返回 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 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 ().

另请参阅 keys () 和 value ().

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

这是重载函数。

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

另请参阅 count () 和 insertMulti ().

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

返回 true 若 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==() .

另请参阅 operator== ().

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

赋值 other to this hash and returns a reference to this hash.

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

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

返回 true 若 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==() .

另请参阅 operator!= ().

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

返回值关联 key 作为可修改引用。

若哈希包含的项不具有 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.

另请参阅 insert () 和 value ().

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

这是重载函数。

如同 value ().

相关非成员

uint qHash (const QXmlNodeModelIndex & index )

Computes a hash key from the QXmlNodeModelIndex index , and returns it. This function would be used by QHash if you wanted to build a hash table for instances of QXmlNodeModelIndex .

The hash is computed on QXmlNodeModelIndex::data (), QXmlNodeModelIndex::additionalData (),和 QXmlNodeModelIndex::model (). This means the hash key can be used for node indexes from different node models.

该函数在 Qt 4.4 引入。

uint qHash ( char key )

返回哈希值为 key .

uint qHash ( uchar key )

返回哈希值为 key .

uint qHash ( signed char key )

返回哈希值为 key .

uint qHash ( ushort key )

返回哈希值为 key .

uint qHash ( short key )

返回哈希值为 key .

uint qHash ( uint key )

返回哈希值为 key .

uint qHash ( int key )

返回哈希值为 key .

uint qHash ( ulong key )

返回哈希值为 key .

uint qHash ( long key )

返回哈希值为 key .

uint qHash ( quint64 key )

返回哈希值为 key .

uint qHash ( qint64 key )

返回哈希值为 key .

uint qHash ( QChar key )

返回哈希值为 key .

uint qHash (const QByteArray & key )

返回哈希值为 key .

uint qHash (const QString & key )

返回哈希值为 key .

uint qHash (const QBitArray & key )

返回哈希值为 key .

uint qHash (const T * key )

返回哈希值为 key .

uint qHash (const QPair < T1 , T2 > & key )

返回哈希值为 key .

类型 T1 and T2 must be supported by qHash ().

该函数在 Qt 4.3 引入。

QDataStream & operator<< ( QDataStream & out , const QHash < Key , T > & hash )

写入哈希 hash 到流 out .

This function requires the key and value types to implement operator<<() .

另请参阅 序列化 Qt 数据类型 .

QDataStream & operator>> ( QDataStream & in , QHash < Key , T > & hash )

读取哈希从流 in into hash .

This function requires the key and value types to implement operator>>() .

另请参阅 序列化 Qt 数据类型 .