QHash Class

メンバ関数のドキュメント

[noexcept default] QHash::QHash()

空のハッシュを生成します。

clear()も参照してください 。

QHash::QHash(std::initializer_list<std::pair<Key, T>> list)

初期化リストlist に含まれる各要素のコピーを用いて、ハッシュを構築します。

template <typename InputIterator> QHash::QHash(InputIterator begin, InputIterator end)

イテレータ範囲 [begin,end) 内の各要素のコピーを用いてハッシュを構築します。この場合、範囲によって反復処理される要素は、first およびsecond データメンバー（std::pair など）を持ち、それぞれKey およびT に変換可能なオブジェクトでなければならないか、あるいはイテレータがkey() およびvalue() メンバー関数を持ち、それぞれKey に変換可能なキーとT に変換可能な値を返すものでなければなりません。

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

other のコピーを作成します。

QHashは暗黙的に共有されているため、この操作は定数時間で実行されます。これにより、関数からQHashを返す処理が非常に高速になります。共有されたインスタンスが変更された場合、そのインスタンスはコピーされます（コピー・オン・ライト）が、これには線形時間がかかります。

operator=()も参照してください 。

[noexcept] QHash::QHash(QHash<Key, T> &&other)

QHashのインスタンスをムーブコンストラクタで生成し、other が指していたのと同じオブジェクトを指すようにします。

QHash::~QHash()

ハッシュを破棄します。ハッシュ内の値への参照およびこのハッシュのすべてのイテレータは無効になります。

このハッシュをキーと値のペアとして反復処理できる範囲オブジェクトを返します。たとえば、この範囲オブジェクトは、構造化バインディング宣言と組み合わせて、範囲ベースの for ループで使用できます。

QHash<QString, int> hash;
hash.insert("January", 1);
hash.insert("February", 2);
// ...
hash.insert("December", 12);

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

この方法で取得されるキーと値は、いずれもハッシュ内の要素への参照であることに注意してください。具体的には、値を変更するとハッシュ自体が変更されます。

これらの関数は Qt 6.4 で導入されました。

QKeyValueIteratorも参照してください 。

QHash<Key, T>::iterator QHash::begin()

ハッシュの最初の要素を指すSTL形式のイテレータを返します。

関連項目： constBegin() およびend()。

[noexcept] QHash<Key, T>::const_iterator QHash::begin() const

[noexcept] qsizetype QHash::capacity() const

QHash の内部ハッシュテーブルに含まれるバケットの数を返します。

この関数の唯一の目的は、QHash のメモリ使用量を微調整する手段を提供することです。通常、この関数を呼び出す必要はほとんどありません。ハッシュに含まれる項目の数を知りたい場合は、size()を呼び出してください。

reserve() およびsqueeze()も参照してください 。

[noexcept] QHash<Key, T>::const_iterator QHash::cbegin() const

ハッシュの最初の要素を指す、STL スタイルのconstイテレータを返します。

begin() およびcend()も参照してください 。

[noexcept] QHash<Key, T>::const_iterator QHash::cend() const

ハッシュの最後の要素の後に存在する架空の要素を指す、STL スタイルのconstイテレータを返します。

cbegin() およびend()も参照してください 。

[noexcept(...)] void QHash::clear()

ハッシュからすべての項目を削除し、ハッシュが使用していたメモリをすべて解放します。

remove()も参照してください 。

[noexcept] QHash<Key, T>::const_iterator QHash::constBegin() const

ハッシュの最初の要素を指す、STL スタイルのconstイテレータを返します。

begin() およびconstEnd()も参照してください 。

[noexcept] QHash<Key, T>::const_iterator QHash::constEnd() const

ハッシュの最後の項目の後に位置する架空の項目を指す、STL スタイルのconstイテレータを返します。

constBegin() およびend()も参照してください 。

[noexcept] QHash<Key, T>::const_iterator QHash::constFind(const Key &key) const

ハッシュ内のkey を持つ項目を指すイテレータを返します。

ハッシュにkey を持つ項目が含まれていない場合、この関数はconstEnd()を返します。

find()も参照してください 。

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::constKeyValueBegin() const

ハッシュの最初のエントリを指す、STL スタイルのconstイテレータを返します。

keyValueBegin()も参照してください 。

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::constKeyValueEnd() const

ハッシュの最後のエントリの直後に位置する仮想のエントリを指す、STL スタイルのconstイテレータを返します。

constKeyValueBegin()も参照してください 。

[noexcept] bool QHash::contains(const Key &key) const

ハッシュに `key` を持つ項目が含まれている場合は `true ` を返し、そうでない場合は `false` を返します。

count()も参照してください 。

[noexcept] qsizetype QHash::count(const Key &key) const

key に関連付けられた項目の数を返します。

「contains()」も参照してください 。

[noexcept] qsizetype QHash::count() const

size() と同じです。

コンテナに新しい要素を挿入します。この新しい要素は、args を構築引数として使用して、その場（インプレース）で構築されます。コンテナにその要素がすでに存在する場合、その要素は置き換えられます。

新しい要素を指すイテレータを返します。

[noexcept] bool QHash::empty() const

この関数は、STLとの互換性を確保するために提供されています。これはisEmpty()と同等であり、ハッシュが空の場合はtrueを返し、そうでない場合はfalse を返します。

[noexcept] QHash<Key, T>::iterator QHash::end()

ハッシュの最後の項目の後に位置する架空の項目を指す、STL スタイルのイテレータを返します。

begin() およびconstEnd()も参照してください 。

[noexcept] QHash<Key, T>::const_iterator QHash::end() const

QHash<Key, T>::iterator QHash::erase(QHash<Key, T>::const_iterator pos)

イテレータ `pos ` に関連付けられた (キー, 値) のペアをハッシュから削除し、ハッシュ内の次の項目へのイテレータを返します。

この関数は、QHash の内部データ構造の再ハッシュ処理を引き起こすことはありません。つまり、反復処理中に安全に呼び出すことができ、ハッシュ内の項目の順序に影響を与えません。例：

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()も参照してください 。

QHash<Key, T>::iterator QHash::find(const Key &key)

ハッシュ内のkey を持つ項目を指すイテレータを返します。

ハッシュにkey を持つ項目が含まれていない場合、この関数はend()を返します。

ハッシュに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()も参照してください 。

[noexcept] QHash<Key, T>::const_iterator QHash::find(const Key &key) const

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

other ハッシュ内のすべての項目を、このハッシュに挿入します。

両方のハッシュに共通するキーがある場合、その値はother に格納されている値に置き換えられます。

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

key というキーと、値value を持つ新しい項目を挿入します。

key というキーを持つ項目がすでに存在する場合、その項目の値はvalue に置き換えられます。

既存のキーを持つキー/値のペアを挿入すると、既存の値が置き換えられます。

新しい要素または更新された要素を指すイテレータを返します。

これらの機能は、Qt 6.11で導入されました。

key およびvalue を使用してアイテムを挿入しようとします。key を持つアイテムがすでに存在する場合、その値はvalue で上書きされます。

TryEmplaceResult のインスタンスを返します。これは、アイテムへのiterator と、アイテムが新規に作成されたか（true ）、または以前に存在していたか（false ）を示すブール値inserted を保持する構造体です。

これらの関数は Qt 6.9 で導入されました。

insert()、tryEmplace()、およびtryInsert()も参照してください 。

key およびvalue を使用して、項目の挿入を試みます。key を持つ項目がすでに存在する場合、その値はvalue で上書きされます。

その項目を指すイテレータと、その項目が新規に作成されたか（true ）、あるいは以前から存在していたか（false ）を示すブール値からなるペアを返します。

これらの関数は、標準ライブラリとの互換性を確保するために提供されています。

これらの関数は Qt 6.9 で導入されました。

insert()、tryEmplace()、tryInsert()、およびinsertOrAssign()も参照してください 。

key およびvalue を使用してアイテムを挿入しようとします。key を持つアイテムがすでに存在する場合、その値はvalue で上書きされます。

その項目を指すイテレータと、その項目が新しく作成されたか（true ）、あるいは以前から存在していたか（false ）を示すブール値からなるタプルを返します。

hint は無視されます。

これらの関数は、標準ライブラリとの互換性のために提供されています。

これらの関数は、Qt 6.9 で導入されました。

insert()、tryEmplace()、およびinsertOrAssign()も参照してください 。

[noexcept] bool QHash::isEmpty() const

ハッシュに要素が含まれていない場合は `true ` を返し、それ以外の場合は `false` を返します。

size()も参照してください 。

value にマッピングされた最初のキーを返します。ハッシュにvalue にマッピングされた項目が含まれていない場合は、defaultKey を返します。また、このパラメータが指定されていない場合は、デフォルトで構築されたキーを返します。

QHash の内部データ構造は、値による検索ではなくキーによる高速な検索のために最適化されているため、この関数の実行は遅くなる可能性があります（線形時間）。

[noexcept] QHash<Key, T>::key_iterator QHash::keyBegin() const

ハッシュ内の最初のキーを指す、STL スタイルのconstイテレータを返します。

keyEnd()も参照してください 。

[noexcept] QHash<Key, T>::key_iterator QHash::keyEnd() const

ハッシュの最後のキーの後に存在する架空の項目を指す、STL スタイルのconstイテレータを返します。

keyBegin()も参照してください 。

QHash<Key, T>::key_value_iterator QHash::keyValueBegin()

ハッシュの最初のエントリを指すSTL形式のイテレータを返します。

keyValueEnd()も参照してください 。

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::keyValueBegin() const

ハッシュの最初のエントリを指す、STL スタイルのconstイテレータを返します。

keyValueEnd()も参照してください 。

QHash<Key, T>::key_value_iterator QHash::keyValueEnd()

ハッシュの最後のエントリの直後に位置する仮想のエントリを指す、STLスタイルのイテレータを返します。

keyValueBegin()も参照してください 。

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::keyValueEnd() const

ハッシュの最後のエントリの直後に位置する仮想のエントリを指す、STL スタイルのconstイテレータを返します。

keyValueBegin()も参照してください 。

QList<Key> QHash::keys() const

ハッシュ内のすべてのキーを、任意の順序で含むリストを返します。

順序は、values() で使用される順序と同じであることが保証されています。

この関数は、線形時間で新しいリストを作成します。これに伴う時間およびメモリの使用は、keyBegin() からkeyEnd() へイテレーションを行うことで回避できます。

values() およびkey()も参照してください 。

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

値 `value` に関連付けられたすべてのキーを、任意の順序で含むリストを返します。

QHash の内部データ構造は、値ではなくキーによる高速な検索用に最適化されているため、この関数の実行速度は遅くなる可能性があります（線形時間）。

[noexcept] float QHash::load_factor() const

QHash の内部ハッシュテーブルの現在の負荷率を返します。これは、capacity() およびsize() と同じ動作をします。実装では、負荷率を0.25から0.5の間に維持するよう努めます。これにより、パフォーマンスを低下させるようなハッシュテーブルの衝突が過度に発生することを防ぎます。

ロードファクタが低くても、ハッシュテーブルの実装によるメモリオーバーヘッドは極めて小さいです。

このメソッドは純粋に診断目的で存在しており、自分で呼び出す必要はほとんどないはずです。

reserve() およびsqueeze()も参照してください 。

bool QHash::remove(const Key &key)

ハッシュから、key を持つ項目を削除します。ハッシュにそのキーが存在し、項目が削除された場合は true を返し、そうでない場合は false を返します。

clear() およびtake()も参照してください 。

[since 6.1] template <typename Predicate> qsizetype QHash::removeIf(Predicate pred)

述語 `pred ` が真を返すすべての要素をハッシュから削除します。

この関数は、QHash<Key, T>::iterator 型の引数、またはstd::pair<const Key &, T &> 型の引数を受け取る述語をサポートしています。

削除された要素がある場合は、その数を返します。

この関数は Qt 6.1 で導入されました。

clear() およびtake()も参照してください 。

void QHash::reserve(qsizetype size)

QHash の内部ハッシュテーブルが、ハッシュテーブルを拡張することなく、少なくともsize 個の項目を格納できる空き容量を確保します。

これは、良好なパフォーマンスを確保するために、ハッシュテーブルには少なくとも 2 *size 個のバケットが含まれることを意味します。

この関数は、巨大なハッシュを構築する必要があり、繰り返し再割り当てを避けたいコードに有用です。例えば：

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

理想的には、size はハッシュ内に予想されるアイテムの最大数であるべきです。そうすれば、QHash は、内部ハッシュテーブルを拡張することなく、size 個のアイテムをテーブルに格納できる最小限のバケット数を選択します。もしsize が過小評価されていたとしても、最悪の場合、QHash の動作がわずかに遅くなるだけです。

一般的に、この関数を呼び出す必要が生じることはほとんどありません。QHash の内部ハッシュテーブルは、メモリを無駄に消費することなく良好なパフォーマンスを確保できるよう、自動的に拡張されます。

squeeze() およびcapacity()も参照してください 。

[noexcept] qsizetype QHash::size() const

ハッシュに含まれる要素の数を返します。

isEmpty() およびcount()も参照してください 。

void QHash::squeeze()

QHash の内部ハッシュテーブルのサイズを縮小し、メモリを節約します。

この関数の唯一の目的は、QHash のメモリ使用量を微調整する手段を提供することです。一般的に、この関数を呼び出す必要が生じることはほとんどありません。

reserve() およびcapacity()も参照してください 。

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

このハッシュをother と入れ替えます。この操作は非常に高速で、失敗することはありません。

T QHash::take(const Key &key)

key を持つ項目をハッシュから削除し、それに関連付けられた値を返します。

ハッシュにその項目が存在しない場合、この関数はデフォルト構築された値を単に返します。

戻り値を使用しない場合は、remove() の方が効率的です。

remove()も参照してください 。

key およびargs から構築された値を持つ新しい項目を挿入します。key を持つ項目がすでに存在する場合、挿入は行われません。

TryEmplaceResult のインスタンスを返します。これは、新しく作成された項目、または挿入を妨げた既存の項目へのiterator と、挿入が行われたかどうかを示すブール値inserted を保持する構造体です。

たとえば、これを使用することで、新旧のサイズを比較する処理や二重ルックアップといったパターンを回避できます。以前は次のようなコードを書いていたかもしれません：

QHash<int, MyType> hash;
// [...]
int myKey = getKey();
qsizetype oldSize = hash.size();
MyType &elem = hash[myKey];
if (oldSize != hash.size()) // Size changed: new element!
    initialize(elem);
// [use elem...]

代わりに次のように記述できます：

QHash<int, MyType> hash;
// [...]
int myKey = getKey();
auto result = hash.tryEmplace(myKey);
if (result.inserted) // New element!
    initialize(*result.iterator);
// [use result.iterator...]

これらの関数は Qt 6.9 で導入されました。

emplace()、tryInsert()、およびinsertOrAssign()も参照してください 。

key を持ち、値がvalue である新しい項目を挿入します。key を持つ項目がすでに存在する場合、挿入は行われません。

TryEmplaceResult のインスタンスを返します。この構造体には、新しく作成された項目、または挿入を阻止した既存の項目へのiterator 、および挿入が行われたかどうかを示すブール値inserted が格納されています。

これらの関数は Qt 6.9 で導入されました。

insert()、tryEmplace()、およびinsertOrAssign()も参照してください 。

key を持つ新しい項目を、args から構築された値とともに挿入します。key を持つ項目がすでに存在する場合、挿入は行われません。

挿入された項目（または挿入を妨げた項目）へのイテレータと、挿入が行われたかどうかを示すブール値からなるペアを返します。

これらの関数は、標準ライブラリとの互換性を確保するために提供されています。

これらの関数は Qt 6.9 で導入されました。

emplace()、tryEmplace()、tryInsert()、およびinsertOrAssign()も参照してください 。

key を持つ新しい項目を、args から生成された値とともに挿入します。key を持つ項目がすでに存在する場合、挿入は行われません。

挿入された項目のイテレータ、または挿入を妨げた項目へのイテレータを返します。

hint は無視されます。

これらの関数は、標準ライブラリとの互換性のために提供されています。

これらの関数は、Qt 6.9 で導入されました。

emplace()、tryEmplace()、tryInsert()、およびinsertOrAssign()も参照してください 。

key に関連付けられた値を返します。

ハッシュにkey を持つ項目が含まれていない場合、この関数はdefaultValue を返します。また、このパラメータが指定されていない場合は、デフォルト構築された値を返します。

QList<T> QHash::values() const

ハッシュ内のすべての値を、任意の順序で含むリストを返します。

順序は、keys() で使用される順序と同じであることが保証されています。

この関数は、線形時間で新しいリストを作成します。これに伴う時間とメモリの使用は、keyValueBegin() からkeyValueEnd() へ反復処理を行うことで回避できます。

keys() およびvalue()も参照してください 。

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

other をこのQHash インスタンスに割り当てます。

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

このハッシュに `other ` を割り当て、このハッシュへの参照を返します。

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

key に関連付けられた値を、変更可能な参照として返します。

ハッシュにkey を持つ項目が含まれていない場合、この関数はkeyを持つデフォルト構築された値をハッシュに挿入し、その参照を返します。

insert() およびvalue()も参照してください 。

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

value() と同じです。